id stringlengths 14 15 | text stringlengths 49 1.09k | source stringlengths 46 101 |
|---|---|---|
0cbd170b2a92-13 | A callback function that is invoked when the image is loaded.
The load event might occur before the image placeholder is removed and the image is fully decoded. If you want to wait until the image has fully loaded, use onLoadingComplete instead.
Good to know: Using props like onLoad, which accept a function, require us... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-14 | loading = 'lazy' // {lazy} | {eager}
The loading behavior of the image. Defaults to lazy.
When lazy, defer loading the image until it reaches a calculated distance from
the viewport.
When eager, load the image immediately.
Learn more about the loading attribute.
blurDataURL
A Data URL to
be used as a placeholder image ... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-15 | You can also generate a solid color Data URL to match the image.
unoptimized
unoptimized = {false} // {false} | {true}
When true, the source image will be served as-is instead of changing quality,
size, or format. Defaults to false.
import Image from 'next/image'
const UnoptimizedImage = (props) => {
return <Imag... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-16 | decoding. It is always "async".
Configuration Options
In addition to props, you can configure the Image Component in next.config.js. The following options are available:
remotePatterns
To protect your application from malicious users, configuration is required in order to use external images. This ensures that only ext... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-17 | pathname: '/account123/**',
},
],
},
}
Good to know: The example above will ensure the src property of next/image must start with https://example.com/account123/. Any other protocol, hostname, port, or unmatched path will respond with 400 Bad Request.
Below is another example of the remotePatterns property ... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-18 | Wildcard patterns can be used for both pathname and hostname and have the following syntax:
* match a single path segment or subdomain
** match any number of path segments at the end or subdomains at the beginning
The ** syntax does not work in the middle of the pattern.
domains
Warning: We recommend configuring strict... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-19 | domains: ['assets.acme.com'],
},
}
loaderFile
If you want to use a cloud provider to optimize images instead of using the Next.js built-in Image Optimization API, you can configure the loaderFile in your next.config.js like the following:
next.config.js module.exports = {
images: {
loader: 'custom',
loaderF... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-20 | Examples:
Custom Image Loader Configuration
Good to know: Customizing the image loader file, which accepts a function, require using Client Components to serialize the provided function.
Advanced
The following configuration is for advanced use cases and is usually not necessary. If you choose to configure the propertie... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-21 | },
}
imageSizes
You can specify a list of image widths using the images.imageSizes property in your next.config.js file. These widths are concatenated with the array of device sizes to form the full array of sizes used to generate image srcsets.
The reason there are two separate lists is that imageSizes is only used fo... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-22 | If the Accept head matches more than one of the configured formats, the first match in the array is used. Therefore, the array order matters. If there is no match (or the source image is animated), the Image Optimization API will fallback to the original image's format.
If no configuration is provided, the default belo... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-23 | If you self-host with a Proxy/CDN in front of Next.js, you must configure the Proxy to forward the Accept header.
Caching Behavior
The following describes the caching algorithm for the default loader. For all other loaders, please refer to your cloud provider's documentation.
Images are optimized dynamically upon reque... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-24 | STALE - the path is in the cache but exceeded the revalidate time so it will be updated in the background
HIT - the path is in the cache and has not exceeded the revalidate time
The expiration (or rather Max Age) is defined by either the minimumCacheTTL configuration or the upstream image Cache-Control header, whicheve... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-25 | minimumCacheTTL
You can configure the Time to Live (TTL) in seconds for cached optimized images. In many cases, it's better to use a Static Image Import which will automatically hash the file contents and cache the image forever with a Cache-Control header of immutable.
next.config.js module.exports = {
images: {
... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-26 | There is no mechanism to invalidate the cache at this time, so its best to keep minimumCacheTTL low. Otherwise you may need to manually change the src prop or delete <distDir>/cache/images.
disableStaticImages
The default behavior allows you to import static files such as import icon from './icon.png and then pass that... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-27 | disableStaticImages: true,
},
}
dangerouslyAllowSVG
The default loader does not optimize SVG images for a few reasons. First, SVG is a vector format meaning it can be resized losslessly. Second, SVG has many of the same features as HTML/CSS, which can lead to vulnerabilities without proper Content Security Policy (CS... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-28 | Animated Images
The default loader will automatically bypass Image Optimization for animated images and serve the image as-is.
Auto-detection for animated files is best-effort and supports GIF, APNG, and WebP. If you want to explicitly bypass Image Optimization for a given animated image, use the unoptimized prop.
Know... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-29 | Use CSS @supports (font: -apple-system-body) and (-webkit-appearance: none) { img[loading="lazy"] { clip-path: inset(0.6px) } }
Use priority if the image is above the fold
Firefox 67+ displays a white background while loading. Possible solutions:
Enable AVIF formats
Use placeholder="blur"
Version History | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-30 | VersionChangesv13.2.0contentDispositionType configuration added.v13.0.6ref prop added.v13.0.0The next/image import was renamed to next/legacy/image. The next/future/image import was renamed to next/image. A codemod is available to safely and automatically rename your imports. <span> wrapper removed. layout, objectFit, ... | https://nextjs.org/docs/app/api-reference/components/image |
0cbd170b2a92-31 | prop added.v12.0.0formats configuration added.AVIF support added.Wrapper <div> changed to <span>.v11.1.0onLoadingComplete and lazyBoundary props added.v11.0.0src prop support for static import.placeholder prop added.blurDataURL prop added.v10.0.5loader prop added.v10.0.1layout prop added.v10.0.0next/image introduced. | https://nextjs.org/docs/app/api-reference/components/image |
4a4414b4536a-0 | <Link>
Examples
Hello World
Active className on Link
<Link> is a React component that extends the HTML <a> element to provide prefetching and client-side navigation between routes. It is the primary way to navigate between routes in Next.js.
app/page.tsx import Link from 'next/link'
export default function Page() {
... | https://nextjs.org/docs/app/api-reference/components/link |
4a4414b4536a-1 | The path or URL to navigate to.
<Link href="/dashboard">Dashboard</Link>
href can also accept an object, for example:
// Navigate to /about?name=test
<Link
href={{
pathname: '/about',
query: { name: 'test' },
}}
>
About
</Link>
replace
Defaults to false. When true, next/link will replace the current his... | https://nextjs.org/docs/app/api-reference/components/link |
4a4414b4536a-2 | Dashboard
</Link>
)
}
prefetch
Defaults to true. When true, next/link will prefetch the page (denoted by the href) in the background. This is useful for improving the performance of client-side navigations. Any <Link /> in the viewport (initially or through scroll) will be preloaded.
Prefetch can be disabled by p... | https://nextjs.org/docs/app/api-reference/components/link |
4a4414b4536a-3 | For dynamic routes, it can be handy to use template literals to create the link's path.
For example, you can generate a list of links to the dynamic route app/blog/[slug]/page.js:app/blog/page.js import Link from 'next/link'
function Page({ posts }) {
return (
<ul>
{posts.map((post) => (
<li key={... | https://nextjs.org/docs/app/api-reference/components/link |
4a4414b4536a-4 | ))}
</ul>
)
}
Middleware
It's common to use Middleware for authentication or other purposes that involve rewriting the user to a different page. In order for the <Link /> component to properly prefetch links with rewrites via Middleware, you need to tell Next.js both the URL to display and the URL to prefetch. Th... | https://nextjs.org/docs/app/api-reference/components/link |
4a4414b4536a-5 | } else {
return NextResponse.rewrite(new URL('/public/dashboard', req.url))
}
}
}
In this case, you would want to use the following code in your <Link /> component:
import Link from 'next/link'
import useIsAuthed from './hooks/useIsAuthed'
export default function Page() {
const isAuthed = useIsAuthed()... | https://nextjs.org/docs/app/api-reference/components/link |
4a4414b4536a-6 | Dashboard
</Link>
)
}
Version History
VersionChangesv13.0.0No longer requires a child <a> tag. A codemod is provided to automatically update your codebase.v10.0.0href props pointing to a dynamic route are automatically resolved and no longer require an as prop.v8.0.0Improved prefetching performance.v1.0.0next/lin... | https://nextjs.org/docs/app/api-reference/components/link |
c89b133466ca-0 | <Script>
This API reference will help you understand how to use props available for the Script Component. For features and usage, please see the Optimizing Scripts page.
app/dashboard/page.tsx import Script from 'next/script'
export default function Dashboard() {
return (
<>
<Script src="https://example.c... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-1 | Required Props
The <Script /> component requires the following properties.
src
A path string specifying the URL of an external script. This can be either an absolute external URL or an internal path. The src property is required unless an inline script is used.
Optional Props
The <Script /> component accepts a number o... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-2 | Scripts denoted with this strategy are preloaded and fetched before any first-party code, but their execution does not block page hydration from occurring.
beforeInteractive scripts must be placed inside the root layout (app/layout.tsx) and are designed to load scripts that are needed by the entire site (i.e. the scrip... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-3 | strategy="beforeInteractive"
/>
</html>
)
}
Good to know: Scripts with beforeInteractive will always be injected inside the head of the HTML document regardless of where it's placed in the component.
Some examples of scripts that should be loaded as soon as possible with beforeInteractive include:
Bot detec... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-4 | export default function Page() {
return (
<>
<Script src="https://example.com/script.js" strategy="afterInteractive" />
</>
)
}
Some examples of scripts that are good candidates for afterInteractive include:
Tag managers
Analytics
lazyOnload
Scripts that use the lazyOnload strategy are injected into t... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-5 | export default function Page() {
return (
<>
<Script src="https://example.com/script.js" strategy="lazyOnload" />
</>
)
}
Examples of scripts that do not need to load immediately and can be fetched with lazyOnload include:
Chat support plugins
Social media widgets
worker
Warning: The worker strategy i... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-6 | next.config.js module.exports = {
experimental: {
nextScriptWorkers: true,
},
}
worker scripts can only currently be used in the pages/ directory:
pages/home.tsx import Script from 'next/script'
export default function Home() {
return (
<>
<Script src="https://example.com/script.js" strategy="work... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-7 | Here's an example of executing a lodash method only after the library has been loaded.
app/page.tsx 'use client'
import Script from 'next/script'
export default function Page() {
return (
<>
<Script
src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js"
onLoad={() =... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-8 | Some third-party scripts require users to run JavaScript code after the script has finished loading and every time the component is mounted (after a route navigation for example). You can execute code after the script's load event when it first loads and then after every subsequent component re-mount using the onReady ... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-9 | onReady={() => {
new google.maps.Map(mapRef.current, {
center: { lat: -34.397, lng: 150.644 },
zoom: 8,
})
}}
/>
</>
)
}
onError
Warning: onError does not yet work with Server Components and can only be used in Client Components. onError cannot be used wit... | https://nextjs.org/docs/app/api-reference/components/script |
c89b133466ca-10 | console.error('Script failed to load', e)
}}
/>
</>
)
}
Version History
VersionChangesv13.0.0beforeInteractive and afterInteractive is modified to support app.v12.2.4onReady prop added.v12.2.2Allow next/script with beforeInteractive to be placed in _document.v11.0.0next/script introduced. | https://nextjs.org/docs/app/api-reference/components/script |
df1f2617208f-0 | default.jsThis documentation is still being written. Please check back later. | https://nextjs.org/docs/app/api-reference/file-conventions/default |
d748f53ee440-0 | error.jsAn error file defines an error UI boundary for a route segment.
It is useful for catching unexpected errors that occur in Server Components and Client Components and displaying a fallback UI.
app/dashboard/error.tsx 'use client' // Error components must be Client Components
import { useEffect } from 'react'
... | https://nextjs.org/docs/app/api-reference/file-conventions/error |
d748f53ee440-1 | }
>
Try again
</button>
</div>
)
}
Props
error
An instance of an Error object forwarded to the error.js Client Component.
error.message
The error message.
For errors forwarded from Client Components, this will be the original Error's message.
For errors forwarded from Server Components, this w... | https://nextjs.org/docs/app/api-reference/file-conventions/error |
d748f53ee440-2 | Can be used to prompt the user to attempt to recover from the error.
Good to know:
error.js boundaries must be Client Components.
In Production builds, errors forwarded from Server Components will be stripped of specific error details to avoid leaking sensitive information.
An error.js boundary will not handle errors t... | https://nextjs.org/docs/app/api-reference/file-conventions/error |
d748f53ee440-3 | reset,
}: {
error: Error & { digest?: string }
reset: () => void
}) {
return (
<html>
<body>
<h2>Something went wrong!</h2>
<button onClick={() => reset()}>Try again</button>
</body>
</html>
)
}
Good to know:
global-error.js replaces the root layout.js when active and so must... | https://nextjs.org/docs/app/api-reference/file-conventions/error |
dee6154bd3c1-0 | layout.jsA layout is UI that is shared between routes.
app/dashboard/layout.tsx export default function DashboardLayout({
children,
}: {
children: React.ReactNode
}) {
return <section>{children}</section>
}
A root layout is the top-most layout in the root app directory. It is used to define the <html> and <body> ... | https://nextjs.org/docs/app/api-reference/file-conventions/layout |
dee6154bd3c1-1 | </html>
)
}
Props
children (required)
Layout components should accept and use a children prop. During rendering, children will be populated with the route segments the layout is wrapping. These will primarily be the component of a child Layout (if it exists) or Page, but could also be other special files like Loading... | https://nextjs.org/docs/app/api-reference/file-conventions/layout |
dee6154bd3c1-2 | children,
params,
}: {
children: React.ReactNode
params: {
tag: string
item: string
}
}) {
// URL -> /shop/shoes/nike-air-max-97
// `params` -> { tag: 'shoes', item: 'nike-air-max-97' }
return <section>{children}</section>
}
Good to know
Layout's do not receive searchParams
Unlike Pages, Layout co... | https://nextjs.org/docs/app/api-reference/file-conventions/layout |
dee6154bd3c1-3 | app
└── dashboard
├── layout.tsx
├── settings
│ └── page.tsx
└── analytics
└── page.js
When navigating from /dashboard/settings to /dashboard/analytics, page.tsx in /dashboard/analytics will be rendered on the server because it is UI that changed, while dashboard/layout.tsx will not be re-rend... | https://nextjs.org/docs/app/api-reference/file-conventions/layout |
dee6154bd3c1-4 | Root Layouts
The app directory must include a root app/layout.js.
The root layout must define <html> and <body> tags.
You should not manually add <head> tags such as <title> and <meta> to root layouts. Instead, you should use the Metadata API which automatically handles advanced requirements such as streaming and de-du... | https://nextjs.org/docs/app/api-reference/file-conventions/layout |
2e4729537772-0 | loading.jsA loading file can create instant loading states built on Suspense.
By default, this file is a Server Component - but can also be used as a Client Component through the "use client" directive.
app/feed/loading.tsx export default function Loading() {
// Or a custom loading skeleton component
return <p>'Loa... | https://nextjs.org/docs/app/api-reference/file-conventions/loading |
b781d741d3fc-0 | not-found.jsThe not-found file is used to render UI when the notFound function is thrown within a route segment. Along with serving a custom UI, Next.js will also return a 404 HTTP status code.
app/blog/not-found.tsx import Link from 'next/link'
export default function NotFound() {
return (
<div>
<h2>Not ... | https://nextjs.org/docs/app/api-reference/file-conventions/not-found |
b781d741d3fc-1 | Props
not-found.js components do not accept any props.
Version History
VersionChangesv13.3.0Root app/not-found handles global unmatched URLs.v13.0.0not-found introduced. | https://nextjs.org/docs/app/api-reference/file-conventions/not-found |
60aeb2307567-0 | page.jsA page is UI that is unique to a route.
app/blog/[slug]/page.tsx export default function Page({
params,
searchParams,
}: {
params: { slug: string }
searchParams: { [key: string]: string | string[] | undefined }
}) {
return <h1>My Page</h1>
}
Props
params (optional)
An object containing the dynamic rout... | https://nextjs.org/docs/app/api-reference/file-conventions/page |
60aeb2307567-1 | searchParams (optional)
An object containing the search parameters of the current URL. For example:
URLsearchParams/shop?a=1{ a: '1' }/shop?a=1&b=2{ a: '1', b: '2' }/shop?a=1&a=2{ a: ['1', '2'] }
Good to know:
searchParams is a Dynamic API whose values cannot be known ahead of time. Using it will opt the page into dyna... | https://nextjs.org/docs/app/api-reference/file-conventions/page |
fbec914e01ed-0 | route.jsRoute Handlers allow you to create custom request handlers for a given route using the Web Request and Response APIs.
HTTP Methods
A route file allows you to create custom request handlers for a given route. The following HTTP methods are supported: GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS.
route.ts exp... | https://nextjs.org/docs/app/api-reference/file-conventions/route |
fbec914e01ed-1 | export async function OPTIONS(request: Request) {}
Good to know: Route Handlers are only available inside the app directory. You do not need to use API Routes (pages) and Route Handlers (app) together, as Route Handlers should be able to handle all use cases.
Parameters
request (optional)
The request object is a NextRe... | https://nextjs.org/docs/app/api-reference/file-conventions/route |
fbec914e01ed-2 | ExampleURLparamsapp/dashboard/[team]/route.js/dashboard/1{ team: '1' }app/shop/[tag]/[item]/route.js/shop/1/2{ tag: '1', item: '2' }app/blog/[...slug]/route.js/blog/1/2{ slug: ['1', '2'] }
NextResponse
Route Handlers can extend the Web Response API by returning a NextResponse object. This allows you to easily set cooki... | https://nextjs.org/docs/app/api-reference/file-conventions/route |
f7873f4ee4f9-0 | Route Segment ConfigThe Route Segment options allows you configure the behavior of a Page, Layout, or Route Handler by directly exporting the following variables:
OptionTypeDefaultdynamic'auto' | 'force-dynamic' | 'error' | 'force-static''auto'dynamicParamsbooleantruerevalidatefalse | 'force-cache' | 0 | numberfalsefet... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-1 | export const revalidate = false
export const fetchCache = 'auto'
export const runtime = 'nodejs'
export const preferredRegion = 'auto'
export const maxDuration = 5
export default function MyComponent() {}
Good to know:
The values of the config options currently need be statically analyzable. For example revalidate = ... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-2 | // 'auto' | 'force-dynamic' | 'error' | 'force-static'
Good to know: The new model in the app directory favors granular caching control at the fetch request level over the binary all-or-nothing model of getServerSideProps and getStaticProps at the page-level in the pages directory. The dynamic option is a way to opt ba... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-3 | Setting the segment config to export const fetchCache = 'force-no-store'
'error': Force static rendering and static data fetching of a layout or page by causing an error if any components use dynamic functions or dynamic fetches. This option is equivalent to:
getStaticProps() in the pages directory.
Setting the option ... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-4 | Good to know:
Instructions on how to migrate from getServerSideProps and getStaticProps to dynamic: 'force-dynamic' and dynamic: 'error' can be found in the upgrade guide.
dynamicParams
Control what happens when a dynamic segment is visited that was not generated with generateStaticParams.
layout.tsx / page.tsx export ... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-5 | revalidate
Set the default revalidation time for a layout or page. This option does not override the revalidate value set by individual fetch requests.
layout.tsx / page.tsx / route.ts export const revalidate = false
// false | 'force-cache' | 0 | number
false: (default) The default heuristic to cache any fetch request... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-6 | 0: Ensure a layout or page is always dynamically rendered even if no dynamic functions or dynamic data fetches are discovered. This option changes the default of fetch requests that do not set a cache option to 'no-store' but leaves fetch requests that opt into 'force-cache' or use a positive revalidate as is.
number: ... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-7 | fetchCache
This is an advanced option that should only be used if you specifically need to override the default behavior.By default, Next.js will cache any fetch() requests that are reachable before any dynamic functions are used and will not cache fetch requests that are discovered after dynamic functions are used.fet... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-8 | 'default-cache': Allow any cache option to be passed to fetch but if no option is provided then set the cache option to 'force-cache'. This means that even fetch requests after dynamic functions are considered static.
'only-cache': Ensure all fetch requests opt into caching by changing the default to cache: 'force-cach... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-9 | 'only-no-store': Ensure all fetch requests opt out of caching by changing the default to cache: 'no-store' if no option is provided and causing an error if any fetch requests use cache: 'force-cache'
'force-no-store': Ensure all fetch requests opt out of caching by setting the cache option of all fetch requests to 'no-... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-10 | The intention of the 'only-*' and force-*' options is to guarantee the whole route is either fully static or fully dynamic. This means:
A combination of 'only-cache' and 'only-no-store' in a single route is not allowed.
A combination of 'force-cache' and 'force-no-store' in a single route is not allowed.
A parent canno... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-11 | edge
Learn more about the Edge and Node.js runtimes.
preferredRegion
layout.tsx / page.tsx / route.ts export const preferredRegion = 'auto'
// 'auto' | 'global' | 'home' | ['iad1', 'sfo1']
Support for preferredRegion, and regions supported, is dependent on your deployment platform.
Good to know:
If a preferredRegion is... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
f7873f4ee4f9-12 | Good to know:
If a maxDuration is not specified, the default value is dependent on your deployment platform and plan.
generateStaticParams
The generateStaticParams function can be used in combination with dynamic route segments to define the list of route segment parameters that will be statically generated at build ti... | https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config |
dc9430bb61da-0 | template.jsThis documentation is still being written. Please check back later. | https://nextjs.org/docs/app/api-reference/file-conventions/template |
84146131d15b-0 | favicon, icon, and apple-iconThe favicon, icon, or apple-icon file conventions allow you to set icons for your application.
They are useful for adding app icons that appear in places like web browser tabs, phone home screens, and search engine results.
There are two ways to set app icons:
Using image files (.ico, .jpg,... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-1 | File conventionSupported file typesValid locationsfavicon.icoapp/icon.ico, .jpg, .jpeg, .png, .svgapp/**/*apple-icon.jpg, .jpeg, .pngapp/**/*
favicon
Add a favicon.ico image file to the root /app route segment.
<head> output <link rel="icon" href="/favicon.ico" sizes="any" />
icon
Add an icon.(ico|jpg|jpeg|png|svg) ima... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-2 | type="image/<generated>"
sizes="<generated>"
/>
Good to know
You can set multiple icons by adding a number suffix to the file name. For example, icon1.png, icon2.png, etc. Numbered files will sort lexically.
Favicons can only be set in the root /app segment. If you need more granularity, you can use icon.
The appropr... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-3 | Generate icons using code (.js, .ts, .tsx)
In addition to using literal image files, you can programmatically generate icons using code.
Generate an app icon by creating an icon or apple-icon route that default exports a function.
File conventionSupported file typesicon.js, .ts, .tsxapple-icon.js, .ts, .tsx
The easiest... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-4 | (
// ImageResponse JSX element
<div
style={{
fontSize: 24,
background: 'black',
width: '100%',
height: '100%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
color: 'white',
}}
>
A... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-5 | Good to know
By default, generated icons are statically optimized (generated at build time and cached) unless they use dynamic functions or dynamic data fetching.
You can generate multiple icons in the same file using generateImageMetadata.
You cannot generate a favicon icon. Use icon or a favicon.ico file instead.
Pro... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-6 | // ...
}
RouteURLparamsapp/shop/icon.js/shopundefinedapp/shop/[slug]/icon.js/shop/1{ slug: '1' }app/shop/[tag]/[item]/icon.js/shop/1/2{ tag: '1', item: '2' }app/shop/[...slug]/icon.js/shop/1/2{ slug: ['1', '2'] }
Returns
The default export function should return a Blob | ArrayBuffer | TypedArray | DataView | ReadableSt... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-7 | export default function Icon() {}
<head> output <link rel="icon" sizes="32x32" />
contentType
icon.tsx / apple-icon.tsx export const contentType = 'image/png'
export default function Icon() {}
<head> output <link rel="icon" type="image/png" />
Route Segment Config
icon and apple-icon are specialized Route Handlers th... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
84146131d15b-8 | export default function Icon() {}
Version History
VersionChangesv13.3.0favicon icon and apple-icon introduced | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/app-icons |
bcfd80d6f30f-0 | opengraph-image and twitter-imageThe opengraph-image and twitter-image file conventions allow you to set Open Graph and Twitter images for a route segment.
They are useful for setting the images that appear on social networks and messaging apps when a user shares a link to your site.
There are two ways to set Open Grap... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-1 | File conventionSupported file typesopengraph-image.jpg, .jpeg, .png, .giftwitter-image.jpg, .jpeg, .png, .gifopengraph-image.alt.txttwitter-image.alt.txt
opengraph-image
Add an opengraph-image.(jpg|jpeg|png|gif) image file to any route segment.
<head> output <meta property="og:image" content="<generated>" />
<meta prop... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-2 | <meta name="twitter:image:width" content="<generated>" />
<meta name="twitter:image:height" content="<generated>" />
opengraph-image.alt.txt
Add an accompanying opengraph-image.alt.txt file in the same route segment as the opengraph-image.(jpg|jpeg|png|gif) image it's alt text.
opengraph-image.alt.txt About Acme
<head>... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-3 | In addition to using literal image files, you can programmatically generate images using code.
Generate a route segment's shared image by creating an opengraph-image or twitter-image route that default exports a function.
File conventionSupported file typesopengraph-image.js, .ts, .tsxtwitter-image.js, .ts, .tsx
Good t... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-4 | export const size = {
width: 1200,
height: 630,
}
export const contentType = 'image/png'
// Font
const interSemiBold = fetch(
new URL('./Inter-SemiBold.ttf', import.meta.url)
).then((res) => res.arrayBuffer())
// Image generation
export default async function Image() {
return new ImageResponse(
(
... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-5 | </div>
),
// ImageResponse options
{
// For convenience, we can re-use the exported opengraph-image
// size config to also set the ImageResponse's width and height.
...size,
fonts: [
{
name: 'Inter',
data: await interSemiBold,
style: 'normal',
... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-6 | Props
The default export function receives the following props:
params (optional)
An object containing the dynamic route parameters object from the root segment down to the segment opengraph-image or twitter-image is colocated in.
app/shop/[slug]/opengraph-image.tsx export default function Image({ params }: { params: {... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-7 | Good to know: ImageResponse satisfies this return type.
Config exports
You can optionally configure the image's metadata by exporting alt, size, and contentType variables from opengraph-image or twitter-image route.
OptionTypealtstringsize{ width: number; height: number }contentTypestring - image MIME type
alt
opengrap... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-8 | <meta property="og:image:height" content="630" />
contentType
opengraph-image.tsx / twitter-image.tsx export const contentType = 'image/png'
export default function Image() {}
<head> output <meta property="og:image:type" content="image/png" />
Route Segment Config
opengraph-image and twitter-image are specialized Rou... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-9 | export default function Image() {}
Examples
Using external data
This example uses the params object and external data to generate the image.
Good to know:
By default, this generated image will be statically optimized. You can configure the individual fetch options or route segments options to change this behavior.
app/... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
bcfd80d6f30f-10 | res.json()
)
return new ImageResponse(
(
<div
style={{
fontSize: 48,
background: 'white',
width: '100%',
height: '100%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}}
>
{post.title}
... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/opengraph-image |
136608218ae1-0 | robots.txtAdd or generate a robots.txt file that matches the Robots Exclusion Standard in the root of app directory to tell search engine crawlers which URLs they can access on your site.
Static robots.txt
app/robots.txt User-Agent: *
Allow: /
Disallow: /private/
Sitemap: https://acme.com/sitemap.xml
Generate a Robots ... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/robots |
136608218ae1-1 | Disallow: /private/
Sitemap: https://acme.com/sitemap.xml
Robots object
type Robots = {
rules:
| {
userAgent?: string | string[]
allow?: string | string[]
disallow?: string | string[]
crawlDelay?: number
}
| Array<{
userAgent: string | string[]
allow?: st... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/robots |
8dac53b20fb9-0 | sitemap.xmlAdd or generate a sitemap.xml file that matches the Sitemaps XML format in the root of app directory to help search engine crawlers crawl your site more efficiently.
Static sitemap.xml
app/sitemap.xml <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://acme.com</loc>
<la... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap |
8dac53b20fb9-1 | <url>
<loc>https://acme.com/blog</loc>
<lastmod>2023-04-06T15:02:24.021Z</lastmod>
</url>
</urlset>
Generate a Sitemap
Add a sitemap.js or sitemap.ts file that returns Sitemap.
app/sitemap.ts import { MetadataRoute } from 'next'
export default function sitemap(): MetadataRoute.Sitemap {
return [
{
... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap |
8dac53b20fb9-2 | lastModified: new Date(),
},
]
}
Output:
acme.com/sitemap.xml <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://acme.com</loc>
<lastmod>2023-04-06T15:02:24.021Z</lastmod>
</url>
<url>
<loc>https://acme.com/about</loc>
<lastmod>2023-04-06T15:02:24.021Z</lastmod>
... | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap |
8dac53b20fb9-3 | </url>
</urlset>
Sitemap Return Type
type Sitemap = Array<{
url: string
lastModified?: string | Date
}>
Good to know
In the future, we will support multiple sitemaps and sitemap indexes.
Version History
VersionChangesv13.3.0sitemap introduced. | https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap |
691420b793cf-0 | cookiesThe cookies function allows you to read the HTTP incoming request cookies from a Server Component or write outgoing request cookies in a Server Action or Route Handler.
Good to know: cookies() is a Dynamic Function whose returned values cannot be known ahead of time. Using it in a layout or page will opt a route... | https://nextjs.org/docs/app/api-reference/functions/cookies |
691420b793cf-1 | return '...'
}
cookies().getAll()
A method that is similar to get, but returns a list of all the cookies with a matching name. If name is unspecified, it returns all the available cookies.
app/page.js import { cookies } from 'next/headers'
export default function Page() {
const cookieStore = cookies()
return cook... | https://nextjs.org/docs/app/api-reference/functions/cookies |
691420b793cf-2 | export default function Page() {
const cookiesList = cookies()
const hasCookie = cookiesList.has('theme')
return '...'
}
cookies().set(name, value, options)
A method that takes a cookie name, value, and options and sets the outgoing request cookie.
Good to know: .set() is only available in a Server Action or Rout... | https://nextjs.org/docs/app/api-reference/functions/cookies |
691420b793cf-3 | httpOnly: true,
path: '/',
})
}
Deleting cookies
To "delete" a cookie, you must set a new cookie with the same name and an empty value. You can also set the maxAge to 0 to expire the cookie immediately.
Good to know: .set() is only available in a Server Action or Route Handler.
app/actions.js 'use server'
impor... | https://nextjs.org/docs/app/api-reference/functions/cookies |
691420b793cf-4 | Version History
VersionChangesv13.0.0cookies introduced. | https://nextjs.org/docs/app/api-reference/functions/cookies |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.