mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
40 lines
1.5 KiB
Plaintext
40 lines
1.5 KiB
Plaintext
---
|
|
title: "<StackProvider />"
|
|
description: A React component that provides Stack context to its children.
|
|
---
|
|
|
|
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
|
|
|
|
| Property | Type | Optional | Description |
|
|
|----------|------|----------|-------------|
|
|
| `children` | `React.ReactNode` | No | The child components to be wrapped by the StackProvider. |
|
|
| `app` | `StackClientApp \| StackServerApp` | No | The Stack app instance to be used. |
|
|
| `lang` | `"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"` | Yes | The language to be used for translations. |
|
|
| `translationOverrides` | `Record<string, string>` | Yes | 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. |
|
|
|
|
## 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>
|
|
);
|
|
}
|
|
```
|