通过 100 多个技巧学习 Nuxt!

样式

了解如何为您的 Nuxt 应用程序设置样式。

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

本地样式表

如果你正在编写本地样式表,最自然的存放位置是 assets/ 目录

在组件内导入

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

pages/index.vue
<script>
// Use a static import for server-side compatibility
import '~/assets/css/first.css'

// Caution: Dynamic imports are not server-side compatible
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 composable 在你的代码中动态设置 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

如果你需要更高级的控制,你可以使用 hook 拦截渲染的 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 partial,你可以使用 vite 的 预处理器选项来做到这一点。

在你的 assets 目录中创建一些 partial

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

然后在你的 nuxt.config

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

Nuxt 默认使用 Vite。如果你希望改为使用 webpack,请参考每个预处理器加载器的 文档

预处理器 Worker (实验性)

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

你可以在你的 nuxt.config 中启用此选项


export default defineNuxtConfig({
  vite: {
    css: {
      preprocessorMaxWorkers: true // number of CPUs minus 1
    }
  }
})
这是一个实验性选项,你应该参考 Vite 文档并 提供反馈

单文件组件 (SFC) 样式

Vue 和 SFC 最好的地方之一是它在自然处理样式方面有多出色。你可以直接在组件文件的 style 块中编写 CSS 或预处理器代码,因此你将拥有极佳的开发者体验,而无需使用像 CSS-in-JS 这样的东西。但是,如果你希望使用 CSS-in-JS,你可以找到支持它的第三方库和模块,例如 pinceau

你可以参考 Vue 文档,以获得有关在 SFC 中设置组件样式的全面参考。

类和样式绑定

你可以利用 Vue SFC 的功能,使用 class 和 style 属性来设置组件的样式。

<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 样式

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 样式块支持预处理器语法。Vite 内置支持 .scss、.sass、.less、.styl 和 .stylus 文件,无需配置。你只需要先安装它们,然后就可以直接在带有 lang 属性的 SFC 中使用它们。

<style lang="scss">
  /* Write scss here */
</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">
  /* Write postcss here */
</style>

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

利用布局实现多种样式

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

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

<style>
.default-layout {
  color: red;
}
</style>
文档 > 指南 > 目录结构 > 布局 中阅读更多内容。

第三方库和模块

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

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

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

轻松加载 Webfonts

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

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

高级

过渡

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

请在 文档 > 入门 > 过渡效果 中阅读更多信息。

字体高级优化

我们建议使用 Fontaine 来减少您的 CLS。 如果您需要更高级的功能,请考虑创建一个 Nuxt 模块来扩展构建过程或 Nuxt 运行时。

请始终记住利用 Web 生态系统中提供的各种工具和技术,使您的应用程序样式设置更轻松高效。 无论您使用原生 CSS、预处理器、postcss、UI 库还是模块,Nuxt 都能满足您的需求。 祝您样式设置愉快!

LCP 高级优化

您可以执行以下操作来加速全局 CSS 文件的下载

  • 使用 CDN,以便文件在物理位置上更靠近您的用户
  • 压缩您的资源,理想情况下使用 Brotli
  • 使用 HTTP2/HTTP3 进行传输
  • 将您的资源托管在同一域名下(不要使用不同的子域名)

如果您使用 Cloudflare、Netlify 或 Vercel 等现代平台,大多数这些事情应该会自动为您完成。 您可以在 web.dev 上找到 LCP 优化指南。

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

nuxt.config.ts
export default defineNuxtConfig({
  hooks: {
    'build:manifest': (manifest) => {
      // find the app entry, css list
      const css = Object.values(manifest).find(options => options.isEntry)?.css
      if (css) {
        // start from the end of the array and go to the beginning
        for (let i = css.length - 1; i >= 0; i--) {
          // if it starts with 'entry', remove it from the list
          if (css[i].startsWith('entry')) css.splice(i, 1)
        }
      }
    },
  },
})