Detail layout
The frame of a person's detail pane: a fixed header, tabs and footer around the one body that scrolls, with the header, its action menu and the tab strip.
What it shows
The frame of a person's detail pane.
Props
CandidateDetailLayout
| Prop | Type | What it does |
|---|---|---|
header (required) | ReactNode | The fixed header, usually a CandidateDetailHeader. |
alert | ReactNode | A message between the header and the tabs, such as a failed refresh. |
tabs (required) | ReactNode | The fixed tab strip, usually CandidateDetailTabs. |
children | ReactNode | The active tab's sections. This is the only part that scrolls. |
footer | ReactNode | A fixed bar under the body, such as the action bar for the role in focus. |
CandidateDetailHeader
| Prop | Type | What it does |
|---|---|---|
avatar (required) | ReactNode | The avatar at the start, such as the kit's PersonAvatar at 56px. |
name (required) | ReactNode | The person's name, the pane's level-3 heading. |
verified | CandidateDetailVerified | Shows a success badge with a shield after the name. |
verifiedAt | ReactNode | When it was verified, already formatted. Shown only with verified. |
headline | ReactNode | The line under the name, such as the current title and company. |
provenance | ReactNode | A quieter line under that, such as where the person came from. |
actions | ReactNode | Controls before the close button, such as a favourite toggle and a CandidateActionMenu. |
onClose (required) | () => void | Closes the pane. |
closeLabel | string | The close button's accessible name. |
CandidateDetailTabs
| Prop | Type | What it does |
|---|---|---|
tabs (required) | readonly CandidateDetailTabItem<TValue>[] | The tabs, in order. |
value (required) | TValue | The active tab. |
onChange (required) | (value: TValue) => void | Called with the tab a person picks. |
CandidateActionMenu
| Prop | Type | What it does |
|---|---|---|
items (required) | readonly CandidateActionMenuItem<TId>[] | The items, in order. The host decides which apply. |
onSelect | (id: TId) => void | Called with the chosen item's id, after the item's own onSelect. |
busy | boolean | Shows a spinner in place of the trigger's glyph while an action runs. |
disabled | boolean | Disables the trigger, for example while an earlier choice saves. |
label | string | The trigger's tooltip and accessible name. |
variant | "ghost" | "quiet" | The trigger's button variant: ghost (default) in a header, quiet beside a card's other quiet actions. |
triggerIconSize | "sm" | "md" | The trigger's glyph size: md (default), or sm on a compact card row. |
itemIconSize | "sm" | "md" | The items' glyph size: md (default), or sm to match small buttons. |
isolateClicks | boolean | Stops a click on the trigger or in the menu from reaching a surrounding clickable card. The menu renders in a portal, but React still bubbles its clicks through the card. |
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
Install RecruiterOS/recruit-ui and add a candidate detail pane with a header, tabs and a footer.