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

Align Luigi Container wc clientAPI with core #3643

Merged
merged 61 commits into from
Mar 8, 2024

Conversation

ndricimrr
Copy link
Contributor

@ndricimrr ndricimrr commented Feb 12, 2024

Description

Changes proposed in this pull request:

  • Add missing clientAPI functions for container WC API reflecting the API we have in Core WC Client API
  • Add 3 new additional attributes: documentTitle, dirtyStatus, hasBack
  • Add documentation
  • Add unit tests
  • Add manual test code to index.html/helloWorld.js

Related issue(s)

Resolves #3632

@ndricimrr ndricimrr requested a review from smahati as a code owner March 5, 2024 17:24
Copy link
Contributor

@JohannesDoberer JohannesDoberer left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@ndricimrr ndricimrr added documentation documentation tasks container labels Mar 6, 2024
@ndricimrr ndricimrr merged commit 2d8c469 into main Mar 8, 2024
11 checks passed
@ndricimrr ndricimrr deleted the 3632-align-wc-Luigi-client-container-w-core branch March 8, 2024 14:39
@ndricimrr ndricimrr changed the title Align wc LC with core Align Luigi Container wc clientAPI with core Mar 8, 2024
Copy link
Contributor

@smahati smahati left a comment

Choose a reason for hiding this comment

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

added suggestions for the documentation

### hasBack

The hasBack value to be passed to the compound micro frontend.
You can use it to mark if there is one or more preserved views. Useful when needing to show a back button.
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
You can use it to mark if there is one or more preserved views. Useful when needing to show a back button.
It indicates that there is one or more preserved views. Useful when you need to show a back button.

### dirtyStatus

The dirty status value to be passed to the compound micro frontend.
Used for unsaved changes when navigating away
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
Used for unsaved changes when navigating away
It's used to indicate that there are unsaved changes when navigating away.

### hasBack

The hasBack value to be passed to the web-component-based micro frontend.
You can use it to mark if there is one or more preserved views. Useful when needing to show a back button.
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
You can use it to mark if there is one or more preserved views. Useful when needing to show a back button.
It indicates that there is one or more preserved views. Useful when you need to show a back button.

### dirtyStatus

The dirty status value to be passed to the web-component-based micro frontend.
Used for unsaved changes when navigating away
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
Used for unsaved changes when navigating away
It's used to indicate that there are unsaved changes when navigating away.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
container documentation documentation tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Align wc LuigiClient in container to the one in core
3 participants