CDP Frontend SDK
    Preparing search index...

    Interface SignInFormProps

    Props for the SignInForm component.

    SignInForm

    interface SignInFormProps {
        as?: ElementType;
        onSuccess?: () => void;
        step?: "credentials" | "verification";
        children?: (
            props: {
                step: "credentials" | "verification";
                authMethod: AuthMethod;
                Form: ReactNode;
            },
        ) => ReactNode;
    }

    Hierarchy

    • Omit<HTMLAttributes<HTMLElement>, "children">
      • SignInFormProps
    Index

    Properties

    as? onSuccess? step? children?

    Properties

    as?: ElementType

    The element type to render the form as.

    onSuccess?: () => void

    The function to call when the sign in is successful.

    step?: "credentials" | "verification"

    If set, will render the form for this step of the sign in flow, regardless of the context value.

    children?: (
        props: {
            step: "credentials" | "verification";
            authMethod: AuthMethod;
            Form: ReactNode;
        },
    ) => ReactNode

    The children of the component.

    Settings

    Member Visibility

    On This Page

    Properties