@open-wc/storybook

Storybook configuration following open-wc recommendations

Usage no npm install needed!

<script type="module">
  import openWcStorybook from 'https://cdn.skypack.dev/@open-wc/storybook';
</script>

README

Demoing via storybook

Part of Open Web Components

Open Web Components provides a set of defaults, recommendations and tools to help facilitate your web component project. Our recommendations include: developing, linting, testing, building, tooling, demoing, publishing and automating.

CircleCI BrowserStack Status Renovate enabled

For demoing and showcasing different states of your Web Component, we recommend using storybook.

::: tip This is part of the default open-wc recommendation :::

Setup

npm i -g yo
npm i -g generator-open-wc

yo open-wc:demoing

Manual

  • yarn add @open-wc/storybook --dev
  • Copy at minimum the .storybook folder to .storybook
  • If you want to bring along the examples, you may also copy the stories folder.
  • Add the following scripts to your package.json
"scripts": {
  "site:build": "npm run storybook:build",
  "storybook:build": "build-storybook -o _site",
  "storybook:start": "start-storybook -p 9001"
},

Usage

Create stories within the stories folder.

npm run storybook:start

Example

The Set-Game Example has the default publishing via storybook on netlify. You can see the finished page at: https://example-set-game-open-wc.netlify.com/.