如何使用Vanilla Extract编写类型安全的CSS代码?

云婷同学_1674

云婷同学_1674

2026-07-05

1005人浏览

原创

vanilla extract 本身不提供类型安全,需配合 @vanilla-extract/css + typescript 及 createtheme、defineproperties、stylemap 等 api 实现;style 返回 string 无校验,易拼错类名;stylevariants 支持有限枚举态的联合类型约束;defineproperties + stylemap 可精确推导设计 token 键名类型;主题类型安全需 createthemecontract 或手动标注,动态计算会丢失类型。

如何使用vanilla extract编写类型安全的css代码?

Vanilla Extract 本身不提供类型安全的 CSS,它只把 CSS 类名编译成字符串——styles.classNamestring,不是类型化的标识符。真正实现类型安全,得靠它配套的 @vanilla-extract/css + TypeScript 的类型推导能力,配合 createThemedefinePropertiesstyleMap 这些 API 才能落地。

为什么直接用 style 函数写出来的类名不是类型安全的?

style 返回的是 string,TypeScript 不会校验你传给 className 的值是否真实存在,也不会阻止你拼错类名。比如:

const className = style({ color: 'red' });<br>div.className = 'typo-clas-nam'; // ✅ 编译通过,但运行时无效

这种写法失去类型保护,和手写字符串没区别。

真正安全的方式是:用 createThemedefineProperties 定义明确的样式契约,再通过 styleVariantsstyleMap 生成带联合类型的返回值。

TypeScript
TypeScript

{"answer":"编写类型安全的 TypeScript,合理运用类型收窄、推断模式与严格模式最佳实践。"}

下载

styleVariants 给按钮状态加类型约束

适合「有限枚举态」场景,比如 variant 只能是 'primary' | 'secondary',每个态对应一组样式。TypeScript 能推导出返回值类型为 Record

  • 定义时必须显式写出所有键,不能漏或拼错;否则 TS 报错
  • 使用时只能传入合法键名:button.className = variants[props.variant] —— 如果 props.variantstring,会报错;必须是 'primary' | 'secondary'
  • 注意:不要在 styleVariants 内部用动态 key,比如 [key]: {...},TS 无法推导类型
const variants = styleVariants({<br>  primary: { backgroundColor: 'blue' },<br>  secondary: { backgroundColor: 'gray' }<br>});

defineProperties + styleMap 控制设计 Token 类型

当你有一套固定的设计系统(如 spacing、colors、radii),defineProperties 能把它们声明为对象字面量,并让 TypeScript 推导出精确的键名类型;styleMap 则基于这些属性生成可索引的样式映射。

  • defineProperties 的参数必须是 const 断言对象,否则 TS 会宽泛推导为 string
  • styleMap 的第一个参数是 defineProperties 的返回值,第二个参数是样式规则函数,它接收的 key 参数会被限制为该对象的键名
  • 错误示例:padding: tokens.spacing['xl'] 中如果 'xl' 拼错,TS 立刻报错
const tokens = defineProperties({<br>  spacing: { sm: '4px', md: '8px', lg: '16px' } as const<br>});<br><br>const paddingMap = styleMap(tokens.spacing, (value) => ({ padding: value }));<br>// paddingMap.sm → string,paddingMap.xl → ❌ TS error

主题切换时如何保持类型不丢失?

createTheme 生成的主题对象本身是类型安全的,但它返回的类名仍是 string。要保留类型,得搭配 createThemeContract(v2+)或手动定义 contract 类型。

  • 不用 createThemeContract 的话,主题里的每个 class 字段都得手动标注类型,比如 container: string
  • createThemeContract 本质是帮你生成一个 interface,让主题对象满足该结构,从而在消费时获得自动补全和校验
  • 注意:主题变量不能在 runtime 动态计算,否则类型信息丢失(例如 color: isDark ? 'black' : 'white'

类型安全不是开箱即来,而是靠你把设计决策提前编码进类型定义里——拼写错误、非法值、多余字段,都会在编辑器里立刻暴露。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

typescript css

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

3836

6

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

857

5

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.28

1698

6

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

2023.08.01

3066

7

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

2023.08.10

5985

11

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

2023.08.10

5111

7

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

2023.08.21

1777

9

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

2023.08.22

2431

5

css禁止点击事件
css禁止点击事件

实现css禁止点击事件的方法有使用CSS的pointer-events属性和使用JavaScript禁用点击事件。本专题为大家提供点击事件相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2073

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习