Addon-docs: Add Methods to web components ArgsTable #12413
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shilman
changed the title
shilman
approved these changes
Sep 8, 2020
shilman
changed the title
shilman
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: #12412
What I did
Some web component frameworks like Stencil are able to generate documentation for public methods of web components.
These should be shown in the ArgsTable of Storybook next to Attributes, Events, Slots etc. but are currently missing.
I added 'methods' to the custom elements interface and extractor and also included a demo entry to the custom-elements.json file in the web components kitchen-sink to display the results.
How to test
Screenshot