Storybook v6.1.14如何为单个故事应用不同主题?
单故事覆盖全局主题的实现方法
实现逻辑非常直接:不要把主题值硬编码在全局装饰器里,利用Storybook自带的故事参数传递机制,让全局装饰器可以读取每个故事的自定义配置,既保留原有默认暗色主题的行为,又能灵活给单个故事切主题,还能避免多层ThemeProvider嵌套的冗余问题。
第一步:重构全局主题装饰器
把原来硬编码dark主题的逻辑,改成从故事上下文中读取自定义主题参数,没有匹配到自定义参数时默认保留暗色主题,和原有行为完全一致,不需要改动preview.js的全局装饰器配置。
改造后的themeDecorator代码:
import React from "react" import { light, dark } from "../src/Themes/Theme"; import { ThemeProvider } from "styled-components"; import { GlobalStyles } from "../src/lib/Themes"; const ThemeDecorator = (storyFn, context) => { // 读取故事自定义传入的主题配置,无配置时默认使用暗色主题 const activeTheme = context.parameters?.customTheme ?? dark; return ( <ThemeProvider theme={activeTheme}> <GlobalStyles /> {storyFn()} </ThemeProvider> ) } export default ThemeDecorator;
注意:
preview.js里的addDecorator(ThemeDecorator)配置不需要做任何修改,所有未自定义主题的故事,依然会默认应用暗色主题,不会破坏现有效果。
第二步:给需要切主题的故事单独传配置参数
Storybook支持故事级别、组件组级别的参数配置,参数会按照 全局配置 < 组件组配置 < 单故事配置 的优先级逐层覆盖:
- 单故事级别覆盖:给需要用亮色主题的故事单独加
parameters配置,指定对应的主题值,同组件下的其他故事不受影响。示例:// 示例:Button组件的stories文件 import Button from '../src/Button' // 无额外配置,自动走全局默认的暗色主题 export const DarkPrimary = () => <Button>主要按钮</Button> // 加单独的参数配置,覆盖全局默认主题为亮色 export const LightPrimary = () => <Button>主要按钮</Button> LightPrimary.parameters = { customTheme: light } - 组件组级别覆盖:如果某个组件下的所有故事都需要默认用亮色主题,只需要在组件的默认导出里配置参数,组内所有故事都会继承这个配置,不需要单独给每个故事加参数:
export default { title: 'Components/Button', parameters: { customTheme: light // 组内所有故事默认用亮色,覆盖全局的暗色默认 } }
常见避坑点
- 不推荐在单个故事里手动嵌套一层
ThemeProvider来切主题:这种写法会和全局装饰器的ThemeProvider形成多层嵌套,虽然最终主题值会被内层覆盖,但会产生不必要的组件层级,还容易导致全局样式匹配错位。 - 示例里的自定义参数名
customTheme可以随意命名,只要装饰器读取参数的键名和故事传值的键名保持一致即可。 GlobalStyles始终保持全局装饰器内的位置,不会因为主题切换丢失全局基础样式规则。
内容的提问来源于stack exchange,提问作者Jonny
相关产品推荐
相关产品推荐

