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

Shortlist

One page per search for your client: a note from you, the people you rate and why, and a yes or no on each.

What it shows

People, a note from you, and a client decision.

Props

CandidateShortlist

PropTypeWhat it does
title (required)ReactNodeThe shortlist's name. It is the section's heading (an h2) and names the section.
eyebrowReactNodeA short label above the title, such as which delivery this is.
descriptionReactNodeA muted line under the title: why these people, or what to do with them.
statusReactNodeBeside the heading, at its end, such as a status badge. It keeps its width: on a narrow screen the title wraps rather than the status.
countnumberHow many people the shortlist holds. Zero shows the empty state in place of children and footer. Left out, the shortlist is empty when children holds nothing to render. It isn't displayed: put a count in title to show one.
childrenReactNodeThe people, usually the host's candidate cards.
footerReactNodeUnder the people, such as where the shortlist is delivered (CandidateDestinationStatus). Not shown while the shortlist is empty.
emptyCandidateEmptyCopyThe blank slate's wording. Defaults to "No candidates shortlisted yet".
emptySizeCandidateShortlistEmptySizeThe blank slate's size. inline (the default) suits a shortlist inside a message, pane or card; md suits one that is the main list on a page of its own, such as a shortlist page sent to a client.

CandidateShortlistNote

PropTypeWhat it does
title (required)ReactNodeWho the note is from, such as "A note from Jordan". It is the note's heading.
titleLevel2 | 3 | 4The title's heading level: 2 (the default) for a note under the page's own h1, or 3 or 4 where it sits deeper in the page's outline. Only the tag changes: the title looks the same at every level.
avatarReactNodeThe sender's face, usually a PersonAvatar. 44px reads best.
metaReactNodeA line under the title, such as the sender's role and firm.
messageReactNodeThe note itself, set as rich text. Pass paragraphs, or Markdown the host has already rendered (and sanitised): the note parses nothing.
mediaReactNodeUnder the message, such as an embedded video from the sender.
signatureReactNodeA sign-off on the note's last line, such as "— Jordan".
actionReactNodeBeside the sign-off, such as a link to book a call with the sender.

CandidateClientDecision

PropTypeWhat it does
candidateName (required)stringThe candidate's name as the dialog should say it.
decisionCandidateDecisionChoice | nullThe answer already recorded, if any.
reasonReactNodeThe reason recorded with it, shown under the answer.
onDecide (required)(decision: CandidateDecisionChoice, reason: string) => Promise<void>Saves the answer and its reason. The dialog stays open, its buttons disabled, until the promise settles, then closes. When the promise rejects, the buttons come back with an error line under them. The reason is an empty string when reasonOptional let the client answer without one.
suggestions{ yes?: readonly string[]; no?: readonly string[]; }One-tap reasons for each answer, already worded.
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.
readOnlybooleanShows the answer and takes none, for someone looking at a client's shortlist who can't answer for them: the recorded answer in words (labels.readOnlyYes, labels.readOnlyNo) with its reason, or labels.unanswered, and no Yes, No or Change. onDecide is never called.
disabledbooleanHolds Yes, No and Change without hiding them, such as while the page the row sits on is loading someone else. A reason being asked for when it turns on is dropped, and nothing is decided.
padding"default" | "none"default is the action row of a review card: inset like the card, under a keyline. none sits the row flush, with no keyline, in a container that already pads and rules it, such as a section of a profile.
labelsPartial<CandidateClientDecisionLabels>

Data it needs

On the Kith data layer, a shortlist reads its people from a search and saves each decision with its reason. With your own backend, pass the same values and callbacks.

It shows JobCandidate from the Kith ATS API.

Copy to your agent

Copy to your agent
Install RecruiterOS/recruit-ui and build a client shortlist page with a note and yes or no decisions.