@redrob-labs/ui v1.8.0 · Redrob Group Design System 2026

PlanDocument

Safeguards · src/components/PlanDocument/PlanDocument.tsx

The plan, written out as a document rather than a list of steps: what was asked, what is known, how, what you get, the assumptions and the risks, and a To do list that ticks as the run goes.

Any paragraph can be changed in place until it runs, and the status line says so the moment it is: a draft becomes "Edited by you". Once running, the text locks, because a plan that changes under a run is no longer the plan that was approved.

The status names who approved it. A plan that runs is one a person said yes to, and the document keeps that on its face.

Import

import { PlanDocument } from '@redrob-labs/ui';

Rendered

The design system's own preview case, run against this package's build. The parity gate compares this rendering to the reference bundle's.

Props

PropTypeNotes
file React.ReactNode The plan's file name: "Plan ยท Ending the Seorin MSA.md".
title React.ReactNode
summary React.ReactNode
sections PlanSection[]
todo PlanTodo[]
done number How many To do items are done; overrides each item's done.
status PlanStatus draft and kept can be edited in place; running and done are locked. Draft shows as edited once changed.
statusLabels Partial<Record<PlanStatus, React.ReactNode>>
note React.ReactNode Which checks will run after, and why.
onRun () => void
onKeep () => void
onEdit (e: unknown) => void
runLabel string
keepLabel string
hint React.ReactNode
todoLabel string
label string
className string

Exported types

PlanItem, PlanSection, PlanTodo