Skip to content

Commit 894f08a

Browse files
author
patched.codes[bot]
committed
Patched /Users/codelion/Documents/GitHub/stack/docs/fern/docs/pages/sdk/auth-page.mdx
1 parent 4b5814f commit 894f08a

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: AuthPage
3+
---
4+
5+
# AuthPage
6+
7+
Renders an authentication page for sign-in or sign-up functionality.
8+
9+
## Parameters
10+
11+
- `fullPage` (optional): `boolean` - Determines if the page should be rendered in full-page mode. Default is `false`.
12+
- `type`: `'sign-in' | 'sign-up'` - Specifies whether the page is for signing in or signing up.
13+
- `automaticRedirect` (optional): `boolean` - Enables automatic redirection after successful authentication.
14+
- `mockProject` (optional): `object` - Mocks project configuration for testing purposes.
15+
- `config`: `object`
16+
- `signUpEnabled`: `boolean`
17+
- `credentialEnabled`: `boolean`
18+
- `magicLinkEnabled`: `boolean`
19+
- `oauthProviders`: `Array<{ id: string }>`
20+
21+
## Example
22+
23+
```tsx
24+
import { AuthPage } from '@stackframe/stack';
25+
26+
// Basic sign-in page
27+
const SignInPage = () => (
28+
<AuthPage type='sign-in' />
29+
);
30+
31+
// Full-page sign-up with automatic redirect
32+
const SignUpPage = () => (
33+
<AuthPage
34+
type='sign-up'
35+
fullPage={true}
36+
automaticRedirect={true}
37+
/>
38+
);
39+
```

0 commit comments

Comments
 (0)