Skip to content

Commit

Permalink
app-router: add support for parallel routes in useParams (#49595)
Browse files Browse the repository at this point in the history
This PR changes `useParams` to return all dynamic params present in the
tree as opposed to only those on the canonical/URL path


<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation or adding/fixing Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md



## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

link NEXT-1108

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Co-authored-by: Tim Neutkens <tim@timneutkens.nl>
  • Loading branch information
3 people committed May 11, 2023
1 parent 062fbf6 commit 85c2921
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 11 deletions.
25 changes: 14 additions & 11 deletions packages/next/src/client/components/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,26 +129,29 @@ export function useRouter(): import('../../shared/lib/app-router-context').AppRo
interface Params {
[key: string]: string
}
// TODO-APP: handle parallel routes

// this function performs a depth-first search of the tree to find the selected
// params
function getSelectedParams(
tree: FlightRouterState,
params: Params = {}
): Params {
// After first parallel route prefer children, if there's no children pick the first parallel route.
const parallelRoutes = tree[1]
const node = parallelRoutes.children ?? Object.values(parallelRoutes)[0]

if (!node) return params
const segment = node[0]
const isDynamicParameter = Array.isArray(segment)
const segmentValue = isDynamicParameter ? segment[1] : segment
if (!segmentValue || segmentValue.startsWith('__PAGE__')) return params
for (const parallelRoute of Object.values(parallelRoutes)) {
const segment = parallelRoute[0]
const isDynamicParameter = Array.isArray(segment)
const segmentValue = isDynamicParameter ? segment[1] : segment
if (!segmentValue || segmentValue.startsWith('__PAGE__')) continue

if (isDynamicParameter) {
params[segment[0]] = segment[1]
}

if (isDynamicParameter) {
params[segment[0]] = segment[1]
params = getSelectedParams(parallelRoute, params)
}

return getSelectedParams(node, params)
return params
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
'use client'
import { useParams } from 'next/navigation'

export default function Page() {
return <div id="bar">{JSON.stringify(useParams())}</div>
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
'use client'
import { useParams } from 'next/navigation'

export default function Page() {
return <div id="foo">{JSON.stringify(useParams())}</div>
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export default function Layout({ bar, foo }) {
return (
<div>
<h1>foo</h1>
{foo}
<h1>bar</h1>
{bar}
</div>
)
}
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,20 @@ createNextDescribe(
'parallel for foo'
)
})

it('should display all parallel route params with useParams', async () => {
const browser = await next.browser('/parallel-dynamic/foo/bar')

await check(
() => browser.waitForElementByCss('#foo').text(),
`{"slug":"foo","id":"bar"}`
)

await check(
() => browser.waitForElementByCss('#bar').text(),
`{"slug":"foo","id":"bar"}`
)
})
})

describe('route intercepting', () => {
Expand Down

0 comments on commit 85c2921

Please sign in to comment.