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

Client search page

A search as the person it is run for sees it, on one page: the conversation that gets the brief ready, then each delivery of people with a Yes or No on each.

What it shows

A search as its client sees it, on one page.

Props

PropTypeWhat it does
title (required)ReactNodeThe search's name: the page's h1.
eyebrowReactNodeAbove the title, such as a link back to the reader's other searches.
subtitleReactNodeUnder the title, such as where the role is. The current step follows it (labels.now: "Now: Shortlist to review").
agentName (required)stringWho runs the search, as the page names them: "Scout has a question", "How Scout searched".
stepsreadonly JobSearchStep[]Where the search stands: its steps in order, as JobSearchProgress takes them, behind the header's Progress button. With none, no button.
briefJobBriefContent | nullThe brief as it stands, or none until there is one: behind the header's Brief button, and under an open search's deliveries.
briefOptionsJobBriefViewOptionsHow the brief is read, as jobBriefView takes it: its title, wording and audience.
draftbooleanThe search is still a draft: the page is the conversation that gets the brief ready (thread, suggestedReplies, onReply). Without it the search is open, and the page is its sections with no reply box.
threadreadonly ClientSearchConversationItem[]A draft's conversation in order, as clientSearchThread returns it.
awaitingReplybooleanA reply to the reader is being written. A draft's conversation ends on a running line and holds its composer; an open search says so (labels.reading) where the question would be.
suggestedRepliesreadonly string[]Replies offered next, already worded: over a draft's composer, and as the answers to an open search's question.
onReply(words: string, files: File[]) => unknownSends the reader's reply in a draft's conversation, with the files they attached, as ClientSearchConversation takes it: a promise holds the composer, and a rejected one puts the words back with an error line.
maxFilesnumberHow many files one reply takes: 5 by default, and 0 leaves files out.
chatClientSearchChatPropsThe kit Chat's own props for the draft's conversation, passed straight through.
questionstring | nullA question put to the reader on an open search, as Markdown, answered with suggestedReplies.
onAnswer(answer: string) => unknownCalled with the answer the reader picked, as ClientSearchQuestion takes it. Defaults to onReply with that answer and no files.
searchingbooleanAn open search is finding people now.
liveStepsreadonly SourcingTraceStep[]The steps of the run under way, as it reports them.
actionsreadonly ClientSearchAction[]What the reader can ask for next on an open search.
onAction(action: ClientSearchAction) => unknownCalled with the action the reader asked for, as ClientSearchNextActions takes it.
actionsNeedCallbooleanAsking for more needs a call first: the actions are offered, and picking one opens the call prompt without calling onAction.
callPromptOpenbooleanWhether the call prompt is open, for a host that opens it itself, such as when its server turns a request down. Left out, the page opens it for actionsNeedCall and closes it.
onCallPromptOpenChange(open: boolean) => voidCalled when the call prompt opens or closes.
deliveriesreadonly ClientSearchDeliveryItem[]Each delivery of people, oldest first. An open search shows them newest first.
otherRunsreadonly ClientSearchRun[]Runs that delivered nobody, each folded to one line under the deliveries.
onDecide(person: ClientSearchPerson, decision: CandidateDecisionChoice, reason: string) => Promise<void>Saves the reader's Yes or No on a person, with their reason, as ClientSearchDelivery takes it.
reasonOptionalbooleanLets an answer on a person be saved with no reason. A reason is required without it.
reasonSuggestions{ yes?: readonly string[]; no?: readonly string[]; }One-tap reasons for each answer on a person, already worded.
callClientSearchCallHow the reader books a call: a link, a callback, or both. An open search offers it in the header; a draft offers it as the current step's next action (labels.callInstead), unless the step has one of its own.
readOnlybooleanThe page as its reader sees it, for someone who can't act for them, such as the team that runs the search: everything shows and nothing can be sent. No composer, no suggested replies, no answers or requests to press, no Yes, No or Change, no call to book, and no step's action. What only opens or folds (the brief, the progress, a run's steps) still does.
markdownComponentsMarkdownComponentsPer-element overrides for every Markdown text on the page.
labelsPartial<ClientSearchLabels>
decisionLabelsPartial<CandidateClientDecisionLabels>The Yes or No row's wording, as CandidateClientDecision takes it.
traceLabelsPartial<SourcingTraceLabels>A run's wording, as SourcingTrace takes it.
progressLabelsPartial<JobSearchProgressLabels>Each step's state in words, as JobSearchProgress takes them.

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 client's search page with the brief's conversation, then deliveries of people to say yes or no to.