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

Adds node params to compound container typings #3934

Merged
merged 5 commits into from
Sep 24, 2024
Merged

Adds node params to compound container typings #3934

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2563261
Adds node params to compound container typings
walmazacn Sep 20, 2024
4e5d7a4
Adds correct version placeholder
walmazacn Sep 20, 2024
0fef334
Merge branch 'main' into 3924-node-params-in-compound-container-typings
walmazacn Sep 23, 2024
94ef4de
Fixes code review issues
walmazacn Sep 23, 2024
eb9fbad
Merge branch 'main' into 3924-node-params-in-compound-container-typings
walmazacn Sep 23, 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
6 changes: 6 additions & 0 deletions container/typings/LuigiCompoundContainer.svelte.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ export default class LuigiCompoundContainer extends HTMLElement {
*/
deferInit: boolean;

/**
* The parameters to be passed to the compound micro frontend.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* The parameters to be passed to the compound micro frontend.
* The parameters to be passed to the compound micro frontend. Will not be passed to the compound children.

Seems like this part is missing here. since we skip it for compound children.

Also I saw that this sentence "Will not be passed to the compound children." is present on LuigiContainer Typings : nodeParams . It should be removed from there and be kept here, since LuigiContainer doesn't deal with compound and that part there is wrong. You can do it in this PR maybe since its related

* @since NEXT_RELEASE_CONTAINER
Copy link
Contributor

@ndricimrr ndricimrr Sep 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about the NEXT_RELEASE_CONTAINER since nodeParams was added in [email protected]
@since 1.0.0 would be correct here I think

*/
nodeParams: Object;

/**
* If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering.
* @since 1.2.0
Expand Down
10 changes: 10 additions & 0 deletions docs/luigi-compound-container-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob

* **since**: 1.0.0

### nodeParams

The parameters to be passed to the compound micro frontend.

Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

**Meta**

* **since**: NEXT_RELEASE_CONTAINER

### noShadow

If set to true, the Luigi compound container webcomponent will not use the shadow DOM for rendering.
Expand Down