Skip to main content
function SignOutButton(props?: SignOutButtonProps): Element;
A button that signs the user out.

​
Parameters

ParameterTypeDescription
props?SignOutButtonPropsThe props for the component.

​
Returns

Element The rendered component.

​
Examples

// Render a sign out button
<SignOutButton onSuccess={() => console.log("Sign out success")} />

// Render a sign out button with a custom label, size, and variant
<SignOutButton size="sm" variant="secondary">Log out</SignOutButton>

// Render a sign out button with a custom button element
<SignOutButton asChild>
  <button className="custom-button">Log out</button>
</SignOutButton>