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

Shared profile

A person's profile as whoever it was shared with sees it: who they are, what the sharer says, how well they fit and their career, with a Yes or No and notes from the reader.

What it shows

A profile as the person it was shared with sees it.

Props

PropTypeWhat it does
person (required)CandidateSharedProfilePersonWho the profile is about.
anonymisedbooleanShows nobody. The name, the avatar, the cover and the profile link are never drawn, even when person carries them, the switcher names nobody, and the Yes or No and the note field say labels.anonymousReference. Everything else is drawn as passed, so the host redacts what an employer's name or a note gives away.
eyebrowReactNodeAbove everything, such as the search or the role the person was shared for.
peoplereadonly CandidateSharedProfilePersonOption[]The people the link shares, for a link that shares several. With fewer than two there is no switcher.
personIdstringWhich of people this profile is.
onPersonChange(id: string) => unknownCalled with the person picked in the switcher; the host shows their profile. While a promise it returns is pending the switcher says who is opening, and it, the Yes or No and the note field are held.
openingPersonIdstring | nullThe person whose profile is on its way, for a host that knows it some other way than that promise. It holds the same controls.
archivedbooleanThe link has been archived: a notice says so above the profile, which dims. For whoever can still see an archived profile, such as the person who shared it.
voiceNoteCandidateSharedProfileRecording | nullA spoken note from whoever shared the profile.
noteCandidateSharedProfileWrittenNote | nullA written note from them.
fitCandidateSharedProfileAssessment | nullHow well the person fits the role they were shared for.
summaryReactNodeA summary of the person. A string keeps its line breaks.
experiencereadonly CareerHistoryItem[]Their career, newest first, as CandidateCareerHistoryTimeline takes it.
experienceOptionsPick<CandidateCareerHistoryTimelineProps, "detailedCompanyGroups" | "earlierLabel" | "presentLabel" | "locale">How the career is drawn, as CandidateCareerHistoryTimeline takes it.
educationreadonly CandidateSharedProfileEducationItem[]Their education.
skillsreadonly ReactNode[]Their skills, a tag each.
certificationsreadonly ReactNode[]Their certifications, a line each.
languagesreadonly ReactNode[]The languages they speak, a line each.
childrenReactNodeFurther sections of the host's own, under the profile's, usually CandidateSharedProfileSections.
decisionCandidateDecisionChoice | nullThe reader's Yes or No on the person, once they have given one.
decisionReasonReactNodeThe 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 CandidateSharedProfileAnswer takes it. Without it the profile has no Yes or No: it shows an answer already given, and nothing where there is none.
reasonOptionalbooleanLets the answer be saved with no reason. A reason is required without it.
reasonSuggestions{ yes?: readonly string[]; no?: readonly string[]; }One-tap reasons for each answer, already worded.
reasonPromptCandidateClientDecisionProps["reasonPrompt"]How the reason is asked for: typed in a dialog (the default), or voice first in a sheet.
reasonSheetCandidateClientDecisionProps["reasonSheet"]The sheet's own settings for reasonPrompt="sheet", as CandidateClientDecision takes them.
clientNotesreadonly CandidateSharedProfileClientNote[]The notes the reader has left on the person, in the order to show them.
onAddNote(text: string) => Promise<void>Saves a note from the reader, as CandidateSharedProfileNotes takes it. Without it the profile takes no notes: it shows the ones given, and nothing where there are none.
noteVoicebooleanfalse leaves dictation out of the note field.
noteMaxLengthnumberThe longest note the field takes.
readOnlybooleanThe profile as its reader sees it, for someone who can't act for them: the answer and the notes show, and none can be given.
creditReactNodeA closing line inside the profile, such as who shared it. It isn't printed.
titleLevelCandidateProfileHeaderTitleLevelThe name's heading level: 1 (the default) for a profile that is the page, or 2 to 4 under a page that has its own h1. The sections sit one level under it.
renderAudio(audio: CandidatePresentationRecorderAudio) => ReactNodeRenders the spoken note's player. Defaults to the browser's own audio controls.
labelsPartial<CandidateSharedProfileLabels>
decisionLabelsPartial<CandidateClientDecisionLabels>The Yes or No row's wording, as CandidateClientDecision takes it.
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 a shared candidate profile page where my client says yes or no and leaves notes.