Addon-actions: Add Storybook Args support #10029
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
tmeasday
requested changes
Mar 3, 2020
addons/actions/README.md
Outdated
| ``` | ||
|
|
||
| Alternatively, suppose you have a naming convention, like `onX` for event handlers. The following configuration automatically creates actions for each `onX` argType (which you can either specify manually or generate automatically using [Storybook Docs](https://www.npmjs.com/package/@storybook/addon-docs). |
There was a problem hiding this comment.
Maybe add an example of how you'd provide an argType to the story? Or is that sort of pointless?
There was a problem hiding this comment.
Waiting on this until the argTypes design is finalized
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: N/A
What I did
Storybook Args is a new format for stories that passes a dynamic data object "Args" into story functions. This can be used to automatically provide actions event callbacks into stories and components.
This PR adds two forms of Args compatibility using story parameters.
argTypes.actionthat adds an action for each matching argTypeactions.argTypesRegexthat adds an action for each arg type name that matches the given regex.See the updated stories for examples.
How to test
See attached tests and
official-storybookstories