Skip to main content

Interface: ChecklistListDef<I, L, B>

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:44

A definition for a single checklist.

Type Parameters

Type ParameterDefault typeDescription
I extends BaseChecklistItemTypeDefMapBaseChecklistItemTypeDefMapA map from checklist item types to checklist item definitions used by the checklist. Defaults to BaseChecklistItemTypeDefMap.
LunknownThe metadata attached to the checklist.
BunknownThe metadata attached to the checklist branches contained in the definition.

Properties

branches

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

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:55

Definitions for the checklist branches that belong to the list.


items

readonly items: readonly (I[Actionable] | I[Branch] | I[Note] | I[Title] | I[Link] | I[Spacer])[]

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

Definitions for the checklist's items.


metadata

readonly metadata: L

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

Metadata for the checklist.


name

readonly name: string

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

The name of the checklist.


uid?

readonly optional uid: string

Defined in: src/sdk/checklist/ChecklistDefinitions.ts:46

The unique ID of the checklist.