# choice.filter

Narrows which items are shown: All, Unread, a source. Pass pressed while it applies

Component: [`<Action>`](https://www.prongs.dev/docs/components/action.md) · Renders: `<button>` · Profile: [UI](https://www.prongs.dev/docs/intents/ui.md)

## Example

```tsx
<Action intent="choice.filter" onClick={filterItem} pressed={isOn}>Filter</Action>
```

## Choosing between neighbours

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

| If it is for… | Use |
|---|---|
| Narrows which items are shown: All, Unread, a source. Pass pressed while it applies | `choice.filter` (this page) |
| Choosing a setting | [`choice.option`](https://www.prongs.dev/docs/intents/choice/option.md) |
| Narrowing a list to matching items (rather than [`nav.view`](https://www.prongs.dev/docs/intents/nav/view.md)) | `choice.filter` (this page) |
| Narrowing which items are shown (rather than [`choice.option`](https://www.prongs.dev/docs/intents/choice/option.md)) | `choice.filter` (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.pill`](https://www.prongs.dev/docs/intents/ui.md#control-pill)

## 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.filter 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`](https://www.prongs.dev/docs/intents/ui.md#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`](https://www.prongs.dev/docs/intents/ui.md#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.filter` (this page) — Narrows which items are shown: All, Unread, a source. Pass pressed while it applies

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.filter': {
  kind: 'semantic',
  description: 'Narrows which items are shown: All, Unread, a source. Pass pressed while it applies',
  refs: ['control.pill'],
  notFor: [{ context: 'choosing a setting', instead: 'choice.option' }],
},
```