如何在TypeScript环境中引入CSS文件_配置declaraion.d.ts声明文件

落宇大大_2781

落宇大大_2781

2026-05-07

1059人浏览

原创

typescript 默认不识别 .css 或 .scss 文件导入,需通过 .d.ts 声明文件告知其存在及导出结构;应声明 *.module.css 和 *.module.scss 模块,避免全局 *.css 声明导致副作用导入报错;声明文件须被 tsconfig.json 的 include 覆盖才能生效。

如何在typescript环境中引入css文件_配置declaraion.d.ts声明文件

TypeScript 默认不识别 .css 或 .scss 文件的导入,直接写 import './style.css' 会报错“找不到模块”。这不是 Webpack 或 Vite 配置问题,而是 TS 编译器层面的类型缺失——必须通过 .d.ts 声明文件告诉它:“这类文件存在,且导出一个对象”。

为什么 import './xxx.module.css' 会报 TS 错误

TS 只认 JS/TS 模块的导出结构,而 CSS 文件在运行时由 loader(如 css-loader)处理成对象,但编译期 TS 完全不知道这个对象长什么样。没有声明,styles.button 就是 any,甚至根本无法 import 成功。

  • 错误现象:Cannot find module './Button.module.css' 或 Module has no exported member 'xxx'
  • 本质原因:TS 类型系统未被告知该模块的存在和形状
  • 不是“loader 没生效”,而是“TS 编译阶段就卡住了”,即使 CSS 最终能正确注入页面,TS 也会报错并可能中断 IDE 智能提示

如何写一个有效的 CSS Modules 声明文件

声明文件必须放在 TS 能扫描到的路径下(如项目根目录或 src/types),且文件名以 .d.ts 结尾。内容不能有实现,只描述类型。

Galileo TypeScript sdk
Galileo TypeScript sdk

完整的Galileo AI平台 TypeScript/JS SDK 参考,用于评估、观察和保护 GenAI 应用。适用于构建 Node.js 或 TypeScript 项目。

下载
  • 对所有 *.module.css 文件统一声明:
    declare module '*.module.css' {
      const classes: { [key: string]: string };
      export default classes;
    }
  • 如果还用 SCSS Modules,补上这一行:
    declare module '*.module.scss' {
      const classes: { [key: string]: string };
      export default classes;
    }
  • 文件名建议为 types/css-modules.d.ts 或 src/custom.d.ts,确保被 tsconfig.json 的 include 或 typeRoots 覆盖
  • 不要写 export = 或 export default 以外的导出;不要给 classes 赋值;不要加 const 以外的修饰符

为什么不能只声明 *.css 而要限定 *.module.css

全局 *.css 声明会影响非模块化 CSS 导入(比如 import 'bootstrap/dist/css/bootstrap.min.css'),这类导入通常无默认导出,只做副作用引入。若声明了 export default,TS 会强制要求你接收返回值,导致编译失败。

  • 安全做法:只声明明确启用模块化的后缀,如 *.module.css、*.module.scss
  • Webpack/Vite 中,模块化 CSS 通常靠文件名约定(.module.css)或规则 modules: true 触发,TS 声明应与之对齐
  • 如果你用的是 css-loader 的 modules: { auto: true },那可以考虑声明 *.css,但需确认项目中所有 .css 确实都走模块化流程

声明后仍提示类名不存在?检查类型精度

上面的基础声明把所有类名都当作 string,能过编译,但失去智能提示。想让 styles.primary 有类型、拼错时报错,就得为每个 CSS 文件配单独的 .d.ts。

  • 例如 button.module.css 对应 button.module.css.d.ts:
    export const primary: string;
    export const disabled: string;
  • 这个文件必须和 CSS 文件同名、同目录,且不能有 declare module 包裹
  • 缺点:手动维护成本高;优点:精准类型 + IDE 补全 + 拼写校验,适合核心组件库
  • 自动化方案(如 typed-css-modules)已基本废弃,现代项目更倾向用基础声明 + CSS-in-JS 或 CSS Modules + PostCSS 插件生成类型

最易被忽略的一点:声明文件写了但没生效,大概率是因为它没被 TS 加载。检查 tsconfig.json 的 include 字段是否包含该 .d.ts 文件路径,或者是否被 exclude 误删。TS 不会自动扫描任意位置的 .d.ts,它只认配置范围内的。

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

相关文章

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

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

下载

相关标签:

css typescript

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3329

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2348

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1280

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1238

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2238

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3620

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16655

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 6万人学习

CSS教程
CSS教程

共754课时 | 98.2万人学习