Skip to content

Commit 0fd8017

Browse files
author
patched.codes[bot]
committed
Patched /Users/codelion/Documents/GitHub/stack/docs/fern/docs/pages/sdk/sign-up.mdx
1 parent 9f84509 commit 0fd8017

1 file changed

Lines changed: 27 additions & 8 deletions

File tree

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
11
---
2-
slug: sdk/sign-up
2+
title: SignUp
33
---
44

5-
The `SignUp` component is a pre-built component that displays all the sign up methods available based on the Stack dashboard configuration.
5+
# SignUp
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+
A component that renders a sign-up page or form.
108

11-
![Sign Up Component](../imgs/sign-up.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 whether to display the sign-up form as a full page. Default is `false`.
12+
13+
## Example
14+
15+
```tsx
16+
import { SignUp } from '@stackframe/stack';
17+
18+
// Default usage (not full page)
19+
const SignUpForm = () => <SignUp />;
20+
21+
// Full page sign-up
22+
const FullPageSignUp = () => <SignUp fullPage={true} />;
23+
24+
// Render in your component
25+
function MyComponent() {
26+
return (
27+
<div>
28+
<SignUpForm />
29+
<FullPageSignUp />
30+
</div>
31+
);
32+
}
33+
```

0 commit comments

Comments
 (0)