recruit/candidate-outreach-composer · CandidateOutreachComposer
Outreach composer
Drafts a first message to a person: a channel, its house style, and an editable draft to copy.
Outreach
Install
With your coding agent
Install RecruiterOS/recruit-ui and add an outreach composer that drafts a first message per channel.With the shadcn CLI
pnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflowsProps
| Prop | Type | What it does |
|---|---|---|
| channelsrequired | readonly CandidateOutreachChannel<TValue>[] | The channels, in order, as buttons in the header. |
| channelrequired | TValue | |
| onChannelChangerequired | (value: TValue) => void | |
| guidancerequired | CandidateOutreachGuidance | |
| draft | CandidateOutreachDraft | null | The draft for the current channel. Without one, the composer offers to write it. |
| drafting | boolean | Shows the draft's progress and disables Draft and Redo. |
| error | ReactNode | Why the last draft failed. |
| copied | boolean | Shows Copied, with a check, in place of Copy. |
| onDraftrequired | () => void | Writes a draft, or a fresh one. |
| onCopyrequired | () => void | Copies the draft; the host decides what goes on the clipboard. |
| onEditDraftrequired | (message: string) => void | |
| labels | Partial<CandidateOutreachComposerLabels> | |
| border | "none" | "top" | "bottom" | The kit PanelSection's divider. |
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.