Skip to main content
Props for the SignOutButton component.

See

SignOutButton

Extends

Properties

PropertyTypeDescriptionOverridesInherited from
children?ReactNodeThe children to render inside the button.ButtonProps.children-
onSuccess?() => voidA function to call when the sign-out is successful.--
pendingLabel?ReactNodeA label to render when the button state is pending.-ButtonProps.pendingLabel
variant?ButtonVariantThe variant of the button. Defaults to “primary”.-ButtonProps.variant
asChild?booleanSet to true to use a custom element or component in place of the default button element.-ButtonProps.asChild
fullWidth?booleanWhether the button should be full width.-ButtonProps.fullWidth
isPending?booleanWhether the button state is pending.-ButtonProps.isPending
size?ButtonSizeThe size of the button. Defaults to “md”.-ButtonProps.size