GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 23:11:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12777 from storybookjs/fix_issue_10856

Browse Source 
Chore: update documentation to address issue #10856
This commit is contained in:
Michael Shilman 2021-06-05 11:06:59 +08:00 committed by GitHub
commit 85426d9651
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/workflows/stories-for-multiple-components.md
View File

@ -68,9 +68,18 @@ One way we improve that situation is by pulling the rendered subcomponent out in
Now that `children` is an arg, we can potentially reuse it in another story.
However, there are some caveats when using this approach that you should be aware of.
The `children` `args` as any other arg needs to be JSON serializable. It means that you should:
- Avoid using empty values
- Use caution with components that include third party libraries
As they could lead into errors with your Storybook.
<div class="aside">
As things stand (we hope to improve this soon) you cannot edit children in a control yet.
We're currently working on improving the overall experience for the children arg and allow you to edit children arg in a control and allow you to use other types of components in the near future. But for now you need to factor in this caveat when you're implementing your stories.
</div>

2
docs/writing-stories/args.md
View File

@ -10,7 +10,7 @@ Learn how and why to write stories in [the introduction](./introduction.md#using
## Args object
The args object can be defined at the story and component level (see below). It is an object with string keys, where values can have any type that is allowed to be passed into a component in your framework.
The args object can be defined at the story and component level (see below). It is a JSON serializable object, composed of string keys with matching valid value types that can be passed into a component for your framework.
## Story args