ListItem - Schema.org Type (original) (raw)
Note: You are viewing the development version of Schema.org. See how we work for more details.
An list item, e.g. a step in a checklist or how-to description.
| Property | Expected Type | Description |
|---|---|---|
| Properties from ListItem | ||
| item | Thing | An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists'). |
| nextItem | ListItem | A link to the ListItem that follows the current one. |
| position | Integer or Text | The position of an item in a series or sequence of items. |
| previousItem | ListItem | A link to the ListItem that precedes the current one. |
| Properties from Thing | ||
| additionalType | Text or URL | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide. |
| alternateName | Text | An alias for the item. |
| description | Text or TextObject | A description of the item. |
| disambiguatingDescription | Text | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. |
| identifier | PropertyValue or Text or URL | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. |
| image | ImageObject or URL | An image of the item. This can be a URL or a fully described ImageObject. |
| mainEntityOfPage | CreativeWork or URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.Inverse property: mainEntity |
| name | Text | The name of the item. |
| potentialAction | Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. |
| sameAs | URL | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. |
| subjectOf | CreativeWork or Event | A CreativeWork or Event about this Thing.Inverse property: about |
| url | URL | URL of the item. |
Instances of ListItem may appear as a value for the following properties
| Property | On Types | Description |
|---|---|---|
| itemListElement | ItemList | For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases. |
| negativeNotes | Product or Review | Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside positiveNotes). For symmetry In the case of a Review, the property describes the itemReviewed from the perspective of the review; in the case of a Product, the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find negativeNotes used in this way. Nevertheless for the sake of symmetry, negativeNotes can be used on Product.The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list). |
| nextItem | ListItem | A link to the ListItem that follows the current one. |
| positiveNotes | Product or Review | Provides positive considerations regarding something, for example product highlights or (alongside negativeNotes) pro/con lists for reviews.In the case of a Review, the property describes the itemReviewed from the perspective of the review; in the case of a Product, the product itself is being described.The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list). |
| previousItem | ListItem | A link to the ListItem that precedes the current one. |
More specific Types
Examples
Example notes or example HTML without markup.
Example encoded as Microdata embedded in HTML.
Example encoded as RDFa embedded in HTML.
Example encoded as JSON-LD in a HTML script tag.
Structured representation of the JSON-LD example.
{ "@context": "https://schema.org", "@type": "BreadcrumbList", "itemListElement": [ { "@type": "ListItem", "position": 1, "item": { "@id": "https://example.com/dresses", "name": "Dresses" } }, { "@type": "ListItem", "position": 2, "item": { "@id": "https://example.com/dresses/real", "name": "Real Dresses" } } ] }