Interface: ChecklistList<I, L, B>

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

A state of a single checklist.

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. Defaults to BaseChecklistItemTypeDefMap.
L	unknown	The metadata attached to the checklist.
B	unknown	The metadata attached to the checklist branches contained in the list.

Properties

branches

readonly branches: readonly ChecklistBranch<I, B>[]

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

The branches that belong to the checklist.

---

isCompleted

readonly isCompleted: Subscribable<boolean>

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

Whether the checklist is completed. A checklist is completed if and only if none of its actionable or branch items are not completed. If a checklist 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:55

The items of the checklist.

---

metadata

readonly metadata: L

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

Metadata for the checklist.

---

name

readonly name: string

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

The name of the checklist.

---

uid?

readonly optional uid: string

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

The unique ID of the list.