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

    Interface AuthFlowProps

    Props for the AuthFlow component.

    interface AuthFlowProps {
        colors?: Partial<AuthFlowColors>;
        defaultEmail?: string;
        initialView?: AuthFlowView;
        labels?: Partial<AuthFlowLabels>;
        onAuthenticated?: (user: AuthUser) => void;
        onError?: (error: Error) => void;
        onRegistered?: (user: AuthUser) => void;
        onRememberMeChange?: (checked: boolean) => void;
        registerCustomFields?: RegisterCustomField[];
        rememberMeChecked?: boolean;
        resetToken?: string;
        showRegisterLink?: boolean;
        showRememberMe?: boolean;
        styles?: Partial<AuthFlowStyles>;
        sx?: SxProps<Theme>;
        verificationToken?: string;
    }
    Index

    Properties

    colors? defaultEmail? initialView? labels? onAuthenticated? onError? onRegistered? onRememberMeChange? registerCustomFields? rememberMeChecked? resetToken? showRegisterLink? showRememberMe? styles? sx? verificationToken?

    Properties

    colors?: Partial<AuthFlowColors>

    Override default color values

    defaultEmail?: string

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

    initialView?: AuthFlowView

    Which view to show initially (default: 'login')

    labels?: Partial<AuthFlowLabels>

    Override default text strings

    onAuthenticated?: (user: AuthUser) => void

    Called when authentication succeeds (login or TFA completion)

    onError?: (error: Error) => void

    Called when any child form encounters an error

    onRegistered?: (user: AuthUser) => void

    Called when registration succeeds

    onRememberMeChange?: (checked: boolean) => void

    Called when the user toggles the "Remember me" checkbox

    registerCustomFields?: RegisterCustomField[]

    Custom fields passed to the RegisterForm. Values are sent as metadata on register.

    rememberMeChecked?: boolean

    Controlled checked state for the "Remember me" checkbox

    resetToken?: string

    Password reset token from URL — auto-navigates to the reset password view

    showRegisterLink?: boolean

    Show the "Create account" link on the login form (default: true)

    showRememberMe?: boolean

    Show a "Remember me" checkbox on the login form (default: false)

    styles?: Partial<AuthFlowStyles>

    Override default dimensions and spacing

    sx?: SxProps<Theme>

    MUI sx prop applied to the root container

    verificationToken?: string

    Email verification token from URL — auto-navigates to the verification view

    Settings

    Member Visibility

    On This Page

    Properties