action.toggle

Turns a state on or off and shows which: follow, subscribe, like. Pass pressed={on}

Component

<Action>

Renders

<button>

Profile

View as Markdown

Action intents

Example

Preview

defaultpresseddisabled

<Action intent="action.toggle" onClick={toggleItem} pressed={isOn}>Toggle</Action>

Code that says toggle, follow, subscribe, like, pin, mute 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
Turns a state on or off and shows which: follow, subscribe, like. Pass pressed={on}
action.toggle this page
A one-off command with no lasting state
action.utility
A setting that stays on or off
rather than action.reveal
action.toggle this page

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.secondary

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.toggle 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.secondary

Filled, lower emphasis; shows a pressed state

rounded-full bg-secondary font-medium text-secondary-foreground
hover:bg-secondary/80 aria-pressed:bg-foreground
aria-pressed:text-background

action.toggle
Turns a state on or off and shows which: follow, subscribe, like. Pass pressed={on}

Final classes

inline-flex shrink-0 items-center justify-center gap-2
whitespace-nowrap 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 rounded-full bg-secondary font-medium
text-secondary-foreground hover:bg-secondary/80
aria-pressed:bg-foreground aria-pressed:text-background

Definition

'action.toggle': {
  kind: 'semantic',
  description: 'Turns a state on or off and shows which: follow, subscribe, like. Pass pressed={on}',
  refs: ['control.secondary'],
  keywords: ['toggle', 'follow', 'subscribe', 'like', 'pin', 'mute'],
  notFor: [
    {
      context: 'a one-off command with no lasting state',
      instead: 'action.utility',
    },
  ],
},