recruit/candidate-favourite-button · CandidateFavouriteButton
Favourite button
A borderless star that marks a candidate as a favourite, safe to use inside a clickable card.
Riley Okafor
Sam Lindqvist
Alex Marchetti
Install
With your coding agent
Install RecruiterOS/recruit-ui and add a favourite star to each candidate card.With the shadcn CLI
pnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflowsProps
| Prop | Type | What it does |
|---|---|---|
| favouritedrequired | boolean | |
| onTogglerequired | () => 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
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.