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.
This version is compatible with storybook version 5.3.x
.
npm i -D storybook-addon-themes
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.
The themes
parameter accept a list of Theme
object.
Each Theme
is an object with the following properties :
name
(string
): Name of the themeclass
(string | string[]
): HTML class(es) associated with the themecolor
(string
): The color of the badge in the theme selectordefault
(boolean
- optionnal): Is the theme selected by default ?
The themes
parameter also accept an object with the following properties :
list
(Theme[]
- optionnal): The list of themesdisable
(boolean
- optionnal): Disable the addon for a story
You can configure the themes globally in the storybook preview.js
file:
import { addParameters } from '@storybook/react'; // <- or your storybook framework
addParameters({
themes: [
{ name: 'twitter', class: 'theme-twt', color: '#00aced', default: true },
{ name: 'facebook', class: 'theme-fb', color: '#3b5998' },
],
});
See the storybook documentation for more informations.
Or configure the themes in your story file like this:
export default {
component: Button,
parameters: {
themes: [
{ name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced' },
{ name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
]
},
title: 'CSF|Button',
};
If you only want to activate the addon or override the themes for a specific story you can write:
export default {
component: Button,
title: 'Button',
};
export const withText = () => <Button onClick={action('clicked')}>Hello Button</Button>;
withText.story = {
parameters: {
themes: [
{ name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced' },
{ name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
]
},
};
Alternatively with the old StoriesOf API:
import { storiesOf } from '@storybook/react'; // <- or your storybook framework
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('Button', module)
.add('with text', () => <button>Click me</button>, {
themes: [{
name: 'red', class: 'theme-red', color: 'rgba(255, 0, 0)',
}]
});
By default the classes will be added to the body
element.
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.
Setup the decorator globally in the preview.js
file:
import { addDecorator, addParameters } from '@storybook/react'; // <- or your storybook framework
import { withThemes } from 'storybook-addon-themes/react'; // <- or your storybook framework
addParameters({
themes: [
{ name: 'twitter', class: 'theme-twt', color: '#00aced', default: true },
{ name: 'facebook', class: 'theme-fb', color: '#3b5998' },
],
});
addDecorator(withThemes);
Or in your story file (for all stories in that file):
export default {
component: Button,
decorators: [ withThemes ],
parameters: {
themes: [
{ name: 'twitter', class: ['theme-twt', 'light-mode'], color: '#00aced' },
{ name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
]
},
title: 'CSF|Button',
};
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' },
{ name: 'facebook', class: ['theme-fb', 'dark-mode'], color: '#3b5998' },
]
},
};
And alternatively with the old StoriesOf API:
import { storiesOf } from '@storybook/react'; // <- or your storybook framework
import { withThemes } from 'storybook-addon-themes/react';
storiesOf('Button', module)
.addDecorator(withThemes)
.add('with text', () => <button>Click me</button>);
React | React Native | Vue | Angular | Polymer | Mithril | HTML | Marko | Svelte | Riot | Ember | Preact | |
---|---|---|---|---|---|---|---|---|---|---|---|---|
Usage without decorator | + | + | + | + | + | + | + | + | + | + | + | |
Usage with decorator | + | + |