Blocks: Canvas stories #19804
Merged
Blocks: Canvas stories #19804
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
JReinhold
commented
Nov 11, 2022
| }; | ||
|
|
||
| // TODO: what is the purpose of mdxSource exactly? | ||
| export const WithMdxSource: Story = { |
There was a problem hiding this comment.
JReinhold
commented
Nov 11, 2022
| withSource?: SourceState; | ||
| mdxSource?: string; | ||
| }; | ||
|
|
||
| const getPreviewProps = ( | ||
| const usePreviewProps = ( |
There was a problem hiding this comment.
It turned out this was actually a hook, just not named as such (which surfaced errors)
JReinhold
commented
Nov 11, 2022
| withSource?: SourceState; | ||
| mdxSource?: string; | ||
| }; | ||
|
|
||
| const getPreviewProps = ( | ||
| const usePreviewProps = ( |
There was a problem hiding this comment.
The diff for this function may seem like a lot, but it maintains the exact same functionality and logic, it's just a refactoring. The refactoring was sparked by the need for useSourceProps hook to be called unconditionally, and so in an attempt to figure the whole thing out I simplified the logic paths.
JReinhold
commented
Nov 11, 2022
| @@ -89,7 +89,7 @@ const getSnippet = (snippet: string, story?: Store_Story<any>): string => { | |||
| type SourceStateProps = { state: SourceState }; | |||
| type PureSourceProps = ComponentProps<typeof PureSource>; | |||
|
|
|||
| export const getSourceProps = ( | |||
| export const useSourceProps = ( | |||
There was a problem hiding this comment.
also a hook, actually.
Merged
tmeasday
approved these changes
Nov 13, 2022
…-898-blocks-canvas
…-898-blocks-canvas
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 adds stories for the Canvas block, both for current features and deprecated features.
Most notably, Having non-story elements/components within a Canvas as well as having multiple stories is being soft-deprecated. This means that we won't be documenting it officially (so in this PR the stories for those use cases are internal, and not in the public Blocks SB), but because we haven't quite figured out the migration path off of this yet* we aren't showing any deprecation warnings yet. This was discussed with @shilman, but I'm open to any input.
* the migration path is likely the variants feature, which won't land for a while.