样式

了解如何为你的 Nuxt 应用添加样式。

Nuxt 在样式处理方面非常灵活。你可以编写自己的样式,或引用本地和外部样式表。 你可以使用 CSS 预处理器、CSS 框架、UI 库和 Nuxt 模块来为你的应用添加样式。

本地样式表

如果你要编写本地样式表,推荐将它们放在 assets/ 目录 中。

在组件中导入

你可以在页面、布局和组件中直接导入样式表。 可以使用 JavaScript 导入,或使用 CSS 的 @import 语句

pages/index.vue
<script>
// 为兼容服务器端,使用静态导入
import '~/assets/css/first.css'

// 注意:动态导入与服务器端不兼容
import('~/assets/css/first.css')
</script>

<style>
@import url("~/assets/css/second.css");
</style>
这些样式表会被内联到 Nuxt 渲染的 HTML 中。

使用 CSS 属性

你也可以在 Nuxt 配置中使用 css 属性。 样式表通常存放在 assets/ 目录 中。你可以引用其路径,Nuxt 会将其应用到应用的所有页面。

nuxt.config.ts
export default defineNuxtConfig({
  css: ['~/assets/css/main.css']
})
这些样式表会被内联到 Nuxt 渲染的 HTML 中,全局注入并出现在所有页面。

处理字体

将你的本地字体文件放在 ~/public/ 目录中,例如 ~/public/fonts。然后你可以在样式表中使用 url() 引用它们。

assets/css/main.css
@font-face {
  font-family: 'FarAwayGalaxy';
  src: url('/fonts/FarAwayGalaxy.woff') format('woff');
  font-weight: normal;
  font-style: normal;
  font-display: swap;
}

然后在你的样式表、页面或组件中通过字体名称引用:

<style>
h1 {
  font-family: 'FarAwayGalaxy', sans-serif;
}
</style>

通过 NPM 分发的样式表

你也可以引用通过 npm 分发的样式表。以流行的 animate.css 库为例。

npm install animate.css

然后你可以在页面、布局和组件中直接引用:

app.vue
<script>
import 'animate.css'
</script>

<style>
@import url("animate.css");
</style>

也可以在 Nuxt 配置的 css 属性中以字符串形式引用该包。

nuxt.config.ts
export default defineNuxtConfig({
  css: ['animate.css']
})

外部样式表

你可以通过在 nuxt.config 文件的 head 部分添加 link 元素来引入外部样式表。你可以通过多种方式实现这一结果。注意,本地样式表也可以通过这种方式引入。

你可以使用 Nuxt 配置的 app.head 属性来操作 head

nuxt.config.ts
export default defineNuxtConfig({
  app: {
    head: {
      link: [{ rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css' }]
    }
  }
})

动态添加样式表

你可以使用 useHead 组合式函数在代码中动态设置 head 的值。

阅读更多 Docs > API > Composables > Use Head.
useHead({
  link: [{ rel: 'stylesheet', href: 'https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css' }]
})

Nuxt 在底层使用 unhead,你可以参考其完整文档 这里

使用 Nitro 插件修改渲染的 Head

如果你需要更高级的控制,可以通过钩子拦截渲染的 HTML 并以编程方式修改 head

~/server/plugins/my-plugin.ts 中创建一个插件:

server/plugins/my-plugin.ts
export default defineNitroPlugin((nitro) => {
  nitro.hooks.hook('render:html', (html) => {
    html.head.push('<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.1.1/animate.min.css">')
  })
})

外部样式表是渲染阻塞资源:它们必须在浏览器渲染页面之前加载和处理。包含不必要的大型样式的网页渲染时间会更长。你可以在 web.dev 上了解更多相关信息。

使用预处理器

要使用像 SCSS、Sass、Less 或 Stylus 这样的预处理器,请先安装它们。

npm install -D sass

编写样式表的推荐位置是 assets 目录。 你可以在 app.vue(或布局文件)中使用预处理器的语法导入源文件。

pages/app.vue
<style lang="scss">
@use "~/assets/scss/main.scss";
</style>

或者,你可以在 Nuxt 配置中使用 css 属性。

nuxt.config.ts
export default defineNuxtConfig({
  css: ['~/assets/scss/main.scss']
})
在上述两种情况下,编译后的样式表都会被内联到 Nuxt 渲染的 HTML 中。

如果你需要在预处理文件中注入代码,例如包含颜色变量的 sass 局部文件,可以使用 Vite 的 预处理器选项

assets 目录中创建一些局部文件:

$primary: #49240F;
$secondary: #E4A79D;

然后在你的 nuxt.config 中:

export default defineNuxtConfig({
  vite: {
    css: {
      preprocessorOptions: {
        scss: {
          additionalData: '@use "~/assets/_colors.scss" as *;'
        }
      }
    }
  }
})

Nuxt 默认使用 Vite。如果你要使用 webpack,请参阅每个预处理器加载器的 文档

预处理器工作线程(实验性)

Vite 提供了一个 实验性选项,可以加速预处理器的使用。

你可以在 nuxt.config 中启用此功能:

export default defineNuxtConfig({
  vite: {
    css: {
      preprocessorMaxWorkers: true // CPU 核心数减 1
    }
  }
})
这是一个实验性选项,你应参考 Vite 文档并在 此处提供反馈

单文件组件(SFC)样式

Vue 和单文件组件(SFC)的一大优点是它们在处理样式方面的出色表现。你可以直接在组件文件的 style 块中编写 CSS 或预处理器代码,从而获得极佳的开发者体验,无需使用 CSS-in-JS 等技术。不过,如果你希望使用 CSS-in-JS,可以找到支持它的第三方库和模块,例如 pinceau

你可以参考 Vue 文档,了解有关在 SFC 中为组件添加样式的全面参考。

类和样式绑定

你可以使用 Vue SFC 的功能,通过 classstyle 属性为组件添加样式。

<script setup lang="ts">
const isActive = ref(true)
const hasError = ref(false)
const classObject = reactive({
  active: true,
  'text-danger': false
})
</script>

<template>
  <div class="static" :class="{ active: isActive, 'text-danger': hasError }"></div>
  <div :class="classObject"></div>
</template>

更多信息请参考 Vue 文档

使用 v-bind 动态样式

你可以在 style 块中使用 v-bind 函数引用 JavaScript 变量和表达式。 绑定是动态的,这意味着如果变量值发生变化,样式会相应更新。

<script setup lang="ts">
const color = ref("red")
</script>

<template>
  <div class="text">hello</div>
</template>

<style>
.text {
  color: v-bind(color);
}
</style>

作用域样式

scoped 属性允许你隔离组件的样式。使用此属性声明的样式仅适用于当前组件。

<template>
  <div class="example">hi</div>
</template>

<style scoped>
.example {
  color: red;
}
</style>

CSS 模块

你可以通过 module 属性使用 CSS 模块。通过注入的 $style 变量访问。

<template>
  <p :class="$style.red">This should be red</p>
</template>

<style module>
.red {
  color: red;
}
</style>

预处理器支持

SFC 的 style 块支持预处理器语法。Vite 内置支持 .scss.sass.less.styl.stylus 文件,无需额外配置。你只需先安装它们,就可以通过 lang 属性直接在 SFC 中使用。

<style lang="scss">
  /* 在此编写 scss */
</style>

你可以参考 Vite CSS 文档@vitejs/plugin-vue 文档。 对于 webpack 用户,请参考 vue-loader 文档

使用 PostCSS

Nuxt 内置了 PostCSS。你可以在 nuxt.config 文件中进行配置。

nuxt.config.ts
export default defineNuxtConfig({
  postcss: {
    plugins: {
      'postcss-nested': {},
      'postcss-custom-media': {}
    }
  }
})

为了在 SFC 中获得正确的语法高亮,你可以使用 postcsslang 属性。

<style lang="postcss">
  /* 在此编写 postcss */
</style>

默认情况下,Nuxt 已预配置以下插件:

为多样式使用布局

如果需要为应用的不同部分完全不同的样式,你可以使用布局。 为不同的布局使用不同的样式。

<template>
  <div class="default-layout">
    <h1>默认布局</h1>
    <slot />
  </div>
</template>

<style>
.default-layout {
  color: red;
}
</style>
阅读更多 Docs > Guide > Directory Structure > Layouts.

第三方库和模块

Nuxt 在样式处理上没有固定的倾向,为你提供了广泛的选择。你可以使用任何你想要的样式工具,例如流行的库如 UnoCSSTailwind CSS

社区和 Nuxt 团队开发了许多 Nuxt 模块,以简化集成。 你可以在网站上的 模块部分 发现它们。 以下是一些帮助你入门的模块:

  • UnoCSS:即时按需原子化 CSS 引擎
  • Tailwind CSS:实用优先的 CSS 框架
  • Fontaine:字体度量回退
  • Pinceau:适应性强的样式框架
  • Nuxt UI:现代 Web 应用的 UI 库
  • Panda CSS:在构建时生成原子化 CSS 的 CSS-in-JS 引擎

Nuxt 模块为你提供了开箱即用的良好开发者体验,但请记住,如果你的首选工具没有模块,并不意味着你无法在 Nuxt 中使用它!你可以为自己的项目进行配置。根据工具的不同,你可能需要使用 Nuxt 插件 和/或 创建自己的模块。如果创建了模块,请与 社区 分享!

轻松加载网络字体

你可以使用 Nuxt Google Fonts 模块 来加载 Google 字体。

如果你使用 UnoCSS,请注意它自带了 网络字体预设,可以方便地从包括 Google Fonts 在内的常见提供商加载字体。

高级

过渡

Nuxt 提供了与 Vue 相同的 <Transition> 元素,并支持实验性的 视图过渡 API

阅读更多 Docs > Getting Started > Transitions.

字体高级优化

我们推荐使用 Fontaine 来减少你的 CLS。如果需要更高级的功能,可以考虑创建 Nuxt 模块来扩展构建过程或 Nuxt 运行时。

始终充分利用 Web 生态系统中的各种工具和技术,让你的应用样式设计更简单、更高效。无论你是使用原生 CSS、预处理器、PostCSS、UI 库还是模块,Nuxt 都能满足你的需求。祝你样式设计愉快!

LCP 高级优化

你可以通过以下方式加速全局 CSS 文件的下载:

  • 使用 CDN,让文件在物理上更接近用户
  • 压缩你的资产,最好使用 Brotli
  • 使用 HTTP2/HTTP3 进行传输
  • 将资产托管在同一域名(不要使用不同的子域名)

如果你使用像 Cloudflare、Netlify 或 Vercel 这样的现代平台,这些优化通常会自动为你完成。 你可以在 web.dev 上找到 LCP 优化指南。

如果你的所有 CSS 都由 Nuxt 内联,你可以(实验性地)完全阻止在渲染的 HTML 中引用外部 CSS 文件。 你可以通过钩子实现这一点,可以将其放在模块或 Nuxt 配置文件中。

nuxt.config.ts
export default defineNuxtConfig({
  hooks: {
    'build:manifest': (manifest) => {
      // 找到应用入口,CSS 列表
      const css = Object.values(manifest).find(options => options.isEntry)?.css
      if (css) {
        // 从数组末尾开始,遍历到开头
        for (let i = css.length - 1; i >= 0; i--) {
          // 如果以 'entry' 开头,则从列表中移除
          if (css[i].startsWith('entry')) css.splice(i, 1)
        }
      }
    },
  },
})