Storybook for Riot

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 understand how Storybook works.

Starter Guide Riot

Storybook has its own Webpack setup and a dev server. The Webpack setup is very similar to tag-loader, but allows you to configure it however you want.

In this guide, we are trying to set up Storybook for your Riot project.

Table of contents

Add @storybook/riot

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

npm i --save-dev @storybook/riot

Add riot and babel-loader

Make sure that you have riot, the riot-compiler, the riot-tag-loader and babel-loader in your dependencies as well because we list it as a peerDependency:

npm i --save riot
npm i --save-dev babel-core riot-compiler riot-tag-loader

Create the NPM script

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.

There are 2 things you need to tell Storybook to do:

  1. Import and globally register with riot.mount() any global custom components just like you did with your project.
  2. Require your stories.

Here’s an example .storybook/config.js to get you started:

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

// Import your globally available components.
import '../src/stories/Button.tag'; 

function loadStories() {
  // You can require as many stories as you need.

configure(loadStories, module);

This example registered your custom Button.tag component, and loaded your Storybook stories defined in ../stories/index.js.

All custom components can be registered before or after calling configure().

This stories folder is just an example, you can load stories from wherever you want to. We think stories are best located close to the source files.

Write your stories

There are several ways to implement a story using either a text import or a component import

import { tag, mount, storiesOf } from '@storybook/riot';
import SimpleTestRaw from './SimpleTest.txt'; //can be loaded as string if you prefer
import './AnotherTest.tag';
//if you need to import .tag files as text, just use the raw-loader instead of the riot-tag-loader

storiesOf('Story|How to create a story', module)
    'built with tag', // the template is compiled below
    () =>
      tag('test', '<div>simple test ({ opts.value })</div>', '', '', () => {}) &&
      mount('test', { value: 'with a parameter' }))

  // tags[0] will be the parent tag, always
  // you can leave out the root tag, if we find out that the new root tag
  // is a built-in html tag, it will be wrapped
  .add('built as string', () => ({ tags: ['<test><div>simple test</div></test>'] })

  // the component is a string, it will be instantiated without params
  // e.g. <SimpletestRaw/>
  .add('built from raw import', () => SimpleTestRaw)

  // the comprehensive form is this one
  // list all the possible tags (the root element is in the content)
  // then scenario is compiled and executed
    'built from tags and scenario',
    () => ({
      tags: [{ content: SimpleTestRaw, boundAs: 'mustBeUniquePlease' }],
        '<SimpleTest test={ "with a parameter" } value={"value is mapped to riotValue"}></SimpleTest>',
        'WARN : the tag file root element must have exactly the same name (or else you will see nothing)',

  // the tag is already compiled before running the js
  // the tag name 'anothertest' must match exactly the root tag inside the tag file
  // mind the lower case
  .add('built from the precompilation', () => mount('anothertest', {}), {
    notes: 'WARN, only works in lower case, never upper case with precompiled templates',

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. You’ll get those changes into Storybook in a snap with the help of Webpack’s HMR API.