tanstack-react-router_api

A reference for TanStack Router's TypeScript types, including options for links, active-link styling, and asynchronously loaded route components.

In plain words
What is it for?
Use it while writing or checking TanStack Router code that styles active links or preloads split route components.
Why use it?
It explains the exact fields and types available when linking between screens or loading route code on demand.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/webmcp-org/webmcp-sh/tanstack-react-router_api
Clone the repo
git clone --depth 1 https://github.com/WebMCP-org/webmcp-sh

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 32,397 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.32397
Opus 5 $0.00000 $0.16199
Sonnet 5 $0.00000 $0.06479
Haiku 4.5 $0.00000 $0.03240

Measured 2d ago against content hash 5261d1d9b8d5, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

tanstack-react-router_api scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to tanstack-react-router_api — 317 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.cursor/rules/tanstack-react-router_api.mdc · 4,337 lines

How it starts

The opening of the file, as written. The whole thing — 4,337 lines — stays where its author put it; the contents beside it link to each section on GitHub.

ActiveLinkOptions type

The ActiveLinkOptions type extends the LinkOptions type and contains additional options that can be used to describe how a link should be styled when it is active.

type ActiveLinkOptions = LinkOptions & {
  activeProps?:
    | React.AnchorHTMLAttributes<HTMLAnchorElement>
    | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>)
  inactiveProps?:
    | React.AnchorHTMLAttributes<HTMLAnchorElement>
    | (() => React.AnchorHTMLAttributes<HTMLAnchorElement>)
}

ActiveLinkOptions properties

The ActiveLinkOptions object accepts/contains the following properties:

activeProps

  • React.AnchorHTMLAttributes<HTMLAnchorElement>
  • Optional
  • The props that will be applied to the anchor element when the link is active

inactiveProps

  • Type: React.AnchorHTMLAttributes<HTMLAnchorElement>
  • Optional
  • The props that will be applied to the anchor element when the link is inactive

AsyncRouteComponent type

The AsyncRouteComponent type is used to describe a code-split route component that can be preloaded using a component.preload() method.

type AsyncRouteComponent<TProps> = SyncRouteComponent<TProps> & {
  preload?: () => Promise<void>
}

FileRoute class

[!CAUTION] This class has been deprecated and will be removed in the next major version of TanStack Router. Please use the createFileRoute function instead.

The FileRoute class is a factory that can be used to create a file-based route instance. This route instance can then be used to automatically generate a route tree with the tsr generate and tsr watch commands.

FileRoute constructor

The FileRoute constructor accepts a single argument: the path of the file that the route will be generated for.

Constructor options

  • Type: string literal
  • Required, but automatically inserted and updated by the tsr generate and tsr watch commands.
  • The full path of the file that the route will be generated from.

Read the full file on GitHub · 4,337 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 4,337 lines · 32,397 tokens per session scan A 5261d1d9b8d5

Subscribe to this mod's changes

tanstack-react-router_api is a cursor rule published in the GitHub repository WebMCP-org/webmcp-sh (17 stars, last pushed 2mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 32,397 tokens. A static security scan graded it A with 0 findings. It is 100% identical to tanstack-react-router_api, differing in 317 lines, and is treated as a copy.