recruit/candidate-notes · CandidateNoteList

Notes

The notes on a person, each with who left it and for which role, and a voice-first composer.

Notes3

Hiring managerClient note · pinnedGeneral
2 days ago

Would like a second conversation.

Jordan Mbeki· voiceFounding GTM Engineer
yesterday

Keen on the founding role; wants to understand who they would report to.

YouGeneral
last week

Prefers hybrid, two days in the office at most.

Install

With your coding agentInstall RecruiterOS/recruit-ui and add a notes section with a composer to a candidate's detail pane.
With the shadcn CLIpnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflows

Props

CandidateNoteList

PropTypeWhat it does
countrequirednumberHow many notes there are. Zero shows the empty state instead of `children`.
loadingbooleanA skeleton row in place of the list, and no count yet.
titleReactNodeThe section heading.
emptyNotesEmptyCopyThe blank slate's wording. Defaults to "No notes yet".
composerReactNodeBelow the notes, usually a NoteComposer.
childrenReactNodeThe notes, usually NoteCards, newest or pinned first.
border"none" | "top" | "bottom"The kit PanelSection's divider.

CandidateNoteCard

PropTypeWhat it does
authorrequiredReactNodeWho left it, already resolved to a display name.
kindNoteKind
pinnedNotePinnedPins the note: it sits on the card surface, not the muted one, with this badge.
scopeNoteScope
dateReactNodeWhen it was left, already formatted.
textReactNodeThe note, kept as written: line breaks are preserved.
onDelete() => voidAdds a delete button. Confirm in the host before deleting anything.
revealDelete"always" | "hover"Whether the delete button is always shown or appears on hover. Use `always` on touch screens.
labelsPartial<NoteCardLabels>

CandidateNoteComposer

PropTypeWhat it does
labelsPartial<CandidateNoteComposerLabels>
onVoice() => voidStarts the host's recorder. Without it the composer opens for typing.
onSubmitrequired(text: string) => Promise<void>Receives trimmed text. Resolve only once saved; reject to preserve the draft.
suggestionsreadonly string[]
valuestringControlled text. In this mode the host clears or replaces it after saving.
onValueChange(text: string) => void
editingbooleanThe host can keep a recovered draft open even when its text becomes empty.
onEditingChange(editing: boolean) => void
onCancel() => void
disabledboolean
errorReactNode
maxLengthnumber

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.