Attributify 预设

这启用了其他预设的 属性模式。

源代码。

安装

pnpm

pnpm add -D @unocss/preset-attributify

yarn

yarn add -D @unocss/preset-attributify

npm

npm install -D @unocss/preset-attributify

bun

bun add -D @unocss/preset-attributify

uno.config.ts

import presetAttributify from '@unocss/preset-attributify'

export default defineConfig({
  presets: [
    presetAttributify({ /* 预设选项 */ }),
    // ...
  ],
})

TIP

该预设包含在 unocss 包中，您也可以从那里导入：

import { presetAttributify } from 'unocss'

属性模式

想象一下，您有一个使用 Tailwind CSS 工具的按钮。当列表变得更长时，阅读和维护变得非常困难。

<button
  class="bg-blue-400 hover:bg-blue-500 text-sm text-white font-mono font-light py-2 px-4 rounded border-2 border-blue-200 dark:bg-blue-500 dark:hover:bg-blue-600"
>
  按钮
</button>

使用属性模式，您可以将工具分离到属性中：

<button
  bg="blue-400 hover:blue-500 dark:blue-500 dark:hover:blue-600"
  text="sm white"
  font="mono light"
  p="y-2 x-4"
  border="2 rounded blue-200"
>
  按钮
</button>

例如，text-sm text-white 可以被归纳为 text="sm white"，而无需重复相同的前缀。

前缀自引用

对于 flex、grid、border 等工具，它们的工具与前缀相同，提供了一个特殊的 ~ 值。

例如：

<button class="border border-red">按钮</button>

可以写成：

<button border="~ red">按钮</button>

无值属性

除了 Windi CSS 的属性模式之外，该预设还支持无值属性。

例如，

<div class="m-2 rounded text-teal-400" />

现在可以是

<div m-2 rounded text-teal-400 />

INFO

注意：如果您正在使用 JSX，<div foo> 可能会被转换为 <div foo={true}>，这将使 UnoCSS 生成的 CSS 无法匹配属性。为了解决这个问题，您可能想要尝试 transformer-attributify-jsx 以及该预设。

属性冲突

如果属性模式的名称与元素或组件的属性发生冲突，您可以添加 un- 前缀以特指 UnoCSS 的属性模式。

例如：

<a text="red">这与链接的 `text` 属性冲突</a>
<!-- 改为 -->
<a un-text="red">文本颜色为红色</a>

前缀默认是可选的，如果您想强制使用前缀，可以设置

presetAttributify({
  prefix: 'un-',
  prefixedOnly: true, // <--
})

您还可以通过以下方式禁用对某些属性的扫描：

presetAttributify({
  ignoreAttributes: [
    'text'
    // ...
  ]
})

TypeScript 支持 (JSX/TSX)

创建 shims.d.ts，内容如下：

默认情况下，类型包含来自 @unocss/preset-wind3 的常见属性。如果您需要自定义属性，请参考 类型源 来实现您自己的类型。

Vue

自 Volar 0.36 起，它现在对未知属性是严格的。要取消严格，可以向项目中添加以下文件：

html.d.ts

declare module '@vue/runtime-dom' {
  interface HTMLAttributes {
    [key: string]: any
  }
}
declare module '@vue/runtime-core' {
  interface AllowedComponentProps {
    [key: string]: any
  }
}
export {}

React

import type { AttributifyAttributes } from '@unocss/preset-attributify'

declare module 'react' {
  interface HTMLAttributes<T> extends AttributifyAttributes {}
}

Vue 3

import type { AttributifyAttributes } from '@unocss/preset-attributify'

declare module '@vue/runtime-dom' {
  interface HTMLAttributes extends AttributifyAttributes {}
}

SolidJS

import type { AttributifyAttributes } from '@unocss/preset-attributify'

declare module 'solid-js' {
  namespace JSX {
    interface HTMLAttributes<T> extends AttributifyAttributes {}
  }
}

Svelte 与 SvelteKit

declare namespace svelteHTML {
  import type { AttributifyAttributes } from '@unocss/preset-attributify'

  type HTMLAttributes = AttributifyAttributes
}

Astro

import type { AttributifyAttributes } from '@unocss/preset-attributify'

declare global {
  namespace astroHTML.JSX {
    interface HTMLAttributes extends AttributifyAttributes { }
  }
}

Preact

import type { AttributifyAttributes } from '@unocss/preset-attributify'

declare module 'preact' {
  namespace JSX {
    interface HTMLAttributes extends AttributifyAttributes {}
  }
}

Marko

import type { AttributifyAttributes } from '@unocss/preset-attributify'

declare global {
  namespace Marko {
    interface HTMLAttributes extends AttributifyAttributes {}
  }
}

带前缀的属性

import type { AttributifyNames } from '@unocss/preset-attributify'

type Prefix = 'uno:' // 将其更改为您的前缀

interface HTMLAttributes extends Partial<Record<AttributifyNames<Prefix>, string>> {}

选项

strict

• 类型: boolean
• 默认值: false

仅为属性或类生成 CSS。

prefix

• 类型: string
• 默认值: 'un-'

属性模式的前缀。

prefixedOnly

• 类型: boolean
• 默认值: false

仅匹配带前缀的属性。

nonValuedAttribute

• 类型: boolean
• 默认值: true

支持匹配无值属性。

ignoreAttributes

• 类型: string[]

要在提取中忽略的属性列表。

trueToNonValued

• 类型: boolean
• 默认值: false

如果在 DOM 中表示的实际值为 true，无值属性也将匹配。此选项存在是为了支持将无值属性编码为 true 的框架。启用此选项将打破以 true 结尾的规则。

致谢

最初的想法来自 @Tahul 和 @antfu。之前的 Windi CSS 实现 由 @voorjaar 完成。