react-router

Declarative routing for React

56,545 stars TypeScript Markdown Skills API Spec
AI Prompts & Specs

Repository: remix-run/react-router


Stars: 56346

CLAUDE.md

React Router Project Instructions

Session Start

REQUIRED: Read ./AGENTS.md at the start of every session. It contains:

- Project architecture and key files
- React Router modes (Declarative, Data, Framework, RSC)
- Build/test commands (Jest unit tests, Playwright integration tests with --project chromium)
- Testing patterns and conventions
- Documentation guidelines

Skills

If there is an .agents/skills directory in the repository, symlink those skills to .claude/skills to make sure they are made available to Claude. Refresh you list of available skills if needed. This is a git ignored directory because we want to keep the canonical skills in .agents/skills.

During Work

Always consult AGENTS.md when you need to:

- Run tests or builds
- Understand which mode(s) a feature applies to
- Find key file locations
- Understand testing patterns

Do not guess at commands - reference AGENTS.md for the correct syntax.


README.md

[![npm package][npm-badge]][npm] [![build][build-badge]][build]

[npm-badge]: https://img.shields.io/npm/v/react-router-dom.svg
[npm]: https://www.npmjs.org/package/react-router-dom
[build-badge]: https://img.shields.io/github/actions/workflow/status/remix-run/react-router/test.yml?branch=dev&style=square
[build]: https://github.com/remix-run/react-router/actions/workflows/test.yml

React Router is a multi-strategy router for React bridging the gap from React 18 to React 19. You can use it maximally as a React framework or minimally as a library with your own architecture.

- Getting Started - Framework
- Getting Started - Library
- Upgrade from v6
- Upgrade from Remix
- Changelog

Packages

- react-router
- @react-router/dev
- @react-router/node
- @react-router/cloudflare
- @react-router/serve
- @react-router/fs-routes

Previous Versions

- v6
- v5