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

build: Switch to Storybook from Styleguidist #19

Merged
merged 32 commits into from
Apr 17, 2019
Merged

build: Switch to Storybook from Styleguidist #19

merged 32 commits into from
Apr 17, 2019

Conversation

milesj
Copy link
Contributor

@milesj milesj commented Apr 6, 2019

to: @stefhatcher @hayes @alecklandgraf

Description

Migrates from Styleguidist to Storybook. This is a proof of concept, let me know your thoughts.

Open questions:

  • Should we switch to Storybook?
  • Where should the story.tsx files live?
  • Should we build our own props table addon?

Motivation and Context

Storybook v5 is really good and offers the following features:

  • Responsive checks.
  • A11y checks.
  • Background switchers.
  • Action/console log.
  • Themeing.
  • Uses TS files for writing examples.
  • Story example files can be linted / type checked.
  • Possibility to use Happo/Percy for visual diffing.

However, things it does poorly compared to Styleguidist.

  • Ugly/useless prop tables (inferred from TS types). (Implemented a custom addon)
  • No live example editing (does support knobs, which is quite involved).

Testing

TBD

Screenshots

Screen Shot 2019-04-05 at 6 30 38 PM

Screen Shot 2019-04-05 at 6 56 32 PM

Checklist

  • My code follows the style guide of this project.
  • I have updated or added documentation accordingly.
  • I have read the CONTRIBUTING document.

@milesj
Copy link
Contributor Author

milesj commented Apr 8, 2019

@stefhatcher @hayes Finished converting all stories. Can pull the storybook locally and test it.

@milesj milesj force-pushed the storybook branch 2 times, most recently from 6c0fa15 to 1f6dd82 Compare April 15, 2019 20:16
@milesj milesj changed the title WIP: Switch to Storybook from Styleguidist build: Switch to Storybook from Styleguidist Apr 16, 2019
@milesj
Copy link
Contributor Author

milesj commented Apr 16, 2019

@alecklandgraf @hayes @stefhatcher This is good to go. Went ahead and wrote my own props addon.

Screen Shot 2019-04-16 at 12 26 40 PM

@stefhatcher
Copy link
Contributor

super excited for this! i'll miss the live example editing, but the added benefits are real nice!!!

@milesj milesj merged commit 129e5c7 into master Apr 17, 2019
@milesj milesj deleted the storybook branch April 17, 2019 17:36
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.

2 participants