Docs: fix 04-linking-and-navigating.mdx locale switcher example #81753
+4
−0
Conversation
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
The original example code has a bug where repeatedly clicking language switcher buttons causes infinite accumulation of locale prefixes in the URL path. Example of the issue: Initial path: /about Click English: /en/about Click French: /fr/en/about Click English again: /en/fr/en/about And so on... Solution: Added a regex pattern to remove any existing locale prefix before adding the new one:
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| @@ -427,6 +427,8 @@ export function LocaleSwitcher() { | |||
| const pathname = usePathname() | |||
|
|
|||
| function switchLocale(locale: string) { | |||
| // Remove existing locale prefix if present | |||
| const pathWithoutLocale = pathname.replace(/^\/(en|fr)/, '') || '/' | |||
| // e.g. '/en/about' or '/fr/contact' | |||
| const newPath = `/${locale}${pathname}` | |||
There was a problem hiding this comment.
The code is using pathname in the newPath construction, but this will cause locale prefixes to accumulate in the URL when switching languages multiple times. To fix this issue, use the newly created pathWithoutLocale variable instead:
const newPath = `/${locale}${pathWithoutLocale}`This ensures that any existing locale prefix is removed before adding the new one, preventing paths like /fr/en/about from occurring.
Suggested change
| const newPath = `/${locale}${pathname}` | |
| const newPath = `/${locale}${pathWithoutLocale}` |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
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.
What?
Fix locale switcher example to prevent infinite URL path accumulation when switching languages multiple times.
Why?
The current example in the documentation has a bug where repeatedly clicking language switcher buttons causes infinite accumulation of locale prefixes in the URL path. For example:
/about/en/about/fr/en/about/en/fr/en/aboutThis creates malformed URLs and poor user experience.
How?
Added a regex pattern to remove existing locale prefixes before adding new ones: