This is an implementation of schema.org ListItem, extended in Stencila Schema for document-oriented list content.

In addition to the schema.org model, it supports block content for rich list items and isChecked for task-list semantics. This makes it suitable for ordinary prose lists as well as checklists and mixed-content document lists.

Key properties include content, item, isChecked, and position.

Analogues

The following external types, elements, or nodes are similar to a ListItem:

schema.org ListItem: Direct schema.org source type, extended in Stencila with rich block content and task-list state.

HTML <li>: Closest HTML analogue for list items, though Stencila can also carry isChecked, position, and structured node-valued item metadata.

JATS <list-item>: Closest JATS analogue for list items.

Pandoc Plain: One common Pandoc representation for a simple list item containing inline-only content.

Pandoc BulletList: Pandoc models list items as nested block lists within list constructors rather than as standalone ListItem nodes.

MDAST ListItem: Closest MDAST analogue; Stencila additionally supports schema.org-style item metadata and explicit checklist state.

Properties

The ListItem type has these properties:

Name	Description	Type	Inherited from
`content`	The content of the list item.	`Block`*	-
`item`	The item represented by this list item.	`Node`	-
`isChecked`	A flag to indicate if this list item is checked.	`Boolean`	-
`position`	The position of the item in a series or sequence of items.	`Integer`	-
`alternateNames`	Alternate names (aliases) for the item.	`String`*	`Thing`
`description`	A description of the item.	`String`	`Thing`
`identifiers`	Any kind of identifier for any kind of Thing.	(`PropertyValue` \| `String`)*	`Thing`
`images`	Images of the item.	`ImageObject`*	`Thing`
`name`	The name of the item.	`String`	`Thing`
`url`	The URL of the item.	`String`	`Thing`
`id`	The identifier for this item.	`String`	`Entity`

The ListItem type is related to these types:

Parents: Thing

Children: none

Bindings

The ListItem type is represented in:

JSON-LD

JSON Schema

Python class ListItem

Rust struct ListItem

TypeScript class ListItem

Testing

During property-based (a.k.a generative) testing, the properties of the ListItem type are generated using the following strategies.

Property	Complexity	Description	Strategy
`content`	Min+	Generate a single, arbitrary, paragraph	`vec_paragraphs(1)`
	Low+	Generate one, arbitrary, non-list block	`vec_blocks_list_item(1)`
	High+	Generate up to two, arbitrary, non-list blocks	`vec_blocks_list_item(2)`
	Max	Generate up to four, arbitrary, non-list blocks	`vec_blocks_list_item(4)`

This documentation was generated from ListItem.yaml by docs_types.rs.

Analogues

Properties

Related

Bindings

Testing