npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pxtrn/storybook-addon-themes

v6.0.2

Published

A storybook addon to switch between different themes for your preview

Downloads

43

Readme

Storybook Addon Themes

Greatly inspired by @storybook/addon-backgrounds.

This Storybook Theme Decorator can be used to add a custom HTML class or classes to the the preview in Storybook.

Demo

Compatibility

This version is compatible with storybook version 6.0.x.

Installation

npm i -D @pxtrn/storybook-addon-themes

Getting started

Then activate the addon by adding it to the storybook main.js file (located in the Storybook config directory):

module.exports = {
  addons: [
    // Maybe other addons here...
    'storybook-addon-themes'
    // Or here...
  ],
};

See the storybook documentation for more informations.

Parameters

The themes parameter accept an array of Theme object.

Each Theme is an object with the following properties :

  • name (string): Name of the theme
  • class (string | string[] - optionnal): HTML class(es) associated with the theme
  • color (string): The color of the badge in the theme selector
  • default (boolean - optionnal): Is the theme selected by default ?

The themes parameter also accept an object with the following properties :

  • list (Theme[] - required): The list of themes
  • clearable (boolean - optionnal - default is true): Can the user clear the selected theme ?
  • disable (boolean - optionnal): Disable the addon for a story
  • Decorator (Component - optionnal): A component to use as the decorator component (see below for more informations)
  • onChange ((themeName: Theme) => void - optionnal): A callback that will be executed when the theme changes
  • target (string - optionnal): Target element selected with document.querySelector() to which classes are applied. Defaults to body, root if classes should be applied to documentElement.

Configuration

Globally

You can configure the themes globally in the storybook preview.js file:

export const parameters = {
  themes: [
    { name: 'twitter', class: 'theme-twt', color: '#00aced', default: true },
    { name: 'facebook', class: 'theme-fb', color: '#3b5998' }
  ]
};

See the storybook documentation for more informations.

In story (Component Story Format)

Or configure the themes in your story file like this:

export default {
  title: 'CSF|Button',
  component: Button,
  parameters: {
    themes: [
      { name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced', default: true },
      { name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
    ],
  },
};

If you only want to activate the addon or override the themes for a specific story you can write:

export default {
  title: 'CSF|Button',
  component: Button,
};

export const withText = () => <Button onClick={action('clicked')}>Hello Button</Button>;
withText.story = {
  parameters: {
    themes: [
      { name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced', default: true },
      { name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
    ],
  },
};

In story (StoriesOf API)

Alternatively with the old StoriesOf API:

import { storiesOf } from '@storybook/react'; // <- or your storybook framework

storiesOf('StoriesOf|Button', module)
  .addParameters({
    themes: [
      { name: 'twitter', class: 'theme-twt', color: '#00aced', default: true },
      { name: 'facebook', class: 'theme-fb', color: '#3b5998' },
    ],
  })
  .add('with text', () => <button>Click me</button>);

And for a single story:

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

storiesOf('StoriesOf|Button', module)
  .add('with text', () => <button>Click me</button>, {
    themes: [
      { name: 'red', class: 'theme-red', color: 'rgba(255, 0, 0)' },
    ],
  });

Usage with decorator

By default the classes will be added to the body element or the element configured with target.

But in this case your theme will not be visible by other addons (like @storybook/addon-storyshots).

To fix this you can add the withThemes decorator in your stories.

But the decorator method is not available for all frameworks

See here for the list of supported framework.

Globally

Setup the decorator globally in the preview.js file:

import { addDecorator } from '@storybook/react'; // <- or your storybook framework
import { withThemes } from '@pxtrn/storybook-addon-themes/react'; // <- or your storybook framework

addDecorator(withThemes);

export const parameters = {
  actions: { argTypesRegex: "^on[A-Z].*" },
  themes:  [
    { name: 'twitter', class: 'theme-twt', color: '#00aced', default: true },
    { name: 'facebook', class: 'theme-fb', color: '#3b5998' }
  ]
};

In story (Component Story Format)

Or in your story file (for all stories in that file):

export default {
  title: 'CSF|Button',
  component: Button,
  decorators: [ withThemes ],
  parameters: {
    themes: [
      { name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced', default: true },
      { name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
    ],
  },
};

Or just for a specific story:

export const withText = () => <Button onClick={action('clicked')}>Hello Button</Button>;
withText.story = {
  decorators: [ withThemes ],
  parameters: {
    themes: [
      { name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced', default: true },
      { name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
    ],
  },
};

In story (StoriesOf API)

And alternatively with the old StoriesOf API:

import { storiesOf } from '@storybook/react'; // <- or your storybook framework
import { withThemes } from '@pxtrn/storybook-addon-themes/react';

storiesOf('StoriesOf|Button', module)
  .addDecorator(withThemes)
  .add('with text', () => <button>Click me</button>);

Custom decorator

General

You can provide a component that will be used as decorator using the Decorator option in the theme parameter.

The decorator will get the following properties :

  • theme: The selected theme or undefined if none is selected.
  • themes: The list of themes as provided in the list option of the theme parameter.
  • themeClasses: The formatted theme classes of the selected theme (if the class option exists on the selected theme).
  • themeName: The name of the selected theme (equal to none if none is selected).

Don't forget to render the story using the children prop (React/HTML) or the <slot></slot> element (Vue/Svelte).

HTML example

To manage reactivity with the HTML storybook your decorator must return an array containing two elements :

  • the HTML element to display in the story
  • An update callback that will be called when the theme change. Like the decorator, the callback will receive the same props (without children).

Example of a customized decorator that use a CSS file for changing the theme:

function getOrCreate(id) {
  const elementOnDom = document.getElementById(id);
  if (elementOnDom) {
    return elementOnDom;
  }

  const element = document.createElement('link');
  element.setAttribute('id', id);
  element.setAttribute('rel', 'stylesheet');
  return element;
}

function Decorator(props) {
  const { children } = props;

  function setStyles({ theme, themeName }) {
    const link = getOrCreate('theme-stylesheet');
    if (!theme) {
      link.parentNode && link.parentNode.removeChild(link);
    } else {
      link.href = themeName === 'facebook' ? 'Button-fb.css' : 'Button-twt.css';
      children.appendChild(link);
    }
  }
  setStyles(props);

  return [children, setStyles];
}

React example

Same example as above for React:

function Decorator(props) {
  const { children, themeName } = props;
  return (
    <>
      {children}
      {themeName === 'twitter' && <link rel="stylesheet" href="twitter.css"/>}
      {themeName === 'facebook' && <link rel="stylesheet" href="facebook.css"/>}
    </>
  );
};

Framework Support Table

| | React|React Native|Vue|Angular| Polymer| Mithril| HTML| Marko| Svelte| Riot| Ember| Preact| | ----------- |:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:|:-------:| |Usage without decorator |+| |+|+|+|+|+|+|+|+|+|+| |Usage with decorator |+| |+| | | |+| |+| | | |