Addon-docs: Refactor Props to use ArgsTable #10341
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
reviewed
Apr 8, 2020
| const { parameters } = context; | ||
| const { component, subcomponents, args = {}, argTypes = {}, docs = {} } = parameters; | ||
| const { extractArgTypes } = docs; | ||
| // if (context.storyFn.length === 0 || !component || !extractArgTypes) { |
There was a problem hiding this comment.
We should decide if we do this.
|
|
||
| extractedArgTypes = Object.entries(componentArgTypes).reduce((acc, [label, compTypes]) => { | ||
| Object.entries(compTypes).forEach(([key, argType]) => { | ||
| const subLabel = label === 'Primary' ? key : camelCase(`${label} ${key}`); |
There was a problem hiding this comment.
The primary component doesn't get its arg names mangled?
There was a problem hiding this comment.
I guess this needs to be thought of in combination with the story/primary component arg combination idea.
| export const inferArgTypes = (args: Args) => { | ||
| if (!args) return {}; | ||
| return Object.entries(args).reduce((acc, [name, arg]) => { | ||
| if (arg != null) { |
There was a problem hiding this comment.
Suggested change
| if (arg != null) { | |
| if (arg !== null) { |
There was a problem hiding this comment.
!= null handles both null and undefined
Comment on lines
+6
to
+11
| // import camelCase from 'lodash/camelCase'; | ||
| // Object.entries(subTypes).forEach(([key, val]) => { | ||
| // const subLabel = camelCase(`${label} ${key}`); | ||
| // acc[subLabel] = { ...val, table: { ...val.table, tab: label } }; | ||
| // }); | ||
|
|
Co-Authored-By: Tom Coleman <[email protected]>
…to 6639-args-table
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: #6639
What I did
This is the first of a series of PRs to add controls (formerly known as "knobs") to the Props block:
This is the largest PR. It contains:
<Props story="story name" />APIArgsTable, a refactor ofPropsTablethat's based on ArgTypesIt is demonstrated in the
props.stories.mdxdemo, which will subsequently be enhanced with Controls in the follow-on PRHow to test
run
official-storybookand navigate toAddons/Docs/props