Interface ListItem

Markdown list item.

interface ListItem {
    checked?: null | boolean;
    children: (BlockContent | DefinitionContent)[];
    data?: ListItemData;
    position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position;
    spread?: null | boolean;
    type: "listItem";
}

Hierarchy (view full)

Properties

checked? children data? position? spread? type

Properties

Optional checked

checked?: null | boolean

Whether the item is a tasklist item (when boolean).

When true, the item is complete. When false, the item is incomplete.

children

children: (BlockContent | DefinitionContent)[]

Children of list item.

Optional data

data?: ListItemData

Data associated with the mdast list item.

Optional position

position?: "/home/runner/work/astro-node-fastify/astro-node-fastify/node_modules/@types/unist/index".Position

Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.

Optional spread

spread?: null | boolean

Whether one or more of the children are separated with a blank line from its siblings (when true), or not (when false or not present).

type

type: "listItem"

Node type of mdast list item.

Settings

Member Visibility

Theme

On This Page

checkedchildrendatapositionspreadtype