@luigi-project/container - npm Package Compare versions

Comparing version 1.3.0-dev.20241150030 to 1.3.0-dev.20241160030

LuigiCompoundContainer.svelte.d.ts

@@ -10,2 +10,5 @@ export declare interface WebComponentSettings {
    * The URL used for the renderer.
+   * 
+   * @example <luigi-container viewurl="/index.html"></luigi-container>
+   * @example myContainer.viewurl = "/index.html"
    */
@@ -18,3 +21,6 @@ viewurl: string;
    * @since 1.0.0
-   *
+   * 
+   * @example renderer = { use: 'grid', config: { columns: '1fr 1fr 1fr 2fr', layouts: [{maxWidth: 600, columns: '1fr', gap: 0, ...}]}};
+   * children = [{ viewUrl: '/main.js', context: { label: 'WC', ...}, layoutConfig: {column: '1 / -1', ...}, eventListeners: [{ source: 'input1', ...}}]}];
+   * myContainer.compoundConfig = { renderer, children };
    */
@@ -26,2 +32,5 @@ compoundConfig: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" defer-init></luigi-container>
+   * @example myContainer.deferInit = true
    */
@@ -34,2 +43,5 @@ deferInit: boolean;
    * @since NEXT_RELEASE_CONTAINER
+   * 
+   * @example <luigi-container locale="en_us"></luigi-container>
+   * @example myContainer.locale = "en_us"
    */
@@ -41,2 +53,5 @@ locale: string;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" node-params='{"node":"param"}'></luigi-container>
+   * @example myContainer.nodeParams = {foo: bar}
    */
@@ -48,2 +63,5 @@ nodeParams: Object;
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" no-shadow></luigi-container>
+   * @example myContainer.noShadow = true
    */
@@ -55,2 +73,5 @@ noShadow: boolean;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" search-params='{"search":"param"}'></luigi-container>
+   * @example myContainer.searchParams = {foo: bar}
    */
@@ -62,2 +83,5 @@ searchParams: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" path-params='{"path":"param"}'></luigi-container>
+   * @example myContainer.pathParams = {foo: "bar"}
    */
@@ -69,2 +93,5 @@ pathParams: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewUrl="/index.html" context='{"label": "Dashboard"}'></luigi-container>
+   * @example myContainer.context = {label: "Dashboard"}
    */
@@ -76,2 +103,5 @@ context: string;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" client-permissions='{"permission": "adminGroup"}'></luigi-container>
+   * @example myContainer.clientPermissions = {permission: "adminGroup"}
    */
@@ -83,2 +113,5 @@ clientPermissions: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" user-settings='{"language": "de", "theme":"sap_horizon"}'></luigi-container>
+   * @example myContainer.userSettings = {language: 'de', theme: 'sap_horizon'}
    */
@@ -90,2 +123,5 @@ userSettings: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" anchor='#foo'></luigi-container>
+   * @example myContainer.anchor = '#foo'
    */
@@ -97,2 +133,5 @@ anchor: string;
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" document-title='Luigi App'></luigi-container>
+   * @example myContainer.documentTitle = 'Luigi App'
    */
@@ -105,4 +144,7 @@ documentTitle: string;
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" has-back></luigi-container>
+   * @example myContainer.hasBack = true
    */
-  hasBack: string;
+  hasBack: boolean;
 
@@ -113,2 +155,5 @@ /**
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" dirty-status></luigi-container>
+   * @example myContainer.dirtyStatus = true
    */
@@ -125,2 +170,5 @@ dirtyStatus: boolean;
    * @since 1.0.0
+   * 
+   * @example <luigi-container webcomponent="{ type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}"></luigi-container>
+   * @example myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}
    */
@@ -132,2 +180,5 @@ webcomponent: boolean | WebComponentSettings | string;
    * @since NEXT_RELEASE_CONTAINER
+   * 
+   * @example <luigi-container viewurl="/index.html" skipInitCheck></luigi-container>
+   * @example myContainer.skipInitCheck = true
    */
@@ -139,2 +190,6 @@ skipInitCheck: boolean;
    * @since NEXT_RELEASE_CONTAINER
+   * 
+   * 
+   * @example <luigi-container viewUrl="/index.html" active-feature-toggle-list='["enable-foo", "allow-bar"]'></luigi-container>
+   * @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"]
    */
@@ -146,2 +201,6 @@ activeFeatureToggleList: string[];
    * @since NEXT_RELEASE_CONTAINER
+   * 
+   * 
+   * @example <luigi-container viewUrl="/index.html" theme='sap_horizon'></luigi-container>
+   * @example myContainer.theme = 'sap_horizon'
    */
@@ -148,0 +207,0 @@ theme: string;

LuigiContainer.svelte.d.ts

@@ -11,2 +11,5 @@ export declare interface WebComponentSettings {
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html"></luigi-container>
+   * @example myContainer.viewurl = "/index.html"
    */
@@ -18,2 +21,5 @@ viewurl: string;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" defer-init></luigi-container>
+   * @example myContainer.deferInit = true
    */
@@ -25,2 +31,6 @@ deferInit: boolean;
    * @since 1.0.0
+   * 
+   * 
+   * @example <luigi-container viewUrl="/index.html" context='{"label": "Dashboard"}'></luigi-container>
+   * @example myContainer.context = {label: "Dashboard"}
    */
@@ -32,2 +42,5 @@ context: string;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewUrl="/index.html" label="Dashboard"></luigi-container>
+   * @example myContainer.label = "Dashboard"
    */
@@ -57,2 +70,4 @@ label: string;
    * @since 1.0.0
+   * @example <luigi-container webcomponent="{ type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}"></luigi-container>
+   * @example myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}
    */
@@ -64,2 +79,5 @@ webcomponent: boolean | WebComponentSettings | string;
    * @since 1.0.0
+   * 
+   * @example <luigi-container locale="en_us"></luigi-container>
+   * @example myContainer.locale = "en_us"
    */
@@ -71,2 +89,5 @@ locale: string;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" theme='sap_horizon'></luigi-container>
+   * @example myContainer.theme = 'sap_horizon'
    */
@@ -78,2 +99,5 @@ theme: string;
    * @since 1.0.0
+   * 
+   * @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"]
+   * @example <luigi-container viewurl="/index.html" active-feature-toggle-list='["enable-foo", "allow-bar"]'></luigi-container>
    */
@@ -85,4 +109,7 @@ activeFeatureToggleList: string[];
    * @since NEXT_RELEASE_CONTAINER
+   * 
+   * @example <luigi-container viewurl="/index.html" skipCookieCheck></luigi-container>
+   * @example myContainer.skipCookieCheck = true
    */
-  skipCookieCheck: 'false' | 'true';
+  skipCookieCheck: boolean;
 
@@ -92,2 +119,5 @@ /**
    * @since 1.0.0
+   * TODO: https://developer.mozilla.org/en-US/docs/Glossary/Boolean/HTML says booleans should not use "true"/"false", find a consistent style for our docs.
+   * @example <luigi-container viewurl="/index.html" skipInitCheck></luigi-container>
+   * @example myContainer.skipInitCheck = true
    */
@@ -99,2 +129,5 @@ skipInitCheck: boolean;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" node-params='{"node":"param"}'></luigi-container>
+   * @example myContainer.nodeParams = {foo: bar}
    */
@@ -106,2 +139,5 @@ nodeParams: Object;
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" no-shadow></luigi-container>
+   * @example myContainer.noShadow = true
    */
@@ -113,2 +149,5 @@ noShadow: boolean;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" search-params='{"search":"param"}'></luigi-container>
+   * @example myContainer.searchParams = {foo: bar}
    */
@@ -120,2 +159,5 @@ searchParams: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" path-params='{"path":"param"}'></luigi-container>
+   * @example myContainer.pathParams = {foo: "bar"}
    */
@@ -127,2 +169,5 @@ pathParams: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" client-permissions='{"permission": "adminGroup"}'></luigi-container>
+   * @example myContainer.clientPermissions = {permission: "adminGroup"}
    */
@@ -134,2 +179,5 @@ clientPermissions: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" user-settings='{"language": "de", "theme":"sap_horizon"}'></luigi-container>
+   * @example myContainer.userSettings = {language: 'de', theme: 'sap_horizon'}
    */
@@ -141,2 +189,5 @@ userSettings: Object;
    * @since 1.0.0
+   * 
+   * @example <luigi-container viewurl="/index.html" anchor='#foo'></luigi-container>
+   * @example myContainer.anchor = '#foo'
    */
@@ -148,3 +199,3 @@ anchor: string;
    * You can use one or more rules by adding them to the array, for example allowRules: ["microphone", "camera"].
-   * @example <luigi-container viewUrl="/index.html" allow-rules='["microphone", "camera"]'></luigi-container>
+   * @example <luigi-container viewurl="/index.html" allow-rules='["microphone", "camera"]'></luigi-container>
    * @example containerElement.allowRules = ['microphone', 'camera']
@@ -158,3 +209,3 @@ * @since 1.2.0
    * You can use one or more rules by adding them to the array, for example sandboxRules: ["allow-scripts", "allow-same-origin"].
-   * @example <luigi-container viewUrl="/index.html" sandbox-rules='["allow-scripts", "allow-same-origin"]'></luigi-container>
+   * @example <luigi-container viewurl="/index.html" sandbox-rules='["allow-scripts", "allow-same-origin"]'></luigi-container>
    * @example containerElement.sandboxRules = ['allow-modals', 'allow-popups']
@@ -168,2 +219,5 @@ * @since 1.2.0
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" document-title='Luigi App'></luigi-container>
+   * @example myContainer.documentTitle = 'Luigi App'
    */
@@ -176,4 +230,7 @@ documentTitle: string;
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" has-back></luigi-container>
+   * @example myContainer.hasBack = true
    */
-  hasBack: string;
+  hasBack: boolean;
 
@@ -184,2 +241,5 @@ /**
    * @since 1.2.0
+   * 
+   * @example <luigi-container viewurl="/index.html" dirty-status></luigi-container>
+   * @example myContainer.dirtyStatus = true
    */
@@ -186,0 +246,0 @@ dirtyStatus: boolean;

package.json

@@ -23,3 +23,3 @@ {
   ],
-  "version": "1.3.0-dev.20241150030"
+  "version": "1.3.0-dev.20241160030"
 }

No alert changes

Improved metrics

Total package byte prevSize

299472

increased by2.24%

Lines of code

1826

increased by6.97%

No dependency changes