Blocks: new Description API, introduce useOf #20563
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.com:storybookjs/storybook into block-description-improvements
…scription-improvements
|
@tmeasday note that the stories that rely on the comment on meta are actually wrong, because we aren't actually extracting meta comments right now. so they currently fall back to the component's description. But I want to do that in a follow up PR. |
tmeasday
requested changes
Jan 11, 2023
tmeasday
approved these changes
Jan 11, 2023
Co-authored-by: Tom Coleman <tom@chromatic.com>
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.
#19964
This PR changes the Description block to work fully with the
ofAPI. It also introduces theuseOfhook which is also meant as a public API.Descriptionblock now accepts anofprop that is a reference to either a meta (default) export, a story export, or the whole CSF file (ie.import * as SomeStories from 'some.stories.tsx).Descriptionis rendered without anofprop, it will look for a description on meta/component in attached mode and throw in unattached mode.useOfreturns a combination of the result ofDocsContext.resolveModuleExportandDocsContext.store.projectAnnotations.The docs for this are in progress, but if anyone wants to try this out immediately, the drafts can be read on this Notion page.
(reminding myself to remove this link when the docs are published, as this link will get stale)
Stories are a bit messy because we need different CSF files for testing different meta description setups, but I've tried to group it as best as possible.
To do