Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(router): clarify dynamic route slug is about a file name, not "folder" #56596

Merged
merged 8 commits into from
Oct 10, 2023
Merged

docs(router): clarify dynamic route slug is about a file name, not "folder" #56596

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7b31761
Update 02-dynamic-routes.mdx
cmbritten Oct 9, 2023
6659a7b
Update 02-dynamic-routes.mdx
cmbritten Oct 9, 2023
a260195
Update 02-dynamic-routes.mdx
cmbritten Oct 9, 2023
a120e57
Update 02-dynamic-routes.mdx
cmbritten Oct 9, 2023
6ebcc54
Update docs/03-pages/01-building-your-application/01-routing/02-dynam…
cmbritten Oct 9, 2023
e7c052e
Merge branch 'canary' into patch-3
leerob Oct 9, 2023
276b437
Update 02-dynamic-routes.mdx
cmbritten Oct 9, 2023
7cb56e7
Merge branch 'canary' into patch-3
leerob Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/03-pages/01-building-your-application/01-routing/02-dynamic-routes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ When you don't know the exact segment names ahead of time and want to create rou

## Convention

A Dynamic Segment can be created by wrapping a folder's name in square brackets: `[folderName]`. For example, `[id]` or `[slug]`.
A Dynamic Segment can be created by wrapping a file or folder name in square brackets: `[segmentName]`. For example, `[id]` or `[slug]`.

Dynamic Segments can be accessed from [`useRouter`](/docs/pages/api-reference/functions/use-router).

Expand All @@ -38,7 +38,7 @@ export default function Page() {

## Catch-all Segments

Dynamic Segments can be extended to **catch-all** subsequent segments by adding an ellipsis inside the brackets `[...folderName]`.
Dynamic Segments can be extended to **catch-all** subsequent segments by adding an ellipsis inside the brackets `[...segmentName]`.

For example, `pages/shop/[...slug].js` will match `/shop/clothes`, but also `/shop/clothes/tops`, `/shop/clothes/tops/t-shirts`, and so on.

Expand All @@ -50,7 +50,7 @@ For example, `pages/shop/[...slug].js` will match `/shop/clothes`, but also `/sh

## Optional Catch-all Segments

Catch-all Segments can be made **optional** by including the parameter in double square brackets: `[[...folderName]]`.
Catch-all Segments can be made **optional** by including the parameter in double square brackets: `[[...segmentName]]`.

For example, `pages/shop/[[...slug]].js` will **also** match `/shop`, in addition to `/shop/clothes`, `/shop/clothes/tops`, `/shop/clothes/tops/t-shirts`.

Expand Down