CDP Frontend SDK
    Preparing search index...

    Interface SignOutButtonProps

    Props for the SignOutButton component.

    SignOutButton

    interface SignOutButtonProps {
        children?: ReactNode;
        onSuccess?: () => void;
        pendingLabel?: ReactNode;
        variant?: ButtonVariant;
        asChild?: boolean;
        fullWidth?: boolean;
        isPending?: boolean;
        size?: ButtonSize;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children? onSuccess? pendingLabel? variant? asChild? fullWidth? isPending? size?

    Properties

    children?: ReactNode

    The children to render inside the button.

    onSuccess?: () => void

    A function to call when the sign-out is successful.

    pendingLabel?: ReactNode

    A label to render when the button state is pending.

    variant?: ButtonVariant

    The variant of the button. Defaults to "primary".

    asChild?: boolean

    Set to true to use a custom element or component in place of the default button element.

    fullWidth?: boolean

    Whether the button should be full width.

    isPending?: boolean

    Whether the button state is pending.

    size?: ButtonSize

    The size of the button. Defaults to "md".

    Settings

    Member Visibility

    On This Page

    Properties