docs: updated togglebox and toggleboxgroup stories #989
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
Removed wrapping helper component to improve code snippets.
|
Uffizzi Preview |
mstruebing
approved these changes
Aug 22, 2023
|
🎉 This PR is included in version 15.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Sep 19, 2023
Closed
Closed
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.
Removed wrapping helper component to improve code snippets.
Description
We have some stories throughout our Storybook that will not display how to use the component under the docs code tab if they are wrapped in a helper component. This HOC (Higher Order Component) pattern does not pair well with the Storybook documentation.
These can be refactored so that the logic from the helper component is integrated directly into the component stories.
I'd like for these changes to serve as a reference for the other stories we need to update. I will be opening those up for open source contributions so others in the community can gain some experience with Storybook.
Here is a an outline of how to go about these changes.
Refactoring Storybook files with helper components
Open the story files related to the component (e.g., ToggleBox.stories.tsx, ToggleBoxGroup.stories.tsx).
Remove the import of the *StoryHelper components.
Integrate the state management and handlers directly into the story templates. Replace the occurrences where the *StoryHelper components were used with the state management logic.
Ensure that the state management, handlers, and component rendering are all contained within the same story file.
Which issue(s) does this PR relate to?
Testing
Test out the
ToggleBoxandToggleBoxGroupcomponents.View the Docs page for these components and click the Code button to open up the code example.
Trade-offs
Screenshots
Before
ToggleBox
ToggleBoxGroup
After
ToggleBox
ToggleBoxGroup
Checklist