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

Add publishEvent documentation and tests #3882

Merged
merged 35 commits into from
Oct 7, 2024
Merged

Conversation

ndricimrr
Copy link
Contributor

@ndricimrr ndricimrr commented Aug 29, 2024

Description

Changes proposed in this pull request:

  • add documentation for publishEvent feature
  • Add example for compound scenario
  • add example for wc scenario

Related issue(s)

Fixes #3860

Preview of docu section example:

Screenshot 2024-09-30 at 12 14 59

@ndricimrr ndricimrr added the documentation documentation tasks label Aug 29, 2024
client/luigi-element.d.ts Outdated Show resolved Hide resolved
@ndricimrr ndricimrr marked this pull request as ready for review September 6, 2024 11:47
@ndricimrr ndricimrr changed the title publishEvent documentation add publishEvent documentation and tests Sep 6, 2024
@ndricimrr ndricimrr changed the title add publishEvent documentation and tests Add publishEvent documentation and tests Sep 6, 2024
@JohannesDoberer JohannesDoberer self-assigned this Sep 10, 2024
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 👍

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.

it's good as is, an alternative for publish event

client/luigi-client-wc-docu-mixin.js Outdated Show resolved Hide resolved
client/luigi-client-wc-docu-mixin.js Show resolved Hide resolved
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.

yeah, I thought that would be bit of a stretch so thank you for trying :).

@smahati
Copy link
Contributor

smahati commented Sep 30, 2024

A general Question, in the comments there are references to filenames Like wcWebcomponent.js, is it for illustration or is it a reference to another example/sample?

@ndricimrr
Copy link
Contributor Author

A general Question, in the comments there are references to filenames Like wcWebcomponent.js, is it for illustration or is it a reference to another example/sample?

wcComponent.js , firstChild.js , etc are just random file names I chose for the example as illustration.

docs/luigi-client-api.md Outdated Show resolved Hide resolved
@JohannesDoberer JohannesDoberer merged commit 53e500e into main Oct 7, 2024
12 checks passed
@JohannesDoberer JohannesDoberer deleted the 3860-publishevent-docu branch October 7, 2024 09:23
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.

Document publishEvent functionality
4 participants