docs: recommend named routes over path strings for <NuxtLinkLocale>#4020
Merged
Conversation
Contributor
WalkthroughThis PR updates the NuxtLinkLocale component documentation to promote named routes over path strings. The "Basic usage" section now shows Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
toprop rejects plain string paths, contradicting documentation #4005toprop (fixes #4005) #4006📚 Description
Updates the
<NuxtLinkLocale>examples to use named routes (name strings and route objects) and documents why path strings are discouraged: they still work at runtime and are kept for backwards compatibility, but paths depend on the configuredstrategyand custom paths, so thetoprop deliberately only accepts named routes on the type level whentypedPagesis enabled. The string examples predate typed routes, which is why the docs contradicted the types.