docs: Update LocaleSwitcherSelect in example-app-router to match docs
#853
Conversation
|
@CodyDuff is attempting to deploy a commit to the next-intl Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| // TypeScript validates that only known `params` are used in combination | ||
| // with a given `pathname`. Since the two will always match for the current | ||
| // route, we can skip runtime checks. | ||
| params: params as any |
There was a problem hiding this comment.
The situation is slightly different here: Since there are no dynamic params in this example, there can never be any params. However, I'd agree that it's beneficial if we show a sample that works for either case.
This would work:
| // TypeScript validates that only known `params` are used in combination | |
| // with a given `pathname`. Since the two will always match for the current | |
| // route, we can skip runtime checks. | |
| params: params as any | |
| // @ts-expect-error -- TypeScript validates that only known `params` are used in combination | |
| // with a given `pathname`. Since the two will always match for the current | |
| // route, we can skip runtime checks. | |
| params |
That would work in the example in the docs too. We could update the docs accordingly so these are in sync.
What do you think?
There was a problem hiding this comment.
Oh ok, I understand. Whatever you want also works for me. I had just stumbled onto this issue because I started a project using example-app-router as my starting point and eventually created a dynamic route causing the error.
Your suggested placement of the @ts-expect-error did not dismiss the error. I actually had to place the @ts-expect-error comment above the entire { pathname, params } object like this:
startTransition(() => {
router.replace(
// @ts-expect-error -- TypeScript will validate that only known `params`
// are used in combination with a given `pathname`. Since the two will
// always match for the current route, we can skip runtime checks.
{ pathname, params },
{ locale: nextLocale },
);
});
Does this work for you?
Also, when you say "We could update the docs accordingly so these are in sync", are you saying the docs at docs/pages/docs/routing/navigation.mdx should include the @ts-expect-error comment as well?
There was a problem hiding this comment.
Sure, that looks good! Yep, would you mind updating navigation.mdx to match the updated implementation in example-app-router?
There was a problem hiding this comment.
I had a moment to update this, this is fixed in 2beef46
amannn
changed the title
examples/example-app-router/src/components/LocaleSwitcherSelect.tsxexamples/example-app-router/src/components/LocaleSwitcherSelect.tsx to match docs
amannn
changed the title
examples/example-app-router/src/components/LocaleSwitcherSelect.tsx to match docsexample-app-router/src/components/LocaleSwitcherSelect.tsx to match docs
amannn
changed the title
example-app-router/src/components/LocaleSwitcherSelect.tsx to match docsLocaleSwitcherSelect in example-app-router to match docs
…sting params as any
Updates LocaleSwitcherSelect.tsx in examples/example-app-router to match the doc changes in commit de285f6, which fixed #581.