Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Storybook #54

Merged
merged 2 commits into from Jun 16, 2021
Merged

Storybook #54

merged 2 commits into from Jun 16, 2021

Conversation

gpxl-dev
Copy link
Contributor

This PR adds storybook with minimal custom config.

Storybook docs are here

To run storybook: yarn run storybook

Notes

  • Added tailwind dark mode addon which adds a moon icon in the toolbar that toggles the dark mode class for components. Currently haven't worked out how to change the background behind the components though so this will need some additional work - for now you can change the background with the background button two to the left of the dark mode one. (PS - for the button story I've implemented, only the neutral intent button is affected by dark mode).
  • I've added a story for Button just to show how they're written, but you may need to reference docs for more complex stories. Note the JSDoc comments on prop types are pulled into the "Docs" section in storybook, so documenting props will be good practice
  • When specifying component titles, if you use a folder structure (title: "components/Button",) the components are listed in that structure. For now I suggest we just reflect the file system structure.
  • Down the line we can also add documentation for non-components - check out mdx stories in the docs.

@gpxl-dev
Copy link
Contributor Author

Reason for resolve in package.json: storybookjs/storybook#13183

@gpxl-dev gpxl-dev changed the base branch from main to develop June 15, 2021 23:06
Copy link
Contributor

@codyenokida codyenokida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, definitely can use this as a template for dev.

@codyenokida codyenokida merged commit bda3c70 into develop Jun 16, 2021
@gpxl-dev gpxl-dev deleted the storybook branch August 25, 2021 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants