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
| Prop | Type | What it does |
|---|---|---|
question (required) | string | The question, as Markdown. |
agentName (required) | string | Who asks it, for the heading ("Scout has a question"). |
answers | readonly string[] | Answers the reader can give in one tap, already worded. |
onAnswer | (answer: string) => unknown | Called 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. |
disabled | boolean | Holds the answers, such as while another request from the same page is on its way. |
readOnly | boolean | Shows the question and the answers offered as text, with nothing to press. |
titleLevel | ClientSearchTitleLevel | The heading's level: 2 (the default), or 3 or 4 to fit the page's outline. |
markdownComponents | MarkdownComponents | Per-element overrides for the question's Markdown. |
labels | Partial<ClientSearchLabels> |
ClientSearchLive
| Prop | Type | What it does |
|---|---|---|
agentName (required) | string | Who is searching, for the heading and the run's name ("Scout is searching"). |
steps | readonly 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. |
more | boolean | The 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). |
description | ReactNode | The line under the heading, in place of either default. |
titleLevel | ClientSearchTitleLevel | The heading's level: 2 (the default), or 3 or 4 to fit the page's outline. |
markdownComponents | MarkdownComponents | Per-element overrides for the steps' Markdown detail. |
labels | Partial<ClientSearchLabels> | |
traceLabels | Partial<SourcingTraceLabels> | The run's own wording, as SourcingTrace takes it. |
ClientSearchNextActions
| Prop | Type | What it does |
|---|---|---|
actions (required) | readonly ClientSearchAction[] | What the reader can ask for, in order. With none, nothing is drawn. |
onAction | (action: ClientSearchAction) => unknown | Called 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. |
disabled | boolean | Holds the actions, such as while another request from the same page is on its way. |
readOnly | boolean | Lists what can be asked for as text, with nothing to press. |
titleLevel | ClientSearchTitleLevel | The heading's level: 2 (the default), or 3 or 4 to fit the page's outline. |
labels | Partial<ClientSearchLabels> |
ClientSearchDelivery
| Prop | Type | What it does |
|---|---|---|
title (required) | ReactNode | The delivery's name: its heading. |
description | ReactNode | What was said about it, under the title. Defaults to labels.deliveryDescription. |
people (required) | readonly ClientSearchPerson[] | The people in it, in its order. |
runSteps | readonly SourcingTraceStep[] | How the run that found them searched: its steps, folded to one line under the people. |
agentName (required) | string | Who 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. |
reasonOptional | boolean | Lets 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. |
readOnly | boolean | Shows each answer and takes none: no Yes, No or Change. |
markdownComponents | MarkdownComponents | Per-element overrides for the run's Markdown detail. |
labels | Partial<ClientSearchLabels> | |
decisionLabels | Partial<CandidateClientDecisionLabels> | The Yes or No row's wording, as CandidateClientDecision takes it. |
traceLabels | Partial<SourcingTraceLabels> | The run's wording, as SourcingTrace takes it. |
ClientSearchBriefPanel
| Prop | Type | What it does |
|---|---|---|
brief (required) | JobBriefContent | The brief as it stands. |
briefOptions | JobBriefViewOptions | How the brief is read, as jobBriefView takes it: its title, wording and audience. |
labels | Partial<ClientSearchLabels> |
ClientSearchProgressPanel
| Prop | Type | What it does |
|---|---|---|
steps (required) | readonly JobSearchStep[] | The search's steps, in order, as JobSearchProgress takes them. |
labels | Partial<ClientSearchLabels> | |
progressLabels | Partial<JobSearchProgressLabels> | Each state in words, as JobSearchProgress takes them. |
ClientSearchCallPrompt
| Prop | Type | What it does |
|---|---|---|
open (required) | boolean | |
onOpenChange (required) | (open: boolean) => void | Called when the reader closes the prompt. |
call | ClientSearchCall | How a call is booked. Without it the prompt only says to talk first. |
labels | Partial<ClientSearchLabels> |
ClientSearchCallButton
| Prop | Type | What it does |
|---|---|---|
call (required) | ClientSearchCall | Where the control leads, or what it calls. |
children (required) | ReactNode | The 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
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.