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

    Interface RegisterFormProps

    Props for the RegisterForm component.

    interface RegisterFormProps {
        beforeSubmit?: ReactNode;
        colors?: Partial<RegisterFormColors>;
        customFields?: RegisterCustomField[];
        defaultEmail?: string;
        icons?: Partial<RegisterFormIcons>;
        labels?: Partial<RegisterFormLabels>;
        lockEmail?: boolean;
        onError?: (error: Error) => void;
        onLogin?: () => void;
        onSuccess?: (user: AuthUser) => void;
        requireName?: boolean;
        showLoginLink?: boolean;
        styles?: Partial<RegisterFormStyles>;
        sx?: SxProps<Theme>;
    }
    Index

    Properties

    beforeSubmit? colors? customFields? defaultEmail? icons? labels? lockEmail? onError? onLogin? onSuccess? requireName? showLoginLink? styles? sx?

    Properties

    beforeSubmit?: ReactNode

    Optional content rendered just above the submit button — for a supplementary control the built-in fields don't cover (e.g. a toggle that reveals an extra input, a consent checkbox, or a short notice). Managed entirely by the consumer; the form does not read or submit it.

    colors?: Partial<RegisterFormColors>

    Override default color values

    customFields?: RegisterCustomField[]

    Custom fields rendered after the name field. Values are sent as metadata on register.

    defaultEmail?: string

    Pre-fill the email field (e.g. from an invitation link).

    icons?: Partial<RegisterFormIcons>

    Override default icons

    labels?: Partial<RegisterFormLabels>

    Override default text strings

    lockEmail?: boolean

    Render the email field read-only. Pair with defaultEmail when the address is fixed by context (e.g. an invitation) and must not be changed.

    onError?: (error: Error) => void

    Called when a registration attempt fails

    onLogin?: () => void

    Called when the user clicks the "Sign in" link

    onSuccess?: (user: AuthUser) => void

    Called when registration completes successfully

    requireName?: boolean

    Make the name field required (default: false)

    showLoginLink?: boolean

    Show the "Already have an account?" link (default: true)

    styles?: Partial<RegisterFormStyles>

    Override default dimensions and spacing

    sx?: SxProps<Theme>

    MUI sx prop applied to the root container

    Settings

    Member Visibility

    On This Page

    Properties