Skip to main content
The props for the AuthButton component.

Extends

Properties

PropertyTypeDescriptionInherited from
children?(props: { Placeholder?: ReactNode; SignOutButton?: ReactNode; SignInModal?: ReactNode; } & { isInitialized: boolean; isSignedIn: boolean; }) => ReactNode--
closeOnSuccessDelay?null | numberThe 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?() => voidA function to call when the sign in is successful.-
onSignInSuccessTransitionEnd?() => voidA function to call after the sign in success, when the dialog close transition ends.-
onSignOutSuccess?() => voidA function to call when the sign out is successful.-
placeholder?(props: Pick<HTMLAttributes<HTMLDivElement>, "className">) => ReactNodeThe placeholder to render while the CDP SDK is initializing.AuthButtonSlots.placeholder
signOutButton?(props: Pick<SignOutButtonProps, "onSuccess">) => ReactNodeThe sign out button, rendered when the user is signed in.AuthButtonSlots.signOutButton
signInModal?(props: Pick<SignInModalProps, "open" | "setIsOpen" | "onSuccess">) => ReactNodeThe sign in modal, rendered when the user is signed out.AuthButtonSlots.signInModal