- document
- ReviewDocument
- default defaultReviewDocument
- The draft under review: a title, a meta line and its heading and paragraph blocks.
- threads / defaultThreads
- ReviewThreadData[]
- default defaultReviewThreads
- The discussions, each anchored to a quote inside one block, with its comments and resolved state. Controlled or uncontrolled.
- onThreadsChange
- (threads: ReviewThreadData[]) => void
- default —
- Fires from the reply or the resolve that changed the list, with the whole new list.
- people
- ReviewPerson[]
- default defaultReviewPeople
- Everyone who can write here: comment authors and the @-mention list.
- me
- string
- default "mira"
- The id of the person replying and resolving.
- now
- Date | number
- default defaultReviewNow
- The moment every comment is dated against; the component never reads the clock.
- active / defaultActive
- string | null
- default null
- The open thread, or null. Controlled or uncontrolled.
- onActiveChange
- (id: string | null) => void
- default —
- Fires when a press, a key or a resolve opens or closes a thread.
- onReply
- (threadId: string, comment: ReviewComment) => void
- default —
- A reply was sent, with the comment as stored.
- onResolve
- (threadId: string, resolved: boolean) => void
- default —
- A thread was resolved (true) or reopened (false).
- onMention
- (personId: string, threadId: string) => void
- default —
- A sent reply mentioned someone.
- onRetry
- () => void
- default —
- The Retry button of the error state.
- leaders
- "curve" | "elbow" | "off"
- default "curve"
- The line that joins a lit passage to its card: a curve, two rounded right angles, or none (the highlight still brightens).
- resolve
- "fold" | "tuck" | "off"
- default "fold"
- What resolving does: fold the thread to a one-line check in place, fold it and tuck it out of the rail behind a Resolved toggle, or no resolving at all.
- density
- "compact" | "cozy" | "roomy"
- default "cozy"
- Type size, card padding, avatar size and how many lines of a closed thread show.
- highlight
- string
- default "var(--warn)"
- The passages' highlight and leader colour, any CSS colour.
- status
- "ready" | "loading" | "error"
- default "ready"
- Loading draws the surface's skeleton; error offers Retry.
- placeholder
- string
- default "Reply, or @ to mention"
- The reply composer's placeholder.
- label
- string
- default —
- The region's accessible name. Defaults to “Review of” and the title.
- sound
- boolean
- default false
- Play a tick on opening and moving between threads and a pop on replying and resolving. Off unless asked for.
- disabled
- boolean
- default false
- Reads but does not reply, resolve or open.
- className
- string
- default —
- Classes for the root. The root is h-[560px] by default; pass a height to change it.