Function: PlanList()

Call Signature

function PlanList(content: ChildBlock[]): Block;

Defined in: src/renderer/blocks/index.ts:2653

Experimental

PlanList — collapsible high-level plan / TODO list with optional streaming shimmer on the title. Drop PlanItem blocks inside.

Parameters

Parameter	Type
content	ChildBlock[]

Returns

Block

Example

PlanList({title: 'Steps'}, [
  PlanItem({status: 'done'}, [Text({content: 'Read docs'})]),
  PlanItem({status: 'in-progress'}, [Text({content: 'Wire components'})]),
  PlanItem([Text({content: 'Open PR'})]),
]);

Call Signature

function PlanList(options: PlanListBlockProps, content: ChildBlock[]): Block;

Defined in: src/renderer/blocks/index.ts:2654

Experimental

PlanList — collapsible high-level plan / TODO list with optional streaming shimmer on the title. Drop PlanItem blocks inside.

Parameters

Parameter	Type
options	PlanListBlockProps
content	ChildBlock[]

Returns

Block

Example

PlanList({title: 'Steps'}, [
  PlanItem({status: 'done'}, [Text({content: 'Read docs'})]),
  PlanItem({status: 'in-progress'}, [Text({content: 'Wire components'})]),
  PlanItem([Text({content: 'Open PR'})]),
]);