TanStack / TanStack/router

feat(history): define safe access to Router-managed navigation entries

Open
#7,777 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
15.1k
Forks
1.9k
Avg merge
1d 20h
Merged PRs (30d)
143

Description

Include:

  • Define a non-breaking API for custom RouterHistory implementations.
  • Expose only entries Router can reliably know. Do not imply native browser-history enumeration.
  • Decide whether persistence is needed. If so, bound storage, validate data, and degrade safely when storage is unavailable.
  • Cover memory, browser, hash, reload, back/forward, blocked navigation, and external history mutations with unit and browser E2E tests.
  • Measure browser bundle impact.
  • Document semantics, limitations, and state-persistence expectations.

Related to closed #3524.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the custom RouterHistory implementations and compare memory, browser, and hash behavior across reload, back/forward, blocked navigation, and external history mutations. Add unit and browser E2E coverage, then assess browser bundle impact. Done means the API semantics, limitations, persistence expectations, validation, bounds, and safe degradation are documented and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend, performance, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.