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

docs: storybook sync up with event arguments #1977

Merged
merged 3 commits into from
Sep 13, 2023
Merged

Conversation

saiponnada
Copy link
Contributor

@saiponnada saiponnada commented Aug 31, 2023

Description

Updated storybook documentation to sync up with the component events. Both DOM and component events are being emitted and storybook displays these events in actions tab. During this process for some component events, marko class information is being emitted. We decided to leave that extra information as is. Other-than that, the callback arguments were appropriately corrected in the storybook documentation.

References

Fixes following
#1930
#1892
#1887
#1890

Screenshots

Page/Section notice
image
image

Fake menu button
image

Confirm dialog
image

Drawer dialog
image

@saiponnada saiponnada self-assigned this Sep 7, 2023
@saiponnada saiponnada marked this pull request as ready for review September 7, 2023 22:51
@saiponnada saiponnada changed the title fix: storybook documentation sync up with events docs: storybook sync up with event arguments Sep 7, 2023
Copy link
Member

@LuLaValva LuLaValva 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 to me! Just one super minor suggestion, but I don't mind if this is merged without changing

el,
originalEvent,
index,
};
eventObj = Object.entries(eventObj)
Copy link
Member

Choose a reason for hiding this comment

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

If you'd like you can use Object.fromEntries here instead of reduce. I think it's a little cleaner but it is personal preference.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like it. Looks cleaner. Rolled out the change.

@saiponnada saiponnada merged commit 87dc686 into 12.6.0 Sep 13, 2023
1 check failed
@saiponnada saiponnada deleted the storybook-fixes branch September 13, 2023 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants