Unverified Commit 8350f7ef authored by Hannes Bornö's avatar Hannes Bornö Committed by GitHub

useSelectedLayoutSegment at the current level (#42299)

When `useSelectedLayoutSegment` is used on the current level or in a
page it should return null.

fixes #41879
fixes #41878

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
parent 9de871e6
...@@ -174,10 +174,10 @@ export function useSelectedLayoutSegments( ...@@ -174,10 +174,10 @@ export function useSelectedLayoutSegments(
*/ */
export function useSelectedLayoutSegment( export function useSelectedLayoutSegment(
parallelRouteKey: string = 'children' parallelRouteKey: string = 'children'
): string { ): string | null {
const selectedLayoutSegments = useSelectedLayoutSegments(parallelRouteKey) const selectedLayoutSegments = useSelectedLayoutSegments(parallelRouteKey)
if (selectedLayoutSegments.length === 0) { if (selectedLayoutSegments.length === 0) {
throw new Error('No selected layout segment below the current level') return null
} }
return selectedLayoutSegments[0] return selectedLayoutSegments[0]
......
'use client' 'use client'
import { useSelectedLayoutSegments } from 'next/navigation' import {
useSelectedLayoutSegments,
useSelectedLayoutSegment,
} from 'next/navigation'
export default function Page() { export default function Page() {
const selectedLayoutSegment = useSelectedLayoutSegments() const selectedLayoutSegments = useSelectedLayoutSegments()
const selectedLayoutSegment = useSelectedLayoutSegment()
return ( return (
<p id="page-layout-segments">{JSON.stringify(selectedLayoutSegment)}</p> <>
<p id="page-layout-segments">{JSON.stringify(selectedLayoutSegments)}</p>
<p id="page-layout-segment">{JSON.stringify(selectedLayoutSegment)}</p>
</>
) )
} }
'use client' 'use client'
import { useSelectedLayoutSegments } from 'next/navigation' import {
useSelectedLayoutSegments,
useSelectedLayoutSegment,
} from 'next/navigation'
export default function Layout({ children }) { export default function Layout({ children }) {
const selectedLayoutSegment = useSelectedLayoutSegments() const selectedLayoutSegments = useSelectedLayoutSegments()
const selectedLayoutSegment = useSelectedLayoutSegment()
return ( return (
<> <>
<p id="inner-layout">{JSON.stringify(selectedLayoutSegment)}</p> <p id="inner-layout">{JSON.stringify(selectedLayoutSegments)}</p>
<p id="inner-layout-segment">{JSON.stringify(selectedLayoutSegment)}</p>
{children} {children}
</> </>
) )
......
'use client' 'use client'
import { useSelectedLayoutSegments } from 'next/navigation' import {
useSelectedLayoutSegments,
useSelectedLayoutSegment,
} from 'next/navigation'
export default function Layout({ children }) { export default function Layout({ children }) {
const selectedLayoutSegment = useSelectedLayoutSegments() const selectedLayoutSegments = useSelectedLayoutSegments()
const selectedLayoutSegment = useSelectedLayoutSegment()
return ( return (
<> <>
<p id="outer-layout">{JSON.stringify(selectedLayoutSegment)}</p> <p id="outer-layout">{JSON.stringify(selectedLayoutSegments)}</p>
<p id="outer-layout-segment">{JSON.stringify(selectedLayoutSegment)}</p>
{children} {children}
</> </>
) )
......
...@@ -1273,7 +1273,7 @@ describe('app dir', () => { ...@@ -1273,7 +1273,7 @@ describe('app dir', () => {
} }
}) })
describe('useSelectedLayoutSegment', () => { describe('useSelectedLayoutSegments', () => {
it.each` it.each`
path | outerLayout | innerLayout path | outerLayout | innerLayout
${'/hooks/use-selected-layout-segment/first'} | ${['first']} | ${[]} ${'/hooks/use-selected-layout-segment/first'} | ${['first']} | ${[]}
...@@ -1303,6 +1303,38 @@ describe('app dir', () => { ...@@ -1303,6 +1303,38 @@ describe('app dir', () => {
expect(JSON.parse($('#page-layout-segments').text())).toEqual([]) expect(JSON.parse($('#page-layout-segments').text())).toEqual([])
}) })
}) })
describe('useSelectedLayoutSegment', () => {
it.each`
path | outerLayout | innerLayout
${'/hooks/use-selected-layout-segment/first'} | ${'first'} | ${null}
${'/hooks/use-selected-layout-segment/first/slug1'} | ${'first'} | ${'slug1'}
${'/hooks/use-selected-layout-segment/first/slug2/second/a/b'} | ${'first'} | ${'slug2'}
`(
'should have the correct layout segment at $path',
async ({ path, outerLayout, innerLayout }) => {
const html = await renderViaHTTP(next.url, path)
const $ = cheerio.load(html)
expect(JSON.parse($('#outer-layout-segment').text())).toEqual(
outerLayout
)
expect(JSON.parse($('#inner-layout-segment').text())).toEqual(
innerLayout
)
}
)
it('should return null in pages', async () => {
const html = await renderViaHTTP(
next.url,
'/hooks/use-selected-layout-segment/first/slug2/second/a/b'
)
const $ = cheerio.load(html)
expect(JSON.parse($('#page-layout-segment').text())).toEqual(null)
})
})
}) })
if (isDev) { if (isDev) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment