Dynamic Routes
事前に正確なセグメント名がわからず、動的データからルートを作成したい場合、リクエスト時に埋め込まれるか、ビルド時に事前レンダリングされるDynamic Segmentsを使用できます。
規約
Dynamic Segmentは、フォルダ名を角括弧で囲むことで作成できます: [folderName]
。例えば、[id]
や[slug]
です。
Dynamic Segmentsは、layout
、page
、route
、およびgenerateMetadata
関数にparams
propとして渡されます。
例
例えば、ブログは次のようなルートを含むことができます: app/blog/[slug]/page.js
。ここで[slug]
はブログ投稿のDynamic Segmentです。
- TypeScript
- JavaScript
export default async function Page({
params,
}: {
params: Promise<{ slug: string }>
}) {
const { slug } = await params
return <div>My Post: {slug}</div>
}
export default async function Page({ params }) {
const { slug } = await params
return <div>My Post: {slug}</div>
}
Route | Example URL | params |
---|---|---|
app/blog/[slug]/page.js | /blog/a | { slug: 'a' } |
app/blog/[slug]/page.js | /blog/b | { slug: 'b' } |
app/blog/[slug]/page.js | /blog/c | { slug: 'c' } |
セグメントのparamsを生成する方法については、generateStaticParams()ページを参照してください。
Good to know
params
propはPromiseであるため、値にアクセスするにはasync/awaitまたはReactのuse関数を使用する必要があります。- バージョン14以前では、
params
は同期的なpropでした。後方互換性を考慮して、Next.js 15ではまだ同期的にアクセスできますが、この動作は将来的に廃止される予定です。
- バージョン14以前では、
- Dynamic Segmentsは、
pages
ディレクトリのDynamic Routesと同等です。
Generating Static Params
generateStaticParams
関数は、dynamic route segmentsと組み合わせて使用することで、リクエスト時ではなくビルド時にルートを静的に生成できます。
- TypeScript
- JavaScript
export async function generateStaticParams() {
const posts = await fetch('https://.../posts').then((res) => res.json())
return posts.map((post) => ({
slug: post.slug,
}))
}
export async function generateStaticParams() {
const posts = await fetch('https://.../posts').then((res) => res.json())
return posts.map((post) => ({
slug: post.slug,
}))
}
generateStaticParams
関数の主な利点は、そのスマートなデータ取得です。generateStaticParams
関数内でfetch
リクエストを使用してコンテンツを取得する場合、リクエストは自動的にメモ化されます。これにより、複数のgenerateStaticParams
、Layouts、およびPagesで同じ引数を持つfetch
リクエストが1回だけ行われ、ビルド時間が短縮されます。
pages
ディレクトリから移行する場合は、移行ガイドを使用してください。
詳細情報や高度な使用例については、generateStaticParams
サーバー関数のドキュメントを参照してください。
Catch-all Segments
Dynamic Segmentsは、角括弧内に省略記号を追加することで、後続のセグメントをすべてキャッチするように拡張できます: [...folderName]
。
例えば、app/shop/[...slug]/page.js
は/shop/clothes
にマッチしますが、/shop/clothes/tops
、/shop/clothes/tops/t-shirts
などにもマッチします。
Route | Example URL | params |
---|---|---|
app/shop/[...slug]/page.js | /shop/a | { slug: ['a'] } |
app/shop/[...slug]/page.js | /shop/a/b | { slug: ['a', 'b'] } |
app/shop/[...slug]/page.js | /shop/a/b/c | { slug: ['a', 'b', 'c'] } |
Optional Catch-all Segments
Catch-all Segmentsは、パラメータを二重角括弧で囲むことでオプションにすることができます: [[...folderName]]
。
例えば、app/shop/[[...slug]]/page.js
は/shop
にもマッチし、さらに/shop/clothes
、/shop/clothes/tops
、/shop/clothes/tops/t-shirts
にもマッチします。
catch-allとoptional catch-allセグメントの違いは、オプションの場合、パラメータなしのルートもマッチすることです(上記の例では/shop
)。
Route | Example URL | params |
---|---|---|
app/shop/[[...slug]]/page.js | /shop | { slug: undefined } |
app/shop/[[...slug]]/page.js | /shop/a | { slug: ['a'] } |
app/shop/[[...slug]]/page.js | /shop/a/b | { slug: ['a', 'b'] } |
app/shop/[[...slug]]/page.js | /shop/a/b/c | { slug: ['a', 'b', 'c'] } |
TypeScript
TypeScriptを使用する場合、設定されたルートセグメントに応じてparams
の型を追加できます。
- TypeScript
- JavaScript
export default async function Page({
params,
}: {
params: Promise<{ slug: string }>
}) {
return <h1>My Page</h1>
}
export default async function Page({ params }) {
return <h1>My Page</h1>
}
Route | params Type Definition |
---|---|
app/blog/[slug]/page.js | { slug: string } |
app/shop/[...slug]/page.js | { slug: string[] } |
app/shop/[[...slug]]/page.js | { slug?: string[] } |
app/[categoryId]/[itemId]/page.js | { categoryId: string, itemId: string } |
Good to know: これは将来的にTypeScriptプラグインによって自動的に行われる可能性があります。