action.signout

Ends the current session and signs the person out

Component

<Action>

Renders

<button>

Profile

View as Markdown

Action intents

Example

Preview

defaultpresseddisabled

<Action intent="action.signout" onClick={signoutItem} current={isCurrent}>Signout</Action>

Code that says signout, logout points here. prongs check warns when an element with this intent has a handler or label that points somewhere else.

Choosing between neighbours

Find the row that describes your element, and use the intent on the right.

If it is
Use
Ends the current session and signs the person out
action.signout this page
Going to the sign-in page
action.navigate

Connections

Declared in the registry, both directions. Where an intent is used in your own code is something check and the gallery see; this site has no app code.

Built from
control.quiet

For registry authors

Starter intents. These are the intents prongs add puts in your registry, shown in this site’s theme. Yours are your own registry.ts: rename, restyle and add to them, and see them with prongs add gallery.

What this intent is built from and its entry in components/prongs/registry.ts. You only need this to change how it looks or to add an intent like it.

How action.signout resolves, and its definition

Each layer adds to the one before it; a later class wins over an earlier one that sets the same thing.

control.base

Shape and behaviour shared by every button

inline-flex shrink-0 items-center justify-center gap-2
whitespace-nowrap rounded-md px-4 py-2 text-sm transition-colors
focus-visible:outline-none focus-visible:ring-2
focus-visible:ring-ring focus-visible:ring-offset-2
ring-offset-surface disabled:pointer-events-none
disabled:opacity-50 aria-disabled:pointer-events-none
aria-disabled:opacity-50

control.quiet

Small text command; shows a pressed state

h-auto px-0 py-0 text-muted-foreground hover:text-foreground
hover:underline underline-offset-4 aria-pressed:text-foreground

action.signout
Ends the current session and signs the person out

Final classes

inline-flex shrink-0 items-center justify-center gap-2
whitespace-nowrap rounded-md text-sm transition-colors
focus-visible:outline-none focus-visible:ring-2
focus-visible:ring-ring focus-visible:ring-offset-2
ring-offset-surface disabled:pointer-events-none
disabled:opacity-50 aria-disabled:pointer-events-none
aria-disabled:opacity-50 h-auto px-0 py-0 text-muted-foreground
hover:text-foreground hover:underline underline-offset-4
aria-pressed:text-foreground

Definition

'action.signout': {
  kind: 'semantic',
  description: 'Ends the current session and signs the person out',
  refs: ['control.quiet'],
  keywords: ['signout', 'logout'],
  notFor: [{ context: 'going to the sign-in page', instead: 'action.navigate' }],
},