docs(router): URL encoding note on <Link/> and how to opt out #6443
Conversation
…aramsAllowedCharacters
📝 WalkthroughWalkthroughAdds documentation clarifying that the Link component URL-encodes path parameter values (e.g., Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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:
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
View your CI Pipeline Execution ↗ for commit a826ad1
☁️ Nx Cloud last updated this comment at |
2 participants
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
✏️ Tip: You can customize this high-level summary in your review settings.