From c30fc3a75bb00d3bc9e29f31a6b5c49fcf079857 Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Thu, 15 Aug 2024 15:26:13 +0200 Subject: [PATCH 01/52] clarify diff attribute props --- docs/luigi-compound-container-api.md | 10 +++++++++- docs/luigi-container-api.md | 11 ++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 0adbea9f4e..775e3d7baa 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -16,7 +16,15 @@ meta --> # Luigi Compound Container API -This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container +This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container. They can be set as HTML attributes or through the Container object's property in JS. The properties use pascalCase and the attributes use dashes. For example you can set the sandbox rules in either of these two equivalent ways: + +```js +myContainer.sandboxRules = ["allow-scripts", "allow-same-origin"] +``` + +```HTML + +``` ## API Reference diff --git a/docs/luigi-container-api.md b/docs/luigi-container-api.md index b3d52fcf2b..6bef775e51 100644 --- a/docs/luigi-container-api.md +++ b/docs/luigi-container-api.md @@ -16,7 +16,16 @@ meta --> # Luigi Container API -This document outlines the parameters provided by the Luigi Container. +This document outlines the parameters provided by the Luigi Container. They can be set as HTML attributes or through the Container object's property in JS. The properties use pascalCase and the attributes use dashes. For example you can set the sandbox rules in either of these two equivalent ways: + +```js +myContainer.sandboxRules = ["allow-scripts", "allow-same-origin"] +``` + +```HTML + +``` + ## API Reference From 339608518c538e352b5c649864d56175e42df75a Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Thu, 15 Aug 2024 15:32:11 +0200 Subject: [PATCH 02/52] cosmetics --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 775e3d7baa..679f53ff6f 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -16,7 +16,7 @@ meta --> # Luigi Compound Container API -This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container. They can be set as HTML attributes or through the Container object's property in JS. The properties use pascalCase and the attributes use dashes. For example you can set the sandbox rules in either of these two equivalent ways: +This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container. The properties can be set as HTML attributes or through the Container object's property in JS. The properties use pascalCase and the attributes use dashes. For example you can set the sandbox rules in either of these two equivalent ways: ```js myContainer.sandboxRules = ["allow-scripts", "allow-same-origin"] From 3035b6ea778a88851556fdd6ed79653765c7c22d Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Tue, 17 Sep 2024 14:45:38 +0200 Subject: [PATCH 03/52] added v2.14 release notes --- blog/2024-07-10-release-notes.md | 36 ++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 blog/2024-07-10-release-notes.md diff --git a/blog/2024-07-10-release-notes.md b/blog/2024-07-10-release-notes.md new file mode 100644 index 0000000000..9e3f468171 --- /dev/null +++ b/blog/2024-07-10-release-notes.md @@ -0,0 +1,36 @@ +--- +title: Luigi v2.14 +seoMetaDescription: Release notes for Luigi v2.13 +author: + - Mahati Shankar +layout: blog +--- + +You can read about the new features in Luigi v2.13 in the release notes below. + + + + +#### E2E Tests With Nightwatch, WebdriverIO and Puppeteer + +You can now use frameworks instead of Cypress which has been deprecated. + +#### getCurrentRoute Has Been Added + +getCurrentRoute has been added to the Luigi core API which as the name suggests returns the current Luigi route. + +#### getCurrentTheme in WC Client + +The method is now part of the core API so you can now use it in the WebComponent client too. + +#### Fiddle Theming Example + +To see the example in action, open [Luigi Fiddle](https://fiddle.luigi-project.io/) then choose the user icon at the top right and finally select `Settings` from the popover. + +#### Fix Top Nav Children Not Rendered + +Fixed issue where nodes weren't rendered in the top navigation under certain conditions. + +#### Bugfixes + +For a full list of bugfixes in this release, see our [changelog](https://github.com/SAP/luigi/blob/main/CHANGELOG.md). \ No newline at end of file From 354d840434f689361eee30afadce4d878da8e0cf Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Mon, 30 Sep 2024 15:39:18 +0200 Subject: [PATCH 04/52] added example snippets --- blog/2024-07-10-release-notes.md | 13 +-- docs/luigi-compound-container-api.md | 158 +++++++++++++++++++++++++-- 2 files changed, 154 insertions(+), 17 deletions(-) diff --git a/blog/2024-07-10-release-notes.md b/blog/2024-07-10-release-notes.md index 9e3f468171..9383361f35 100644 --- a/blog/2024-07-10-release-notes.md +++ b/blog/2024-07-10-release-notes.md @@ -1,31 +1,28 @@ --- title: Luigi v2.14 -seoMetaDescription: Release notes for Luigi v2.13 +seoMetaDescription: Release notes for Luigi v2.14 author: - Mahati Shankar layout: blog --- -You can read about the new features in Luigi v2.13 in the release notes below. +You can read about the new features in Luigi v2.14 in the release notes below. #### E2E Tests With Nightwatch, WebdriverIO and Puppeteer -You can now use frameworks instead of Cypress which has been deprecated. +The testing-utilities library now additionally supports Nightwatch, WebdriverIO and Puppeteer. You can now use these testing frameworks for your e2e tests. #### getCurrentRoute Has Been Added -getCurrentRoute has been added to the Luigi core API which as the name suggests returns the current Luigi route. +[getCurrentRoute](https://docs.luigi-project.io/docs/luigi-core-api?section=getcurrentroute) has been added to the Luigi core API which as the name suggests returns the current Luigi route. #### getCurrentTheme in WC Client -The method is now part of the core API so you can now use it in the WebComponent client too. +The method [getCurrentTheme](https://docs.luigi-project.io/docs/luigi-core-api?section=getcurrenttheme) is now part of the core API so you can now use it in the WebComponent client too. -#### Fiddle Theming Example - -To see the example in action, open [Luigi Fiddle](https://fiddle.luigi-project.io/) then choose the user icon at the top right and finally select `Settings` from the popover. #### Fix Top Nav Children Not Rendered diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index a6a52bf330..0041d165dc 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -16,15 +16,7 @@ meta --> # Luigi Compound Container API -This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container. The properties can be set as HTML attributes or through the Container object's property in JS. The properties use pascalCase and the attributes use dashes. For example you can set the sandbox rules in either of these two equivalent ways: - -```js -myContainer.sandboxRules = ["allow-scripts", "allow-same-origin"] -``` - -```HTML - -``` +This document outlines the parameters provided by the Luigi Compound Container. Luigi Compound Container provides the possibility to insert multiple webcomponent-based microfrontends in one container. The properties can be set as HTML attributes or through the Container object's property in JS. ## API Reference @@ -36,6 +28,14 @@ The URL used for the renderer. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +```js +myContainer.viewUrl = "/index.html" +``` + +```HTML + +``` + ### compoundConfig The configuration for the compound microfrontend @@ -46,6 +46,14 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa **Meta** * **since**: 1.0.0 +TODO: better example +```js +myContainer.compoundConfig = {foo: bar} +``` + +```HTML + +``` ### deferInit @@ -57,6 +65,14 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob * **since**: 1.0.0 +```js +myContainer.deferInit = true +``` +TODO: is it preferred to assign true or declare it to indicate it's set +```HTML + +``` + ### nodeParams The parameters to be passed to the compound micro frontend. Will not be passed to the compound children. @@ -67,6 +83,14 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 +```js +myContainer.nodeParams = {foo: bar} +``` + +```HTML + +``` + ### noShadow If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering. @@ -77,6 +101,14 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob * **since**: 1.2.0 +```js +myContainer.noShadow = true +``` + +```HTML + +``` + ### searchParams The search parameters to be passed to the compound micro frontend. @@ -87,6 +119,14 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 +```js +myContainer.searchParams = {foo: bar} +``` + +```HTML + +``` + ### pathParams The path parameters to be passed to the compound micro frontend. @@ -97,6 +137,14 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 +```js +myContainer.pathParams = {foo: bar} +``` + +```HTML + +``` + ### context The stringified context to be passed to the compound microfrontend @@ -106,6 +154,14 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa **Meta** * **since**: 1.0.0 +TODO: is it better to use JSON.stringify({foo: bar}) for the value +```js +myContainer.context = '{foo: bar}' +``` + +```HTML + +``` ### clientPermissions @@ -117,6 +173,14 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 +```js +myContainer.clientPermissions = '{foo: bar}' +``` + +```HTML + +``` + ### userSettings The user settings to be passed to the compound micro frontend @@ -127,6 +191,14 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 +```js +myContainer.userSettings = '{foo: bar}' +``` + +```HTML + +``` + ### anchor The anchor value to be passed to the compound micro frontend. @@ -137,6 +209,14 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 +```js +myContainer.anchor = '#foo' +``` + +```HTML + +``` + ### documentTitle The document title value to be passed to the compound micro frontend. @@ -147,6 +227,14 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.2.0 +```js +myContainer.documentTitle = 'Luigi App' +``` + +```HTML + +``` + ### hasBack The hasBack value to be passed to the compound micro frontend. @@ -158,6 +246,14 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.2.0 +```js +myContainer.hasBack = '/detailsPage' +``` + +```HTML + +``` + ### dirtyStatus The dirty status value to be passed to the compound micro frontend. @@ -169,6 +265,14 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob * **since**: 1.2.0 +```js +myContainer.dirtyStatus = true +``` + +```HTML + +``` + ### webcomponent The following properties can be set for the web component object. By default, the web component is set to true. @@ -188,6 +292,14 @@ Type: ([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glo * **since**: 1.0.0 +```js +myContainer.webcomponent = { webComponentSettings: {type: 'foo', selfRegistered: true, tagName: '#wcMountpoint'}} +``` +#TODO: this is probably wrong/not the best way, maybe there is a custom element? +```HTML + +``` + ### activeFeatureToggleList The list of active feature toggles to be passed to the compound microfrontend. @@ -198,6 +310,14 @@ Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global * **since**: NEXT_RELEASE_CONTAINER +```js +myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] +``` + +```HTML + +``` + ### theme The theme to be passed to the compound microfrontend. @@ -208,6 +328,14 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: NEXT_RELEASE_CONTAINER +```js +myContainer.theme = 'SAP-Horizon' +``` + +```HTML + +``` + ### updateContext Function that updates the context of the compound microfrontend. @@ -237,3 +365,15 @@ Returns **void** **Meta** * **since**: 1.0.0 +#TODO: made up example +```js + ... + myContainer.deferInit = true +} +#or HTML: js: the handler + +eventHandlerFn{ + ... + myContainer.init() +} +``` From d52774c4b3470f25fcbd2a2cf980c023c2a22fc8 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:21:31 +0200 Subject: [PATCH 05/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 0041d165dc..de72bebed8 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -33,7 +33,7 @@ myContainer.viewUrl = "/index.html" ``` ```HTML - + ``` ### compoundConfig From e3e0825f133ac9a48ea8f53e915179b82a300205 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:21:44 +0200 Subject: [PATCH 06/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index de72bebed8..0ec27ade8e 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -88,7 +88,7 @@ myContainer.nodeParams = {foo: bar} ``` ```HTML - + ``` ### noShadow From 8c63eeccec8d090f4e07829cb4ffaaa425c15188 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:21:56 +0200 Subject: [PATCH 07/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 0ec27ade8e..c43299147b 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -124,7 +124,7 @@ myContainer.searchParams = {foo: bar} ``` ```HTML - + ``` ### pathParams From d93fcaa7b1d1a7a1ead3b4585a6d6fef6546841a Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:22:05 +0200 Subject: [PATCH 08/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index c43299147b..e772e25b77 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -142,7 +142,7 @@ myContainer.pathParams = {foo: bar} ``` ```HTML - + ``` ### context From 294a844957510b849ea3116cbedee520921b2e83 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:22:25 +0200 Subject: [PATCH 09/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index e772e25b77..a1f72c3d89 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -160,7 +160,7 @@ myContainer.context = '{foo: bar}' ``` ```HTML - + ``` ### clientPermissions From 42e6ce05ea016e3c717d8f60b227b6d7841108b2 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:22:51 +0200 Subject: [PATCH 10/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index a1f72c3d89..a4008eb9a2 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -156,7 +156,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 TODO: is it better to use JSON.stringify({foo: bar}) for the value ```js -myContainer.context = '{foo: bar}' +myContainer.context = {label: "Dashboard"} ``` ```HTML From 5ecdce69aeda7c153d22e1826e304477d39cd5f1 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:23:12 +0200 Subject: [PATCH 11/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index a4008eb9a2..9a45b239e0 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -178,7 +178,7 @@ myContainer.clientPermissions = '{foo: bar}' ``` ```HTML - + ``` ### userSettings From ab442f4577c27a14152b498a387fd0cdec6ef017 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:23:28 +0200 Subject: [PATCH 12/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 9a45b239e0..a755967335 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -174,7 +174,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 ```js -myContainer.clientPermissions = '{foo: bar}' +myContainer.clientPermissions = {permission: "adminGroup"} ``` ```HTML From 3928988cb8788ab7d82f0f913e73d0d469f695c8 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:23:42 +0200 Subject: [PATCH 13/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index a755967335..65643fcbca 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -196,7 +196,7 @@ myContainer.userSettings = '{foo: bar}' ``` ```HTML - + ``` ### anchor From 8566a3849db9388d98d58427e059506bdb6b89a1 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:23:57 +0200 Subject: [PATCH 14/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 65643fcbca..14c9dfaa21 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -192,7 +192,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 ```js -myContainer.userSettings = '{foo: bar}' +myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} ``` ```HTML From d210c8377fbf6f3c344cf2138e9944cafa918c7a Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:24:24 +0200 Subject: [PATCH 15/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 14c9dfaa21..6fa68a8690 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -293,7 +293,7 @@ Type: ([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glo * **since**: 1.0.0 ```js -myContainer.webcomponent = { webComponentSettings: {type: 'foo', selfRegistered: true, tagName: '#wcMountpoint'}} +myContainer.webcomponent = { webComponentSettings: {type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}} ``` #TODO: this is probably wrong/not the best way, maybe there is a custom element? ```HTML From 96f5740b93dc9f8a756927bf49be9723222ada10 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:24:40 +0200 Subject: [PATCH 16/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 6fa68a8690..544cb4d890 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -297,7 +297,7 @@ myContainer.webcomponent = { webComponentSettings: {type: 'module', selfRegister ``` #TODO: this is probably wrong/not the best way, maybe there is a custom element? ```HTML - + ``` ### activeFeatureToggleList From e7d4321b9c626fc71a84acdb8fe3022a079274bf Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:24:55 +0200 Subject: [PATCH 17/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 544cb4d890..4f690ee9f7 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -329,7 +329,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: NEXT_RELEASE_CONTAINER ```js -myContainer.theme = 'SAP-Horizon' +myContainer.theme = 'sap_horizon' ``` ```HTML From 1fc5e1a0d6d61dbab83b4f993eb66f9a434efab8 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:25:06 +0200 Subject: [PATCH 18/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 4f690ee9f7..c7056c65cb 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -333,7 +333,7 @@ myContainer.theme = 'sap_horizon' ``` ```HTML - + ``` ### updateContext From 30b0f4fdba20f52db81e7522322bfb013c8c5929 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:25:30 +0200 Subject: [PATCH 19/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 71 +++++++++++++++++++++++++++- 1 file changed, 70 insertions(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index c7056c65cb..501ee019a1 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -48,7 +48,76 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 TODO: better example ```js -myContainer.compoundConfig = {foo: bar} +myContainer.compoundConfig = lcc.compoundConfig = { + renderer: { + use: 'grid', + config: { + columns: '1fr 1fr 1fr 2fr', + /*rows: '150px',*/ + /*gap: '30px',*/ + layouts: [ + { + minWidth: 0, + maxWidth: 600, + columns: '1fr', + gap: 0 + }, + { + minWidth: 600, + maxWidth: 1024, + columns: '1fr 1fr', + gap: '30px' + } + ] + } + }, + children: [ + { + viewUrl: 'http://www.examples.com/header.js', + context: { + title: 'My Awesome Grid 000', + description: 'Really awesome' + }, + layoutConfig: { + row: '1', + column: '1 / -1' + }, + eventListeners: [ + { + source: 'input1', + name: 'sendInput', + action: 'update', + dataConverter: data => { + return 'new text: ' + data; + } + } + ] + }, + { + id: 'input1', + viewUrl: '/helloWorldWC.js', + context: { + title: 'Some input', + instant: true + } + }, + { + viewUrl: 'http://www.examples.com/main.js', + context: { + label: 'Another web component' + } + }, + { + viewUrl: '/panelFooter.js', + context: { + footer: 'This is the end of awesomeness' + }, + layoutConfig: { + column: '1 / -1' + } + } + ] + }; ``` ```HTML From 36aae049a787631319ca766142eb509946708c5d Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:46:08 +0200 Subject: [PATCH 20/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 501ee019a1..5683f54266 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -121,7 +121,7 @@ myContainer.compoundConfig = lcc.compoundConfig = { ``` ```HTML - + ``` ### deferInit From 6c3898b4e874df77115f93c88afc3a37fc5ace5c Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:48:16 +0200 Subject: [PATCH 21/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 5683f54266..d9a9baca9d 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -139,7 +139,7 @@ myContainer.deferInit = true ``` TODO: is it preferred to assign true or declare it to indicate it's set ```HTML - + ``` ### nodeParams From d107ec36c54e7532ea37bc77845d971dac580c9b Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:53:13 +0200 Subject: [PATCH 22/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index d9a9baca9d..2b1e99387a 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -33,7 +33,7 @@ myContainer.viewUrl = "/index.html" ``` ```HTML - + ``` ### compoundConfig From 73e287fc8f108e526266fde703b69476d30c75ce Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:53:35 +0200 Subject: [PATCH 23/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 2b1e99387a..1428965f0a 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -48,7 +48,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa * **since**: 1.0.0 TODO: better example ```js -myContainer.compoundConfig = lcc.compoundConfig = { +myContainer.compoundConfig = { renderer: { use: 'grid', config: { From df811cff36fcc52b8c632de5708a2bc118bd788c Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:53:56 +0200 Subject: [PATCH 24/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 1428965f0a..f8dbd074ee 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -157,7 +157,7 @@ myContainer.nodeParams = {foo: bar} ``` ```HTML - + ``` ### noShadow From 89d035995c5222ac1ff60765790243eb138ba978 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:54:12 +0200 Subject: [PATCH 25/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index f8dbd074ee..6b215fd712 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -175,7 +175,7 @@ myContainer.noShadow = true ``` ```HTML - + ``` ### searchParams From 6aa30bc9305af3b99fcea252a4d64499c0cd7498 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:54:22 +0200 Subject: [PATCH 26/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 6b215fd712..548e1294b4 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -193,7 +193,7 @@ myContainer.searchParams = {foo: bar} ``` ```HTML - + ``` ### pathParams From c330f5e65baeaa9d3b5eb0ac9f897ef2548915e3 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:54:30 +0200 Subject: [PATCH 27/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 548e1294b4..dfc1af4b5f 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -211,7 +211,7 @@ myContainer.pathParams = {foo: bar} ``` ```HTML - + ``` ### context From 3d75f90b6b94e2369a86c258738fc3cd37eeb958 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:54:41 +0200 Subject: [PATCH 28/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index dfc1af4b5f..c410a22921 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -247,7 +247,7 @@ myContainer.clientPermissions = {permission: "adminGroup"} ``` ```HTML - + ``` ### userSettings From e3ba528243accab6bbf0e23287b7ea7ad070f1ab Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:54:49 +0200 Subject: [PATCH 29/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index c410a22921..40d266db61 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -265,7 +265,7 @@ myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} ``` ```HTML - + ``` ### anchor From 4372dea1c3201c2b5cb940fde7aa1a2c528d98b1 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:54:59 +0200 Subject: [PATCH 30/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 40d266db61..3197e358f2 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -301,7 +301,7 @@ myContainer.documentTitle = 'Luigi App' ``` ```HTML - + ``` ### hasBack From 2da9238f7bc4bd61a816828f2984e918887419ec Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:55:07 +0200 Subject: [PATCH 31/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 3197e358f2..21f4a2af0f 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -320,7 +320,7 @@ myContainer.hasBack = '/detailsPage' ``` ```HTML - + ``` ### dirtyStatus From 81a12f2cfbd8b2a6b8dcddf85e4d774d52291ada Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:55:15 +0200 Subject: [PATCH 32/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 21f4a2af0f..a04a0a5448 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -339,7 +339,7 @@ myContainer.dirtyStatus = true ``` ```HTML - + ``` ### webcomponent From 9a053fc132df9f0a5dc27cb45f9cb88c3ab47dd2 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Fri, 11 Oct 2024 16:55:25 +0200 Subject: [PATCH 33/52] Update docs/luigi-compound-container-api.md Co-authored-by: Johannes Doberer --- docs/luigi-compound-container-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index a04a0a5448..75ab8c25bd 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -384,7 +384,7 @@ myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] ``` ```HTML - + ``` ### theme From 115ef0be4b9c139c49869cfefc5ff5bb44499b16 Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Fri, 11 Oct 2024 17:00:05 +0200 Subject: [PATCH 34/52] review changes --- docs/luigi-compound-container-api.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index 75ab8c25bd..a588eabcf5 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -46,7 +46,6 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa **Meta** * **since**: 1.0.0 -TODO: better example ```js myContainer.compoundConfig = { renderer: { @@ -120,10 +119,6 @@ myContainer.compoundConfig = { }; ``` -```HTML - -``` - ### deferInit If set to true defers from initializing the microfronted automatically. In that case init() can be used @@ -137,7 +132,7 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob ```js myContainer.deferInit = true ``` -TODO: is it preferred to assign true or declare it to indicate it's set + ```HTML ``` @@ -223,7 +218,7 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa **Meta** * **since**: 1.0.0 -TODO: is it better to use JSON.stringify({foo: bar}) for the value + ```js myContainer.context = {label: "Dashboard"} ``` @@ -364,7 +359,7 @@ Type: ([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glo ```js myContainer.webcomponent = { webComponentSettings: {type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}} ``` -#TODO: this is probably wrong/not the best way, maybe there is a custom element? + ```HTML ``` From 5d0ece2c3cdbf771f33ed50002ca5baebe7425f9 Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Mon, 21 Oct 2024 15:22:38 +0200 Subject: [PATCH 35/52] added an example --- container/typings/LuigiContainer.svelte.d.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 357ecfe269..202a5a9d1d 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -8,12 +8,27 @@ export default class LuigiContainer extends HTMLElement { /** * The URL of the microfrontend to be rendered * @since 1.0.0 + * + * ```js + * myContainer.viewUrl = "/index.html" + * ``` + * + * ```HTML + * + * ``` */ viewurl: string; /** * If set to true defers from initializing the microfronted automatically. In that case init() can be used * @since 1.0.0 + * ```js +myContainer.deferInit = true +``` + +```HTML + +``` */ deferInit: boolean; From 9de61df053b4cd99d8a89173e976f00f76ace69e Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Mon, 21 Oct 2024 16:44:34 +0200 Subject: [PATCH 36/52] added examples --- .../LuigiCompoundContainer.svelte.d.ts | 8 + container/typings/LuigiContainer.svelte.d.ts | 140 +++++++++++++++++- 2 files changed, 142 insertions(+), 6 deletions(-) diff --git a/container/typings/LuigiCompoundContainer.svelte.d.ts b/container/typings/LuigiCompoundContainer.svelte.d.ts index 6b4d21a96c..b951d6cb3b 100644 --- a/container/typings/LuigiCompoundContainer.svelte.d.ts +++ b/container/typings/LuigiCompoundContainer.svelte.d.ts @@ -28,6 +28,14 @@ export default class LuigiCompoundContainer extends HTMLElement { * * The locale to be passed to the compound micro frontend. * @since NEXT_RELEASE_CONTAINER + * + * ```js + * myContainer.locale = locale="en_us" + * ``` + * + * ```HTML + * + * ``` */ locale: string; diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 202a5a9d1d..6c53ea602d 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -22,13 +22,14 @@ export default class LuigiContainer extends HTMLElement { /** * If set to true defers from initializing the microfronted automatically. In that case init() can be used * @since 1.0.0 + * * ```js -myContainer.deferInit = true -``` - -```HTML - -``` + * myContainer.deferInit = true + * ``` + * + * ```HTML + * + * ``` */ deferInit: boolean; @@ -65,78 +66,181 @@ myContainer.deferInit = true * The advantage of this line of code is: you don't have to specify a tag name, thus avoiding the duplication of self-defined tag names. *
* @since 1.0.0 + * ```js + * myContainer.webcomponent = { webComponentSettings: {type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}} + * ``` + * + * ```HTML + * + * ``` */ webcomponent: boolean | WebComponentSettings | string; /** * The locale to be passed to the web-component-based micro frontend * @since 1.0.0 + * + * ```js + * myContainer.locale = locale="en_us" + * ``` + * + * ```HTML + * + * ``` */ locale: string; /** * The theme to be passed to the web-component-based micro frontend * @since 1.0.0 + * + * ```js + * myContainer.theme = 'sap_horizon' + * ``` + * + * ```HTML + * + * ``` */ theme: string; /** * The list of active feature toggles to be passed to the web-component-based micro frontend * @since 1.0.0 + * + * ```js + * myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] + * ``` + * + * ```HTML + * + * ``` */ activeFeatureToggleList: string[]; /** * If set to true, skips third party cookie check * @since NEXT_RELEASE_CONTAINER + * + * ```js + * myContainer.skipCookieCheck = true + * ``` + * + * ```HTML + * + * ``` */ skipCookieCheck: 'false' | 'true'; /** * If set to true, skips handshake and ready event is fired immediately * @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. + * ```js + * myContainer.skipInitCheck = true + * ``` + * + * ```HTML + * + * ``` */ skipInitCheck: boolean; /** * The parameters to be passed to the web-component-based micro frontend. * @since 1.0.0 + * + * ```js + * myContainer.nodeParams = {foo: bar} + * ``` + * + * ```HTML + * + * ``` */ nodeParams: Object; /** * If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering. * @since 1.2.0 + * + * ```js + * myContainer.noShadow = true + * ``` + * + * ```HTML + * + * ``` */ noShadow: boolean; /** * The search parameters to be passed to the web-component-based micro frontend. * @since 1.0.0 + * + * ```js + * myContainer.searchParams = {foo: bar} + * ``` + * + * ```HTML + * + * ``` */ searchParams: Object; /** * The path parameters to be passed to the web-component-based micro frontend. * @since 1.0.0 + * + * ```js + * myContainer.pathParams = {foo: bar} + * ``` + * + * ```HTML + * + * ``` */ pathParams: Object; /** * The clientPermissions to be passed to the web-component-based micro frontend. * @since 1.0.0 + * + * ```js + * myContainer.clientPermissions = {permission: "adminGroup"} + * ``` + * + * ```HTML + * + * ``` */ clientPermissions: Object; /** * The user settings to be passed to the web-component-based micro frontend * @since 1.0.0 + * + * ```js + * myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} + * ``` + * + * ```HTML + * + * ``` */ userSettings: Object; /** * The anchor value to be passed to the web-component-based micro frontend. * @since 1.0.0 + * + * ```js + * myContainer.anchor = '#foo' + * ``` + * + * ```HTML + * + * ``` */ anchor: string; @@ -161,6 +265,14 @@ myContainer.deferInit = true /** * The document title value to be passed to the web-component-based micro frontend. * @since 1.2.0 + * + * ```js + * myContainer.documentTitle = 'Luigi App' + * ``` + * + * ```HTML + * + * ``` */ documentTitle: string; @@ -168,6 +280,14 @@ myContainer.deferInit = true * The hasBack value to be passed to the web-component-based micro frontend. * It indicates that there is one or more preserved views. Useful when you need to show a back button. * @since 1.2.0 + * + * ```js + * myContainer.hasBack = '/detailsPage' + * ``` + * + * ```HTML + * + * ``` */ hasBack: string; @@ -175,6 +295,14 @@ myContainer.deferInit = true * The dirty status value to be passed to the web-component-based micro frontend. * It's used to indicate that there are unsaved changes when navigating away. * @since 1.2.0 + * + * ```js + * myContainer.dirtyStatus = true + * ``` + * + * ```HTML + * + * ``` */ dirtyStatus: boolean; From fc4f88810e58338df938b4d69b1a664b2392e3b7 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:29:03 +0200 Subject: [PATCH 37/52] Update container/typings/LuigiCompoundContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiCompoundContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiCompoundContainer.svelte.d.ts b/container/typings/LuigiCompoundContainer.svelte.d.ts index b951d6cb3b..cac20a3204 100644 --- a/container/typings/LuigiCompoundContainer.svelte.d.ts +++ b/container/typings/LuigiCompoundContainer.svelte.d.ts @@ -30,7 +30,7 @@ export default class LuigiCompoundContainer extends HTMLElement { * @since NEXT_RELEASE_CONTAINER * * ```js - * myContainer.locale = locale="en_us" + * myContainer.locale = "en_us" * ``` * * ```HTML From 6ead828bc44fe1918e963ff13cab612902d00087 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:29:20 +0200 Subject: [PATCH 38/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 6c53ea602d..6e983501d4 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -10,7 +10,7 @@ export default class LuigiContainer extends HTMLElement { * @since 1.0.0 * * ```js - * myContainer.viewUrl = "/index.html" + * myContainer.viewurl = "/index.html" * ``` * * ```HTML From f02faa608066e62d3cd17581201ccf7e13a070a6 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:29:40 +0200 Subject: [PATCH 39/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 6e983501d4..c6c5205253 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -67,7 +67,7 @@ export default class LuigiContainer extends HTMLElement { *
* @since 1.0.0 * ```js - * myContainer.webcomponent = { webComponentSettings: {type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}} + * myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'} * ``` * * ```HTML From e7af0ea387f7df83c1735a6ec467ec076c8d54c3 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:29:51 +0200 Subject: [PATCH 40/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index c6c5205253..08bf335866 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -71,7 +71,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ webcomponent: boolean | WebComponentSettings | string; From 076f4dc3c6403d172073e9be3cca9c7ac6e1a122 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:30:06 +0200 Subject: [PATCH 41/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 08bf335866..4a188481bd 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -81,7 +81,7 @@ export default class LuigiContainer extends HTMLElement { * @since 1.0.0 * * ```js - * myContainer.locale = locale="en_us" + * myContainer.locale = "en_us" * ``` * * ```HTML From 6e412a3b4e859ee992c88ae6d9ad9c4cc55e147a Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:30:24 +0200 Subject: [PATCH 42/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 4a188481bd..0a0db196d8 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -99,7 +99,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ theme: string; From 9c0007683a8808056578609463981297932cc0a1 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:30:41 +0200 Subject: [PATCH 43/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 0a0db196d8..2a66913a52 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -113,7 +113,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ activeFeatureToggleList: string[]; From cb0e4cc9254e85a18a2f5266f1a40b9c7ae48166 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:30:50 +0200 Subject: [PATCH 44/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 2a66913a52..b9c52f39a0 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -271,7 +271,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ documentTitle: string; From f82d01441664c8fd6e2c48611590b59259d8c308 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:33:38 +0200 Subject: [PATCH 45/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index b9c52f39a0..9930526295 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -282,7 +282,7 @@ export default class LuigiContainer extends HTMLElement { * @since 1.2.0 * * ```js - * myContainer.hasBack = '/detailsPage' + * myContainer.hasBack = true * ``` * * ```HTML From c25e87d35f1b7322b8044541f6eb25a1db2f4e2b Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:35:32 +0200 Subject: [PATCH 46/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 9930526295..3af15f8db9 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -286,7 +286,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ hasBack: string; From 19542ec276104090d6664c588329098a07c8a7b9 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:35:44 +0200 Subject: [PATCH 47/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 3af15f8db9..e392b2e5b6 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -127,7 +127,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ skipCookieCheck: 'false' | 'true'; From 0e2ef9b0d578e77432e8ff12257763e59cc86dc5 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:36:00 +0200 Subject: [PATCH 48/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index e392b2e5b6..f2e7e116aa 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -141,7 +141,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ skipInitCheck: boolean; From 33de579c01ebad7e65b6b7d0dd1241e463759f7a Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:36:12 +0200 Subject: [PATCH 49/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index f2e7e116aa..ab8a778494 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -155,7 +155,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ nodeParams: Object; From da4f7e53f8499c14a1e976b5c051bfa2deda9f00 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:36:22 +0200 Subject: [PATCH 50/52] Update container/typings/LuigiContainer.svelte.d.ts Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index ab8a778494..51361e4b82 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -169,7 +169,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ noShadow: boolean; From 4494cb61b1564c7e1ad3a27f4c1bc3ac7b7b5761 Mon Sep 17 00:00:00 2001 From: Mahati Shankar <93712176+smahati@users.noreply.github.com> Date: Wed, 23 Oct 2024 14:37:26 +0200 Subject: [PATCH 51/52] Apply suggestions from code review Co-authored-by: Johannes Doberer --- container/typings/LuigiContainer.svelte.d.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index 51361e4b82..b8a1e524a8 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -183,7 +183,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ searchParams: Object; @@ -193,11 +193,11 @@ export default class LuigiContainer extends HTMLElement { * @since 1.0.0 * * ```js - * myContainer.pathParams = {foo: bar} + * myContainer.pathParams = {foo: "bar"} * ``` * * ```HTML - * + * * ``` */ pathParams: Object; @@ -211,7 +211,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ clientPermissions: Object; @@ -225,7 +225,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ userSettings: Object; @@ -239,7 +239,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ anchor: string; @@ -289,7 +289,7 @@ export default class LuigiContainer extends HTMLElement { * * ``` */ - hasBack: string; + hasBack: boolean; /** * The dirty status value to be passed to the web-component-based micro frontend. @@ -301,7 +301,7 @@ export default class LuigiContainer extends HTMLElement { * ``` * * ```HTML - * + * * ``` */ dirtyStatus: boolean; From c46d39b3782ae88503928fc3e6ddf416d8943e17 Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Fri, 25 Oct 2024 18:22:18 +0200 Subject: [PATCH 52/52] Added examples in both files --- .../LuigiCompoundContainer.svelte.d.ts | 69 +++- container/typings/LuigiContainer.svelte.d.ts | 175 +++------ docs/luigi-compound-container-api.md | 341 ++++++++---------- docs/luigi-container-api.md | 209 ++++++++++- website/docs/.nvmrc | 2 +- 5 files changed, 470 insertions(+), 326 deletions(-) diff --git a/container/typings/LuigiCompoundContainer.svelte.d.ts b/container/typings/LuigiCompoundContainer.svelte.d.ts index cac20a3204..fb8ae0c214 100644 --- a/container/typings/LuigiCompoundContainer.svelte.d.ts +++ b/container/typings/LuigiCompoundContainer.svelte.d.ts @@ -7,6 +7,9 @@ export declare interface WebComponentSettings { export default class LuigiCompoundContainer extends HTMLElement { /** * The URL used for the renderer. + * + * @example + * @example myContainer.viewurl = "/index.html" */ viewurl: string; @@ -14,13 +17,19 @@ export default class LuigiCompoundContainer extends HTMLElement { * The configuration for the compound microfrontend * Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navigation-parameters-reference/?section=compound) for details. * @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 }; */ compoundConfig: Object; /** * If set to true defers from initializing the microfronted automatically. In that case init() can be used * @since 1.0.0 + * + * @example + * @example myContainer.deferInit = true */ deferInit: boolean; @@ -29,67 +38,89 @@ export default class LuigiCompoundContainer extends HTMLElement { * The locale to be passed to the compound micro frontend. * @since NEXT_RELEASE_CONTAINER * - * ```js - * myContainer.locale = "en_us" - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.locale = "en_us" */ locale: string; /** * The parameters to be passed to the compound micro frontend. Will not be passed to the compound children. * @since 1.0.0 + * + * @example + * @example myContainer.nodeParams = {foo: bar} */ nodeParams: Object; /** * If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering. * @since 1.2.0 + * + * @example + * @example myContainer.noShadow = true */ noShadow: boolean; /** * The search parameters to be passed to the compound micro frontend. * @since 1.0.0 + * + * @example + * @example myContainer.searchParams = {foo: bar} */ searchParams: Object; /** * The path parameters to be passed to the compound micro frontend. * @since 1.0.0 + * + * @example + * @example myContainer.pathParams = {foo: "bar"} */ pathParams: Object; /** * The stringified context to be passed to the compound microfrontend * @since 1.0.0 + * + * @example + * @example myContainer.context = {label: "Dashboard"} */ context: string; /** * The clientPermissions to be passed to the compound micro frontend. * @since 1.0.0 + * + * @example + * @example myContainer.clientPermissions = {permission: "adminGroup"} */ clientPermissions: Object; /** * The user settings to be passed to the compound micro frontend * @since 1.0.0 + * + * @example + * @example myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} */ userSettings: Object; /** * The anchor value to be passed to the compound micro frontend. * @since 1.0.0 + * + * @example + * @example myContainer.anchor = '#foo' */ anchor: string; /** * The document title value to be passed to the compound micro frontend. * @since 1.2.0 + * + * @example + * @example myContainer.documentTitle = 'Luigi App' */ documentTitle: string; @@ -97,13 +128,19 @@ export default class LuigiCompoundContainer extends HTMLElement { * The hasBack value to be passed to the compound micro frontend. * It indicates that there is one or more preserved views. Useful when you need to show a back button. * @since 1.2.0 + * + * @example + * @example myContainer.hasBack = true */ - hasBack: string; + hasBack: boolean; /** * The dirty status value to be passed to the compound micro frontend. * It's used to indicate that there are unsaved changes when navigating away. * @since 1.2.0 + * + * @example + * @example myContainer.dirtyStatus = true */ dirtyStatus: boolean; @@ -115,24 +152,38 @@ export default class LuigiCompoundContainer extends HTMLElement { * @param {string} WebComponentSettings.tagName: tag name where web component is added to DOM. * @param {string} string must be a stringified JSON object from type `WebComponentSettings`. * @since 1.0.0 + * + * @example + * @example myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'} */ webcomponent: boolean | WebComponentSettings | string; /** * If set to true, skips handshake and ready event is fired immediately. * @since NEXT_RELEASE_CONTAINER + * + * @example + * @example myContainer.skipInitCheck = true */ skipInitCheck: boolean; /** * The list of active feature toggles to be passed to the compound microfrontend. * @since NEXT_RELEASE_CONTAINER + * + * + * @example + * @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] */ activeFeatureToggleList: string[]; /** * The theme to be passed to the compound microfrontend. * @since NEXT_RELEASE_CONTAINER + * + * + * @example + * @example myContainer.theme = 'sap_horizon' */ theme: string; diff --git a/container/typings/LuigiContainer.svelte.d.ts b/container/typings/LuigiContainer.svelte.d.ts index b8a1e524a8..8a01c92292 100644 --- a/container/typings/LuigiContainer.svelte.d.ts +++ b/container/typings/LuigiContainer.svelte.d.ts @@ -9,13 +9,8 @@ export default class LuigiContainer extends HTMLElement { * The URL of the microfrontend to be rendered * @since 1.0.0 * - * ```js - * myContainer.viewurl = "/index.html" - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.viewurl = "/index.html" */ viewurl: string; @@ -23,25 +18,27 @@ export default class LuigiContainer extends HTMLElement { * If set to true defers from initializing the microfronted automatically. In that case init() can be used * @since 1.0.0 * - * ```js - * myContainer.deferInit = true - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.deferInit = true */ deferInit: boolean; /** * The stringified context object to be passed to the microfrontend * @since 1.0.0 + * + * + * @example + * @example myContainer.context = {label: "Dashboard"} */ context: string; /** * Label information for the microfrontend * @since 1.0.0 + * + * @example + * @example myContainer.label = "Dashboard" */ label: string; @@ -66,13 +63,8 @@ export default class LuigiContainer extends HTMLElement { * The advantage of this line of code is: you don't have to specify a tag name, thus avoiding the duplication of self-defined tag names. *
* @since 1.0.0 - * ```js - * myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'} - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'} */ webcomponent: boolean | WebComponentSettings | string; @@ -80,13 +72,8 @@ export default class LuigiContainer extends HTMLElement { * The locale to be passed to the web-component-based micro frontend * @since 1.0.0 * - * ```js - * myContainer.locale = "en_us" - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.locale = "en_us" */ locale: string; @@ -94,13 +81,8 @@ export default class LuigiContainer extends HTMLElement { * The theme to be passed to the web-component-based micro frontend * @since 1.0.0 * - * ```js - * myContainer.theme = 'sap_horizon' - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.theme = 'sap_horizon' */ theme: string; @@ -108,13 +90,8 @@ export default class LuigiContainer extends HTMLElement { * The list of active feature toggles to be passed to the web-component-based micro frontend * @since 1.0.0 * - * ```js - * myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] - * ``` - * - * ```HTML - * - * ``` + * @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] + * @example */ activeFeatureToggleList: string[]; @@ -122,27 +99,17 @@ export default class LuigiContainer extends HTMLElement { * If set to true, skips third party cookie check * @since NEXT_RELEASE_CONTAINER * - * ```js - * myContainer.skipCookieCheck = true - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.skipCookieCheck = true */ - skipCookieCheck: 'false' | 'true'; + skipCookieCheck: boolean; /** * If set to true, skips handshake and ready event is fired immediately * @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. - * ```js - * myContainer.skipInitCheck = true - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.skipInitCheck = true */ skipInitCheck: boolean; @@ -150,13 +117,8 @@ export default class LuigiContainer extends HTMLElement { * The parameters to be passed to the web-component-based micro frontend. * @since 1.0.0 * - * ```js - * myContainer.nodeParams = {foo: bar} - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.nodeParams = {foo: bar} */ nodeParams: Object; @@ -164,13 +126,8 @@ export default class LuigiContainer extends HTMLElement { * If set to true, the Luigi container webcomponent will not use the shadow DOM for rendering. * @since 1.2.0 * - * ```js - * myContainer.noShadow = true - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.noShadow = true */ noShadow: boolean; @@ -178,13 +135,8 @@ export default class LuigiContainer extends HTMLElement { * The search parameters to be passed to the web-component-based micro frontend. * @since 1.0.0 * - * ```js - * myContainer.searchParams = {foo: bar} - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.searchParams = {foo: bar} */ searchParams: Object; @@ -192,13 +144,8 @@ export default class LuigiContainer extends HTMLElement { * The path parameters to be passed to the web-component-based micro frontend. * @since 1.0.0 * - * ```js - * myContainer.pathParams = {foo: "bar"} - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.pathParams = {foo: "bar"} */ pathParams: Object; @@ -206,13 +153,8 @@ export default class LuigiContainer extends HTMLElement { * The clientPermissions to be passed to the web-component-based micro frontend. * @since 1.0.0 * - * ```js - * myContainer.clientPermissions = {permission: "adminGroup"} - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.clientPermissions = {permission: "adminGroup"} */ clientPermissions: Object; @@ -220,13 +162,8 @@ export default class LuigiContainer extends HTMLElement { * The user settings to be passed to the web-component-based micro frontend * @since 1.0.0 * - * ```js - * myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} */ userSettings: Object; @@ -234,20 +171,15 @@ export default class LuigiContainer extends HTMLElement { * The anchor value to be passed to the web-component-based micro frontend. * @since 1.0.0 * - * ```js - * myContainer.anchor = '#foo' - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.anchor = '#foo' */ anchor: string; /** * The list of rules for the content in the iframe, managed by the HTML `allow` attribute. * You can use one or more rules by adding them to the array, for example allowRules: ["microphone", "camera"]. - * @example + * @example * @example containerElement.allowRules = ['microphone', 'camera'] * @since 1.2.0 */ @@ -256,7 +188,7 @@ export default class LuigiContainer extends HTMLElement { /** * The list of rules for the content in the iframe, managed by the HTML `sandbox` attribute. * You can use one or more rules by adding them to the array, for example sandboxRules: ["allow-scripts", "allow-same-origin"]. - * @example + * @example * @example containerElement.sandboxRules = ['allow-modals', 'allow-popups'] * @since 1.2.0 */ @@ -266,13 +198,8 @@ export default class LuigiContainer extends HTMLElement { * The document title value to be passed to the web-component-based micro frontend. * @since 1.2.0 * - * ```js - * myContainer.documentTitle = 'Luigi App' - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.documentTitle = 'Luigi App' */ documentTitle: string; @@ -281,13 +208,8 @@ export default class LuigiContainer extends HTMLElement { * It indicates that there is one or more preserved views. Useful when you need to show a back button. * @since 1.2.0 * - * ```js - * myContainer.hasBack = true - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.hasBack = true */ hasBack: boolean; @@ -296,13 +218,8 @@ export default class LuigiContainer extends HTMLElement { * It's used to indicate that there are unsaved changes when navigating away. * @since 1.2.0 * - * ```js - * myContainer.dirtyStatus = true - * ``` - * - * ```HTML - * - * ``` + * @example + * @example myContainer.dirtyStatus = true */ dirtyStatus: boolean; diff --git a/docs/luigi-compound-container-api.md b/docs/luigi-compound-container-api.md index f5a380a0ad..169e0c2112 100644 --- a/docs/luigi-compound-container-api.md +++ b/docs/luigi-compound-container-api.md @@ -29,14 +29,16 @@ The URL used for the renderer. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) -```js -myContainer.viewUrl = "/index.html" -``` +#### Examples -```HTML +```javascript ``` +```javascript +myContainer.viewurl = "/index.html" +``` + ### compoundConfig The configuration for the compound microfrontend @@ -44,81 +46,17 @@ Take a look at the [compound parameter](https://docs.luigi-project.io/docs/navig Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) +#### Examples + +```javascript +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 }; +``` + **Meta** * **since**: 1.0.0 -```js -myContainer.compoundConfig = { - renderer: { - use: 'grid', - config: { - columns: '1fr 1fr 1fr 2fr', - /*rows: '150px',*/ - /*gap: '30px',*/ - layouts: [ - { - minWidth: 0, - maxWidth: 600, - columns: '1fr', - gap: 0 - }, - { - minWidth: 600, - maxWidth: 1024, - columns: '1fr 1fr', - gap: '30px' - } - ] - } - }, - children: [ - { - viewUrl: 'http://www.examples.com/header.js', - context: { - title: 'My Awesome Grid 000', - description: 'Really awesome' - }, - layoutConfig: { - row: '1', - column: '1 / -1' - }, - eventListeners: [ - { - source: 'input1', - name: 'sendInput', - action: 'update', - dataConverter: data => { - return 'new text: ' + data; - } - } - ] - }, - { - id: 'input1', - viewUrl: '/helloWorldWC.js', - context: { - title: 'Some input', - instant: true - } - }, - { - viewUrl: 'http://www.examples.com/main.js', - context: { - label: 'Another web component' - } - }, - { - viewUrl: '/panelFooter.js', - context: { - footer: 'This is the end of awesomeness' - }, - layoutConfig: { - column: '1 / -1' - } - } - ] - }; -``` ### deferInit @@ -126,17 +64,19 @@ If set to true defers from initializing the microfronted automatically. In that Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.deferInit = true ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### locale @@ -144,28 +84,39 @@ The locale to be passed to the compound micro frontend. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.locale = "en_us" +``` + **Meta** * **since**: NEXT_RELEASE_CONTAINER - ### nodeParams The parameters to be passed to the compound micro frontend. Will not be passed to the compound children. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.nodeParams = {foo: bar} ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### noShadow @@ -173,17 +124,19 @@ If set to true, the Luigi compound container webcomponent will not use the shado Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) -**Meta** +#### Examples -* **since**: 1.2.0 +```javascript + +``` -```js +```javascript myContainer.noShadow = true ``` -```HTML - -``` +**Meta** + +* **since**: 1.2.0 ### searchParams @@ -191,17 +144,19 @@ The search parameters to be passed to the compound micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.searchParams = {foo: bar} ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### pathParams @@ -209,35 +164,39 @@ The path parameters to be passed to the compound micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) -**Meta** - -* **since**: 1.0.0 +#### Examples -```js -myContainer.pathParams = {foo: bar} +```javascript + ``` -```HTML - +```javascript +myContainer.pathParams = {foo: "bar"} ``` +**Meta** + +* **since**: 1.0.0 + ### context The stringified context to be passed to the compound microfrontend Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.context = {label: "Dashboard"} ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### clientPermissions @@ -245,17 +204,19 @@ The clientPermissions to be passed to the compound micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.clientPermissions = {permission: "adminGroup"} ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### userSettings @@ -263,17 +224,19 @@ The user settings to be passed to the compound micro frontend Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### anchor @@ -281,17 +244,19 @@ The anchor value to be passed to the compound micro frontend. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) -**Meta** +#### Examples -* **since**: 1.0.0 +```javascript + +``` -```js +```javascript myContainer.anchor = '#foo' ``` -```HTML - -``` +**Meta** + +* **since**: 1.0.0 ### documentTitle @@ -299,37 +264,41 @@ The document title value to be passed to the compound micro frontend. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) -**Meta** +#### Examples -* **since**: 1.2.0 +```javascript + +``` -```js +```javascript myContainer.documentTitle = 'Luigi App' ``` -```HTML - -``` +**Meta** + +* **since**: 1.2.0 ### hasBack The hasBack value to be passed to the compound micro frontend. It indicates that there is one or more preserved views. Useful when you need to show a back button. -Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) - -**Meta** +Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) -* **since**: 1.2.0 +#### Examples -```js -myContainer.hasBack = '/detailsPage' +```javascript + ``` -```HTML - +```javascript +myContainer.hasBack = true ``` +**Meta** + +* **since**: 1.2.0 + ### dirtyStatus The dirty status value to be passed to the compound micro frontend. @@ -337,17 +306,19 @@ It's used to indicate that there are unsaved changes when navigating away. Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) -**Meta** +#### Examples -* **since**: 1.2.0 +```javascript + +``` -```js +```javascript myContainer.dirtyStatus = true ``` -```HTML - -``` +**Meta** + +* **since**: 1.2.0 ### webcomponent @@ -364,24 +335,36 @@ Type: ([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glo * `WebComponentSettings.tagName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** : tag name where web component is added to DOM. * `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** must be a stringified JSON object from type `WebComponentSettings`. -**Meta** - -* **since**: 1.0.0 +#### Examples -```js -myContainer.webcomponent = { webComponentSettings: {type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}} +```javascript + ``` -```HTML - +```javascript +myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'} ``` +**Meta** + +* **since**: 1.0.0 + ### skipInitCheck If set to true, skips handshake and ready event is fired immediately. Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) +#### Examples + +```javascript + +``` + +```javascript +myContainer.skipInitCheck = true +``` + **Meta** * **since**: NEXT_RELEASE_CONTAINER @@ -392,17 +375,19 @@ The list of active feature toggles to be passed to the compound microfrontend. Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> -**Meta** +#### Examples -* **since**: NEXT_RELEASE_CONTAINER +```javascript + +``` -```js +```javascript myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] ``` -```HTML - -``` +**Meta** + +* **since**: NEXT_RELEASE_CONTAINER ### theme @@ -410,17 +395,19 @@ The theme to be passed to the compound microfrontend. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) -**Meta** +#### Examples -* **since**: NEXT_RELEASE_CONTAINER +```javascript + +``` -```js +```javascript myContainer.theme = 'sap_horizon' ``` -```HTML - -``` +**Meta** + +* **since**: NEXT_RELEASE_CONTAINER ### updateContext @@ -451,15 +438,3 @@ Returns **void** **Meta** * **since**: 1.0.0 -#TODO: made up example -```js - ... - myContainer.deferInit = true -} -#or HTML: js: the handler - -eventHandlerFn{ - ... - myContainer.init() -} -``` diff --git a/docs/luigi-container-api.md b/docs/luigi-container-api.md index 43a6aa6ddb..63a8d402d7 100644 --- a/docs/luigi-container-api.md +++ b/docs/luigi-container-api.md @@ -29,6 +29,16 @@ The URL of the microfrontend to be rendered Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.viewurl = "/index.html" +``` + **Meta** * **since**: 1.0.0 @@ -39,6 +49,16 @@ If set to true defers from initializing the microfronted automatically. In that Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) +#### Examples + +```javascript + +``` + +```javascript +myContainer.deferInit = true +``` + **Meta** * **since**: 1.0.0 @@ -49,6 +69,16 @@ The stringified context object to be passed to the microfrontend Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.context = {label: "Dashboard"} +``` + **Meta** * **since**: 1.0.0 @@ -59,6 +89,16 @@ Label information for the microfrontend Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.label = "Dashboard" +``` + **Meta** * **since**: 1.0.0 @@ -88,6 +128,16 @@ Type: ([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glo The advantage of this line of code is: you don't have to specify a tag name, thus avoiding the duplication of self-defined tag names.
+#### Examples + +```javascript + +``` + +```javascript +myContainer.webcomponent = { type: 'module', selfRegistered: true, tagName: 'my-webcomponent'} +``` + **Meta** * **since**: 1.0.0 @@ -98,6 +148,16 @@ The locale to be passed to the web-component-based micro frontend Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.locale = "en_us" +``` + **Meta** * **since**: 1.0.0 @@ -108,6 +168,16 @@ The theme to be passed to the web-component-based micro frontend Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.theme = 'sap_horizon' +``` + **Meta** * **since**: 1.0.0 @@ -118,6 +188,16 @@ The list of active feature toggles to be passed to the web-component-based micro Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> +#### Examples + +```javascript +myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"] +``` + +```javascript + +``` + **Meta** * **since**: 1.0.0 @@ -126,7 +206,17 @@ Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global If set to true, skips third party cookie check -Type: (`"false"` | `"true"`) +Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) + +#### Examples + +```javascript + +``` + +```javascript +myContainer.skipCookieCheck = true +``` **Meta** @@ -138,9 +228,20 @@ If set to true, skips handshake and ready event is fired immediately Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) +#### Examples + +```javascript + +``` + +```javascript +myContainer.skipInitCheck = true +``` + **Meta** * **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. ### nodeParams @@ -148,6 +249,16 @@ The parameters to be passed to the web-component-based micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) +#### Examples + +```javascript + +``` + +```javascript +myContainer.nodeParams = {foo: bar} +``` + **Meta** * **since**: 1.0.0 @@ -158,6 +269,16 @@ If set to true, the Luigi container webcomponent will not use the shadow DOM for Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) +#### Examples + +```javascript + +``` + +```javascript +myContainer.noShadow = true +``` + **Meta** * **since**: 1.2.0 @@ -168,6 +289,16 @@ The search parameters to be passed to the web-component-based micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) +#### Examples + +```javascript + +``` + +```javascript +myContainer.searchParams = {foo: bar} +``` + **Meta** * **since**: 1.0.0 @@ -178,6 +309,16 @@ The path parameters to be passed to the web-component-based micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) +#### Examples + +```javascript + +``` + +```javascript +myContainer.pathParams = {foo: "bar"} +``` + **Meta** * **since**: 1.0.0 @@ -188,6 +329,16 @@ The clientPermissions to be passed to the web-component-based micro frontend. Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) +#### Examples + +```javascript + +``` + +```javascript +myContainer.clientPermissions = {permission: "adminGroup"} +``` + **Meta** * **since**: 1.0.0 @@ -198,6 +349,16 @@ The user settings to be passed to the web-component-based micro frontend Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) +#### Examples + +```javascript + +``` + +```javascript +myContainer.userSettings = {language: 'de', theme: 'sap_horizon'} +``` + **Meta** * **since**: 1.0.0 @@ -208,6 +369,16 @@ The anchor value to be passed to the web-component-based micro frontend. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.anchor = '#foo' +``` + **Meta** * **since**: 1.0.0 @@ -222,7 +393,7 @@ Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global #### Examples ```javascript - + ``` ```javascript @@ -243,7 +414,7 @@ Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global #### Examples ```javascript - + ``` ```javascript @@ -260,6 +431,16 @@ The document title value to be passed to the web-component-based micro frontend. Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +#### Examples + +```javascript + +``` + +```javascript +myContainer.documentTitle = 'Luigi App' +``` + **Meta** * **since**: 1.2.0 @@ -269,7 +450,17 @@ Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa The hasBack value to be passed to the web-component-based micro frontend. It indicates that there is one or more preserved views. Useful when you need to show a back button. -Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) +Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) + +#### Examples + +```javascript + +``` + +```javascript +myContainer.hasBack = true +``` **Meta** @@ -282,6 +473,16 @@ It's used to indicate that there are unsaved changes when navigating away. Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) +#### Examples + +```javascript + +``` + +```javascript +myContainer.dirtyStatus = true +``` + **Meta** * **since**: 1.2.0 diff --git a/website/docs/.nvmrc b/website/docs/.nvmrc index 3c032078a4..c32828c2c2 100644 --- a/website/docs/.nvmrc +++ b/website/docs/.nvmrc @@ -1 +1 @@ -18 +lts/hydrogen \ No newline at end of file