Interface ToolkitPortableTextHtmlList

Toolkit-specific type representing a nested list in HTML mode, where deeper lists are nested inside of the list items, eg <ul><li>Some text<ul><li>Deeper</li></ul></li></ul>

interface ToolkitPortableTextHtmlList {
    _type: "@list";
    _key: string;
    mode: "html";
    level: number;
    listItem: string;
    children: ToolkitPortableTextListItem[];
}

Properties

_type: "@list"

Type name, prefixed with @ to signal that this is a toolkit-specific node.

_key: string

Unique key for this list (within its parent)

mode: "html"

List mode, signaling that list nodes will appear as children of the list items

level: number

Level/depth of this list node (starts at 1)

listItem: string

Style of this list item (bullet, number are common values, but can be customized)

Child nodes of this list - toolkit-specific list items which can themselves hold deeper lists