List

Type: Node · Category: Rich Content

Lists organize content into sequential items. Supports both bullet (unordered) and numbered (ordered) lists.

Demo

Installation

import { BulletList } from "@arkpad/extension-bullet-list";
import { OrderedList } from "@arkpad/extension-ordered-list";
// Note: ListItem is loaded automatically by lists, but can be imported explicitly:
import { ListItem } from "@arkpad/extension-list-item";

Commands

// Toggles the current block between a bullet list and a paragraph
editor.runCommand("toggleBulletList");

// Toggles the current block between an ordered list and a paragraph
editor.runCommand("toggleOrderedList");

// Alignment & indent navigation
editor.runCommand("sinkListItem"); // Indent / Nest list item
editor.runCommand("liftListItem"); // Outdent / Unnest list item

Key	Action
`Mod-Shift-8`	Toggles bullet list
`Mod-Shift-7`	Toggles ordered list
`Enter`	Splits list item / exits list if empty
`Tab`	Indents current list item (nesting)
`Shift-Tab`	Outdents current list item (unnesting)

Markdown Input Rules

Type these patterns at the beginning of a line followed by a space to quickly build lists:

Pattern	Result
`-` or `+` or `*`	Bullet List
`1.` (or any number + `.` )	Ordered List

Active State

const isBullet = editor.isActive("bulletList");
const isOrdered = editor.isActive("orderedList");