recruit/candidate-shared-profile-sections · CandidateSharedProfileHeader
Shared profile sections
The sections of a shared profile, each usable on its own: the people one link shares, who the person is, the sharer's notes, the fit, the reader's answer and their notes.
Named: the page shows who they are.
2 people shared with you
AM
Alex Marchetti
Head of SalesFictional Robotics
London12 yrs experience
Note from Riley Okafor
Built two sales teams from the first hire. Open to a move this quarter.
Fit for Head of Sales, London
A — Strong fit
Has built this team at this size before.
- Positive: Took a team from two to fourteen in three years.
What to test
- Neutral: Has sold only to engineering buyers.
Notice period
Three months, and open to an earlier start.
Install
With your coding agent
Install RecruiterOS/recruit-ui and add the sections of a shared candidate profile to a page I lay out myself: the header, the fit, the answer and the notes.With the shadcn CLI
pnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflowsProps
CandidateSharedProfileSwitcher
| Prop | Type | What it does |
|---|---|---|
| peoplerequired | readonly CandidateSharedProfilePersonOption[] | The people the link shares, in its order. |
| valuerequired | string | The person whose profile is showing: the pressed chip. |
| onChange | (id: string) => unknown | Called with the person picked. The host shows their profile. While a promise it returns is pending the caption says who is opening and the chips are held; if it rejects, a line under them says so (`labels.switchFailed`). Without it the chips can't be pressed. |
| opening | string | null | The person whose profile is on its way, for a host that knows it some other way than a promise from `onChange`, such as a route that has changed and not yet loaded. |
| error | ReactNode | A line under the chips, for a host that knows a profile didn't open some other way than that promise. |
| anonymised | boolean | Names nobody: each chip says its place in the row (`labels.anonymousPerson`) and shows no face, whatever `people` holds. |
| labels | Partial<CandidateSharedProfileLabels> | |
| id | string | |
| className | string | |
| style | CSSProperties |
CandidateSharedProfileHeader
| Prop | Type | What it does |
|---|---|---|
| personrequired | CandidateSharedProfilePerson | |
| anonymised | boolean | Shows nobody: the heading is `labels.anonymous`, a glyph stands in for the face, and their cover and profile link are never drawn, whatever `person` holds. The stock banner still is, dealt by no seed, so it is the same for everyone and says nothing of who they are. |
| titleLevel | CandidateProfileHeaderTitleLevel | The name's heading level, as `CandidateProfileHeader` takes it. 1 by default. |
| labels | Partial<CandidateSharedProfileLabels> | |
| id | string | |
| className | string | |
| style | CSSProperties | |
| eyebrow | ReactNode | |
| status | ReactNode | |
| padding | Extract<CandidateCoverHeaderPadding, "lg" | "dialog" | "none"> | `lg` (the default) pads the header like a card's. `dialog` pads it like the kit's dialog header, so as a CandidateProfileDialog's `header` the name starts at the body's left edge, in line with what the body holds. `none` sits it flush in a container the host already pads, such as a drawer body. |
CandidateSharedProfileVoiceNote
| Prop | Type | What it does |
|---|---|---|
| srcrequired | string | Where the recording plays from. The host resolves it. |
| transcript | string | null | What it says, for a reader who would sooner read. Line breaks are kept. |
| titleLevel | CandidateSharedProfileSectionLevel | The heading's level: 2 (the default), or 3 to 5 to fit the page's outline. |
| renderAudio | (audio: CandidatePresentationRecorderAudio) => ReactNode | Renders the player. Defaults to the browser's own audio controls. |
| labels | Partial<CandidateSharedProfileLabels> | |
| id | string | |
| className | string | |
| style | CSSProperties |
CandidateSharedProfileNote
| Prop | Type | What it does |
|---|---|---|
| textrequired | string | The note, as written. Line breaks are kept. |
| author | string | null | Who wrote it, for the heading ("Note from Jordan"). |
| titleLevel | CandidateSharedProfileSectionLevel | The heading's level: 2 (the default), or 3 to 5 to fit the page's outline. |
| labels | Partial<CandidateSharedProfileLabels> | |
| id | string | |
| className | string | |
| style | CSSProperties |
CandidateSharedProfileFit
| Prop | Type | What it does |
|---|---|---|
| titleLevel | CandidateSharedProfileSectionLevel | The heading's level: 2 (the default), or 3 to 5 to fit the page's outline. |
| labels | Partial<CandidateSharedProfileLabels> | |
| id | string | |
| className | string | |
| style | CSSProperties | |
| roleTitle | ReactNode | The role they were assessed for, for the heading ("Fit for Staff Engineer"). |
| grade | CandidateSharedProfileGrade | null | The grade, as `CandidateGradeBadge` takes it: the letter with the host's own label and tone, or sentiment. Nothing is read into the letter here. The badge is one line of text unless `format` says otherwise. |
| summary | ReactNode | A line or two on why, over the evidence. |
| evidence | readonly CandidateSummaryBullet[] | The evidence, a line each, each with the host's sentiment. |
| groups | readonly CandidateSharedProfileFitGroup[] | Further lists that belong with the assessment, under the evidence and each under its own heading, such as what to test in an interview and what stands out. The host names each and gives each line its sentiment. A group with no lines isn't drawn. |
CandidateSharedProfileFitGroup, each of the fit's groups
| Prop | Type | What it does |
|---|---|---|
| titlerequired | ReactNode | The list's heading, such as "What to test". |
| itemsrequired | readonly CandidateSummaryBullet[] | Its lines, each with the host's sentiment. |
CandidateSharedProfileAnswer
| Prop | Type | What it does |
|---|---|---|
| candidateNamerequired | string | The person's name as the question should say it. |
| decision | CandidateDecisionChoice | null | The reader's answer, once they have given one. |
| reason | ReactNode | The reader's own reason for it, shown under the answer. |
| onDecide | (decision: CandidateDecisionChoice, reason: string) => Promise<void> | Saves the reader's Yes or No with their reason, as `CandidateClientDecision` takes it: what asks for the reason stays open until the promise settles, and a rejected one says so and keeps the buttons. Without it the section only shows the answer given. |
| reasonSuggestions | { yes?: readonly string[]; no?: readonly string[]; } | One-tap reasons for each answer, already worded. |
| readOnly | boolean | Shows the answer and takes none: no Yes, No or Change. |
| disabled | boolean | Holds Yes, No and Change, such as while another person's profile is opening. |
| titleLevel | CandidateSharedProfileSectionLevel | The heading's level in the page's outline: 2 (the default), or 3 to 5. The heading is the kit's small section header at every level. |
| labels | Partial<CandidateSharedProfileLabels> | |
| decisionLabels | Partial<CandidateClientDecisionLabels> | The Yes or No row's wording, as `CandidateClientDecision` takes it. |
| id | string | |
| className | string | |
| style | CSSProperties | |
| reasonOptional | boolean | Lets the client answer without a reason: the dialog still asks why, and saves with none given. The reason is required without it. |
| reasonPrompt | CandidateClientDecisionReasonPrompt | How the reason is asked for. `dialog` (the default) is a typed reason in `CandidateDecisionReasonDialog`. `sheet` is the voice-first `CandidateDecisionReasonSheet`: speaking is the default, a suggested reason is one tap, typing is a tap away, and Skip saves with no reason where `reasonOptional` allows it. The sheet holds itself on a saving state while `onDecide`'s promise is pending and, when it rejects, keeps the reason and says so there, so the row shows no error of its own. If the sheet can't be downloaded, the row asks in the dialog. |
| reasonSheet | CandidateClientDecisionSheetProps | ((decision: CandidateDecisionChoice) => CandidateClientDecisionSheetProps) | The sheet's own settings for `reasonPrompt="sheet"`, or a function of the answer being explained that returns them, for wording that names the answer. |
CandidateSharedProfileNotes
| Prop | Type | What it does |
|---|---|---|
| notesrequired | readonly CandidateSharedProfileClientNote[] | The reader's notes, in the order to show them. |
| candidateNamerequired | string | The person's name as the note field should say it. |
| onAdd | (text: string) => Promise<void> | Saves a note. Resolve once it is saved, and pass it back in `notes`; reject to keep the words in the composer, with `labels.noteFailed` under them. Without it the section only shows the notes. |
| readOnly | boolean | Shows the notes and takes none. |
| disabled | boolean | Holds the composer, such as while another person's profile is opening. |
| voice | boolean | `false` leaves dictation out, and the composer opens for typing. It also opens there wherever dictation can't run. |
| maxLength | number | The longest note the composer takes, typed or spoken. |
| titleLevel | CandidateSharedProfileSectionLevel | The heading's level in the page's outline: 2 (the default), or 3 to 5. The heading is the kit's small section header at every level. |
| labels | Partial<CandidateSharedProfileLabels> | |
| id | string | |
| className | string | |
| style | CSSProperties |
CandidateSharedProfileSection
| Prop | Type | What it does |
|---|---|---|
| titlerequired | ReactNode | The section's heading, which also names it. |
| titleLevel | CandidateSharedProfileSectionLevel | The heading's level: 2 (the default), or 3 to 5 to fit the page's outline. Only the tag changes. |
| printVisibility | "visible" | "hidden" | `hidden` leaves the section off a printed profile. |
| children | ReactNode | |
| id | string | |
| className | string | |
| style | CSSProperties |
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.