GitHub

choice.option

One of a small set of options for a setting: theme, layout, a category. Pass pressed on the chosen one

Component

<Action>

Renders

<button>

Profile

UI
View as Markdown

Choice intents

Example

Preview
defaultpresseddisabled
<Action intent="choice.option" onClick={optionItem} pressed={isOn}>Option</Action>

Choosing between neighbours

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

  • If it is

    Use

  • One of a small set of options for a setting: theme, layout, a category. Pass pressed on the chosen one

    choice.option this page

  • Narrowing which items are shown

    choice.filter

  • Choosing a setting

    rather than choice.filter
    choice.option this page

  • Named options like light or dark

    rather than choice.color
    choice.option this page

  • One of a few options shown on the page

    rather than choice.open
    choice.option this page

  • A few options that fit on the page

    rather than popover.picker
    choice.option 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.

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 choice.option 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.pill

    Rounded option; filled while pressed

    rounded-full border border-surface-border px-3 py-1
hover:bg-surface-hover aria-pressed:border-foreground
aria-pressed:bg-foreground aria-pressed:text-background
  • choice.option

    One of a small set of options for a setting: theme, layout, a category. Pass pressed on the chosen one

Final classes
inline-flex shrink-0 items-center justify-center gap-2
whitespace-nowrap 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 border
border-surface-border px-3 py-1 hover:bg-surface-hover
aria-pressed:border-foreground aria-pressed:bg-foreground
aria-pressed:text-background
Definition
TS
'choice.option': {
  kind: 'semantic',
  description: 'One of a small set of options for a setting: theme, layout, a category. Pass pressed on the chosen one',
  refs: ['control.pill'],
  notFor: [
    { context: 'narrowing which items are shown', instead: 'choice.filter' },
  ],
},