import * as Solid from 'solid-js' import '@testing-library/jest-dom/vitest' import { afterEach, beforeEach, describe, expect, test } from 'vitest' import { cleanup, fireEvent, render, screen, waitFor, } from '@solidjs/testing-library' import { z } from 'zod' import { trailingSlashOptions } from '@tanstack/router-core' import { Outlet, RouterProvider, createBrowserHistory, createRootRoute, createRoute, createRouteMask, createRouter, getRouteApi, useNavigate, useParams, } from '../src' import type { RouterHistory } from '../src' let history: RouterHistory beforeEach(() => { history = createBrowserHistory() expect(window.location.pathname).toBe('/') }) afterEach(() => { history.destroy() window.history.replaceState(null, 'root', '/') cleanup() }) test('when navigating to /posts', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: '/posts', component: () => { return ( <>

Posts

) }, }) const router = createRouter({ routeTree: rootRoute.addChildren([indexRoute, postsRoute]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'Posts' }) fireEvent.click(postsButton) expect( await screen.findByRole('heading', { name: 'Posts' }), ).toBeInTheDocument() expect(window.location.pathname).toBe('/posts') }) test('when navigating from /posts to ./$postId', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', component: PostsComponent, }) const PostsIndexComponent = () => { const navigate = useNavigate() return ( <>

Posts Index

) } const postsIndexRoute = createRoute({ getParentRoute: () => postsRoute, path: '/', component: PostsIndexComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) const navigate = useNavigate() return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, postsRoute.addChildren([postsIndexRoute, postRoute]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'Posts' }) fireEvent.click(postsButton) expect(await screen.findByText('Posts Index')).toBeInTheDocument() const postButton = await screen.findByRole('button', { name: 'To the first post', }) fireEvent.click(postButton) expect(await screen.findByText('Params: id1')).toBeInTheDocument() expect(window.location.pathname).toBe('/posts/id1') }) test('when navigating from /posts to ../posts/$postId', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', component: PostsComponent, }) const PostsIndexComponent = () => { const navigate = useNavigate() return ( <>

Posts Index

) } const postsIndexRoute = createRoute({ getParentRoute: () => postsRoute, path: '/', component: PostsIndexComponent, }) const PostComponent = () => { const navigate = useNavigate() const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, postsRoute.addChildren([postsIndexRoute, postRoute]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'Posts' }) fireEvent.click(postsButton) expect(await screen.findByText('Posts Index')).toBeInTheDocument() const postButton = await screen.findByRole('button', { name: 'To the first post', }) fireEvent.click(postButton) expect(await screen.findByText('Params: id1')).toBeInTheDocument() }) test('when navigating from /posts/$postId to /posts/$postId/info and the current route is /posts/$postId/details', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const DetailsComponent = () => { const navigate = useNavigate() return ( <>

Details!

) } const detailsRoute = createRoute({ getParentRoute: () => postRoute, path: 'details', component: DetailsComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ postsRoute.addChildren([ postRoute.addChildren([detailsRoute, informationRoute]), ]), ]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postsButton) expect(await screen.findByText('Params: id1')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/details') const informationButton = await screen.findByRole('button', { name: 'To Information', }) fireEvent.click(informationButton) expect(await screen.findByText('Information')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/info') expect(await screen.findByText('Params: id1')) }) test('when navigating from /posts/$postId to ./info and the current route is /posts/$postId/details', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const DetailsComponent = () => { const navigate = useNavigate() return ( <>

Details!

) } const detailsRoute = createRoute({ getParentRoute: () => postRoute, path: 'details', component: DetailsComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ postsRoute.addChildren([ postRoute.addChildren([detailsRoute, informationRoute]), ]), ]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postsButton) expect(await screen.findByText('Params: id1')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/details') const informationButton = await screen.findByRole('button', { name: 'To Information', }) fireEvent.click(informationButton) expect(await screen.findByText('Information')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/info') expect(await screen.findByText('Params: id1')) }) test('when navigating from /posts/$postId to ../$postId and the current route is /posts/$postId/details', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const DetailsComponent = () => { const navigate = useNavigate() return ( <>

Details!

) } const detailsRoute = createRoute({ getParentRoute: () => postRoute, path: 'details', component: DetailsComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ postsRoute.addChildren([ postRoute.addChildren([detailsRoute, informationRoute]), ]), ]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postsButton) expect(await screen.findByText('Params: id1')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/details') const postButton = await screen.findByRole('button', { name: 'To Post', }) fireEvent.click(postButton) expect(await screen.findByText('Posts')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1') }) test('when navigating from /posts/$postId with an index to ../$postId and the current route is /posts/$postId/details', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const postIndexRoute = createRoute({ getParentRoute: () => postRoute, path: '/', component: () =>

Post Index

, }) const DetailsComponent = () => { const navigate = useNavigate() return ( <>

Details!

) } const detailsRoute = createRoute({ getParentRoute: () => postRoute, path: 'details', component: DetailsComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ postsRoute.addChildren([ postRoute.addChildren([ postIndexRoute, detailsRoute, informationRoute, ]), ]), ]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postsButton) expect(await screen.findByText('Params: id1')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/details') const postButton = await screen.findByRole('button', { name: 'To Post', }) fireEvent.click(postButton) expect(await screen.findByText('Posts')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1') }) test('when navigating from /invoices to ./invoiceId and the current route is /posts/$postId/details', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const DetailsComponent = () => { const navigate = useNavigate() const [error, setError] = Solid.createSignal() return ( <>

Details!

Something went wrong! ) } const detailsRoute = createRoute({ getParentRoute: () => postRoute, path: 'details', component: DetailsComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const invoicesRoute = createRoute({ getParentRoute: () => rootRoute, path: 'invoices', component: () => ( <>

Invoices!

), }) const InvoiceComponent = () => { const params = useParams({ strict: false }) return ( <> invoiceId: {params().invoiceId} ) } const invoiceRoute = createRoute({ getParentRoute: () => invoicesRoute, path: '$invoiceId', component: InvoiceComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ invoicesRoute.addChildren([invoiceRoute]), postsRoute.addChildren([ postRoute.addChildren([detailsRoute, informationRoute]), ]), ]), ]), }) render(() => ) const postsButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postsButton) const invoicesButton = await screen.findByRole('button', { name: 'To Invoices', }) fireEvent.click(invoicesButton) expect(await screen.findByText('Something went wrong!')).toBeInTheDocument() }) test('when navigating to /posts/$postId/info which is masked as /posts/$postId', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const routeTree = rootRoute.addChildren([ indexRoute, postsRoute.addChildren([postRoute.addChildren([informationRoute])]), ]) const routeMask = createRouteMask({ routeTree, from: '/posts/$postId/info', to: '/posts', }) const router = createRouter({ routeTree, routeMasks: [routeMask], }) render(() => ) const postButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postButton) await new Promise((r) => setTimeout(r, 0)) expect(await screen.findByText('Params: id1')) }) test('when navigating to /posts/$postId/info which is imperatively masked as /posts/$postId', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const PostsComponent = () => { return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const InformationComponent = () => { return ( <>

Information

) } const informationRoute = createRoute({ getParentRoute: () => postRoute, path: 'info', component: InformationComponent, }) const routeTree = rootRoute.addChildren([ indexRoute, postsRoute.addChildren([postRoute.addChildren([informationRoute])]), ]) const router = createRouter({ routeTree, }) render(() => ) const postButton = await screen.findByRole('button', { name: 'To first post', }) fireEvent.click(postButton) expect(await screen.findByText('Information')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1') }) test('when setting search params with 2 parallel navigate calls', async () => { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() const search = indexRoute.useSearch() return ( <>

Index

{search().param1}
{search().param2}
) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, validateSearch: z.object({ param1: z.string().default('param1-default'), param2: z.string().default('param2-default'), }), }) // console.log(indexRoute.options.validateSearch) const router = createRouter({ routeTree: rootRoute.addChildren([indexRoute]), }) render(() => ) // Wait for router to initialize with defaults await screen.findByTestId('param1') // console.log(router.state.location) expect(router.state.location.search).toEqual({ param1: 'param1-default', param2: 'param2-default', }) const postsButton = await screen.findByRole('button', { name: 'search' }) fireEvent.click(postsButton) await new Promise((r) => setTimeout(r, 0)) expect(await screen.findByTestId('param1')).toHaveTextContent('foo') expect(await screen.findByTestId('param2')).toHaveTextContent('bar') expect(router.state.location.search).toEqual({ param1: 'foo', param2: 'bar' }) const search = new URLSearchParams(window.location.search) expect(search.get('param1')).toEqual('foo') expect(search.get('param2')).toEqual('bar') }) describe('when on /posts/$postId and navigating to ../ with default `from` /posts', () => { async function runTest(navigateVia: 'Route' | 'RouteApi') { const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { const routeNavigate = postsRoute.useNavigate() const routeApiNavigate = getRouteApi('/_layout/posts').useNavigate() return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const PostIndexComponent = () => { return ( <>

Post Index

) } const postIndexRoute = createRoute({ getParentRoute: () => postRoute, path: '/', component: PostIndexComponent, }) const DetailsComponent = () => { return ( <>

Details!

) } const detailsRoute = createRoute({ getParentRoute: () => postRoute, path: 'details', component: DetailsComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ postsRoute.addChildren([ postRoute.addChildren([postIndexRoute, detailsRoute]), ]), ]), ]), }) render(() => ) const postsButton = await screen.findByTestId('index-to-first-post-btn') fireEvent.click(postsButton) expect(await screen.findByTestId('details-heading')).toBeInTheDocument() expect(window.location.pathname).toEqual('/posts/id1/details') const homeButton = await screen.findByTestId('btn-to-home') fireEvent.click(homeButton) expect(await screen.findByTestId('index-heading')).toBeInTheDocument() expect(window.location.pathname).toEqual('/') } test('Route', () => runTest('Route')) test('RouteApi', () => runTest('RouteApi')) }) describe.each([{ basepath: '' }, { basepath: '/basepath' }])( 'relative useNavigate with %s', ({ basepath }) => { const setupRouter = () => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: () => { return

Index Route

}, }) const aRoute = createRoute({ getParentRoute: () => rootRoute, path: 'a', component: () => { return ( <>

A Route

) }, }) const bRoute = createRoute({ getParentRoute: () => aRoute, path: 'b', component: function BRoute() { const navigate = useNavigate() return ( <>

B Route

) }, }) const paramRoute = createRoute({ getParentRoute: () => rootRoute, path: 'param/$param', component: function ParamRoute() { const navigate = useNavigate() return ( <>

Param Route

) }, }) const paramARoute = createRoute({ getParentRoute: () => paramRoute, path: 'a', component: function ParamARoute() { const navigate = useNavigate() return ( <>

Param A Route

) }, }) const paramBRoute = createRoute({ getParentRoute: () => paramARoute, path: 'b', component: function ParamBRoute() { const navigate = useNavigate() return ( <>

Param B Route

) }, }) return createRouter({ routeTree: rootRoute.addChildren([ indexRoute, aRoute.addChildren([bRoute]), paramRoute.addChildren([paramARoute, paramBRoute]), ]), basepath: basepath === '' ? undefined : basepath, }) } test('should navigate to the parent route', async () => { const router = setupRouter() // Navigate to /a/b window.history.replaceState(null, 'root', `${basepath}/a/b`) render(() => ) // Inspect the link to go up a parent const parentLink = await screen.findByText('Link to Parent') // Click the link and ensure the new location fireEvent.click(parentLink) await waitFor(() => expect(window.location.pathname).toBe(`${basepath}/a`), ) }) test('should navigate to the parent route and keep params', async () => { const router = setupRouter() // Navigate to /param/oldParamValue/a/b window.history.replaceState(null, 'root', `${basepath}/param/foo/a/b`) render(() => ) // Inspect the link to go up a parent and keep the params const parentLink = await screen.findByText('Link to Parent') // Click the link and ensure the new location fireEvent.click(parentLink) await waitFor(() => expect(window.location.pathname).toBe(`${basepath}/param/foo/a`), ) }) test('should navigate to the parent route and change params', async () => { const router = setupRouter() // Navigate to /param/oldParamValue/a/b window.history.replaceState(null, 'root', `${basepath}/param/foo/a/b`) render(() => ) // Inspect the link to go up a parent and keep the params const parentLink = await screen.findByText( 'Link to Parent with param:bar', ) // Click the link and ensure the new location fireEvent.click(parentLink) await waitFor(() => expect(window.location.pathname).toBe(`${basepath}/param/bar/a`), ) }) test('should navigate to a relative link based on render location with basepath', async () => { const router = setupRouter() window.history.replaceState(null, 'root', `${basepath}/param/foo/a/b`) render(() => ) // Inspect the relative link to ./a const relativeLink = await screen.findByText('Link to ./a') // Click the link and ensure the new location fireEvent.click(relativeLink) await waitFor(() => expect(window.location.pathname).toBe(`${basepath}/param/foo/a`), ) }) test('should navigate to a parent link based on render location', async () => { const router = setupRouter() window.history.replaceState(null, 'root', `${basepath}/param/foo/a/b`) render(() => ) // Inspect the relative link to ./a const relativeLink = await screen.findByText( 'Link to .. from /param/foo/a', ) // Click the link and ensure the new location fireEvent.click(relativeLink) await waitFor(() => expect(window.location.pathname).toBe(`${basepath}/param/foo`), ) }) test('should navigate to a parent link based on active location', async () => { const router = setupRouter() render(() => ) window.history.replaceState(null, 'root', `${basepath}/param/foo/a/b`) const relativeLink = await screen.findByTestId('link-to-previous') // Click the link and ensure the new location fireEvent.click(relativeLink) await waitFor(() => expect(window.location.pathname).toBe(`${basepath}/param/foo/a`), ) }) test('should navigate to same route with different params', async () => { const router = setupRouter() window.history.replaceState(null, 'root', `${basepath}/param/foo/a/b`) render(() => ) const parentLink = await screen.findByText('Link to . with param:bar') fireEvent.click(parentLink) await waitFor( () => expect(window.location.pathname).toBe(`${basepath}/param/bar/a/b`), {}, ) }) }, ) describe('relative navigate to current route', () => { test.each([true, false])( 'should navigate to current route with search params when using "." in nested route structure from Index Route with trailingSlash: %s', async (trailingSlash: boolean) => { const tail = trailingSlash ? '/' : '' const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <> ) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, validateSearch: z.object({ param1: z.string().optional(), }), }) const postRoute = createRoute({ getParentRoute: () => indexRoute, path: 'post', component: () =>
Post
, }) const router = createRouter({ routeTree: rootRoute.addChildren([indexRoute, postRoute]), history, trailingSlash: trailingSlash ? 'always' : 'never', }) render(() => ) const postButton = await screen.findByTestId('posts-btn') fireEvent.click(postButton) await waitFor(() => { expect(router.state.location.pathname).toBe(`/post${tail}`) }) const searchButton = await screen.findByTestId('search-btn') fireEvent.click(searchButton) await waitFor(() => { expect(router.state.location.pathname).toBe(`/post${tail}`) expect(router.state.location.search).toEqual({ param1: 'value1' }) }) const searchButton2 = await screen.findByTestId('search2-btn') fireEvent.click(searchButton2) await waitFor(() => { expect(router.state.location.pathname).toBe(`/post${tail}`) expect(router.state.location.search).toEqual({ param1: 'value2' }) }) }, ) test.each([true, false])( 'should navigate to current route with changing path params when using "." in nested route structure with trailingSlash: %s', async (trailingSlash) => { const tail = trailingSlash ? '/' : '' const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { const navigate = useNavigate() return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const PostComponent = () => { const params = useParams({ strict: false }) return ( <> Params: {params().postId} ) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([postsRoute.addChildren([postRoute])]), ]), trailingSlash: trailingSlash ? 'always' : 'never', }) render(() => ) const postsButton = await screen.findByTestId('posts-btn') fireEvent.click(postsButton) await waitFor(() => { expect(screen.queryByTestId('posts-index-heading')).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts${tail}`) }) const firstPostButton = await screen.findByTestId('first-post-btn') fireEvent.click(firstPostButton) await waitFor(() => { expect(screen.queryByTestId('post-id1')).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/id1${tail}`) }) const secondPostButton = await screen.findByTestId('second-post-btn') fireEvent.click(secondPostButton) await waitFor(() => { expect(screen.queryByTestId('post-id2')).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/id2${tail}`) }) }, ) test.each([true, false])( 'should navigate to current route with search params when using "." in nested route structure from non-Index Route with trailingSlash: %s', async (trailingSlash) => { const tail = trailingSlash ? '/' : '' const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const PostsComponent = () => { const navigate = postsRoute.useNavigate() return ( <>

Posts

) } const postsRoute = createRoute({ getParentRoute: () => rootRoute, path: 'posts', component: PostsComponent, }) const useModal = (name: string) => { const currentOpen = postRoute.useSearch({ select: (search) => search[`_${name}`], }) const navigate = useNavigate() const setModal = (open: boolean) => { navigate({ to: '.', search: (prev: {}) => ({ ...prev, [`_${name}`]: open ? true : undefined, }), resetScroll: false, }) } return [currentOpen, setModal] as const } function DetailComponent(props: { id: string }) { const params = useParams({ strict: false }) const [currentTest, setTest] = useModal('test') return ( <>
Post Path "/{params().postId}/detail-{props.id}"!
{currentTest() ? ( ) : ( )} ) } const PostComponent = () => { const params = useParams({ strict: false }) return (
Post "{params().postId}"!
) } const postRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostComponent, validateSearch: z.object({ _test: z.boolean().optional(), }), }) const detailRoute = createRoute({ getParentRoute: () => postRoute, path: 'detail', component: () => , }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, postsRoute.addChildren([postRoute.addChildren([detailRoute])]), ]), trailingSlash: trailingSlash ? 'always' : 'never', }) render(() => ) const postsButton = await screen.findByTestId('posts-btn') fireEvent.click(postsButton) await waitFor(() => { expect(screen.queryByTestId('posts-index-heading')).toBeInTheDocument() }) const post1Button = await screen.findByTestId('first-post-btn') fireEvent.click(post1Button) await waitFor(() => { expect(screen.queryByTestId('post-heading')).toBeInTheDocument() expect(screen.queryByTestId('detail-heading-1')).toBeInTheDocument() expect(screen.queryByTestId('detail-heading-2')).toBeInTheDocument() expect(screen.queryByTestId('detail-heading-1')).toHaveTextContent( 'Post Path "/id1/detail-1', ) expect(screen.queryByTestId('detail-heading-2')).toHaveTextContent( 'Post Path "/id1/detail-2', ) }) const detail1AddBtn = await screen.findByTestId('detail-btn-add-1') fireEvent.click(detail1AddBtn) await waitFor(() => { expect(router.state.location.pathname).toBe(`/posts/id1/detail${tail}`) expect(router.state.location.search).toEqual({ _test: true }) }) const detail1RemoveBtn = await screen.findByTestId('detail-btn-remove-1') fireEvent.click(detail1RemoveBtn) await waitFor(() => { expect(router.state.location.pathname).toBe(`/posts/id1/detail${tail}`) expect(router.state.location.search).toEqual({}) }) const detail2AddBtn = await screen.findByTestId('detail-btn-add-2') fireEvent.click(detail2AddBtn) await waitFor(() => { expect(router.state.location.pathname).toBe(`/posts/id1/detail${tail}`) expect(router.state.location.search).toEqual({ _test: true }) }) }, ) }) describe('relative navigate to from route', () => { test.each([true, false])( 'should navigate to from route when using "." in nested route structure from Index Route with trailingSlash: %s', async (trailingSlash: boolean) => { const tail = trailingSlash ? '/' : '' const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <> ) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, validateSearch: z.object({ param1: z.string().optional(), }), }) const postRoute = createRoute({ getParentRoute: () => indexRoute, path: 'post', component: () =>
Post
, }) const router = createRouter({ routeTree: rootRoute.addChildren([indexRoute, postRoute]), history, trailingSlash: trailingSlash ? 'always' : 'never', }) render(() => ) const postButton = await screen.findByTestId('posts-btn') fireEvent.click(postButton) await waitFor(() => { expect(router.state.location.pathname).toBe(`/post${tail}`) }) const searchButton = await screen.findByTestId('search-btn') fireEvent.click(searchButton) await waitFor(() => { expect(router.state.location.pathname).toBe(`/post${tail}`) expect(router.state.location.search).toEqual({ param1: 'value1' }) }) const homeBtn = await screen.findByTestId('home-btn') fireEvent.click(homeBtn) await waitFor(() => { expect(router.state.location.pathname).toBe(`/`) expect(router.state.location.search).toEqual({}) }) }, ) test.each([true, false])( 'should navigate to from route with path params when using "." in nested route structure with trailingSlash: %s', async (trailingSlash) => { const tail = trailingSlash ? '/' : '' const rootRoute = createRootRoute() const IndexComponent = () => { const navigate = useNavigate() return ( <>

Index

) } const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) const layoutRoute = createRoute({ getParentRoute: () => rootRoute, id: '_layout', component: () => { return ( <>

Layout

) }, }) const PostsComponent = () => { const navigate = postsRoute.useNavigate() return ( <>

Posts

) } const PostDetailComponent = () => { const navigate = postDetailRoute.useNavigate() return ( <>

Post Detail

) } const PostInfoComponent = () => { return ( <>

Post Info

) } const PostNotesComponent = () => { return ( <>

Post Notes

) } const postsRoute = createRoute({ getParentRoute: () => layoutRoute, path: 'posts', component: PostsComponent, }) const postDetailRoute = createRoute({ getParentRoute: () => postsRoute, path: '$postId', component: PostDetailComponent, }) const postInfoRoute = createRoute({ getParentRoute: () => postDetailRoute, path: 'info', component: PostInfoComponent, }) const postNotesRoute = createRoute({ getParentRoute: () => postDetailRoute, path: 'notes', component: PostNotesComponent, }) const router = createRouter({ routeTree: rootRoute.addChildren([ indexRoute, layoutRoute.addChildren([ postsRoute.addChildren([ postDetailRoute.addChildren([postInfoRoute, postNotesRoute]), ]), ]), ]), trailingSlash: trailingSlash ? 'always' : 'never', }) render(() => ) const postsButton = await screen.findByTestId('posts-btn') fireEvent.click(postsButton) await waitFor(() => { expect(screen.queryByTestId('posts-index-heading')).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts${tail}`) }) const firstPostButton = await screen.findByTestId('first-post-btn') fireEvent.click(firstPostButton) await waitFor(() => { expect( screen.queryByTestId('post-detail-index-heading'), ).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/1${tail}`) }) const postInfoButton = await screen.findByTestId('post-info-btn') fireEvent.click(postInfoButton) await waitFor(() => { expect(screen.queryByTestId('post-info-heading')).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/1/info${tail}`) }) const toPostDetailIndexButton = await screen.findByTestId( 'to-post-detail-index-btn', ) fireEvent.click(toPostDetailIndexButton) await waitFor(() => { expect( screen.queryByTestId('post-detail-index-heading'), ).toBeInTheDocument() expect( screen.queryByTestId('post-info-heading'), ).not.toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/1${tail}`) }) const postNotesButton = await screen.findByTestId('post-notes-btn') fireEvent.click(postNotesButton) await waitFor(() => { expect(screen.queryByTestId('post-notes-heading')).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/1/notes${tail}`) }) const toPostsIndexButton = await screen.findByTestId('to-posts-index-btn') fireEvent.click(toPostsIndexButton) await waitFor(() => { expect(screen.queryByTestId('posts-index-heading')).toBeInTheDocument() expect( screen.queryByTestId('post-notes-heading'), ).not.toBeInTheDocument() expect( screen.queryByTestId('post-detail-index-heading'), ).not.toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts${tail}`) }) const secondPostButton = await screen.findByTestId('second-post-btn') fireEvent.click(secondPostButton) await waitFor(() => { expect( screen.queryByTestId('post-detail-index-heading'), ).toBeInTheDocument() expect(window.location.pathname).toEqual(`/posts/2${tail}`) }) }, ) }) describe('splat routes with empty splat', () => { test.each(Object.values(trailingSlashOptions))( 'should handle empty _splat parameter with trailingSlash: %s', async (trailingSlash) => { const tail = trailingSlash === 'always' ? '/' : '' const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: function IndexComponent() { const navigate = useNavigate() return ( <>

Index Route

) }, }) const splatRoute = createRoute({ getParentRoute: () => rootRoute, path: 'splat/$', component: () => { return

Splat Route

}, }) const router = createRouter({ routeTree: rootRoute.addChildren([indexRoute, splatRoute]), history, trailingSlash, }) render(() => ) // Navigate with empty _splat const splatBtnWithEmptySplat = await screen.findByTestId( 'splat-btn-with-empty-splat', ) fireEvent.click(splatBtnWithEmptySplat) await waitFor(async () => { expect(window.location.pathname).toBe(`/splat${tail}`) expect(await screen.findByText('Splat Route')).toBeInTheDocument() }) // Navigate back to index history.push('/') // Navigate with undefined _splat const splatBtnWithUndefinedSplat = await screen.findByTestId( 'splat-btn-with-undefined-splat', ) fireEvent.click(splatBtnWithUndefinedSplat) await waitFor(async () => { expect(window.location.pathname).toBe(`/splat${tail}`) expect(await screen.findByText('Splat Route')).toBeInTheDocument() }) // Navigate back to index history.push('/') // Navigate with no _splat const splatBtnWithNoSplat = await screen.findByTestId( 'splat-btn-with-no-splat', ) fireEvent.click(splatBtnWithNoSplat) await waitFor(async () => { expect(window.location.pathname).toBe(`/splat${tail}`) expect(await screen.findByText('Splat Route')).toBeInTheDocument() }) }, ) }) describe('encoded and unicode paths', () => { const testCases = [ { name: 'with prefix', path: '/foo/prefix@λŒ€{$}', expectedPath: '/foo/prefix@%EB%8C%80test[s%5C/.%5C/parameter%25!%F0%9F%9A%80%40]', expectedLocation: '/foo/prefix@λŒ€test[s%5C/.%5C/parameter%25!πŸš€%40]', params: { _splat: 'test[s\\/.\\/parameter%!πŸš€@]', '*': 'test[s\\/.\\/parameter%!πŸš€@]', }, }, { name: 'with suffix', path: '/foo/{$}λŒ€suffix@', expectedPath: '/foo/test[s%5C/.%5C/parameter%25!%F0%9F%9A%80%40]%EB%8C%80suffix@', expectedLocation: '/foo/test[s%5C/.%5C/parameter%25!πŸš€%40]λŒ€suffix@', params: { _splat: 'test[s\\/.\\/parameter%!πŸš€@]', '*': 'test[s\\/.\\/parameter%!πŸš€@]', }, }, { name: 'with wildcard', path: '/foo/$', expectedPath: '/foo/test[s%5C/.%5C/parameter%25!%F0%9F%9A%80]', expectedLocation: '/foo/test[s%5C/.%5C/parameter%25!πŸš€]', params: { _splat: 'test[s\\/.\\/parameter%!πŸš€]', '*': 'test[s\\/.\\/parameter%!πŸš€]', }, }, // '/' is left as is with splat params but encoded with normal params { name: 'with path param', path: `/foo/$id`, expectedPath: '/foo/test[s%5C%2F.%5C%2Fparameter%25!%F0%9F%9A%80%40]', expectedLocation: '/foo/test[s%5C%2F.%5C%2Fparameter%25!πŸš€%40]', params: { id: 'test[s\\/.\\/parameter%!πŸš€@]', }, }, ] test.each(testCases)( 'should handle encoded, decoded paths with unicode characters correctly - $name', async ({ path, expectedPath, expectedLocation, params }) => { const rootRoute = createRootRoute() const indexRoute = createRoute({ getParentRoute: () => rootRoute, path: '/', component: IndexComponent, }) function IndexComponent() { const navigate = useNavigate() return ( <>

Index Route

) } const pathRoute = createRoute({ getParentRoute: () => rootRoute, path, component: PathRouteComponent, }) function PathRouteComponent() { const params = pathRoute.useParams() return (

Path Route

params:{' '} {JSON.stringify(params())}

) } const router = createRouter({ routeTree: rootRoute.addChildren([indexRoute, pathRoute]), history, }) render(() => ) const link = await screen.findByTestId('btn-to-path') fireEvent.click(link) await waitFor(async () => { const paramsToValidate = await screen.findByTestId('params-to-validate') expect(window.location.pathname).toBe(expectedPath) expect(router.latestLocation.pathname).toBe(expectedLocation) expect(paramsToValidate.textContent).toEqual(JSON.stringify(params)) }) }, ) })