Appearance
规则
规则用于定义工具类及其对应的 CSS 样式。UnoCSS 自带许多内置规则,同时也支持轻松添加自定义规则。
静态规则
以下是一个示例:
ts
rules: [
['m-1', { margin: '0.25rem' }],
]
每当在用户的代码库中检测到 m-1
时,将生成以下 CSS:
css
.m-1 { margin: 0.25rem; }
注意:主体语法遵循 CSS 属性语法,例如使用
font-weight
而不是fontWeight
。如果属性名中包含连字符-
,则需要用引号括起来。tsrules: [ ['font-bold', { 'font-weight': 700 }], ]
动态规则
为了让规则更智能,可以将匹配器改为 RegExp
,并将规则体改为函数:
ts
rules: [
[/^m-(\d+)$/, ([, d]) => ({ margin: `${d / 4}rem` })],
[/^p-(\d+)$/, match => ({ padding: `${match[1] / 4}rem` })],
]
主体函数的第一个参数是 RegExp
匹配结果,可以对其进行解构以获取匹配的分组。
例如,使用以下代码时:
html
<div class="m-100">
<button class="m-3">
<icon class="p-5" />
My Button
</button>
</div>
将生成相应的 CSS:
css
.m-100 { margin: 25rem; }
.m-3 { margin: 0.75rem; }
.p-5 { padding: 1.25rem; }
恭喜!现在你已经拥有了自己强大的原子化 CSS 工具集。尽情享受吧!
CSS 规则回退
在某些情况下,你可能希望利用 CSS 规则回退来使用新的 CSS 特性,同时还能回退以支持旧版浏览器。你可以选择返回一个二维数组,作为具有相同键的规则的 CSS 表示形式。例如:
ts
rules: [
[/^h-(\d+)dvh$/, ([_, d]) => {
return [
['height', `${d}vh`],
['height', `${d}dvh`],
]
}],
]
这将使 h-100dvh
生成:
css
.h-100dvh { height: 100vh; height: 100dvh; }
排序
UnoCSS 会在生成的 CSS 中尊重你定义的规则顺序。后面定义的规则优先级更高。
使用动态规则时,它可能会匹配多个标记。默认情况下,单个动态规则下匹配项的输出会在组内按字母顺序排序。
规则合并
默认情况下,UnoCSS 会合并具有相同样式体的 CSS 规则,以最小化 CSS 文件大小。
例如,<div class="m-2 hover:m2">
会生成:
css
.hover\:m2:hover,
.m-2 {
margin: 0.5rem;
}
而不是两条单独的规则:
css
.hover\:m2:hover {
margin: 0.5rem;
}
.m-2 {
margin: 0.5rem;
}
特殊符号
自 v0.61 版本起,UnoCSS 支持使用特殊符号为生成的 CSS 定义额外的元信息。你可以从动态规则匹配器函数的第二个参数中访问这些符号。
例如:
ts
rules: [
[/^grid$/, ([, d], { symbols }) => {
return {
[symbols.parent]: '@supports (display: grid)',
display: 'grid',
}
}],
]
将生成:
css
@supports (display: grid) {
.grid {
display: grid;
}
}
可用符号
symbols.parent
:生成的 CSS 规则的父包装器(例如@supports
、@media
等)symbols.selector
:一个用于修改生成的 CSS 规则选择器的函数(请参阅下面的示例)symbols.layer
:一个字符串、函数或正则表达式匹配项,用于设置生成的 CSS 规则的 UnoCSS 层symbols.variants
:一个应用于当前 CSS 对象的变体处理函数数组symbols.shortcutsNoMerge
:一个布尔值,用于禁用当前规则在快捷方式中的合并symbols.noMerge
:一个布尔值,用于禁用当前规则在快捷方式中的合并symbols.sort
:一个数字,用于覆盖当前 CSS 对象的排序顺序
多选择器规则
自 v0.61 版本起,UnoCSS 通过 JavaScript 生成器函数 支持多选择器。
例如:
ts
rules: [
[/^button-(.*)$/, function* ([, color], { symbols }) {
yield {
background: color
}
yield {
[symbols.selector]: selector => `${selector}:hover`,
// https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/color-mix
background: `color-mix(in srgb, ${color} 90%, black)`
}
}],
]
将生成多个 CSS 规则:
css
.button-red {
background: red;
}
.button-red:hover {
background: color-mix(in srgb, red 90%, black);
}
完全受控规则
提示
这是一个高级功能,在大多数情况下并不需要。
当你确实需要一些 动态规则 和 变体 组合无法覆盖的高级规则时,UnoCSS 也提供了一种让你完全控制生成 CSS 的方法。
它允许你从动态规则的主体函数中返回一个字符串,该字符串将 直接 传递给生成的 CSS(这也意味着你需要处理诸如 CSS 转义、应用变体、构建 CSS 等事项)。
ts
import { defineConfig, toEscapedSelector as e } from 'unocss'
export default defineConfig({
rules: [
[/^custom-(.+)$/, ([, name], { rawSelector, currentSelector, variantHandlers, theme }) => {
// discard mismatched rules
if (name.includes('something'))
return
// if you want, you can disable the variants for this rule
if (variantHandlers.length)
return
const selector = e(rawSelector)
// return a string instead of an object
return `
${selector} {
font-size: ${theme.fontSize.sm};
}
/* you can have multiple rules */
${selector}::after {
content: 'after';
}
.foo > ${selector} {
color: red;
}
/* or media queries */
@media (min-width: ${theme.breakpoints.sm}) {
${selector} {
font-size: ${theme.fontSize.sm};
}
}
`
}],
],
})