nuxt logo

文档翻译(非官方)

样式

学习如何为您的 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 部分添加链接元素来在应用程序中包含外部样式表。您可以使用不同的方法实现此结果。请注意,本地样式表也可以这样包含。

您可以使用 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 中的值。

另请参阅 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 的最佳之处之一是它在处理样式方面的自然优势。您可以直接在组件文件的样式块中编写 CSS 或预处理器代码,因此您将拥有出色的开发者体验,而无需使用类似 CSS-in-JS 的东西。不过,如果您希望使用 CSS-in-JS,您可以找到支持它的第三方库和模块,例如 pinceau

您可以参考 Vue 文档 以获取有关在 SFC 中样式化组件的全面参考。

类和样式绑定

您可以利用 Vue SFC 功能,通过类和样式属性为组件设置样式。

<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 的动态样式

您可以在样式块中使用 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 Modules 一起使用。通过注入的 $style 变量访问它。

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

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

预处理器支持

SFC 样式块支持预处理器语法。Vite 内置支持 .scss、.sass、.less、.styl 和 .stylus 文件,无需配置。您只需先安装它们,它们将在 SFC 中通过 lang 属性直接可用。

<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 中正确的语法高亮,您可以使用 postcss lang 属性。

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

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

利用布局实现多样式

如果您需要为应用程序的不同部分完全不同地设置样式,您可以使用布局。为不同的布局使用不同的样式。

<template>
  <div class="default-layout">
    <h1>Default Layout</h1>
    <slot />
  </div>
</template>

<style>
.default-layout {
  color: red;
}
</style>
另请参阅 guide > directory-structure > layouts

第三方库和模块

Nuxt 在样式方面没有固定的意见,并为您提供了多种选择。您可以使用任何您想要的样式工具,例如流行的库如 UnoCSSTailwind CSS

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

Nuxt 模块为您提供了良好的开发者体验,但请记住,如果您喜欢的工具没有模块,这并不意味着您不能在 Nuxt 中使用它!您可以为自己的项目自行配置它。根据工具的不同,您可能需要使用 Nuxt 插件 和/或 制作您自己的模块。如果您这样做,请与 社区 分享!

轻松加载 Web 字体

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

如果您正在使用 UnoCSS,请注意它带有一个 web 字体预设,可以方便地从常见提供商(包括 Google 字体等)加载字体。

高级

过渡

Nuxt 提供了与 Vue 相同的 <Transition> 元素,并且还支持实验性的 View Transitions API

另请参阅 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)
        }
      }
    },
  },
})