IHTMLHeading | @jupyterlab (original) (raw)

• @jupyterlab
• toc
• TableOfContentsUtils
• IHTMLHeading

Interface IHTMLHeading

HTML heading

interface IHTMLHeading {
collapsed?: boolean;
dataset?: Record<string, string>;
id?: null | string;
level: number;
prefix?: null | string;
skip?: boolean;
text: string;
}

Hierarchy (View Summary)

• TableOfContents.IHeading
  • IHTMLHeading

Index

Properties

collapsed? dataset? id? level prefix? skip? text

Properties

Optionalcollapsed

collapsed?: boolean

Whether the heading is collapsed or not

Optionaldataset

dataset?: Record<string, string>

Dataset to add to the item node

Optionalid

id?: null | string

HTML id

level

level: number

HTML heading level.

Optionalprefix

prefix?: null | string

Heading prefix.

Optionalskip

skip?: boolean

Whether the heading is marked to skip or not

text

text: string

Heading text.