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.

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

Conversation

walmazacn
Copy link
Contributor

Description

Changes proposed in this pull request:

  • adds node params to compound container typings

Related issue(s)

Resolves #3924

Copy link
Contributor

@ndricimrr ndricimrr left a comment

Choose a reason for hiding this comment

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

Looks good. Small comments

@@ -24,6 +24,12 @@ export default class LuigiCompoundContainer extends HTMLElement {
*/
deferInit: boolean;

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

@ndricimrr ndricimrr Sep 23, 2024

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

@@ -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

@ndricimrr ndricimrr self-assigned this Sep 23, 2024
Copy link
Contributor

@ndricimrr ndricimrr left a comment

Choose a reason for hiding this comment

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

Looks good

@walmazacn walmazacn merged commit cdd4f4d into main Sep 24, 2024
12 checks passed
@walmazacn walmazacn deleted the 3924-node-params-in-compound-container-typings branch September 24, 2024 08:37
@JohannesDoberer JohannesDoberer added the enhancement New feature or request label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
container enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

nodeParams are not documented in LuigiCompoundContainer.svelte.d.ts
3 participants