docs(router): URL encoding note on <Link/> and how to opt out by bodadotsh · Pull Request #6443 · TanStack/router

bodadotsh · 2026-01-21T19:45:34Z

Took me weeks to find out about the config option pathParamsAllowedCharacters, otherwise I was trying some hack to stop the encoding in the URL path params.

Summary by CodeRabbit

Documentation
- Clarified that special characters in URL parameters are URL-encoded by default (e.g., "@" → "%40").
- Added examples demonstrating how encoded paths appear at runtime.
- Documented how to opt out or customize parameter encoding via router configuration, including a usage example for the configuration option.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

…aramsAllowedCharacters

coderabbitai · 2026-01-21T19:46:09Z

📝 Walkthrough

Walkthrough

Adds documentation clarifying that the Link component URL-encodes path parameter values (e.g., @ → %40) by default and provides an example plus an opt-out snippet using pathParamsAllowedCharacters to allow unencoded characters.

Changes

Cohort / File(s)	Summary
Documentation Updates `docs/router/framework/react/api/router/linkComponent.md`	Added notes showing default URL-encoding of Link path params with an example (`@` → `%40`) and included a code snippet demonstrating `pathParamsAllowedCharacters` to permit unencoded characters.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibble doc leaves in the moonlit code,
Transforming @ to %40 down the road,
A tweak to let wild characters play,
Hop, unescape, and brighten the way 🐇✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly describes the main change: adding documentation about URL encoding in the Link component and how to opt out via configuration.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/router/framework/react/api/router/linkComponent.md`:
- Line 46: Replace the non‑breaking hyphen character in the phrase "opt‑out"
with a standard hyphen-minus (U+002D); locate the occurrence near the mention of
the router config "pathParamsAllowedCharacters" and change "opt‑out" to
"opt-out" so text processing and searching behave correctly.

🧹 Nitpick comments (1)

docs/router/framework/react/api/router/linkComponent.md (1)
39-39: Improve sentence structure for clarity.

The current phrasing has awkward grammar with a missing article. Consider rephrasing for better readability:
📝 Suggested rephrasing options
-By default, passing param value with characters such as `@`, it will be encoded in the URL:
+By default, param values with characters such as `@` will be encoded in the URL:
Or alternatively:
-By default, passing param value with characters such as `@`, it will be encoded in the URL:
+By default, when passing param values with characters such as `@`, they will be encoded in the URL:

docs/router/framework/react/api/router/linkComponent.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

nx-cloud · 2026-01-24T12:54:26Z

View your CI Pipeline Execution ↗ for commit a826ad1

Command	Status	Duration	Result
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	1m	View ↗
`nx affected --targets=test:eslint,test:unit,tes...`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2026-01-24 12:58:21 UTC

docs/router/framework/react/api/router/linkComponent.md

pkg-pr-new · 2026-01-24T12:59:37Z

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@6443

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@6443

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@6443

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@6443

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@6443

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@6443

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@6443

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@6443

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@6443

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@6443

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@6443

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@6443

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@6443

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@6443

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@6443

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@6443

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@6443

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@6443

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@6443

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@6443

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@6443

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@6443

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@6443

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@6443

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@6443

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@6443

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-fn-stubs@6443

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@6443

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@6443

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@6443

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@6443

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@6443

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@6443

@tanstack/vue-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router@6443

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router-devtools@6443

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router-ssr-query@6443

@tanstack/vue-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-start@6443

@tanstack/vue-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-start-client@6443

@tanstack/vue-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-start-server@6443

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@6443

commit: a826ad1

…ck#6443) * docs(router): Add URL encoding note on <Link/> and opt out with pathParamsAllowedCharacters * Update docs/router/framework/react/api/router/linkComponent.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * rabbit suggestion * convert to link * ci: apply automated fixes --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Nico Lynzaad <nlynzaad@zylangroup.com> Co-authored-by: Nico Lynzaad <44094871+nlynzaad@users.noreply.github.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

docs(router): Add URL encoding note on <Link/> and opt out with pathP…

b1b7f25

…aramsAllowedCharacters

github-actions bot added the documentation Everything documentation related label Jan 21, 2026

coderabbitai bot reviewed Jan 21, 2026

View reviewed changes

docs/router/framework/react/api/router/linkComponent.md Outdated Show resolved Hide resolved

bodadotsh and others added 3 commits January 21, 2026 20:10

Update docs/router/framework/react/api/router/linkComponent.md

3dce70f

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

rabbit suggestion

d972617

Merge branch 'main' into patch-1

d2b8abd

schiller-manuel requested a review from nlynzaad January 24, 2026 10:21

nlynzaad and others added 2 commits January 24, 2026 14:53

convert to link

2814e2a

Merge branch 'main' into patch-1

35dea0d

ci: apply automated fixes

a826ad1

nlynzaad approved these changes Jan 24, 2026

View reviewed changes

docs/router/framework/react/api/router/linkComponent.md Outdated Show resolved Hide resolved

nlynzaad merged commit 3aa27d5 into TanStack:main Jan 24, 2026
6 checks passed

bodadotsh deleted the patch-1 branch January 24, 2026 15:06

coderabbitai bot mentioned this pull request Feb 15, 2026

docs(solid): fix broken RouterOptions link in path params guide #6663

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(router): URL encoding note on <Link/> and how to opt out#6443

docs(router): URL encoding note on <Link/> and how to opt out#6443
nlynzaad merged 7 commits intoTanStack:mainfrom
bodadotsh:patch-1

bodadotsh commented Jan 21, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 21, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

nx-cloud bot commented Jan 24, 2026 •

edited

Loading

Uh oh!

Uh oh!

pkg-pr-new bot commented Jan 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

bodadotsh commented Jan 21, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nx-cloud bot commented Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Jan 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bodadotsh commented Jan 21, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 21, 2026 •

edited

Loading

nx-cloud bot commented Jan 24, 2026 •

edited

Loading