Skip to content
This repository has been archived by the owner on Dec 6, 2019. It is now read-only.

Setup storybook addons #10

Closed
conrad-vanl opened this issue Oct 10, 2017 · 4 comments
Closed

Setup storybook addons #10

conrad-vanl opened this issue Oct 10, 2017 · 4 comments
Assignees

Comments

@conrad-vanl
Copy link
Contributor

conrad-vanl commented Oct 10, 2017

Lets take a peek at the available storybook addons and make sure we setup those that we want to use:
https://storybook.js.org/addons/addon-gallery

Might be relevant to touch base with Drew or Nick to see what addons they see most relevant

Candidates:

  • Links: link stories together
  • Knobs: allow you to edit props from the Storybook UI
  • Info: show docs / other info in Storybook UI (could be how we document our code)
    • Or the community addon "readme"
  • Storyshots: automatic jest-snapshots for all stories
  • Story-router: allows you to integrate react-router components in stories
  • JSX preview: shows the JSX code used to render the story
  • Apollo: for mocking apollo data
@conrad-vanl conrad-vanl added this to the October milestone Oct 11, 2017
@conrad-vanl conrad-vanl modified the milestones: October, November Nov 1, 2017
@burkeshartsis
Copy link
Member

burkeshartsis commented Nov 2, 2017

I looked into and tried a few documentation based addons and none of them completely work with our setup on RN and Web. Below are some notes for when someone circles back on this.

ONE OF THESE:

  • Info: This will remain unusable until this PR is merged.
  • Props: This looked promising and might be solvable but my tests died here. The developer of this PR also said it will be deprecated when the Info PR above is merged.

AND ONE OF THESE:

  • Readme: Should work but would require increased manual documentation.
  • Notes: See Readme above.

@burkeshartsis
Copy link
Member

Not sure about this addon's compatibility but looks promising. https://github.com/mthuret/storybook-addon-specifications

@conrad-vanl
Copy link
Contributor Author

Props: This looked promising and might be solvable but my tests died here. The developer of this PR also said it will be deprecated when the Info PR above is merged.

Burke said: I think we can get this to work now, due to babel config change.

@burkeshartsis
Copy link
Member

Storyshots would be nice to have too. Currently it outputs all the snapshots into a single file (gross) the maintainers have a fix in the next release (already merged into the release branch) that addresses this by storying the snapshot next to the test. You can track that issue here.

@IsaacHardy IsaacHardy removed this from the Sprint 1 milestone Apr 25, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants