mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-30 21:01:54 +08:00
8514e42979
## Summary
- Added missing language codes to the `lang` prop type in StackProvider
documentation
- Added: `ja-JP`, `ko-KR`, `zh-CN`, `zh-TW`
## Context
The `quetzal-translations.ts` file already contains translations for
these languages, but the documentation didn't list them as supported
options for the `lang` prop.
This fixes a documentation inconsistency where users couldn't discover
that Japanese, Korean, and Chinese translations are available.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Added support for Japanese, Korean, Simplified Chinese, and
Traditional Chinese language options in localization settings.
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Co-authored-by: Madison <madison.w.kennedy@gmail.com>
59 lines
1.6 KiB
Plaintext
59 lines
1.6 KiB
Plaintext
---
|
|
title: "<StackProvider />"
|
|
---
|
|
|
|
A React component that provides Stack context to its children.
|
|
|
|
For detailed usage instructions, please refer to the manual section of the [setup guide](../getting-started/setup).
|
|
|
|
## Props
|
|
|
|
<PropTable
|
|
props={[
|
|
{
|
|
name: "children",
|
|
type: "React.ReactNode",
|
|
description: "The child components to be wrapped by the StackProvider."
|
|
},
|
|
{
|
|
name: "app",
|
|
type: "StackClientApp | StackServerApp",
|
|
description: "The Stack app instance to be used."
|
|
},
|
|
{
|
|
name: "lang",
|
|
type: '"en-US" | "de-DE" | "es-419" | "es-ES" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "pt-PT" | "zh-CN" | "zh-TW"',
|
|
description: "The language to be used for translations.",
|
|
optional: true
|
|
},
|
|
{
|
|
name: "translationOverrides",
|
|
type: "Record<string, string>",
|
|
description: "A mapping of English translations to translated equivalents. These will take priority over the translations from the language specified in the lang property. Note that the keys are case-sensitive. You can find a full list of supported strings on GitHub.",
|
|
optional: true
|
|
}
|
|
]}
|
|
/>
|
|
|
|
## Example
|
|
|
|
```tsx title="layout.tsx"
|
|
import { StackProvider } from '@stackframe/stack';
|
|
import { stackServerApp } from '@/stack/server';
|
|
|
|
function App() {
|
|
return (
|
|
<StackProvider
|
|
app={stackServerApp}
|
|
lang="de-DE"
|
|
translationOverrides={{
|
|
"Sign in": "Einloggen",
|
|
"Sign In": "Einloggen",
|
|
}}
|
|
>
|
|
{/* Your app content */}
|
|
</StackProvider>
|
|
);
|
|
}
|
|
```
|