recruit/candidate-grade · CandidateGradeBadge
Grade badge
A grade letter with your own label and tone, plus helpers that normalise and format grades.
With labels
AStrong fit
BGood fit
CWorth a screen
DPoor fit
—
Letters only
A
B
C
D
Inline text, compact
A — Strong fit
B — Good fit
C — Worth a screen
D — Poor fit
Sentiment pill
A — Strong fitB — Good fitC — Worth a screenD — Poor fit
As text
B — Good fit
Install
With your coding agent
Install RecruiterOS/recruit-ui and add a grade badge with my own labels to each candidate card.With the shadcn CLI
pnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflowsProps
| Prop | Type | What it does |
|---|---|---|
| graderequired | string | null | undefined | |
| label | ReactNode | One-off host wording. Takes precedence over `labels`. With no grade, the inline format shows it alone, such as "Needs review", in place of the dash. |
| labels | CandidateGradeLabels | Host-owned wording map for shared badge instances. |
| tone | CandidateGradeTone | Host-owned semantic treatment; no meaning is inferred from the letter. |
| showLabel | boolean | |
| size | BadgeProps["size"] | The kit badge size, such as `compact` for dense rows. |
| as | "div" | "span" | Root element: a block-level `div` (default) or an inline `span`. |
| shrink | boolean | Keep the badge at its natural width in a flex row. |
| format | "split" | "inline" | `split` (default): the letter and the label as separate spans, the letter with an accessible name. `inline`: a single line of text, "A — Strong fit", for a host that names the grade in a tooltip or the surrounding text; with no grade, the label alone, or "—" without one. |
| appearance | "badge" | "sentiment" | `badge` (default): the kit Badge in `tone`. `sentiment`: the kit's sentiment pill, a coloured dot and text, in `sentiment`. The pill takes only `className`; other attributes are not passed to it. |
| sentiment | CandidateGradeSentiment | Host-owned sentiment for `appearance="sentiment"`. |
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.