使用 CSS 模块脚本导入样式表

了解如何使用 CSS 模块脚本,通过与 JavaScript 模块相同的语法导入 CSS 样式表。

借助新的 CSS 模块脚本功能,您可以使用 import 语句加载 CSS 样式表,就像加载 JavaScript 模块一样。然后,可以采用与可构造样式表相同的方式将样式表应用于文档或影子根。与导入和应用 CSS 的其他方式相比,这种方式可能更方便,性能也更高。

浏览器支持

Chrome 和 Edge 93 版中默认提供 CSS 模块脚本。

Firefox 和 Safari 尚不支持此功能。您可以分别在 Gecko bug 和 WebKit bug 中跟踪实现进度。

前提条件

使用 CSS 模块脚本

导入 CSS 模块脚本并将其应用于文档或 shadow root,如下所示:

import sheet from './styles.css' assert { type: 'css' };
document.adoptedStyleSheets = [sheet];
shadowRoot.adoptedStyleSheets = [sheet];

CSS 模块脚本的默认导出内容是一个可构造样式表,其内容是导入文件的内容。与任何其他可构造样式表一样,它使用 adoptedStyleSheets 应用于文档或 shadow root。

与通过 JavaScript 应用 CSS 的其他方式不同,您无需创建 <style> 元素或处理 CSS 文本的 JavaScript 字符串。

CSS 模块还具有与 JavaScript 模块相同的一些优势。

  • 去重:如果从应用中的多个位置导入同一 CSS 文件,该文件仍只会提取、实例化和解析一次。
  • 一致的求值顺序:当导入 JavaScript 运行时,它可以依赖于它导入的样式表已经提取和解析。
  • 安全性:模块通过 CORS 提取,并使用严格的 MIME 类型检查。

导入断言(“assert”是什么?)

import 语句的 assert { type: 'css' } 部分是导入断言。这是必需的;否则,import 会被视为普通的 JavaScript 模块导入,如果导入的文件具有非 JavaScript MIME 类型,则会失败。

import sheet from './styles.css'; // Failed to load module script:
                                  // Expected a JavaScript module
                                  // script but the server responded
                                  // with a MIME type of "text/css".

动态导入的样式表

您还可以使用动态导入来导入 CSS 模块,并为 type: 'css' 导入断言添加新的第二个参数:

const cssModule = await import('./style.css', {
  assert: { type: 'css' }
});
document.adoptedStyleSheets = [cssModule.default];

尚不允许使用 @import 规则

目前,CSS @import 规则在可构造样式表(包括 CSS 模块脚本)中不起作用。如果可构造样式表中存在 @import 规则,系统会忽略这些规则。

/* atImported.css */
div {
    background-color: blue;
}
/* styles.css */
@import url('./atImported.css'); /* Ignored in CSS module */
div {
    border: 1em solid green;
}
<!-- index.html -->
<script type="module">
    import styles from './styles.css' assert { type: "css" };
    document.adoptedStyleSheets = [styles];
</script>
<div>This div will have a green border but no background color.</div>

CSS 模块脚本中对 @import 的支持可能会添加到规范中。在 GitHub 问题中跟踪此规范讨论。