如何在Vanilla Extract中编写类型安全的零运行时CSS?

浅芳姑娘_9132

浅芳姑娘_9132

2026-09-03

991人浏览

原创

vanilla extract 的类型安全需依赖 @vanilla-extract/css 与 typescript 联合推导,通过 stylevariants、defineproperties、createthemecontract 等 api 手动构建;style 返回 string 无类型校验,易拼错且重构不报错;stylevariants 对枚举变体提供联合类型约束;defineproperties 配合 as const 锁定设计 token 键名;createthemecontract 以契约先行保障主题类型完整性。

如何在vanilla extract中编写类型安全的零运行时css?

Vanilla Extract 本身不提供类型安全,它只生成 string 类名;真正的类型安全必须靠 @vanilla-extract/css + TypeScript 的联合推导能力,配合 styleVariantsdefinePropertiescreateThemeContract 等 API 手动构建。

为什么 style 返回的类名不是类型安全的?

style 函数返回的是 string,TypeScript 完全无法校验你后续是否拼错类名、是否真实存在该样式。比如:

const button = style({ color: 'red' });
div.className = 'btn-clas-nam'; // ✅ 编译通过,但运行时无效
  • 这种写法和手写字符串无异,失去所有类型保护
  • 组件中引用 button 时,它的类型就是 string,没有键名约束、没有变体枚举、没有设计 token 键校验
  • 一旦重构类名或删除样式,TS 不会报错,只能靠运行时发现

styleVariants 给有限状态加联合类型约束

适合按钮变体、尺寸、禁用态等明确枚举的场景,让 TypeScript 推导出 Record 这样的精确返回类型:

CSS婚礼策划服务机构宣传网站模板
CSS婚礼策划服务机构宣传网站模板

CSS婚礼策划服务机构宣传网站模板是一款适合提供婚礼策划和婚庆服务机构宣传网站模板下载。提示:本模板调用到谷歌字体库,可能会出现页面打开比较缓慢。

下载
const variants = styleVariants({
  primary: { backgroundColor: 'blue' },
  secondary: { backgroundColor: 'gray' }
});
  • 键名必须显式写出,漏一个或拼错(如 'primery')就会触发 TS 错误
  • 使用时必须传入字面量类型: button.className = variants[props.variant] —— 如果 props.variantstring,会直接报错
  • 禁止在 styleVariants 内部用动态 key:[dynamicKey]: {},TS 无法推导类型

defineProperties + styleMap 控制设计 Token 键名类型

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

const vars = defineProperties({
  properties: {
    color: {
      primary: '#0070f3',
      secondary: '#666'
    }
  }
});

export const colorStyles = styleMap(vars.color);
  • vars.color 的类型是 { primary: string; secondary: string },键名被严格锁定
  • colorStyles.primarycolorStyles.secondary 都是 string,但访问非法键(如 colorStyles.accent)会立即报错
  • defineProperties 参数必须带 as const 断言,否则 TS 会宽泛推导为 Record<string unknown></string>

createThemeContract 是主题类型安全的唯一可靠方式

手动标注主题变量类型容易遗漏或不一致;createThemeContract 强制你先声明契约结构,再由 createTheme 去实现,任何缺失或类型不匹配都会在编译期暴露:

const themeContract = createThemeContract({
  color: {
    background: null,
    text: null
  }
});

export const darkTheme = createTheme(themeContract, {
  color: {
    background: '#1a1a1a',
    text: '#ffffff'
  }
});
  • themeContract 是纯类型定义,不生成 CSS,只用于约束实现
  • createTheme 第二个参数必须完全满足契约,少一个字段、多一个字段、类型不对(比如 background 写成 number)都会报错
  • 动态计算值(如 background: lighten('#1a1a1a', 0.1))会丢失类型,因为 TS 无法静态分析函数返回值

真正难的不是写对一个 style,而是让整个样式系统的每个出口——变体、token、主题——都保持可索引、不可拼错、删了就报错。这需要主动放弃“写完就跑”的惯性,用 as const、契约先行、显式枚举来换类型保障。

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

相关文章

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

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

下载

相关标签:

css css教程 css表格样式

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

相关专题

更多
css
css

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

2023.06.15

3856

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

3086

7

css字体颜色
css字体颜色

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

2023.08.10

6025

11

什么是css
什么是css

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

2023.08.10

5131

7

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

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

2023.08.21

1797

9

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

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

2023.08.22

2431

5

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

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

2023.08.23

2093

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 5.6万人学习

CSS教程
CSS教程

共754课时 | 93.7万人学习