Notes
The notes on a person, each with who left it and for which role, and a voice-first composer.
What it shows
The notes on a person, and a composer.
Props
CandidateNoteList
| Prop | Type | What it does |
|---|---|---|
count (required) | number | How many notes there are. Zero shows the empty state instead of children. |
loading | boolean | A skeleton row in place of the list, and no count yet. |
title | ReactNode | The section heading. |
empty | NotesEmptyCopy | The blank slate's wording. Defaults to "No notes yet". |
composer | ReactNode | Below the notes, usually a NoteComposer. |
children | ReactNode | The notes, usually NoteCards, newest or pinned first. |
border | "none" | "top" | "bottom" | The kit PanelSection's divider. |
CandidateNoteCard
| Prop | Type | What it does |
|---|---|---|
author (required) | ReactNode | Who left it, already resolved to a display name. |
kind | NoteKind | |
pinned | NotePinned | Pins the note: it sits on the card surface, not the muted one, with this badge. |
scope | NoteScope | |
date | ReactNode | When it was left, already formatted. |
text | ReactNode | The note, kept as written: line breaks are preserved. |
onDelete | () => void | Adds 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. |
labels | Partial<NoteCardLabels> |
CandidateNoteComposer
| Prop | Type | What it does |
|---|---|---|
labels | Partial<CandidateNoteComposerLabels> | |
onVoice | () => void | Starts the host's recorder. Without it the composer opens for typing. |
onSubmit (required) | (text: string) => Promise<void> | Receives trimmed text. Resolve only once saved; reject to preserve the draft. |
suggestions | readonly string[] | |
value | string | Controlled text. In this mode the host clears or replaces it after saving. |
onValueChange | (text: string) => void | |
editing | boolean | The host can keep a recovered draft open even when its text becomes empty. |
onEditingChange | (editing: boolean) => void | |
onCancel | () => void | |
disabled | boolean | |
error | ReactNode | |
maxLength | number |
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 a notes section with a composer to a candidate's detail pane.