Interface: ChecklistBranch<I, B>

Defined in: src/sdk/checklist/ChecklistState.ts:76

A state of a checklist branch.

Type Parameters

Type Parameter	Default type	Description
I extends BaseChecklistItemTypeDefMap	BaseChecklistItemTypeDefMap	A map from checklist item types to checklist item definitions used by the checklist branch. Defaults to BaseChecklistItemTypeDefMap.
B	unknown	The metadata attached to the branch.

Properties

isCompleted

readonly isCompleted: Subscribable<boolean>

Defined in: src/sdk/checklist/ChecklistState.ts:93

Whether the branch is completed. A branch is completed if and only if none of its actionable or branch items are not completed. If a branch has no actionable or branch items, then it is always considered completed.

---

items

readonly items: readonly (ChecklistCompletableItem<I, Actionable> | ChecklistBranchItem<I> | { def: I[Note]; type: Note; } | { def: I[Title]; type: Title; } | { def: I[Link]; type: Link; } | { def: I[Spacer]; type: Spacer; })[]

Defined in: src/sdk/checklist/ChecklistState.ts:84

The items of the branch.

---

metadata

readonly metadata: B

Defined in: src/sdk/checklist/ChecklistState.ts:87

Metadata for the branch.

---

name

readonly name: string

Defined in: src/sdk/checklist/ChecklistState.ts:81

The name of the branch.

---

uid

readonly uid: string

Defined in: src/sdk/checklist/ChecklistState.ts:78

The unique ID of the branch.