prosekit/extensions/list

The attributes of a list node.

kind?: "toggle" | "bullet" | "ordered" | "task"

The kind of list node.

order?: number | null

The optional order of the list node.

checked?: boolean

Whether the list node is checked if its kind is "task".

collapsed?: boolean

Whether the list node is collapsed if its kind is "toggle".

---

Options for the list keymap.

strict?: boolean

Whether the indent, dedent and split key bindings run in strict mode. In strict mode a list node is never more than one level deeper than the block before it, so no list node ends up with a hidden marker. Tab on the first item of a list then does nothing.

Default

Section titled “Default”

false

function insertList(attrs?: ListAttributes): Command

---

function defineList(): ListExtension