Hiyve Components - v1.0.0
    Preparing search index...

    Interface LoginFormProps

    Props for the LoginForm component.

    interface LoginFormProps {
        colors?: Partial<LoginFormColors>;
        defaultEmail?: string;
        icons?: Partial<LoginFormIcons>;
        labels?: Partial<LoginFormLabels>;
        onError?: (error: Error) => void;
        onForgotPassword?: () => void;
        onRegister?: () => void;
        onRememberMeChange?: (checked: boolean) => void;
        onSuccess?: (user: AuthUser) => void;
        onTfaRequired?: (event: TfaRequiredEvent) => void;
        rememberMeChecked?: boolean;
        showForgotPassword?: boolean;
        showRegisterLink?: boolean;
        showRememberMe?: boolean;
        styles?: Partial<LoginFormStyles>;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    colors? defaultEmail? icons? labels? onError? onForgotPassword? onRegister? onRememberMeChange? onSuccess? onTfaRequired? rememberMeChecked? showForgotPassword? showRegisterLink? showRememberMe? styles? sx?

    Properties

    colors?: Partial<LoginFormColors>

    Override default color values

    defaultEmail?: string

    Pre-fill the email field (e.g., from a saved "remember me" value)

    icons?: Partial<LoginFormIcons>

    Override default icons

    labels?: Partial<LoginFormLabels>

    Override default text strings

    onError?: (error: Error) => void

    Called when a login attempt fails

    onForgotPassword?: () => void

    Called when the user clicks the "Forgot password" link

    onRegister?: () => void

    Called when the user clicks the "Register" link

    onRememberMeChange?: (checked: boolean) => void

    Called when the user toggles the "Remember me" checkbox

    onSuccess?: (user: AuthUser) => void

    Called when authentication completes successfully (without TFA)

    onTfaRequired?: (event: TfaRequiredEvent) => void

    Called when the server requires two-factor verification after login

    rememberMeChecked?: boolean

    Controlled checked state for the "Remember me" checkbox

    showForgotPassword?: boolean

    Show the "Forgot password" link (default: true)

    showRegisterLink?: boolean

    Show the "Register" link (default: true)

    showRememberMe?: boolean

    Show a "Remember me" checkbox (default: false)

    styles?: Partial<LoginFormStyles>

    Override default dimensions and spacing

    sx?: SxProps<Theme>

    MUI sx prop applied to the root container

    Settings

    Member Visibility

    On This Page

    Properties