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

Client search sections

The sections of a client's open search, each usable on its own: a question with its answers, the search under way, what to ask for next, a delivery of people, the brief and the progress behind buttons, and a prompt to book a call.

What it shows

The sections of an open search, each on its own.

Props

ClientSearchQuestion

PropTypeWhat it does
question (required)stringThe question, as Markdown.
agentName (required)stringWho asks it, for the heading ("Scout has a question").
answersreadonly string[]Answers the reader can give in one tap, already worded.
onAnswer(answer: string) => unknownCalled with the answer the reader picked. While a promise it returns is pending the answers are held; if it rejects, they come back with labels.failed under them. Without it the answers show as text.
disabledbooleanHolds the answers, such as while another request from the same page is on its way.
readOnlybooleanShows the question and the answers offered as text, with nothing to press.
titleLevelClientSearchTitleLevelThe heading's level: 2 (the default), or 3 or 4 to fit the page's outline.
markdownComponentsMarkdownComponentsPer-element overrides for the question's Markdown.
labelsPartial<ClientSearchLabels>

ClientSearchLive

PropTypeWhat it does
agentName (required)stringWho is searching, for the heading and the run's name ("Scout is searching").
stepsreadonly SourcingTraceStep[]The steps of the run under way, as it reports them. Left out or empty, the section says only that the search is on.
morebooleanThe search has already delivered people: the line under the heading says it is looking for more (labels.searchingMore), not that the first are on their way (labels.searchingFirst).
descriptionReactNodeThe line under the heading, in place of either default.
titleLevelClientSearchTitleLevelThe heading's level: 2 (the default), or 3 or 4 to fit the page's outline.
markdownComponentsMarkdownComponentsPer-element overrides for the steps' Markdown detail.
labelsPartial<ClientSearchLabels>
traceLabelsPartial<SourcingTraceLabels>The run's own wording, as SourcingTrace takes it.

ClientSearchNextActions

PropTypeWhat it does
actions (required)readonly ClientSearchAction[]What the reader can ask for, in order. With none, nothing is drawn.
onAction(action: ClientSearchAction) => unknownCalled with the action the reader asked for. While a promise it returns is pending the actions are held; if it rejects, they come back with labels.failed under them. Without it the actions show as text.
disabledbooleanHolds the actions, such as while another request from the same page is on its way.
readOnlybooleanLists what can be asked for as text, with nothing to press.
titleLevelClientSearchTitleLevelThe heading's level: 2 (the default), or 3 or 4 to fit the page's outline.
labelsPartial<ClientSearchLabels>

ClientSearchDelivery

PropTypeWhat it does
title (required)ReactNodeThe delivery's name: its heading.
descriptionReactNodeWhat was said about it, under the title. Defaults to labels.deliveryDescription.
people (required)readonly ClientSearchPerson[]The people in it, in its order.
runStepsreadonly SourcingTraceStep[]How the run that found them searched: its steps, folded to one line under the people.
agentName (required)stringWho searched, for the run's name ("How Scout searched").
onDecide(person: ClientSearchPerson, decision: CandidateDecisionChoice, reason: string) => Promise<void>Saves the reader's Yes or No on a person, with their reason, as CandidateClientDecision asks for it: the dialog stays open until the promise settles, and a rejected one brings the buttons back with an error line. Without it the cards only show the answers given.
reasonOptionalbooleanLets an 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.
readOnlybooleanShows each answer and takes none: no Yes, No or Change.
markdownComponentsMarkdownComponentsPer-element overrides for the run's Markdown detail.
labelsPartial<ClientSearchLabels>
decisionLabelsPartial<CandidateClientDecisionLabels>The Yes or No row's wording, as CandidateClientDecision takes it.
traceLabelsPartial<SourcingTraceLabels>The run's wording, as SourcingTrace takes it.

ClientSearchBriefPanel

PropTypeWhat it does
brief (required)JobBriefContentThe brief as it stands.
briefOptionsJobBriefViewOptionsHow the brief is read, as jobBriefView takes it: its title, wording and audience.
labelsPartial<ClientSearchLabels>

ClientSearchProgressPanel

PropTypeWhat it does
steps (required)readonly JobSearchStep[]The search's steps, in order, as JobSearchProgress takes them.
labelsPartial<ClientSearchLabels>
progressLabelsPartial<JobSearchProgressLabels>Each state in words, as JobSearchProgress takes them.

ClientSearchCallPrompt

PropTypeWhat it does
open (required)boolean
onOpenChange (required)(open: boolean) => voidCalled when the reader closes the prompt.
callClientSearchCallHow a call is booked. Without it the prompt only says to talk first.
labelsPartial<ClientSearchLabels>

ClientSearchCallButton

PropTypeWhat it does
call (required)ClientSearchCallWhere the control leads, or what it calls.
children (required)ReactNodeThe control's words, such as "Book a call".
variant"default" | "outline"default (the default) where the call is the one thing to do, outline beside other controls.
size"sm" | "default"

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 client's open search: a question, the search under way, what to ask for next and a delivery of people.