集成Tailwind CSS与 Storybook
1. 配置 PostCSS
Tailwind 使用 PostCSS 来编译你的 CSS。如果你正在使用
vite@storybook/nextjs@storybook/preset-create-react-app与react-scripts@2.0.0@storybook/angular
则可以跳到下一步。
对于 Webpack 用户，你需要安装 @storybook/addon-styling-webpack 插件。
运行以下脚本安装并注册插件
npx storybook@latest add @storybook/addon-styling-webpack这将运行一个配置脚本，指导你设置插件。如果出现提示，请从配置选项中选择 PostCSS。
配置脚本失败了吗？
底层原理是，此命令运行 npx @storybook/auto-config styling，负责读取你的项目并尝试为你的目标工具配置 Storybook Webpack。如果直接运行该命令无法解决你的问题，请考虑在 @storybook/auto-config 仓库提交 bug 报告，以便我们进一步改进。对于 PostCSS 的手动配置说明，你可以参考此处的文档。
2. 为 Stories 提供 Tailwind
现在你可以将 tailwind.css 文件导入到你的 .storybook/preview.js 文件中。这将使 Tailwind 的样式类对你的所有 stories 可用。
// .storybook/preview.js
import '../src/tailwind.css'; // replace with the name of your tailwind css file2.1. Angular
如果你正在使用 Angular，则需要将 tailwind.css 文件添加到你的 angular.json 文件中。这将确保你的样式使用 PostCSS 进行处理，并注入到渲染 stories 的预览 iframe 中。
// angular.json
{
"storybook": {
"builder": "@storybook/angular:start-storybook",
"options": {
"browserTarget": "my-default-project:build",
"styles": ["src/tailwind.css"]
}
}
}3. 添加主题切换工具
Tailwind 开箱即支持浅色和深色主题。你可以覆盖这些主题并添加更多。为了充分利用你的 stories，你应该有一种方法来切换所有主题。
首先，更新你的 tailwind.config.js 文件，以基于类或数据属性更改主题。本例使用数据属性。
// tailwind.config.js
module.exports = {
content: ['./src/**/*.{js,jsx,ts,tsx}'],
// Toggle dark-mode based on .dark class or data-mode="dark"
darkMode: ['class', '[data-mode="dark"]'],
theme: {
extend: {},
},
plugins: [],
};接下来，安装 @storybook/addon-themes 插件以提供切换工具。
运行以下脚本安装并注册插件
npx storybook@latest add @storybook/addon-themes这将运行一个配置脚本，指导你设置插件。
配置脚本失败了吗？
底层原理是，这会运行 npx @storybook/auto-config themes，它会读取你的项目并尝试使用正确的装饰器配置你的 Storybook。如果直接运行该命令无法解决你的问题，请在 @storybook/auto-config 仓库提交 bug 报告，以便我们进一步改进。要手动添加此插件，请安装它，然后将其添加到你的 .storybook/main.ts 文件中的 addons 数组中。
3.1. 通过类名切换主题
从 @storybook/addon-themes 将 withThemeByClassName 装饰器添加到你的 Storybook。
// .storybook/preview.js
import { withThemeByClassName } from '@storybook/addon-themes';
/* snipped for brevity */
export const decorators = [
withThemeByClassName({
themes: {
light: 'light',
dark: 'dark',
},
defaultTheme: 'light',
}),
];3.2. 通过数据属性切换主题
从 @storybook/addon-themes 将 withThemeByDataAttribute 装饰器添加到你的 Storybook。
// .storybook/preview.js
import { withThemeByDataAttribute } from '@storybook/addon-themes';
/* snipped for brevity */
export const decorators = [
withThemeByDataAttribute({
themes: {
light: 'light',
dark: 'dark',
},
defaultTheme: 'light',
attributeName: 'data-mode',
}),
];此代码将在工具栏中创建一个新的菜单，用于为你的 stories 选择所需的主题。
参与贡献
现在你已经准备好将 Tailwind 与 Storybook 一起使用了。🎉
如果你在工作中使用 Tailwind，我们很希望得到你的帮助，让这个设置变得更容易。加入 Discord 社区，与维护者一起参与贡献，或者查看插件文档。
- ShaunEvening
