UNPKG

1.27 kBMarkdownView Raw
1# Storybook for Polymer
2
3Storybook for polymer is a UI development environment for your Polymer components.
4With it, you can visualize different states of your UI components and develop them interactively.
5
6> Storybook for Polymer is at the **EXPERIMENTAL** stage!
7
8![Storybook Screenshot](https://github.com/storybookjs/storybook/blob/master/media/storybook-intro.gif)
9
10Storybook runs outside of your app.
11So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
12
13## Getting Started
14
15```sh
16cd my-polymer-app
17npx -p @storybook/cli sb init
18```
19
20For more information visit: [storybook.js.org](https://storybook.js.org)
21
22---
23
24Storybook also comes with a lot of [addons](https://storybook.js.org/addons/introduction) and a great API to customize as you wish.
25You can also build a [static version](https://storybook.js.org/basics/exporting-storybook) of your storybook and deploy it anywhere you want.
26
27## Polymer Notes
28
29- This is super super experimental, if you want to use this, expect some bugs, and missing features.
30- We're looking for help to support this. If you're a member of the Polymer community and like this project, please help us!
31 If you need any onboarding from us, we're happy to help you in any way!