Serving Static Files

Edit this page

It’s often useful to load static files like images and videos when creating components and stories.

Storybook provides two ways to do that.

1. Via Imports

You can import any media assets by simply importing (or requiring) them as shown below.

import React from 'react';
import { storiesOf } from '@storybook/react';

import imageFile from './static/image.png';

const image = {
  src: imageFile,
  alt: 'my image',
};

storiesOf('<img />', module)
  .add('with an image', () => (
    <img src={image.src} alt={image.alt} />
  ));

This is enabled with our default config. But, if you are using a custom Webpack config, you need to add the file-loader into your custom Webpack config.

2. Via a Directory

You can also configure a directory (or a list of directories) for searching static content when you are starting Storybook. You can do that with the -s flag.

See the following npm script on how to use it:

{
"scripts": {
  "start-storybook": "start-storybook -s ./public -p 9001"
}
}

Here ./public is our static directory. Now you can use static files in the public directory in your components or stories like this.

import React from 'react';
import { storiesOf } from '@storybook/react';

const imageAlt = 'my image';

// assume image.png is located in the "public" directory.
storiesOf('<img />', module)
  .add('with a image', () => (
    <img src="/image.png" alt={imageAlt} />
  ));

You can also pass a list of directories separated by commas without spaces instead of a single directory.

{
"scripts": {
  "start-storybook": "start-storybook -s ./public,./static -p 9001"
}
}

3. Via a CDN

Upload your files to an online CDN and just reference them. In this example we’re using a placeholder image service.

import React from 'react';
import { storiesOf } from '@storybook/react';

storiesOf('<img />', module)
  .add('with a image', () => (
    <img src="https://placehold.it/350x150" alt="My CDN placeholder" />
  ));

Absolute versus relative paths

Sometimes, you may want to deploy your storybook into a subpath, like https://example.com/storybook.

In this case, you need to have all your images and media files with relative paths. Otherwise, Storybook cannot locate those files.

If you load static content via importing, this is automatic and you do not have to do anything.

If you are using a static directory, then you need to use relative paths to load images.