Integrate Sass with Storybook
This recipe assumes that you have an app using Sass and have just set up Storybook >=7.0 using the getting started guide. Don’t have this? Then run:
# Add Storybook:
npx storybook@latest init1. Add @storybook/addon-styling-webpack
Some Storybook configurations are pre-configured to support Sass. If your project meets any of the following criteria, you can skip to the next step.
- Storybook >= 7.x with the
vitebuilder. - Storybook >= 7.x with the
@storybook/nextjsframework. - Storybook >= 7.x with the
@storybook/preset-create-react-appand[email protected]or higher. - Storybook >= 7.x with the
@storybook/angularframework
Run the following script to install and register the addon:
npx storybook@latest add @storybook/addon-styling-webpackThis will run a configuration script that will walk you through setting up the addon. When prompted, select Sass from the configuration options.
Did the configuration script fail?
Under the hood, this command runs npx @storybook/auto-config styling, which is responsible for reading your project and attempting to configure your Storybook Webpack for your desired tools. If running that command directly does not resolve your issue, please consider filing a bug report on the @storybook/auto-config repository so that we can further improve it. For manual configuration instructions for Sass, you can refer to the documentation here.
2. Import global styles
If you have any global styles you would like to expose for your stories, you can now import them into your preview.js file:
// .storybook/preview.js
import '../src/index.scss';2.1. Angular
If you are using Angular, you will need to add your global scss file(s) to your angular.json file instead. This will make sure your styles are processed by Angular's Webpack and injected into the preview iframe where your stories are rendered.
// angular.json
{
"storybook": {
"builder": "@storybook/angular:start-storybook",
"options": {
"browserTarget": "my-default-project:build",
"styles": ["src/index.scss"]
}
}
}Get involved
Now you're ready to use Sass with Storybook. 🎉 If you use Sass at work, we'd love your feedback on the Sass + Storybook experience.
Join the maintainers and our thriving community in Discord.
- ShaunEvening
