如何在你的应用程序中使用 CSS
Next.js 提供了几种在你的应用程序中使用 CSS 的方法,包括:
本页将指导你如何使用每种方法。
CSS Modules
CSS Modules 通过生成唯一的类名来局部作用域化 CSS。这允许你在不同的文件中使用相同的类,而无需担心冲突。
要开始使用 CSS Modules,请创建一个扩展名为 .module.css
的新文件,并将其导入到 app
目录内的任何组件中
.blog {
padding: 24px;
}
import styles from './styles.module.css'
export default function Page({ children }: { children: React.ReactNode }) {
return <main className={styles.blog}>{children}</main>
}
全局 CSS
你可以使用全局 CSS 在你的应用程序中应用样式。
要使用全局样式,请创建一个新的 CSS 文件,例如 app/global.css
body {
padding: 20px 20px 60px;
max-width: 680px;
margin: 0 auto;
}
在根布局 (app/layout.js
) 中导入该文件,以将样式应用于你的应用程序中的每个路由
// These styles apply to every route in the application
import './global.css'
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
须知: 全局样式可以导入到
app
目录内的任何布局、页面或组件中。但是,由于 Next.js 使用 React 的内置样式表支持与 Suspense 集成。这种内置支持目前不会在你路由之间导航时移除样式表。因此,我们建议对真正全局的 CSS 使用全局样式,而对作用域 CSS 使用 CSS Modules。
Tailwind CSS
Tailwind CSS 是一个实用至上的 CSS 框架,可以与 Next.js 无缝集成。
安装 Tailwind
要开始使用 Tailwind,请安装必要的 Tailwind CSS 包
npm install -D tailwindcss @tailwindcss/postcss postcss
配置 Tailwind
在你的项目根目录中创建一个 postcss.config.mjs
文件,并将 @tailwindcss/postcss
插件添加到你的 PostCSS 配置中
/** @type {import('tailwindcss').Config} */
export default {
plugins: {
'@tailwindcss/postcss': {},
},
}
使用 Tailwind
将 Tailwind 指令 添加到你的 全局样式表
@import 'tailwindcss';
然后,在 根布局 中导入样式
import type { Metadata } from 'next'
// These styles apply to every route in the application
import './globals.css'
export const metadata: Metadata = {
title: 'Create Next App',
description: 'Generated by create next app',
}
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body>{children}</body>
</html>
)
}
最后,你可以开始在你的应用程序中编写 Tailwind 的实用类。
export default function Page() {
return <h1 className="text-3xl font-bold underline">Hello, Next.js!</h1>
}
Sass
Next.js 集成了 Sass,同时使用 .scss
和 .sass
扩展名和语法。
你还可以通过 CSS Modules 和 .module.scss
或 .module.sass
扩展名使用组件级别的 Sass。
安装 Sass
要开始使用 Sass,请安装 sass
包
npm install --save-dev sass
自定义 Sass 选项
如果你想配置你的 Sass 选项,请使用 next.config.js
中的 sassOptions
选项。
import type { NextConfig } from 'next'
const nextConfig: NextConfig = {
sassOptions: {
additionalData: `$var: red;`,
},
}
export default nextConfig
CSS-in-JS
警告: 需要运行时 JavaScript 的 CSS-in-JS 库目前在 React 服务器组件中不受支持。将 CSS-in-JS 与较新的 React 功能(如服务器组件和流式处理)一起使用,需要库作者支持最新版本的 React。
以下库在 app
目录中的客户端组件中受支持(按字母顺序排列):
ant-design
chakra-ui
@fluentui/react-components
kuma-ui
@mui/material
@mui/joy
pandacss
styled-jsx
styled-components
stylex
tamagui
tss-react
vanilla-extract
以下库目前正在努力提供支持:
如果你想为服务器组件设置样式,我们建议使用 CSS Modules 或其他输出 CSS 文件的解决方案,例如 Tailwind CSS。
配置 CSS-in-JS
要配置 CSS-in-JS,你需要:
- 创建一个样式注册表以收集渲染中的所有 CSS 规则。
- 使用
useServerInsertedHTML
钩子在任何可能使用它们的内容之前注入规则。 - 创建一个客户端组件,在初始服务器端渲染期间用样式注册表包装你的应用程序。
styled-jsx
要为你的应用程序配置 styled-jsx
,请创建一个新的注册表
'use client'
import React, { useState } from 'react'
import { useServerInsertedHTML } from 'next/navigation'
import { StyleRegistry, createStyleRegistry } from 'styled-jsx'
export default function StyledJsxRegistry({
children,
}: {
children: React.ReactNode
}) {
// Only create stylesheet once with lazy initial state
// x-ref: https://reactjs.ac.cn/docs/hooks-reference.html#lazy-initial-state
const [jsxStyleRegistry] = useState(() => createStyleRegistry())
useServerInsertedHTML(() => {
const styles = jsxStyleRegistry.styles()
jsxStyleRegistry.flush()
return <>{styles}</>
})
return <StyleRegistry registry={jsxStyleRegistry}>{children}</StyleRegistry>
}
然后,用注册表包装你的根布局
import StyledJsxRegistry from './registry'
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html>
<body>
<StyledJsxRegistry>{children}</StyledJsxRegistry>
</body>
</html>
)
}
styled-components
要使用 styled-components
,请在 next.config.js
中启用它
import type { NextConfig } from 'next'
const nextConfig: NextConfig = {
compiler: {
styledComponents: true,
},
}
export default nextConfig
然后,使用 styled-components
API 创建一个全局注册表组件,以收集渲染期间生成的所有 CSS 样式规则,并创建一个函数来返回这些规则。然后使用 useServerInsertedHTML
钩子将注册表中收集的样式注入到根布局的 <head>
HTML 标签中。
'use client'
import React, { useState } from 'react'
import { useServerInsertedHTML } from 'next/navigation'
import { ServerStyleSheet, StyleSheetManager } from 'styled-components'
export default function StyledComponentsRegistry({
children,
}: {
children: React.ReactNode
}) {
// Only create stylesheet once with lazy initial state
// x-ref: https://reactjs.ac.cn/docs/hooks-reference.html#lazy-initial-state
const [styledComponentsStyleSheet] = useState(() => new ServerStyleSheet())
useServerInsertedHTML(() => {
const styles = styledComponentsStyleSheet.getStyleElement()
styledComponentsStyleSheet.instance.clearTag()
return <>{styles}</>
})
if (typeof window !== 'undefined') return <>{children}</>
return (
<StyleSheetManager sheet={styledComponentsStyleSheet.instance}>
{children}
</StyleSheetManager>
)
}
用样式注册表组件包装根布局的 children
import StyledComponentsRegistry from './lib/registry'
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html>
<body>
<StyledComponentsRegistry>{children}</StyledComponentsRegistry>
</body>
</html>
)
}
外部样式表
外部包发布的样式表可以导入到 app
目录中的任何位置,包括并置组件
import 'bootstrap/dist/css/bootstrap.css'
export default function RootLayout({
children,
}: {
children: React.ReactNode
}) {
return (
<html lang="en">
<body className="container">{children}</body>
</html>
)
}
外部样式表必须直接从 npm 包导入,或者下载并与你的代码库并置。你不能使用 <link rel="stylesheet" />
。
API 参考
这有帮助吗?