Storybook for HTML

Edit this page

You may have tried to use our quick start guide to setup your project for Storybook. If you want to set up Storybook manually, this is the guide for you.

This will also help you to understand how Storybook works.

Starter Guide HTML

Storybook has its own Webpack setup and a dev server.

In this guide, we will set up Storybook for your HTML project.

Table of contents

Add @storybook/html

First of all, you need to add @storybook/html to your project. To do that, simply run:

npm i --save-dev @storybook/html

If you don’t have package.json in your project, you’ll need to init it first:

npm init

Add babel-runtime, babel-core, and babel-loader

Make sure that you have babel-runtime, babel-core, and babel-loader in your dependencies as well because we list these as a peerDependency:

npm i --save-dev @babel-core
npm i --save-dev babel-loader

Then add the following NPM script to your package json in order to start the storybook later in this guide:

{
  "scripts": {
    "storybook": "start-storybook -p 9001 -c .storybook"
  }
}

Create the config file

Storybook can be configured in several different ways. That’s why we need a config directory. We’ve added a -c option to the above NPM script mentioning .storybook as the config directory.

For the basic Storybook configuration file, you don’t need to do much, but simply tell Storybook where to find stories.

To do that, simply create a file at .storybook/config.js with the following content:

import { configure } from '@storybook/html';

function loadStories() {
  require('../stories/index.js');
  // You can require as many stories as you need.
}

configure(loadStories, module);

That’ll load stories in ../stories/index.js.

Write your stories

Now you can write some stories inside the ../stories/index.js file, like this:

/* global document */
import { storiesOf } from '@storybook/html';

storiesOf('Demo', module)
  .add('heading', () => '<h1>Hello World</h1>')
  .add('button', () => {
    const button = document.createElement('button');
    button.innerText = 'Hello Button';
    button.addEventListener('click', e => console.log(e));
    return button;
  });

Story is a single HTML snippet or DOM node. In the above case, there are two stories:

  1. heading — an HTML snippet
  2. button — a DOM node with event listener

Run your Storybook

Now everything is ready. Simply run your storybook with:

npm run storybook

Now you can change components and write stories whenever you need to.