GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 07:21:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

UPDATE addon-contexts: README.md

Browse Source
This commit is contained in:
Leo Y. Li 2019-04-23 22:04:36 -04:00
parent 90ed045c71
commit 2df5ff6d21
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
addons/contexts/README.md
View File

@ -31,6 +31,8 @@ once then apply it everywhere**.
use it to bridge with your favorite routing, state-management solutions, or even your own use it to bridge with your favorite routing, state-management solutions, or even your own
[React Context](https://reactjs.org/docs/context.html) provider. [React Context](https://reactjs.org/docs/context.html) provider.
4. Offer chainable and granular configurations. It is even possible to fine-tune at per story level. 4. Offer chainable and granular configurations. It is even possible to fine-tune at per story level.
5. Visual regression friendly. You can use this addon to driving the same story under different contexts to smoke
testing important visual states.
## 🧰 Requirements ## 🧰 Requirements
@ -227,6 +229,9 @@ be shown at first in the toolbar menu in your Storybook.
4. The addon will persist the selected params (the addon state) between stories at run-time (similar to other 4. The addon will persist the selected params (the addon state) between stories at run-time (similar to other
addons). If the active param were gone after story switching, it fallback to the default then the first. As a addons). If the active param were gone after story switching, it fallback to the default then the first. As a
rule of thumbs, whenever collisions made possible, always the first wins. rule of thumbs, whenever collisions made possible, always the first wins.
5. Query parameters are supported for pre-selecting contexts param, which comes handy for visual regression testing.
You can do this by appending `&contexts=[name of contexts]=[name of param]` in the URL under iframe mode. Use `,`
to separate multiple contexts (e.g. `&contexts=Theme=Forests,Language=Fr`.
## 📖 License ## 📖 License