storybook-tailwind-dark-mode
v1.0.22
Published
Toggle stories between light and dark mode using tailwind
Downloads
19,484
Maintainers
Readme
storybook-tailwind-dark-mode
Installation
Install the following npm module:
npm i --save-dev storybook-tailwind-dark-mode
or with yarn:
yarn add -D storybook-tailwind-dark-mode
Then, add following content to .storybook/main.js
module.exports = {
addons: ['storybook-tailwind-dark-mode'],
};
Make sure tailwind is configured to use the darkmode class in the tailwind.config.js
module.exports = {
darkMode: 'class',
// ...
}
Set Dark Mode as default
To set dark mode as default, Add the following lines of code to your preview.js file
const preview = {
globalTypes: {
darkMode: {
defaultValue: true, // Enable dark mode by default on all stories
},
// Optional (Default: 'dark')
className: {
defaultValue: 'custom-classname', // Set your custom dark mode class name
},
},
};