Vizel API / core/src / VizelOutlineItemSpec

Interface: VizelOutlineItemSpec

Defined in: packages/core/src/builders/outline.ts:15

One entry in a document outline tree.

Each entry corresponds to a single heading node from the editor's document. Entries are nested by heading level: an h2 becomes a child of the nearest preceding h1, an h3 becomes a child of the nearest preceding h2, and so on. Entries at the highest level encountered in the document appear at the top of VizelOutlineSpec.items.

Properties

children

readonly children: readonly VizelOutlineItemSpec[];

Defined in: packages/core/src/builders/outline.ts:27

Headings nested under this entry, in document order.

---

isCurrent

readonly isCurrent: boolean;

Defined in: packages/core/src/builders/outline.ts:25

Whether the current selection sits inside this heading's node range.

---

key

readonly key: string;

Defined in: packages/core/src/builders/outline.ts:17

Stable identifier for keyed rendering (heading-${pos}).

---

label

readonly label: string;

Defined in: packages/core/src/builders/outline.ts:21

Plain-text label derived from the heading's text content.

---

level

readonly level: number;

Defined in: packages/core/src/builders/outline.ts:19

Heading level, 1-6, as stored in the node's level attribute.

---

pos

readonly pos: number;

Defined in: packages/core/src/builders/outline.ts:23

Document position of the heading node start.