NNext.js 中文网 GitHub

如何在应用中使用 CSS

了解向应用添加 CSS 的不同方式,包括 CSS Modules、全局 CSS、Tailwind CSS 等。

Next.js 提供了多种使用 CSS 为应用程序设置样式的方式,包括:

Tailwind CSS#

Tailwind CSS 是一个实用性优先的 CSS 框架,它提供低级别的实用类来构建自定义设计。

安装 Tailwind CSS:

bash · pnpm
pnpm add -D tailwindcss @tailwindcss/postcss
bash · npm
npm install -D tailwindcss @tailwindcss/postcss
bash · yarn
yarn add -D tailwindcss @tailwindcss/postcss
bash · bun
bun add -D tailwindcss @tailwindcss/postcss

将 PostCSS 插件添加到你的 postcss.config.mjs 文件中:

postcss.config.mjs
export default {
  plugins: {
    '@tailwindcss/postcss': {},
  },
}

在你的全局 CSS 文件中导入 Tailwind:

app/globals.css
@import 'tailwindcss';

在根布局中导入该 CSS 文件:

app/layout.tsx
import './globals.css'

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  )
}
app/layout.js
import './globals.css'

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  )
}

现在你可以开始在应用程序中使用 Tailwind 的实用类了:

app/page.tsx
export default function Page() {
  return (
    <main className="flex min-h-screen flex-col items-center justify-between p-24">
      <h1 className="text-4xl font-bold">Welcome to Next.js!</h1>
    </main>
  )
}
app/page.js
export default function Page() {
  return (
    <main className="flex min-h-screen flex-col items-center justify-between p-24">
      <h1 className="text-4xl font-bold">Welcome to Next.js!</h1>
    </main>
  )
}

安装 Tailwind CSS:

bash · pnpm
pnpm add -D tailwindcss @tailwindcss/postcss
bash · npm
npm install -D tailwindcss @tailwindcss/postcss
bash · yarn
yarn add -D tailwindcss @tailwindcss/postcss
bash · bun
bun add -D tailwindcss @tailwindcss/postcss

将 PostCSS 插件添加到你的 postcss.config.mjs 文件中:

postcss.config.mjs
export default {
  plugins: {
    '@tailwindcss/postcss': {},
  },
}

在你的全局 CSS 文件中导入 Tailwind:

styles/globals.css
@import 'tailwindcss';

在你的 pages/_app.js 文件中导入该 CSS 文件:

pages/_app.js
import '@/styles/globals.css'

export default function MyApp({ Component, pageProps }) {
  return <Component {...pageProps} />
}

现在你可以开始在应用程序中使用 Tailwind 的实用类了:

pages/index.tsx
export default function Home() {
  return (
    <main className="flex min-h-screen flex-col items-center justify-between p-24">
      <h1 className="text-4xl font-bold">Welcome to Next.js!</h1>
    </main>
  )
}
pages/index.js
export default function Home() {
  return (
    <main className="flex min-h-screen flex-col items-center justify-between p-24">
      <h1 className="text-4xl font-bold">Welcome to Next.js!</h1>
    </main>
  )
}

小知识: 如果你需要为非常旧的浏览器提供更广泛的浏览器支持,请参阅 Tailwind CSS v3 设置说明。

CSS Modules#

CSS Modules 通过生成唯一的类名在本地限定 CSS 的作用域。这使你可以在不同文件中使用相同的类,而无需担心命名冲突。

要开始使用 CSS Modules,请创建一个扩展名为 .module.css 的新文件,并将其导入到 app 目录中的任何组件里:

app/blog/blog.module.css
.blog {
  padding: 24px;
}
app/blog/page.tsx
import styles from './blog.module.css'

export default function Page() {
  return <main className={styles.blog}></main>
}
app/blog/page.js
import styles from './blog.module.css'

export default function Page() {
  return <main className={styles.blog}></main>
}

要开始使用 CSS Modules,请创建一个扩展名为 .module.css 的新文件,并将其导入到 pages 目录中的任何组件里:

styles/blog.module.css
.blog {
  padding: 24px;
}
pages/blog/index.tsx
import styles from '@/styles/blog.module.css'

export default function Page() {
  return <main className={styles.blog}></main>
}
pages/blog/index.js
import styles from '@/styles/blog.module.css'

export default function Page() {
  return <main className={styles.blog}></main>
}

全局 CSS#

你可以使用全局 CSS 在整个应用程序中应用样式。

创建一个 app/global.css 文件并在根布局中导入它,即可将样式应用于应用程序中的每个路由:

app/global.css
body {
  padding: 20px 20px 60px;
  max-width: 680px;
  margin: 0 auto;
}
app/layout.tsx
// 这些样式适用于应用程序中的每个路由
import './global.css'

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  )
}
app/layout.js
// 这些样式适用于应用程序中的每个路由
import './global.css'

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  )
}

小知识: 全局样式可以导入到 app 目录中的任何布局、页面或组件中。但是,由于 Next.js 使用 React 对样式表的内置支持来与 Suspense 集成,目前在路由之间导航时不会移除样式表,这可能导致冲突。我们建议将全局样式用于真正全局的 CSS(如 Tailwind 的基础样式),使用 Tailwind CSS 处理组件样式,并在需要时使用 CSS Modules 处理自定义作用域 CSS。

在 pages/_app.js 文件中导入样式表,即可将样式应用于应用程序中的每个路由:

pages/_app.js
import '@/styles/global.css'

export default function MyApp({ Component, pageProps }) {
  return <Component {...pageProps} />
}

由于样式表的全局性,并且为了避免冲突,你应该在 pages/_app.js 中导入它们。

外部样式表#

由外部包发布的样式表可以在 app 目录中的任何位置导入,包括并置的组件:

app/layout.tsx
import 'bootstrap/dist/css/bootstrap.css'

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body className="container">{children}</body>
    </html>
  )
}
app/layout.js
import 'bootstrap/dist/css/bootstrap.css'

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body className="container">{children}</body>
    </html>
  )
}

小知识: 在 React 19 中,也可以使用 <link rel="stylesheet" href="..." />。有关更多信息,请参阅 React link 文档。

Next.js 允许你从 JavaScript 文件导入 CSS 文件。这是可能的,因为 Next.js 将 import 的概念扩展到了 JavaScript 之外。

从 node_modules 导入样式#

自 Next.js 9.5.4 起,允许在应用程序的任何位置从 node_modules 导入 CSS 文件。

对于全局样式表,如 bootstrap 或 nprogress,你应该在 pages/_app.js 中导入该文件。例如:

pages/_app.js
import 'bootstrap/dist/css/bootstrap.css'

export default function MyApp({ Component, pageProps }) {
  return <Component {...pageProps} />
}

要导入第三方组件所需的 CSS,你可以在组件中进行导入。例如:

components/example-dialog.js
import { useState } from 'react'
import { Dialog } from '@reach/dialog'
import VisuallyHidden from '@reach/visually-hidden'
import '@reach/dialog/styles.css'

function ExampleDialog(props) {
  const [showDialog, setShowDialog] = useState(false)
  const open = () => setShowDialog(true)
  const close = () => setShowDialog(false)

  return (
    <div>
      <button onClick={open}>Open Dialog</button>
      <Dialog isOpen={showDialog} onDismiss={close}>
        <button className="close-button" onClick={close}>
          <VisuallyHidden>Close</VisuallyHidden>
          <span aria-hidden>×</span>
        </button>
        <p>Hello there. I am a dialog</p>
      </Dialog>
    </div>
  )
}

排序与合并#

Next.js 在生产构建期间通过自动分块(合并)样式表来优化 CSS。CSS 的顺序取决于你在代码中导入样式的顺序。

例如,base-button.module.css 会排在 page.module.css 之前,因为 <BaseButton> 在 page.module.css 之前被导入:

page.tsx
import { BaseButton } from './base-button'
import styles from './page.module.css'

export default function Page() {
  return <BaseButton className={styles.primary} />
}
page.js
import { BaseButton } from './base-button'
import styles from './page.module.css'

export default function Page() {
  return <BaseButton className={styles.primary} />
}
base-button.tsx
import styles from './base-button.module.css'

export function BaseButton() {
  return <button className={styles.primary} />
}
base-button.js
import styles from './base-button.module.css'

export function BaseButton() {
  return <button className={styles.primary} />
}

建议#

要保持 CSS 顺序可预测:

  • 尽量将 CSS 导入集中在单个 JavaScript 或 TypeScript 入口文件中。
  • 在应用程序的根目录导入全局样式和 Tailwind 样式表。
  • 使用 Tailwind CSS 满足大部分样式需求,因为它用实用类覆盖了常见的设计模式。
  • 当 Tailwind 实用类不够用时,使用 CSS Modules 处理组件特定的样式。
  • 为 CSS Modules 使用一致的命名约定。例如,使用 <name>.module.css 而不是 <name>.tsx。
  • 将共享样式提取到共享组件中,以避免重复导入。
  • 关闭会自动排序导入的 linters 或格式化工具,例如 ESLint 的 sort-imports。
  • 你可以使用 next.config.js 中的 cssChunking 选项来控制 CSS 的分块方式。

开发环境与生产环境#

  • 在开发环境中(next dev),CSS 更新会通过 Fast Refresh 立即生效。
  • 在生产环境中(next build),所有 CSS 文件会自动拼接成多个经过压缩和代码分割的 .css 文件,确保路由只加载最少的 CSS。
  • 在生产环境中,即使禁用 JavaScript,CSS 仍会加载,但在开发环境中,Fast Refresh 需要 JavaScript。
  • CSS 顺序在开发环境中的表现可能不同,请务必检查构建结果(next build)以验证最终的 CSS 顺序。
Next.js 中文网