Use Storybook to create reusable UI components in isolation #289
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
Storybook is an open source tool for building UI components and pages in isolation. In this project it hopefully helps us to create reusable UI components. Storybook was initialized using the CLI tool and react-webpack default settings. Some dependencies were manually added to package.json to get rid of warnings.
This should make it easier to spot problems the components might have when rendered on our dark background color.
Wraps each Storybook story with ChakraProvider, making the expected styles work.
Also add short doc string for the components, to see how Storybook displays these on its Docs tab.
Storybook's play function allows initializing the components to specific states by mimicking user actions. Ideally components' hard-to-reach states can be shown without user having to manually interact with the component. The examples included in this commit are rather lame, but they work as an showcase for what can be done with Storybook. Storybook also provides tools for visual, accessibility and snapshot testing, but the current components didn't entice me to check these out at this time. Maybe later when more suitable components are created.
MythicManiac
approved these changes
Dec 2, 2021
| } | ||
| ] | ||
| ] | ||
| } |
There was a problem hiding this comment.
pre-commit not handling missing newlines in this repo? Should we perhaps add pre-commit or something similar (in another PR)?
There was a problem hiding this comment.
Well there is this long-forgotten PR: #32 .
There's also seems to be a pre-commit config in the repo, but I've not set it up yet. Should we use pre-commit as we do in our other repos and ignore that old PR?
There was a problem hiding this comment.
Yeah that sounds like a good idea
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 does much of the same stuff as PR #84. Includes:
Select,MultiSelectandMarkdowncomponentsIncluded in PR #84, but not included here:
Closes PR #84.