Pipeline board
A job's pipeline as a board: a column for each stage and a card for each person, moved by a drag or from the card's move menu, with each move saved by your app.
What it shows
A job's pipeline as a board, a column per stage.
Props
| Prop | Type | What it does |
|---|---|---|
columns (required) | readonly CandidatePipelineBoardColumn[] | The stages, in pipeline order. |
items (required) | readonly T[] | undefined | The people on the board, in the order each column lists them. A person whose stage is not one of columns is not shown. |
getId (required) | (item: T) => string | number | A stable id for each person's card. |
getStage (required) | (item: T) => string | The id of the column the person is in. |
getName (required) | (item: T) => string | The person's name: on the default card, and how their move menu and the board's announcements name them whoever draws the card. |
renderCard | (item: T, stage: string) => ReactNode | Draws a person's card, given the stage it is shown in. Defaults to a CandidatePipelineCard with the name, which calls onSelect. The card needs no wrapper and no drag handling of its own. |
onSelect | (item: T) => void | Called when the default card is activated, usually to open the person. |
onMove | (item: T, toStage: string) => unknown | Makes the cards movable, and is called with the person and the stage they were moved to, by a drag or from the card's move menu. The host saves the move. If it returns a promise, the card shows in the new stage at once. If the promise rejects, the card goes back to where getStage puts it. Once it resolves, the card stays where it was moved until the host says something new about the person, by passing another record for them or changing their stage, and getStage decides from then on. A callback that returns nothing leaves the card where getStage puts it throughout. |
loading | boolean | Skeleton cards in each column that has nobody to show yet. |
error | ReactNode | A failed load, worded by the host, in place of the columns. |
empty | CandidateEmptyCopy | The blank slate when the board holds nobody. Defaults to "No candidates yet". |
narrowed | boolean | Whether a search or a filter is narrowing the board, which words the blank slates ("No matches", not "No candidates"). Worked out from searchTerm and filters when left out. |
columnWidth | CandidatePipelineBoardColumnWidth | wide (the default) is 400px, or the screen's width if less; narrow is 280px. |
height | CandidatePipelineBoardHeight | viewport (the default) fills the screen's height, each column scrolling under its own heading, so the headings and the sideways scrollbar stay in view. content grows with the longest column. |
columnHeadingLevel | 2 | 3 | 4 | The column headings' level: 3 (the default), or 2 or 4 to fit the page's outline. |
labels | Partial<CandidatePipelineBoardLabels> |
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.
It shows JobCandidate from the Kith ATS API.
Copy to your agent
Install RecruiterOS/recruit-ui and add a pipeline board with a column per stage and cards that move between them.