-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Chore: update documentation to address issue #10856 #12777
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly LGTM
The `children` `args` as any other arg needs to be JSON serializable. This means that you should: | ||
|
||
- avoid using empty values. | ||
- avoid using components that include third party libraries such as `emotion`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure we know enough to put this in the docs. i think emotion does work in general, but fails in some cases--not sure which ones yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shilman as you said it we don't know much about it yet, and it will be a bit of "pickle" (pardon the bad pun) to hunt down each and every use case, for now we could probably frame it as :
The `children` `args` as any other arg needs to be JSON serializable. This means that you should:
- avoid using empty values
- use caution with components that include third party libraries
Let me know if you're ok with the changes and i'll commit them and we get it in the docs
Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks! |
Chore: update documentation to address issue #10856
With this pull request the issue #10856 is addressed and can be closed.
What was done:
workflows/stories-for-multiple-components
page to address the issue at hand.writing-stories/args
to include a bit more context to match the page above.Feel free to provide feedback