# Client search page (/ui/client-search-page)

## What it shows [#what-it-shows]

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

## Props [#props]

| Prop | Type | What it does |
| --- | --- | --- |
| `title` (required) | `ReactNode` | The search's name: the page's h1. |
| `eyebrow` | `ReactNode` | Above the title, such as a link back to the reader's other searches. |
| `subtitle` | `ReactNode` | Under the title, such as where the role is. The current step follows it (`labels.now`: "Now: Shortlist to review"). |
| `agentName` (required) | `string` | Who runs the search, as the page names them: "Scout has a question", "How Scout searched". |
| `steps` | `readonly JobSearchStep[]` | Where the search stands: its steps in order, as `JobSearchProgress` takes them, behind the header's Progress button. With none, no button. |
| `brief` | `JobBriefContent \| null` | The brief as it stands, or none until there is one: behind the header's Brief button, and under an open search's deliveries. |
| `briefOptions` | `JobBriefViewOptions` | How the brief is read, as `jobBriefView` takes it: its title, wording and audience. |
| `draft` | `boolean` | The 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. |
| `thread` | `readonly ClientSearchConversationItem[]` | A draft's conversation in order, as `clientSearchThread` returns it. |
| `awaitingReply` | `boolean` | A 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. |
| `suggestedReplies` | `readonly 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[]) => unknown` | Sends 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. |
| `maxFiles` | `number` | How many files one reply takes: 5 by default, and 0 leaves files out. |
| `chat` | `ClientSearchChatProps` | The kit Chat's own props for the draft's conversation, passed straight through. |
| `question` | `string \| null` | A question put to the reader on an open search, as Markdown, answered with `suggestedReplies`. |
| `onAnswer` | `(answer: string) => unknown` | Called with the answer the reader picked, as `ClientSearchQuestion` takes it. Defaults to `onReply` with that answer and no files. |
| `searching` | `boolean` | An open search is finding people now. |
| `liveSteps` | `readonly SourcingTraceStep[]` | The steps of the run under way, as it reports them. |
| `actions` | `readonly ClientSearchAction[]` | What the reader can ask for next on an open search. |
| `onAction` | `(action: ClientSearchAction) => unknown` | Called with the action the reader asked for, as `ClientSearchNextActions` takes it. |
| `actionsNeedCall` | `boolean` | Asking for more needs a call first: the actions are offered, and picking one opens the call prompt without calling `onAction`. |
| `callPromptOpen` | `boolean` | Whether 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) => void` | Called when the call prompt opens or closes. |
| `deliveries` | `readonly ClientSearchDeliveryItem[]` | Each delivery of people, oldest first. An open search shows them newest first. |
| `otherRuns` | `readonly 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. |
| `reasonOptional` | `boolean` | Lets 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. |
| `call` | `ClientSearchCall` | How 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. |
| `readOnly` | `boolean` | The 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. |
| `markdownComponents` | `MarkdownComponents` | Per-element overrides for every Markdown text on the page. |
| `labels` | `Partial<ClientSearchLabels>` |   |
| `decisionLabels` | `Partial<CandidateClientDecisionLabels>` | The Yes or No row's wording, as `CandidateClientDecision` takes it. |
| `traceLabels` | `Partial<SourcingTraceLabels>` | A run's wording, as `SourcingTrace` takes it. |
| `progressLabels` | `Partial<JobSearchProgressLabels>` | Each step's state in words, as `JobSearchProgress` takes them. |

## Data it needs [#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]

```text title="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.
```