recruit/candidate-detail-layout · CandidateDetailLayout

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.

RO
Riley Okafor

GTM Engineer at Example Labs

Install

With your coding agentInstall RecruiterOS/recruit-ui and add a candidate detail pane with a header, tabs and a footer.
With the shadcn CLIpnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflows

Props

CandidateDetailLayout

PropTypeWhat it does
headerrequiredReactNodeThe fixed header, usually a CandidateDetailHeader.
alertReactNodeA message between the header and the tabs, such as a failed refresh.
tabsrequiredReactNodeThe fixed tab strip, usually CandidateDetailTabs.
childrenReactNodeThe active tab's sections. This is the only part that scrolls.
footerReactNodeA fixed bar under the body, such as the action bar for the role in focus.

CandidateDetailHeader

PropTypeWhat it does
avatarrequiredReactNodeThe avatar at the start, such as the kit's PersonAvatar at 56px.
namerequiredReactNodeThe person's name, the pane's level-3 heading.
verifiedCandidateDetailVerifiedShows a success badge with a shield after the name.
verifiedAtReactNodeWhen it was verified, already formatted. Shown only with `verified`.
headlineReactNodeThe line under the name, such as the current title and company.
provenanceReactNodeA quieter line under that, such as where the person came from.
actionsReactNodeControls before the close button, such as a favourite toggle and a CandidateActionMenu.
onCloserequired() => voidCloses the pane.
closeLabelstringThe close button's accessible name.

CandidateDetailTabs

PropTypeWhat it does
tabsrequiredreadonly CandidateDetailTabItem<TValue>[]The tabs, in order.
valuerequiredTValueThe active tab.
onChangerequired(value: TValue) => voidCalled with the tab a person picks.

CandidateActionMenu

PropTypeWhat it does
itemsrequiredreadonly CandidateActionMenuItem<TId>[]The items, in order. The host decides which apply.
onSelect(id: TId) => voidCalled with the chosen item's `id`, after the item's own `onSelect`.
busybooleanShows a spinner in place of the trigger's glyph while an action runs.
disabledbooleanDisables the trigger, for example while an earlier choice saves.
labelstringThe 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.
isolateClicksbooleanStops 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

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.