UnoCSS

外观

Vite 插件 ​

Vite 插件与 unocss 包一起提供。

安装 ​

bash
pnpm add -D unocss
bash
yarn add -D unocss
bash
npm install -D unocss

安装插件

vite.config.ts
ts
import UnoCSS from 'unocss/vite'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    UnoCSS(),
  ],
})

创建一个 uno.config.ts 文件

uno.config.ts
ts
import { defineConfig } from 'unocss'

export default defineConfig({
  // ...UnoCSS options
})

将 virtual:uno.css 添加到您的主入口

main.ts
ts
import 'virtual:uno.css'

模式 ​

Vite 插件带有一组模式，可以实现不同的行为。

global (默认) ​

这是插件的默认模式：在这种模式下，您需要在入口点添加 uno.css 的导入。

此模式为 build 和带有 HMR 支持的 dev 启用了一组 Vite 插件。

生成的 css 将是一个全局样式表，注入到 index.html 中。

vue-scoped ​

此模式将生成的 CSS 注入到 Vue SFC 的 <style scoped> 中，以实现隔离。

svelte-scoped ​

svelte-scoped 模式已移至其自己的包，请参阅 @unocss/svelte-scoped/vite。

shadow-dom ​

由于 Web Components 使用 Shadow DOM，因此无法直接从全局样式表对内容进行样式设置（除非您使用 CSS 自定义属性，这些属性将穿透 Shadow DOM），您需要将插件生成的 CSS 内联到 Shadow DOM 样式中。

要内联生成的 CSS，您只需要将插件模式配置为 shadow-dom，并在每个 Web 组件样式 CSS 块中包含 @unocss-placeholder 魔法占位符。如果您在 Vue SFC 中定义 Web 组件，并希望在 UnoCSS 旁边定义自定义样式，您可以将占位符包装在 CSS 注释中，以避免 IDE 中出现语法错误。

per-module (实验性) ​

此模式将为每个模块生成一个 CSS 表，可以进行范围限定。

dist-chunk (实验性) ​

此模式将在构建时为每个代码块生成一个 CSS 表，非常适合 MPA。

在 DevTools 中编辑类 ​

由于“按需”的限制，DevTools 不知道您在源代码中尚未使用的类。因此，如果您想通过直接在 DevTools 中更改类来尝试其工作原理，只需将以下几行添加到您的主入口中即可。

ts
import 'uno.css'
import 'virtual:unocss-devtools'

警告

请谨慎使用，在幕后我们使用 MutationObserver 来检测类更改。这意味着不仅您的手动更改，而且脚本进行的更改也将被检测到并包含在样式表中。当您根据脚本标签中的某些逻辑添加动态类时，这可能会导致开发和生产构建之间出现一些错位。建议将动态部分添加到 安全列表 中，或者尽可能为您的生产构建设置 UI 回归测试。

框架 ​

一些 UI/App 框架有一些需要注意的地方，必须进行修正才能使其正常工作，如果您正在使用以下框架之一，请应用建议。

VanillaJS / TypeScript ​

当使用 VanillaJS 或 TypeScript 时，您需要添加 js 和 ts 文件扩展名，以允许 UnoCSS 读取和解析内容，默认情况下，js 和 ts 文件会被排除，请查看 从构建工具管道提取 部分。

React ​

如果您使用 @vitejs/plugin-react

vite.config.ts
ts
import React from '@vitejs/plugin-react'
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    React(),
    UnoCSS(),
  ],
}

如果您使用 @unocss/preset-attributify，您应该从 build 脚本中删除 tsc。

如果您使用 @vitejs/plugin-react 与 @unocss/preset-attributify，您必须在 @vitejs/plugin-react 之前添加插件。

vite.config.ts
ts
import React from '@vitejs/plugin-react'
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    UnoCSS(),
    React(),
  ],
}

您在 examples/vite-react 目录中有一个 React 示例项目，使用这两个插件，查看 package.json 上的脚本及其 Vite 配置文件。

Preact ​

如果您使用 @preact/preset-vite

vite.config.ts
ts
import Preact from '@preact/preset-vite'
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    UnoCSS(),
    Preact(),
  ],
}

或者如果您使用 @prefresh/vite

vite.config.ts
ts
import Prefresh from '@prefresh/vite'
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    UnoCSS(),
    Prefresh(),
  ],
}

如果您使用 @unocss/preset-attributify，您应该从 build 脚本中删除 tsc。

您在 examples/vite-preact 目录中有一个 Preact 示例项目，使用这两个插件，查看 package.json 上的脚本及其 Vite 配置文件。

Svelte ​

您必须在 @sveltejs/vite-plugin-svelte 之前添加插件。

要支持 class:foo 和 class:foo={bar}，请添加插件并在 extractors 选项中配置 extractorSvelte。

您可以使用简单的规则，例如 class:bg-red-500={foo}，或者使用 shortcuts 来包含多个规则，请查看下面链接的示例项目中的 src/App.svelte。

vite.config.ts
ts
import { svelte } from '@sveltejs/vite-plugin-svelte'
import extractorSvelte from '@unocss/extractor-svelte'
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    UnoCSS({
      extractors: [
        extractorSvelte(),
      ],
      /* more options */
    }),
    svelte(),
  ],
}

Sveltekit ​

要支持 class:foo 和 class:foo={bar}，请添加插件并在 extractors 选项中配置 extractorSvelte。

您可以使用简单的规则，例如 class:bg-red-500={foo}，或者使用 shortcuts 来包含多个规则，请查看下面链接的示例项目中的 src/routes/+layout.svelte。

vite.config.ts
ts
import { sveltekit } from '@sveltejs/kit/vite'
import extractorSvelte from '@unocss/extractor-svelte'
import UnoCSS from 'unocss/vite'

/** @type {import('vite').UserConfig} */
const config = {
  plugins: [
    UnoCSS({
      extractors: [
        extractorSvelte(),
      ],
      /* more options */
    }),
    sveltekit(),
  ],
}

Web Components ​

要与 Web 组件一起使用，您需要在插件中启用 shadow-dom 模式。

不要忘记删除 uno.css 的导入，因为 shadow-dom 模式不会公开它，应用程序将无法工作。

vite.config.ts
ts
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    UnoCSS({
      mode: 'shadow-dom',
      /* more options */
    }),
  ],
}

在每个 web component 中，只需将其样式 CSS 块添加 @unocss-placeholder 即可

ts
const template = document.createElement('template')
template.innerHTML = `
<style>
:host {...}
@unocss-placeholder
</style>
<div class="m-1em">
...
</div>
`

如果您使用的是 Lit

ts
@customElement('my-element')
export class MyElement extends LitElement {
  static styles = css`
    :host {...}
    @unocss-placeholder
  `
  // ...
}

您在 examples/vite-lit 目录中有一个 Web Components 示例项目。

::part 内置支持 ​

您可以使用 ::part，因为插件通过 shortcuts 支持它，并使用 preset-mini 中的 part-[<part-name>]:<rule|shortcut> 规则，例如，使用它与简单的规则，如 part-[<part-name>]:bg-green-500，或者使用一些 shortcut：查看下面链接的示例项目中的 src/my-element.ts。

part-[<part-name>]:<rule|shortcut> 仅在使用 shadow-dom 模式的此插件时才有效。

插件使用 nth-of-type 来避免在同一个 Web 组件中出现多个部分的冲突，以及在不同 Web 组件上出现相同部分的冲突，您无需担心，插件会为您处理。

vite.config.ts
ts
import UnoCSS from 'unocss/vite'

export default {
  plugins: [
    UnoCSS({
      mode: 'shadow-dom',
      shortcuts: [
        { 'cool-blue': 'bg-blue-500 text-white' },
        { 'cool-green': 'bg-green-500 text-black' },
      ],
      /* more options */
    }),
  ],
}

然后在您的 Web 组件中

ts
// my-container-wc.ts
const template = document.createElement('template')
template.innerHTML = `
<style>
@unocss-placeholder
</style>
<my-wc-with-parts class="part-[cool-part]:cool-blue part-[another-cool-part]:cool-green">...</my-wc-with-parts>
`
ts
// my-wc-with-parts.ts
const template = document.createElement('template')
template.innerHTML = `
<style>
@unocss-placeholder
</style>
<div>
  <div part="cool-part">...</div>
  <div part="another-cool-part">...</div>
</div>
`

Solid ​

您需要在 UnoCSS 的插件之后添加 vite-plugin-solid 插件。

vite.config.ts
ts
import UnoCSS from 'unocss/vite'
import solidPlugin from 'vite-plugin-solid'

export default {
  plugins: [
    UnoCSS({
      /* options */
    }),
    solidPlugin(),
  ],
}

Elm ​

您需要在 UnoCSS 的插件之前添加 vite-plugin-elm 插件。

vite.config.ts
ts
import UnoCSS from 'unocss/vite'
import { defineConfig } from 'vite'
import Elm from 'vite-plugin-elm'

export default defineConfig({
  plugins: [
    Elm(),
    UnoCSS(),
  ],
})

Legacy ​

如果 @vitejs/plugin-legacy 与 renderModernChunks: false 一起使用，您需要将其添加到 unocss 选项中

ts
import legacy from '@vitejs/plugin-legacy'
import vue from '@vitejs/plugin-vue'
import { presetUno } from 'unocss'
import Unocss from 'unocss/vite'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
    vue(),
    Unocss({
      presets: [presetUno()],
      legacy: {
        renderModernChunks: false,
      },
    }),
    legacy({
      targets: ['defaults', 'not IE 11'],
      renderModernChunks: false,
    }),
  ],
})

许可证 ​

根据 MIT 许可证发布。

版权所有 © 2021-PRESENT Anthony Fu