# Favourite button (/ui/candidate-favourite-button)

## What it shows [#what-it-shows]

A star that marks a favourite.

## Props [#props]

| Prop | Type | What it does |
| --- | --- | --- |
| `favourited` (required) | `boolean` |   |
| `onToggle` (required) | `() => void` | Called with no arguments; the host flips and persists the marker. |
| `labels` | `Partial<CandidateFavouriteButtonLabels>` |   |
| `idleTone` | `"muted" \| "inherit"` | The star's colour while the candidate is not a favourite: `muted` (default) on a card, or `inherit` to take the surrounding text colour, as the other icon actions in a detail header do. |

## Data it needs [#data-it-needs]

The component takes plain values and callbacks and keeps no records of its own. Pass it yours, from the Kith data layer or from a backend you already run.

## Copy to your agent [#copy-to-your-agent]

```text title="Copy to your agent"
Install RecruiterOS/recruit-ui and add a favourite star to each candidate card.
```