storybook: create type table component #84282
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
github-actions
bot
added
the
Scope: Frontend
TkDodo
approved these changes
Jan 30, 2025
Comment on lines
330
to
340
| function groupByParent(props: PropItem[]) { | ||
| return props.reduce( | ||
| (acc, prop) => { | ||
| acc[prop.parent?.fileName ?? ''] = (acc[prop.parent?.fileName ?? ''] ?? []).concat( | ||
| prop | ||
| ); | ||
| return acc; | ||
| }, | ||
| {} as Record<string, PropItem[]> | ||
| ); | ||
| } |
There was a problem hiding this comment.
I think we could leverage the built-in Object.groupBy method here:
Object.groupBy(props, prop => prop.parent?.fileName ?? '');
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #84282 +/- ##
===========================================
+ Coverage 56.15% 87.64% +31.49%
===========================================
Files 9572 9564 -8
Lines 542163 540723 -1440
Branches 21264 21279 +15
===========================================
+ Hits 304434 473943 +169509
+ Misses 237377 66425 -170952
- Partials 352 355 +3 |
natemoo-re
approved these changes
Jan 30, 2025
Co-authored-by: Nate Moore <[email protected]>
andrewshie-sentry
pushed a commit
that referenced
this pull request
Feb 5, 2025
This PR exposes the type documentation generated in #84169 and #84166 to the user via a searchable table component and a story provided documentation helper. You can see an example of prop documentation added to the button.stories.tsx, which follows the current convention of storybook providing the helper that should be called by the user. ``` export default storyBook('Button', (story, APIReference) => { APIReference(types.Button); story('Default', () => ... ); ``` Note that the call order does not matter, the documentation (if provided) is being displayed under the components. In a perfect world, this should really work by passing the component itself to the API (the types can be stored directly on the function itself), however that is currently just not feasible as a broader loader implementation cripples the devserver to a point where it is not usable... The only notable design decision is that given how exhaustive our type generation is, I have decided to prioritize the props that are defined inside the component while other types which the component might extend from remain collapsed (users can expand them and they will show when searching), which https://github.com/user-attachments/assets/53fbea3c-7aea-4054-bfb9-1b4079b80f2d I do not consider this final and there are still aspects of this that I would like to improve, such as adding visual cues to indicate prop types, improving the type extraction and possibly breaking this down into smaller type definitions instead of files (sometimes the props are a merge of multiple different types defined in a single component) --------- Co-authored-by: Nate Moore <[email protected]>
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.
This PR exposes the type documentation generated in #84169 and #84166 to the user via a searchable table component and a story provided documentation helper.
You can see an example of prop documentation added to the button.stories.tsx, which follows the current convention of storybook providing the helper that should be called by the user.
Note that the call order does not matter, the documentation (if provided) is being displayed under the components. In a perfect world, this should really work by passing the component itself to the API (the types can be stored directly on the function itself), however that is currently just not feasible as a broader loader implementation cripples the devserver to a point where it is not usable...
The only notable design decision is that given how exhaustive our type generation is, I have decided to prioritize the props that are defined inside the component while other types which the component might extend from remain collapsed (users can expand them and they will show when searching), which
CleanShot.2025-01-29.at.18.42.12.mp4
I do not consider this final and there are still aspects of this that I would like to improve, such as adding visual cues to indicate prop types, improving the type extraction and possibly breaking this down into smaller type definitions instead of files (sometimes the props are a merge of multiple different types defined in a single component)