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

[bodadotsh]

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 encoded paths to illustrate runtime behavior.
  • Documented how to opt out or customize parameter encoding via router configuration, with an example showing the configuration option.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds documentation clarifying that Link component path parameter values are URL-encoded by default (e.g., @ → %40) and shows how to opt out by configuring pathParamsAllowedCharacters.

Changes

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

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibble doc leaves in the moonlight glow,
Turning @ to %40 as I go,
Tucked a setting where wild chars can play,
Hop, tweak, and let the paths have their 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 accurately and specifically describes the main change: adding documentation about URL encoding in the Link component and how to opt out of it.
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

• X
• Mastodon
• Reddit
• LinkedIn

_{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: