CDP Frontend SDK
    Preparing search index...

    Interface AuthButtonProps

    The props for the AuthButton component.

    interface AuthButtonProps {
        children?: (
            props: {
                Placeholder?: ReactNode;
                SignOutButton?: ReactNode;
                SignInModal?: ReactNode;
            } & { isInitialized: boolean; isSignedIn: boolean },
        ) => ReactNode;
        closeOnSuccessDelay?: null | number;
        onSignInSuccess?: () => void;
        onSignInSuccessTransitionEnd?: () => void;
        onSignOutSuccess?: () => void;
        placeholder?: (
            props: Pick<HTMLAttributes<HTMLDivElement>, "className">,
        ) => ReactNode;
        signOutButton?: (props: Pick<SignOutButtonProps, "onSuccess">) => ReactNode;
        signInModal?: (
            props: Pick<SignInModalProps, "open" | "setIsOpen" | "onSuccess">,
        ) => ReactNode;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children? closeOnSuccessDelay? onSignInSuccess? onSignInSuccessTransitionEnd? onSignOutSuccess? placeholder? signOutButton? signInModal?

    Properties

    children?: (
        props: {
            Placeholder?: ReactNode;
            SignOutButton?: ReactNode;
            SignInModal?: ReactNode;
        } & { isInitialized: boolean; isSignedIn: boolean },
    ) => ReactNode
    closeOnSuccessDelay?: null | number

    The delay in milliseconds before the sign in modal is closed and the sign out button is shown after the sign in is successful. If null, the sign in modal will not be closed automatically. If 0, the sign in modal will be closed immediately.

    onSignInSuccess?: () => void

    A function to call when the sign in is successful.

    onSignInSuccessTransitionEnd?: () => void

    A function to call after the sign in success, when the dialog close transition ends.

    onSignOutSuccess?: () => void

    A function to call when the sign out is successful.

    placeholder?: (
        props: Pick<HTMLAttributes<HTMLDivElement>, "className">,
    ) => ReactNode

    The placeholder to render while the CDP SDK is initializing.

    signOutButton?: (props: Pick<SignOutButtonProps, "onSuccess">) => ReactNode

    The sign out button, rendered when the user is signed in.

    signInModal?: (
        props: Pick<SignInModalProps, "open" | "setIsOpen" | "onSuccess">,
    ) => ReactNode

    The sign in modal, rendered when the user is signed out.

    Settings

    Member Visibility

    On This Page

    Properties