在 Griffel 中执行 CSS 提取的 Vite 插件
用于执行 CSS 提取的 Vite 插件 @griffel/react。 。 。 .
安装
yarn add --dev @griffel/vite-plugin
# or
npm install --save-dev @griffel/vite-plugin
++ 插件需要 Vite 8 或以上 和
@griffel/react1.7.7或以上 (中文(简体) ).
使用量
在您的 Vite 配置中, 添加插件 :
import { defineConfig } from 'vite';
import { griffel } from '@griffel/vite-plugin';
export default defineConfig({
plugins: [griffel()],
});
自动插件 :
- 变换
makeStyles(), (中文(简体) ),makeResetStyles(),以及makeStaticStyles()构建时的呼叫 - 从这些调用中提取 CSS 到 Vite 处理的样式表
- 按特异性桶、媒体查询和容器查询排序 CSS 规则
不需要额外的配置: CSS 由 Vite 自己处理, 所以 <link> 生产中的标签照常使用。 单位
开发插件不会做任何事情, Griffel 在运行时处理样式.
选项
griffel({
// Files to process (default: /\.[cm]?[jt]sx?$/)
include: /\.[cm]?[jt]sx?$/,
// Files to skip, nothing is excluded by default as dependencies may also use Griffel
exclude: undefined,
// Compare function for sorting media queries (default: @griffel/core's defaultCompareMediaQueries)
compareMediaQueries: myCompareFunction,
// Compare function for sorting container queries (default: same comparator as compareMediaQueries)
compareContainerQueries: myCompareFunction,
// Override the resolver used to resolve imports inside evaluated modules
resolverFactory: myResolverFactory,
// A salt that is added to generated class names
classNameHashSalt: '',
// Modules that export Griffel functions (default: ["@griffel/core", "@griffel/react", "@fluentui/react-components"])
importsToTransform: ['@griffel/react'],
// Functions that should be treated as Griffel style calls
functionsToTransform: ['makeStyles', 'makeResetStyles', 'makeStaticStyles'],
// Rules that define how matched files are transformed during the evaluation
evaluationRules: undefined,
// Collect and log timing stats once a build is finished
collectStats: false,
// Collect and log dependencies that slow down evaluation (CJS modules, "export *" barrels)
collectPerfIssues: false,
});
如何运作
插件是一对 Vite 插件 :
griffel:transform运行于其他变换之前( e)enforce: 'pre')并用评估结果取代Griffel的电话 结果。 取取的CSS是从一个被转换出的文件所导入的虚拟CSS模块得到的.griffel:extract在生产CSS资产后运行(enforce: 'post')并将所有块的 CSS 合并为 输入点的资产,排序和删除途中的规则.
两者仅适用于生产建筑.
Griffel依赖于 CSS 规则的顺序:规则按照样式桶组合,只能被规则从
同一桶或一个后桶。 随着每个块的Vite发布样式表,懒惰加载块的规则将会被应用
在申请规则之后 插件通过将所有 Griffel 规则移动到单个样式表来避免它, this
匹配指定的行为 griffel 块入 @griffel/webpack-plugin。 。 。 .
开发模式
插件仅适用于生产构建( E)apply: 'build') (中文(简体) ). Dev 服务器没有捆绑步骤,所以没有
样式表可以将规则提取到其中,而Griffel在运行时处理样式,因为它没有插件.
洞穴
- 不是ES模块的文件被跳过,其中的Griffel呼叫会由运行时间处理.
- 如果一个项目有多个切入点,每个切入点都会得到所有提取出Griffel CSS的副本.