Skip to content

docs(how-to/file-route-conventions): clarify 404 response code in catch-all section #13771

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

Merged
timdorr merged 2 commits into from
Jun 6, 2025
Merged

docs(how-to/file-route-conventions): clarify 404 response code in catch-all section #13771

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e214e3d
clarify 404 response code
davidbielik Jun 6, 2025
ecdb888
Update file-route-conventions.md
davidbielik Jun 6, 2025
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
9 changes: 9 additions & 0 deletions docs/how-to/file-route-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,15 @@ To create a route that will match any requests that don't match other defined ro
| `/about` | `app/routes/about.tsx` |
| `/any-invalid-path-will-match` | `app/routes/$.tsx` |

To have this route serve as a 404 page, be sure to modify the response code with a [`loader`](https://reactrouter.com/start/framework/data-loading#server-data-loading) function:

```tsx
import type { Route } from './+types/$';
export const loader = async ({ request }: Route.LoaderArgs) => {
return data({}, 404);
};
```

## Escaping Special Characters

If you want one of the special characters used for these route conventions to actually be a part of the URL, you can escape the conventions with `[]` characters. This can be especially helpful for [resource routes][resource_routes] that include an extension in the URL.
Expand Down