storybookjs / addon-design-assets

Design asset preview for storybook

Storybook addon for design assets

This addon for storybook allows you to link to image files, other files, and even url's for embedding in the storybook panel!

You can add as many assets to a single story as you want.

Install

npm install @storybook/addon-design-assets

Usage

within .storybook/main.js:

module.exports = {
  addons: ["@storybook/addon-design-assets"],
};

within your stories:

import React from "react";

import imageUrl from "./images/my-image.jpg";

export default {
  title: "Design Assets",
  parameters: {
    assets: [
      imageUrl, // link to a file imported
      "https://via.placeholder.com/300/09f/fff.png", // link to an external image
      "https://www.example.com", // link to a webpage
      "https://www.example.com?id={id}", // link to a webpage with the current story's id in the url
    ],
  },
};

export const defaultView = () => <div>your story here</div>;

Credits

While this addon was part of the Storybook monorepo, it received commits from the following authors:

Andrew Lisowski, Brody McKee, Clément DUNGLER, Gaëtan Maisse, Jimmy Somsanith, Jon Palmer, Joris W, Lynn Chyi, Michael Shilman, Michaël De Boey, Norbert de Langen, Paul Rosania, Renovate Bot, Robert Lange, Simen Bekkhus, Varun Vachhar