Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Container release v1.4.0 #4015

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Container release v1.4.0 #4015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e073e8a
container release-v1.4.0
JohannesDoberer Nov 5, 2024
e6ffb59
prettier
JohannesDoberer Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion container/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@



## [v1.4.0] (2024-11-05)

#### :rocket: Added

* [#3985](https://github.com/SAP/luigi/pull/3985) Add custom elements manifest for Luigi(Compound)Container ([@JohannesDoberer](https://github.com/JohannesDoberer))
* [#3936](https://github.com/SAP/luigi/pull/3936) Adds theme property for compound container ([@walmazacn](https://github.com/walmazacn))
* [#3934](https://github.com/SAP/luigi/pull/3934) Adds node params to compound container typings ([@walmazacn](https://github.com/walmazacn))
* [#3937](https://github.com/SAP/luigi/pull/3937) Adds activeFeatureToggleList property to LuigiCompoundContainer ([@walmazacn](https://github.com/walmazacn))
* [#3935](https://github.com/SAP/luigi/pull/3935) Adds locale property to Luigi Compound Container ([@ndricimrr](https://github.com/ndricimrr))

#### :bug: Fixed

* [#3988](https://github.com/SAP/luigi/pull/3988) fix wrong msg target resolution ([@hardl](https://github.com/hardl))




## [v1.3.0] (2024-08-27)

#### :rocket: Added
Expand Down Expand Up @@ -36,4 +53,5 @@

[v1.1.0]: https://github.com/SAP/luigi/compare/container/v1.0.0...container/v1.1.0
[v1.2.0]: https://github.com/SAP/luigi/compare/container/v1.1.0...container/v1.2.0
[v1.3.0]: https://github.com/SAP/luigi/compare/container/v1.2.0...container/v1.3.0
[v1.3.0]: https://github.com/SAP/luigi/compare/container/v1.2.0...container/v1.3.0
[v1.4.0]: https://github.com/SAP/luigi/compare/container/v1.3.0...container/v1.4.0
2 changes: 1 addition & 1 deletion container/public/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
"micro-frontends",
"microfrontends"
],
"version": "1.3.0"
"version": "1.4.0"
}
50 changes: 25 additions & 25 deletions container/typings/LuigiCompoundContainer.svelte.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export declare interface WebComponentSettings {
export default class LuigiCompoundContainer extends HTMLElement {
/**
* The URL used for the renderer.
*
*
* @example <luigi-container viewurl="/index.html"></luigi-container>
* @example myContainer.viewurl = "/index.html"
*/
Expand All @@ -17,7 +17,7 @@ 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 };
Expand All @@ -27,7 +27,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* If set to true defers from initializing the microfronted automatically. In that case init() can be used.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" defer-init></luigi-container>
* @example myContainer.deferInit = true
*/
Expand All @@ -36,8 +36,8 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
*
* The locale to be passed to the compound micro frontend.
* @since NEXT_RELEASE_CONTAINER
*
* @since 1.4.0
*
* @example <luigi-container locale="en_us"></luigi-container>
* @example myContainer.locale = "en_us"
*/
Expand All @@ -46,7 +46,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The parameters to be passed to the compound micro frontend. Will not be passed to the compound children.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" node-params='{"node":"param"}'></luigi-container>
* @example myContainer.nodeParams = {foo: bar}
*/
Expand All @@ -55,7 +55,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering.
* @since 1.2.0
*
*
* @example <luigi-container viewurl="/index.html" no-shadow></luigi-container>
* @example myContainer.noShadow = true
*/
Expand All @@ -64,7 +64,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The search parameters to be passed to the compound micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" search-params='{"search":"param"}'></luigi-container>
* @example myContainer.searchParams = {foo: bar}
*/
Expand All @@ -73,7 +73,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The path parameters to be passed to the compound micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" path-params='{"path":"param"}'></luigi-container>
* @example myContainer.pathParams = {foo: "bar"}
*/
Expand All @@ -82,7 +82,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The stringified context to be passed to the compound microfrontend.
* @since 1.0.0
*
*
* @example <luigi-container viewUrl="/index.html" context='{"label": "Dashboard"}'></luigi-container>
* @example myContainer.context = {label: "Dashboard"}
*/
Expand All @@ -91,7 +91,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The clientPermissions to be passed to the compound micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" client-permissions='{"permission": "adminGroup"}'></luigi-container>
* @example myContainer.clientPermissions = {permission: "adminGroup"}
*/
Expand All @@ -100,7 +100,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The user settings to be passed to the compound micro frontend.
* @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'}
*/
Expand All @@ -109,7 +109,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The anchor value to be passed to the compound micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" anchor='#foo'></luigi-container>
* @example myContainer.anchor = '#foo'
*/
Expand All @@ -118,7 +118,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
/**
* The document title value to be passed to the compound micro frontend.
* @since 1.2.0
*
*
* @example <luigi-container viewurl="/index.html" document-title='Luigi App'></luigi-container>
* @example myContainer.documentTitle = 'Luigi App'
*/
Expand All @@ -128,7 +128,7 @@ 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 <luigi-container viewurl="/index.html" has-back></luigi-container>
* @example myContainer.hasBack = true
*/
Expand All @@ -138,7 +138,7 @@ export default class LuigiCompoundContainer extends HTMLElement {
* 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 <luigi-container viewurl="/index.html" dirty-status></luigi-container>
* @example myContainer.dirtyStatus = true
*/
Expand All @@ -152,36 +152,36 @@ 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 <luigi-container webcomponent="{ type: 'module', selfRegistered: true, tagName: 'my-webcomponent'}"></luigi-container>
* @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
*
* @since 1.4.0
*
* @example <luigi-container viewurl="/index.html" skipInitCheck></luigi-container>
* @example myContainer.skipInitCheck = true
*/
skipInitCheck: boolean;

/**
* The list of active feature toggles to be passed to the compound microfrontend.
* @since NEXT_RELEASE_CONTAINER
*
*
* @since 1.4.0
*
*
* @example <luigi-container viewUrl="/index.html" active-feature-toggle-list='["enable-foo", "allow-bar"]'></luigi-container>
* @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"]
*/
activeFeatureToggleList: string[];

/**
* The theme to be passed to the compound microfrontend.
* @since NEXT_RELEASE_CONTAINER
*
*
* @since 1.4.0
*
*
* @example <luigi-container viewUrl="/index.html" theme='sap_horizon'></luigi-container>
* @example myContainer.theme = 'sap_horizon'
*/
Expand Down
40 changes: 20 additions & 20 deletions container/typings/LuigiContainer.svelte.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The URL of the microfrontend to be rendered
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html"></luigi-container>
* @example myContainer.viewurl = "/index.html"
*/
Expand All @@ -17,7 +17,7 @@ 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
*
*
* @example <luigi-container viewurl="/index.html" defer-init></luigi-container>
* @example myContainer.deferInit = true
*/
Expand All @@ -26,8 +26,8 @@ export default class LuigiContainer extends HTMLElement {
/**
* The stringified context object to be passed to the microfrontend
* @since 1.0.0
*
*
*
*
* @example <luigi-container viewUrl="/index.html" context='{"label": "Dashboard"}'></luigi-container>
* @example myContainer.context = {label: "Dashboard"}
*/
Expand All @@ -36,7 +36,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* Label information for the microfrontend
* @since 1.0.0
*
*
* @example <luigi-container viewUrl="/index.html" label="Dashboard"></luigi-container>
* @example myContainer.label = "Dashboard"
*/
Expand Down Expand Up @@ -71,7 +71,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The locale to be passed to the web-component-based micro frontend
* @since 1.0.0
*
*
* @example <luigi-container locale="en_us"></luigi-container>
* @example myContainer.locale = "en_us"
*/
Expand All @@ -80,7 +80,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The theme to be passed to the web-component-based micro frontend
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" theme='sap_horizon'></luigi-container>
* @example myContainer.theme = 'sap_horizon'
*/
Expand All @@ -89,16 +89,16 @@ 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
*
*
* @example myContainer.activeFeatureToggleList = ["enable-foo", "allow-bar"]
* @example <luigi-container viewurl="/index.html" active-feature-toggle-list='["enable-foo", "allow-bar"]'></luigi-container>
*/
activeFeatureToggleList: string[];

/**
* If set to true, skips third party cookie check
* @since NEXT_RELEASE_CONTAINER
*
* @since 1.4.0
*
* @example <luigi-container viewurl="/index.html" skipCookieCheck></luigi-container>
* @example myContainer.skipCookieCheck = true
*/
Expand All @@ -116,7 +116,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The parameters to be passed to the web-component-based micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" node-params='{"node":"param"}'></luigi-container>
* @example myContainer.nodeParams = {foo: bar}
*/
Expand All @@ -125,7 +125,7 @@ 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
*
*
* @example <luigi-container viewurl="/index.html" no-shadow></luigi-container>
* @example myContainer.noShadow = true
*/
Expand All @@ -134,7 +134,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The search parameters to be passed to the web-component-based micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" search-params='{"search":"param"}'></luigi-container>
* @example myContainer.searchParams = {foo: bar}
*/
Expand All @@ -143,7 +143,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The path parameters to be passed to the web-component-based micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" path-params='{"path":"param"}'></luigi-container>
* @example myContainer.pathParams = {foo: "bar"}
*/
Expand All @@ -152,7 +152,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The clientPermissions to be passed to the web-component-based micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" client-permissions='{"permission": "adminGroup"}'></luigi-container>
* @example myContainer.clientPermissions = {permission: "adminGroup"}
*/
Expand All @@ -161,7 +161,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The user settings to be passed to the web-component-based micro frontend
* @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'}
*/
Expand All @@ -170,7 +170,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The anchor value to be passed to the web-component-based micro frontend.
* @since 1.0.0
*
*
* @example <luigi-container viewurl="/index.html" anchor='#foo'></luigi-container>
* @example myContainer.anchor = '#foo'
*/
Expand All @@ -197,7 +197,7 @@ export default class LuigiContainer extends HTMLElement {
/**
* The document title value to be passed to the web-component-based micro frontend.
* @since 1.2.0
*
*
* @example <luigi-container viewurl="/index.html" document-title='Luigi App'></luigi-container>
* @example myContainer.documentTitle = 'Luigi App'
*/
Expand All @@ -207,7 +207,7 @@ export default class LuigiContainer extends HTMLElement {
* 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
*
*
* @example <luigi-container viewurl="/index.html" has-back></luigi-container>
* @example myContainer.hasBack = true
*/
Expand All @@ -217,7 +217,7 @@ export default class LuigiContainer extends HTMLElement {
* 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
*
*
* @example <luigi-container viewurl="/index.html" dirty-status></luigi-container>
* @example myContainer.dirtyStatus = true
*/
Expand Down
Loading