Skip to content

Commit 6b57134

Browse files
author
patched.codes[bot]
committed
Patched /Users/codelion/Documents/GitHub/stack/docs/fern/docs/pages/sdk/sign-in.mdx
1 parent 22b8334 commit 6b57134

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
---
2-
slug: sdk/sign-in
2+
title: SignIn
33
---
44

5-
The `SignIn` component is a pre-built UI element that displays all available sign-in methods as configured in the Stack dashboard.
5+
# SignIn
66

7-
<Note>
8-
This component does not redirect a signed-in user. To achieve automatic redirection for signed-in users, you can use the `useUser` hook to check the user's sign-in status and perform the redirection if necessary.
9-
</Note>
7+
Renders a sign-in page component.
108

11-
![Sign In Component](../imgs/sign-in.png)
9+
## Parameters
1210

13-
## Props
14-
- `fullPage` (boolean): Determines whether the component should occupy the full page. Default is `false`.
11+
- `fullPage` (optional): `boolean` - Determines if the sign-in page should be rendered in full-page mode. Default is `false`.
12+
13+
## Example
14+
15+
```tsx
16+
import { SignIn } from '@stackframe/stack';
17+
18+
// Default usage
19+
<SignIn />
20+
21+
// Full-page mode
22+
<SignIn fullPage={true} />
23+
```
24+
25+
This component wraps the `AuthPage` component with the 'sign-in' type, providing a pre-configured sign-in page.

0 commit comments

Comments
 (0)