recruit/client-search-sections · ClientSearchDelivery

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.

Book a call

Scout has a question

Should we look outside **London**?

Scout is searching

We are looking for more people. Review the ones below while we do.

Searched for peoplePeople who built outbound at seed stage
Grading each person against the brief

First shortlist

Each card says why we picked them. Tell us Yes or No, and why: the next card gets sharper.

Riley Okafor

GTM Engineer · Example Labs

Why we picked them

Built the outbound stack alone at a seed-stage company.

Sam Lindqvist

RevOps Lead · Sample Analytics

Why we picked them

Writes the code and runs the campaigns.Ask about: being the only one on the team.

Install

With your coding agentInstall 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.
With the shadcn CLIpnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflows

Props

ClientSearchQuestion

PropTypeWhat it does
questionrequiredstringThe question, as Markdown.
agentNamerequiredstringWho 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
agentNamerequiredstringWho 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
actionsrequiredreadonly 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
titlerequiredReactNodeThe delivery's name: its heading.
descriptionReactNodeWhat was said about it, under the title. Defaults to `labels.deliveryDescription`.
peoplerequiredreadonly 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.
agentNamerequiredstringWho 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
briefrequiredJobBriefContentThe brief as it stands.
briefOptionsJobBriefViewOptionsHow the brief is read, as `jobBriefView` takes it: its title, wording and audience.
labelsPartial<ClientSearchLabels>

ClientSearchProgressPanel

PropTypeWhat it does
stepsrequiredreadonly 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
openrequiredboolean
onOpenChangerequired(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
callrequiredClientSearchCallWhere the control leads, or what it calls.
childrenrequiredReactNodeThe 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

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.