New: Kith open-sources its ATS.Read why
Skip to Content

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.

What it shows

The sections of a shared profile, each on its own.

Props

CandidateSharedProfileSwitcher

PropTypeWhat it does
people (required)readonly CandidateSharedProfilePersonOption[]The people the link shares, in its order.
value (required)stringThe person whose profile is showing: the pressed chip.
onChange(id: string) => unknownCalled 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.
openingstring | nullThe 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.
errorReactNodeA line under the chips, for a host that knows a profile didn't open some other way than that promise.
anonymisedbooleanNames nobody: each chip says its place in the row (labels.anonymousPerson) and shows no face, whatever people holds.
labelsPartial<CandidateSharedProfileLabels>
idstring
classNamestring
styleCSSProperties

CandidateSharedProfileHeader

PropTypeWhat it does
person (required)CandidateSharedProfilePerson
anonymisedbooleanShows 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.
titleLevelCandidateProfileHeaderTitleLevelThe name's heading level, as CandidateProfileHeader takes it. 1 by default.
labelsPartial<CandidateSharedProfileLabels>
idstring
classNamestring
styleCSSProperties
eyebrowReactNode
statusReactNode
paddingExtract<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

PropTypeWhat it does
src (required)stringWhere the recording plays from. The host resolves it.
transcriptstring | nullWhat it says, for a reader who would sooner read. Line breaks are kept.
titleLevelCandidateSharedProfileSectionLevelThe heading's level: 2 (the default), or 3 to 5 to fit the page's outline.
renderAudio(audio: CandidatePresentationRecorderAudio) => ReactNodeRenders the player. Defaults to the browser's own audio controls.
labelsPartial<CandidateSharedProfileLabels>
idstring
classNamestring
styleCSSProperties

CandidateSharedProfileNote

PropTypeWhat it does
text (required)stringThe note, as written. Line breaks are kept.
authorstring | nullWho wrote it, for the heading ("Note from Jordan").
titleLevelCandidateSharedProfileSectionLevelThe heading's level: 2 (the default), or 3 to 5 to fit the page's outline.
labelsPartial<CandidateSharedProfileLabels>
idstring
classNamestring
styleCSSProperties

CandidateSharedProfileFit

PropTypeWhat it does
titleLevelCandidateSharedProfileSectionLevelThe heading's level: 2 (the default), or 3 to 5 to fit the page's outline.
labelsPartial<CandidateSharedProfileLabels>
idstring
classNamestring
styleCSSProperties
roleTitleReactNodeThe role they were assessed for, for the heading ("Fit for Staff Engineer").
gradeCandidateSharedProfileGrade | nullThe 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.
assessmentTagsreadonly string[]Labels chosen by the host for this assessment.
summaryReactNodeA line or two on why, over the evidence.
evidencereadonly CandidateSummaryBullet[]The evidence, a line each, each with the host's sentiment.
groupsreadonly 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

PropTypeWhat it does
title (required)ReactNodeThe list's heading, such as "What to test".
items (required)readonly CandidateSummaryBullet[]Its lines, each with the host's sentiment.

CandidateSharedProfileAnswer

PropTypeWhat it does
candidateName (required)stringThe person's name as the question should say it.
decisionCandidateDecisionChoice | nullThe reader's answer, once they have given one.
reasonReactNodeThe 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.
readOnlybooleanShows the answer and takes none: no Yes, No or Change.
disabledbooleanHolds Yes, No and Change, such as while another person's profile is opening.
titleLevelCandidateSharedProfileSectionLevelThe 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.
labelsPartial<CandidateSharedProfileLabels>
decisionLabelsPartial<CandidateClientDecisionLabels>The Yes or No row's wording, as CandidateClientDecision takes it.
idstring
classNamestring
styleCSSProperties
reasonOptionalbooleanLets the client answer without a reason: the dialog still asks why, and saves with none given. The reason is required without it.
reasonPromptCandidateClientDecisionReasonPromptHow 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.
reasonSheetCandidateClientDecisionSheetProps | ((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

PropTypeWhat it does
notes (required)readonly CandidateSharedProfileClientNote[]The reader's notes, in the order to show them.
candidateName (required)stringThe 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.
readOnlybooleanShows the notes and takes none.
disabledbooleanHolds the composer, such as while another person's profile is opening.
voicebooleanfalse leaves dictation out, and the composer opens for typing. It also opens there wherever dictation can't run.
maxLengthnumberThe longest note the composer takes, typed or spoken.
titleLevelCandidateSharedProfileSectionLevelThe 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.
labelsPartial<CandidateSharedProfileLabels>
idstring
classNamestring
styleCSSProperties

CandidateSharedProfileSection

PropTypeWhat it does
title (required)ReactNodeThe section's heading, which also names it.
titleLevelCandidateSharedProfileSectionLevelThe 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.
childrenReactNode
idstring
classNamestring
styleCSSProperties

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
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.