web/docs/auth/ui.md
import { EmailPill, UsernameAndPasswordPill, GithubPill, GooglePill, KeycloakPill, SlackPill, DiscordPill } from "./Pills";
To make using authentication in your app as easy as possible, Wasp generates the server-side code but also the client-side UI for you. It enables you to quickly get the login, signup, password reset and email verification flows in your app.
Below we cover all of the available UI components and how to use them.
:::note
Remember that if you need a more custom approach, you can always create your own UI.
:::
After Wasp generates the UI components for your auth, you can use it as is, or customize it to your liking.
Based on the authentication providers you enabled in your main.wasp.ts file, the Auth UI will show the corresponding UI (form and buttons). For example, if you enabled e-mail authentication:
import { app } from "@wasp.sh/spec"
export default app({
name: "MyApp",
//...
auth: {
methods: {
// highlight-next-line
email: {},
},
// ...
},
// ...
})
You'll get the following UI:
And then if you enable Google and Github:
import { app } from "@wasp.sh/spec"
export default app({
name: "MyApp",
//...
auth: {
methods: {
email: {},
// highlight-start
google: {},
gitHub: {},
// highlight-end
},
// ...
},
// ...
})
The form will automatically update to look like this:
Let's go through all of the available components and how to use them.
The following components are available for you to use in your app:
Used with <UsernameAndPasswordPill />, <EmailPill />, <GithubPill />, <GooglePill />, <KeycloakPill />, <SlackPill /> and <DiscordPill /> authentication.
You can use the LoginForm component to build your login page:
import { app, page, route } from "@wasp.sh/spec"
import { LoginPage } from "./src/LoginPage" with { type: "ref" }
export default app({
// ...
spec: [
route("LoginRoute", "/login", page(LoginPage)),
],
})
// Use it like this
export function LoginPage() {
return <LoginForm />
}
```
// Use it like this
export function LoginPage() {
return <LoginForm />
}
```
It will automatically show the correct authentication providers based on your main.wasp.ts file.
Used with <UsernameAndPasswordPill />, <EmailPill />, <GithubPill />, <GooglePill />, <KeycloakPill />, <SlackPill /> and <DiscordPill /> authentication.
You can use the SignupForm component to build your signup page:
import { app, page, route } from "@wasp.sh/spec"
import { SignupPage } from "./src/SignupPage" with { type: "ref" }
export default app({
// ...
spec: [
route("SignupRoute", "/signup", page(SignupPage)),
],
})
// Use it like this
export function SignupPage() {
return <SignupForm />
}
```
// Use it like this
export function SignupPage() {
return <SignupForm />
}
```
It will automatically show the correct authentication providers based on your main.wasp.ts file.
Read more about customizing the signup process like adding additional fields or extra UI in the Auth Overview section.
Used with <EmailPill /> authentication.
If users forget their password, they can use this form to reset it.
You can use the ForgotPasswordForm component to build your own forgot password page:
import { app, page, route } from "@wasp.sh/spec"
import { ForgotPasswordPage } from "./src/ForgotPasswordPage" with { type: "ref" }
export default app({
// ...
spec: [
route(
"RequestPasswordResetRoute",
"/request-password-reset",
page(ForgotPasswordPage)
),
],
})
// Use it like this
export function ForgotPasswordPage() {
return <ForgotPasswordForm />
}
```
// Use it like this
export function ForgotPasswordPage() {
return <ForgotPasswordForm />
}
```
Used with <EmailPill /> authentication.
After users click on the link in the email they receive after submitting the forgot password form, they will be redirected to this form where they can reset their password.
You can use the ResetPasswordForm component to build your reset password page:
import { app, page, route } from "@wasp.sh/spec"
import { ResetPasswordPage } from "./src/ResetPasswordPage" with { type: "ref" }
export default app({
// ...
spec: [
route("PasswordResetRoute", "/password-reset", page(ResetPasswordPage)),
],
})
// Use it like this
export function ResetPasswordPage() {
return <ResetPasswordForm />
}
```
// Use it like this
export function ResetPasswordPage() {
return <ResetPasswordForm />
}
```
Used with <EmailPill /> authentication.
After users sign up, they will receive an email with a link to this form where they can verify their email.
You can use the VerifyEmailForm component to build your email verification page:
import { app, page, route } from "@wasp.sh/spec"
import { VerifyEmailPage } from "./src/VerifyEmailPage" with { type: "ref" }
export default app({
// ...
spec: [
route("EmailVerificationRoute", "/email-verification", page(VerifyEmailPage)),
],
})
// Use it like this
export function VerifyEmailPage() {
return <VerifyEmailForm />
}
```
// Use it like this
export function VerifyEmailPage() {
return <VerifyEmailForm />
}
```
You customize all of the available forms by passing props to them.
Props you can pass to all of the forms:
appearance - customize the form colors (via design tokens)logo - path to your logosocialLayout - layout of the social buttons, which can be vertical or horizontalWe use CSS variables in our styling so you can customize the styles by overriding the default theme tokens.
:::info List of all available tokens
See the list of all available tokens which you can override.
:::
<Tabs groupId="js-ts"> <TabItem value="js" label="JavaScript"> ```js title="src/appearance.js" export const authAppearance = { colors: { brand: "#5969b8", // blue brandAccent: "#de5998", // pink submitButtonText: "white", }, } ``````jsx title="src/LoginPage.jsx"
import { LoginForm } from "wasp/client/auth"
import { authAppearance } from "./appearance"
export function LoginPage() {
return (
<LoginForm
// Pass the appearance object to the form
appearance={authAppearance}
/>
)
}
```
export const authAppearance: CustomizationOptions["appearance"] = {
colors: {
brand: "#5969b8", // blue
brandAccent: "#de5998", // pink
submitButtonText: "white",
},
}
```
```tsx title="src/LoginPage.tsx"
import { LoginForm } from "wasp/client/auth"
import { authAppearance } from "./appearance"
export function LoginPage() {
return (
<LoginForm
// Pass the appearance object to the form
appearance={authAppearance}
/>
)
}
```
We recommend defining your appearance in a separate file and importing it into your components.
You can add your logo to the Auth UI by passing the logo prop to any of the components.
export function LoginPage() {
return (
<LoginForm
// Pass in the path to your logo
logo={Logo}
/>
)
}
```
export function LoginPage() {
return (
<LoginForm
// Pass in the path to your logo
logo={Logo}
/>
)
}
```
You can change the layout of the social buttons by passing the socialLayout prop to any of the components. It can be either vertical or horizontal (default).
If we pass in vertical:
export function LoginPage() {
return (
<LoginForm
// Pass in the socialLayout prop
socialLayout="vertical"
/>
)
}
```
export function LoginPage() {
return (
<LoginForm
// Pass in the socialLayout prop
socialLayout="vertical"
/>
)
}
```
We get this:
If we provide the logo and custom colors:
<Tabs groupId="js-ts"> <TabItem value="js" label="JavaScript"> ```js title="src/appearance.js" export const appearance = { colors: { brand: "#5969b8", // blue brandAccent: "#de5998", // pink submitButtonText: "white", }, } ``````jsx title="src/LoginPage.jsx"
import { LoginForm } from "wasp/client/auth"
import { authAppearance } from "./appearance"
import todoLogo from "./todoLogo.png"
export function LoginPage() {
return <LoginForm appearance={appearance} logo={todoLogo} />
}
```
export const appearance: CustomizationOptions["appearance"] = {
colors: {
brand: "#5969b8", // blue
brandAccent: "#de5998", // pink
submitButtonText: "white",
},
}
```
```tsx title="src/LoginPage.tsx"
import { LoginForm } from "wasp/client/auth"
import { authAppearance } from "./appearance"
import todoLogo from "./todoLogo.png"
export function LoginPage() {
return <LoginForm appearance={appearance} logo={todoLogo} />
}
```
We get a form looking like this:
<div style={{ textAlign: 'center' }}> </div>