Skip to main content

List Item

A single item in a list.

!array('This is an implementation, and extension, of schema.org ')ListItem!array('. It extends schema.ord ')ListItem!array(' by adding ')content!array(' and ')isChecked!array(' properties.')

!array('Analogues of ')ListItem!array(' in other schema include:')

Properties#

Name@idTypeDescriptionInherited from
alternateNamesschema:alternateNameArray of stringAlternate names (aliases) for the item.Thing
contentstencila:contentArray of BlockContent or Array of InlineContentThe content of the list item. See note 1.ListItem
descriptionschema:descriptionArray of BlockContent or Array of InlineContent or stringA description of the item. See note 2.Thing
idschema:idstringThe identifier for this item.Entity
identifiersschema:identifierArray of (PropertyValue or string)Any kind of identifier for any kind of Thing. See note 3.Thing
imagesschema:imageArray of (ImageObject or Format 'uri')Images of the item.Thing
isCheckedstencila:isCheckedbooleanA flag to indicate if this list item is checked.ListItem
itemschema:itemNodeThe item represented by this list item. See note 4.ListItem
metastencila:metaobjectMetadata associated with this item.Entity
nameschema:namestringThe name of the item.Thing
positionschema:positionintegerThe position of the item in a series or sequence of items.ListItem
urlschema:urlFormat 'uri'The URL of the item.Thing

Notes#

  1. content : !array('Use either ')content!array(' or ')item!array(', not both.')
  2. description : !array('Allows for the description to be an array of nodes (e.g. an array of inline content, or a couple of paragraphs), or a string. The ')minItems!array(' restriction avoids a string being coerced into an array with a single string item.')
  3. identifiers : !array('Some identifiers have specific properties e.g the ')issn!array(' property for the ')Periodical!array(' type. These should be used in preference to this property which is intended for identifiers that do not yet have a specific property. Identifiers can be represented as strings, but using a ')PropertyValue!array(' will usually be better because it allows for ')propertyID!array(' (i.e. the type of identifier).')
  4. item : !array('Use either ')item!array(' or ')content!array(', not both.')

Examples#

{
"type": "ListItem",
"content": [
"List Item Content"
]
}
{
"type": "ListItem",
"content": [
"List Item Content",
{
"type": "List",
"order": "ordered",
"items": [
"Nested Item One"
]
}
]
}
{
"type": "ListItem",
"isChecked": true,
"content": [
"Completed todo item"
]
}

Related#

  • Parent: Thing
  • Descendants: None

Available as#

Source#

This documentation was generated from ListItem.schema.yaml.