Library/pages/Login

Login

page

Auth screen with login and forgot-password flows. Centered form with gradient submit button, error/loading states, remember-me, and a trust indicator below the form.

Added in 0.6.1

Live Preview

ThemeDefault Light
Device
Desktop

Props

PropTypeDescriptionRequired
onLogin(creds: { username, password, rememberMe }) => Promise<void>Submit handler. Throw to surface an error.yes
welcomeTitlestringLogin form title. Defaults to "Welcome back".yes
welcomeSubtitlestringSubtitle below the login titleyes
forgotTitlestringForgot-password title. Defaults to "Forgot password?".yes
forgotSubtitlestringSubtitle on the forgot-password screenyes
trustIndicatorstring | falseShield-icon trust line below the form. Pass false to hide.yes
rememberMeDefaultbooleanInitial value of the Remember Me checkboxyes
onForgotPassword(info: { email }) => Promise<void>Forgot-password handler. Omit to hide the link.yes
screen"login" | "forgot"Externally controlled screen (otherwise managed internally)yes
onScreenChange(next) => voidFires when the screen togglesyes

Usage

import { Login } from '@qsp-life/particle';

<Login
  onLogin={async ({ username, password, rememberMe }) => {
    // throw new Error("Invalid credentials") to surface error state
  }}
  onForgotPassword={async ({ email }) => {
    // call your reset-password API
  }}
/>

Import

import { Login } from '@qsp-life/particle';