Skip to content

主题

UnoCSS 也支持您可能在 Tailwind CSS / Windi CSS 中熟悉的主题系统。在用户级别,您可以在配置中指定 theme 属性,并且它将被深度合并到默认主题中。

使用方法

ts
theme: {
  // ...
  colors: {
    veryCool: '#0000ff', // class="text-very-cool"
    brand: {
      primary: 'hsl(var(--hue, 217) 78% 51%)', //class="bg-brand-primary"
      DEFAULT: '#942192' //class="bg-brand"
    },
  },
}

TIP

在解析过程中,theme 将始终存在于 context 中。

在规则中使用

在规则中使用主题:

ts
rules: [
  [/^text-(.*)$/, ([, c], { theme }) => {
    if (theme.colors[c])
      return { color: theme.colors[c] }
  }],
]

在变体中使用

在变体中使用主题:

ts
variants: [
  {
    name: 'variant-name',
    match(matcher, { theme }) {
      // ...
    },
  },
]

在快捷方式中使用

在动态快捷方式中使用主题:

ts
shortcuts: [
  [/^badge-(.*)$/, ([, c], { theme }) => {
    if (Object.keys(theme.colors).includes(c))
      return `bg-${c}4:10 text-${c}5 rounded`
  }],
]

断点

WARNING

当提供自定义 breakpoints 对象时,默认对象将被覆盖而不是合并。

通过以下示例,您将只能使用 sm:md: 断点变体:

ts
theme: {
  // ...
  breakpoints: {
    sm: '320px',
    md: '640px',
  },
}

如果你想继承original主题的断点,你可以使用extendTheme

ts
extendTheme: (theme) => {
  return {
    ...theme,
    breakpoints: {
      ...theme.breakpoints,
      sm: '320px',
      md: '640px',
    },
  }
}

INFO

verticalBreakpointsbreakpoints 相同,但用于垂直布局。

另外,我们将按照大小(相同单位)对屏幕点进行排序。对于不同单位的屏幕点,为了避免错误,请在配置中使用统一的单位。

ts
theme: {
  // ...
  breakpoints: {
    sm: '320px',
    // 由于 uno 不支持不同单位大小的比较排序,请转换为相同单位。
    // md: '40rem',
    md: `${40 * 16}px`,
    lg: '960px',
  },
}

ExtendTheme

ExtendTheme allows you to edit the deeply merged theme to get the complete theme object.

Custom functions mutate the theme object.

ts
extendTheme: (theme) => {
  theme.colors.veryCool = '#0000ff' // class="text-very-cool"
  theme.colors.brand = {
    primary: 'hsl(var(--hue, 217) 78% 51%)', // class="bg-brand-primary"
  }
}

It's also possible to return a new theme object to completely replace the original one.

ts
extendTheme: (theme) => {
  return {
    ...theme,
    colors: {
      ...theme.colors,
      veryCool: '#0000ff', // class="text-very-cool"
      brand: {
        primary: 'hsl(var(--hue, 217) 78% 51%)', // class="bg-brand-primary"
      },
    },
  }
}

Released under the MIT License.