Menu

Home
GitHub(opens in a new tab)

Next.js Docs

App Router
Glossary

Getting Started
Installation
Project Structure
Layouts and Pages
Linking and Navigating
Server and Client Components
Fetching Data
Mutating Data
Caching
Revalidating
Error Handling
CSS
Image Optimization
Font Optimization
Metadata and OG images
Route Handlers
Proxy
Deploying
Upgrading

AI Coding Agents
Analytics
Authentication
Backend for Frontend
Caching (Previous Model)
CDN Caching
CI Build Caching
Content Security Policy
CSS-in-JS
Custom Server
Data Security
Debugging
Deploying to Platforms
Draft Mode
Environment Variables
Forms
How Revalidation Works
ISR
Instant navigation
Instrumentation
Internationalization
JSON-LD
Lazy Loading
Development Environment
Next.js MCP Server
MDX
Memory Usage
Migrating to Cache Components
Multi-tenant
Multi-zones
OpenTelemetry
Package Bundling
PPR Platform Guide
Prefetching
Preserving UI state
Production
PWAs
Public pages
Redirecting
Rendering Philosophy
Sass
Scripts
Self-Hosting
SPAs
Static Exports
Streaming
Tailwind CSS v3
Third Party Libraries
Videos

App Router
Create React App
Vite

Testing
Cypress
Jest
Playwright
Vitest

Upgrading
Codemods
Version 14
Version 15
Version 16

Edge Runtime
Turbopack

Directives
use cache: private
use cache: remote
use cache
use client
use server

Components
Font
Form Component
Image Component
Link Component
Script Component

default.js
Dynamic Segments
error.js
forbidden.js
instrumentation-client.js
instrumentation.js
Intercepting Routes
layout.js
loading.js
mdx-components.js
not-found.js
page.js
Parallel Routes
proxy.js
public
Route Groups
route.js
src
template.js
unauthorized.js

Metadata Files
favicon, icon, and apple-icon
manifest.json
opengraph-image and twitter-image
robots.txt
sitemap.xml

Route Segment Config
dynamicParams
instant
maxDuration
preferredRegion
runtime

Functions
after
cacheLife
cacheTag
unstable_catchError
connection
cookies
draftMode
fetch
forbidden
generateImageMetadata
generateMetadata
generateSitemaps
generateStaticParams
generateViewport
headers
ImageResponse
NextRequest
NextResponse
notFound
permanentRedirect
redirect
refresh
revalidatePath
revalidateTag
unauthorized
unstable_cache
unstable_noStore
unstable_rethrow
updateTag
useLinkStatus
useParams
usePathname
useReportWebVitals
useRouter
useSearchParams
useSelectedLayoutSegment
useSelectedLayoutSegments
userAgent

TypeScript
ESLint

next.config.js
adapterPath
allowedDevOrigins
appDir
assetPrefix
authInterrupts
basePath
cacheComponents
cacheHandlers
cacheLife
compress
crossOrigin
cssChunking
deploymentId
devIndicators
distDir
env
expireTime
exportPathMap
generateBuildId
generateEtags
headers
htmlLimitedBots
httpAgentOptions
images
cacheHandler
inlineCss
logging
mdxRs
onDemandEntries
optimizePackageImports
output
pageExtensions
poweredByHeader
productionBrowserSourceMaps
proxyClientMaxBodySize
reactCompiler
reactMaxHeadersLength
reactStrictMode
redirects
rewrites
sassOptions
serverActions
serverComponentsHmrCache
serverExternalPackages
staleTimes
staticGeneration*
taint
trailingSlash
transpilePackages
turbopack
turbopackFileSystemCache
turbopack.ignoreIssue
typedRoutes
typescript
urlImports
useLightningcss
viewTransition
webpack
webVitalsAttribution

CLI
create-next-app
next CLI

Adapters
Configuration
Creating an Adapter
API Reference
Testing Adapters
Routing with @next/routing
Implementing PPR in an Adapter
Runtime Integration
Invoking Entrypoints
Output Types
Routing Information
Use Cases

Pages Router

Installation
Project Structure
Images
Fonts
CSS
Deploying

Analytics
Authentication
Babel
CI Build Caching
Content Security Policy
CSS-in-JS
Custom Server
Debugging
Draft Mode
Environment Variables
Forms
ISR
Instrumentation
Internationalization
Lazy Loading
MDX
Multi-Zones
OpenTelemetry
Package Bundling
PostCSS
Preview Mode
Production
Redirecting
Sass
Scripts
Self-Hosting
Static Exports
Tailwind CSS
Third Party Libraries

App Router
Create React App
Vite

Testing
Cypress
Jest
Playwright
Vitest

Upgrading
Codemods
Version 10
Version 11
Version 12
Version 13
Version 14
Version 9

Routing
Pages and Layouts
Dynamic Routes
Linking and Navigating
Custom App
Custom Document
API Routes
Custom Errors

Rendering
Server-side Rendering (SSR)
Static Site Generation (SSG)
Automatic Static Optimization
Client-side Rendering (CSR)

Data Fetching
getStaticProps
getStaticPaths
Forms and Mutations
getServerSideProps
Client-side Fetching

Configuring
Error Handling

Edge Runtime
Turbopack

Components
Font
Form
Head
Image (Legacy)
Image
Link
Script

instrumentation.js
Proxy
public
src Directory

Functions
getInitialProps
getServerSideProps
getStaticPaths
getStaticProps
NextRequest
NextResponse
useParams
useReportWebVitals
useRouter
useSearchParams
userAgent

TypeScript
ESLint

next.config.js Options
adapterPath
allowedDevOrigins
assetPrefix
basePath
bundlePagesRouterDependencies
compress
crossOrigin
deploymentId
devIndicators
distDir
env
exportPathMap
generateBuildId
generateEtags
headers
httpAgentOptions
images
logging
onDemandEntries
optimizePackageImports
output
pageExtensions
poweredByHeader
productionBrowserSourceMaps
experimental.proxyClientMaxBodySize
reactStrictMode
redirects
rewrites
serverExternalPackages
trailingSlash
transpilePackages
turbopack
typescript
urlImports
useLightningcss
webpack
webVitalsAttribution

CLI
create-next-app CLI
next CLI

Adapters
Configuration
Creating an Adapter
API Reference
Testing Adapters
Routing with @next/routing
Implementing PPR in an Adapter
Runtime Integration
Invoking Entrypoints
Output Types
Routing Information
Use Cases

Architecture
Accessibility
Fast Refresh
Next.js Compiler
Supported Browsers

Community
Contribution Guide
Rspack

Directives

The following directives are available:

Edit on GitHub

Adapted from nextjs.org/docs/app/api-reference/directives by Vercel, Inc., licensed under MIT. Changes were made: this page is re-rendered from the original's source.

PreviousTurbopack Nextuse cache: private

Wide content