Skip to content
Source
Sign inSign up
TanStack/router

Documentation Getting Started Flow - auto file gen can get users stuck #5351

Send to my agent
Openparadoxloop(GitHub profile, opens in a new tab) opened this issue 2 comments

Which project does this relate to?

Router

Describe the bug

New user follows the getting started flow "build from scratch" can get stuck with with dynamic paths "not working" because the posts.tsx which is meant to be a layout route in the example is auto filled with a page code.

There is nothing wrong with the code here it can just lead to a poor first experience of the framework.

Auto Filled posts.tsx

import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/posts')({
    component: RouteComponent,
})

function RouteComponent() {
    return <div>Hello "/posts"!</div>
}

Potential solutions:

  • Improve the documentation to clearly explain that users need to adjust the generated posts.tsx with an for dynamic routes to work; or
  • Alternatively, change the auto-generated content for layout routes so it better reflects their intended use in the tutorial flow.

This would help prevent misunderstandings for first-time users.

Your Example Website or App

NA

Steps to Reproduce the Bug or Issue

How to reproduce:

  1. Following getting started guide
  2. Under Routing / Creating File Routes create the files in the order they are listed posts.tsx -> posts/index.tsx -> posts/$postId.tsx
  3. Check whether the dev server has auto filled the files with RouteComponents
  4. Navigate to localhost:3000/posts/10

Expected behavior

When dev app is running the dynamic url (posts/$postId.tsx) does not appear to be working because the posts.tsx captures all requests rather than being a layout route.

This is not a great experience for someone first exposure to the Tanstack framework.

Screenshots or Videos

Image

Platform

NA

Additional context

No response

  1. LadyBluenotes(GitHub profile, opens in a new tab) added labelsgood first issue

  2. 'd like to work on this issue. I plan to update the React routing documentation to clarify the behavior of generated parent/layout routes and explain when is required for nested and dynamic routes. I'll also add a small example showing the expected posts.tsx, posts/index.tsx, and posts/$postId.tsx structure.

  3. I'd like to work on this issue. I plan to update the React routing documentation to clarify the behavior of generated parent/layout routes and explain when <Outlet /> is required for nested and dynamic routes. I'll also add a small example showing the expected posts.tsx, posts/index.tsx, and posts/$postId.tsx structure.

Sign in to join this conversation.