HTML itemscope global attribute
itemscope is a booleanglobal attribute that defines the scope of associated metadata. Specifying theitemscope attribute for an element creates a new item, which results in a number of name-value pairs that are associated with the element.
A related attribute,itemtype, is used to specify the valid URL of a vocabulary (such asschema.org) that describes the item and its properties context. In each of the following examples, the vocabulary is fromschema.org.
Every HTML element may have anitemscope attribute specified. Anitemscope element that does not have an associateditemtype must have an associateditemref.
Note:Find more aboutitemtype attributes athttps://schema.org/Thing
Usage notes
itemscope id attributes
When you specify theitemscope attribute for an element, a new item is created. The item consists of a group of name-value pairs. For elements with anitemscope attribute and anitemtype attribute, you may also specify anid attribute. You can use theid attribute to set a global identifier for the new item. A global identifier allows the item to relate to other items found on pages across the Web.
Examples
Representing structured data for a movie
The following example specifies theitemtype as "http://schema.org/Movie", and specifies four relateditemprop attributes.
| itemscope | Itemtype | Movie | |
| itemprop | (itemprop name) | (itemprop value) | |
| itemprop | director | James Cameron | |
| itemprop | genre | Science Fiction | |
| itemprop | name | Avatar | |
| itemprop | Trailer | https://youtu.be/0AY1XIkX7bY | |
<div itemscope itemtype="https://schema.org/Movie"> <h1 itemprop="name">Avatar</h1> <span> Director: <span itemprop="director">James Cameron</span> (born August 16, 1954) </span> <span itemprop="genre">Science fiction</span> <a href="https://youtu.be/0AY1XIkX7bY" itemprop="trailer">Trailer</a></div>Representing structured data for a recipe
There are fouritemscope attributes in the following example. Eachitemscope attribute sets the scope of its correspondingitemtype attribute. Theitemtypes,Recipe,AggregateRating, andNutritionInformation in the following example are part of theschema.org structured data for a recipe, as specified by the firstitemtype,http://schema.org/Recipe.
| itemscope | itemtype | Recipe | |
| itemprop | name | Grandma's Holiday Apple Pie | |
| itemprop | image | https://c1.staticflickr.com/1/30/42759561_8631e2f905_n.jpg | |
| itemprop | datePublished | 2022-11-05 | |
| itemprop | description | This is my grandmother's apple pie recipe. I like to add a dash of nutmeg. | |
| itemprop | prepTime | PT30M | |
| itemprop | cookTime | PT1H | |
| itemprop | totalTime | PT1H30M | |
| itemprop | recipeYield | 1 9" pie (8 servings) | |
| itemprop | recipeIngredient | Thinly-sliced apples: 6 cups | |
| itemprop | recipeIngredient | White sugar: 3/4 cup | |
| itemprop | recipeInstructions | 1. Cut and peel apples 2. Mix sugar and cinnamon. Use additional sugar for tart apples. | |
| itemprop | author [Person] | ||
| itemprop | name | Carol Smith | |
| itemscope | itemprop[itemtype] | aggregateRating [AggregateRating] | |
| itemprop | ratingValue | 4.0 | |
| itemprop | reviewCount | 35 | |
| itemscope | itemprop[itemtype] | nutrition [NutritionInformation] | |
| itemprop | servingSize | 1 medium slice | |
| itemprop | calories | 250 cal | |
| itemprop | fatContent | 12 g | |
Note:A handy tool for extracting microdata structures from HTML is Google'sRich Results Testing Tool. Try it on the HTML shown here.
HTML
<div itemscope itemtype="https://schema.org/Recipe"> <h2 itemprop="name">Grandma's Holiday Apple Pie</h2> <img itemprop="image" src="https://c1.staticflickr.com/1/30/42759561_8631e2f905_n.jpg" width="50" height="50" /> <p> By <span itemprop="author" itemscope itemtype="https://schema.org/Person"> <span itemprop="name">Carol Smith</span> </span> </p> <p> Published: <time datetime="2022-11-05" itemprop="datePublished"> November 5, 20022 </time> </p> <span itemprop="description"> This is my grandmother's apple pie recipe. I like to add a dash of nutmeg. </span> <br /> <span itemprop="aggregateRating" itemscope itemtype="https://schema.org/AggregateRating"> <span itemprop="ratingValue">4.0</span> stars based on <span itemprop="reviewCount">35</span> reviews </span> <br /> Prep time: <time datetime="PT30M" itemprop="prepTime">30 min</time> <br /> Cook time: <time datetime="PT1H" itemprop="cookTime">1 hour</time> <br /> Total time: <time datetime="PT1H30M" itemprop="totalTime">1 hour 30 min</time> <br /> Yield: <span itemprop="recipeYield">1 9" pie (8 servings)</span> <br /> <span itemprop="nutrition" itemscope itemtype="https://schema.org/NutritionInformation"> Serving size: <span itemprop="servingSize">1 medium slice</span><br /> Calories per serving: <span itemprop="calories">250 cal</span><br /> Fat per serving: <span itemprop="fatContent">12 g</span><br /> </span> <p> Ingredients:<br /> <span itemprop="recipeIngredient">Thinly-sliced apples: 6 cups<br /></span> <span itemprop="recipeIngredient">White sugar: 3/4 cup<br /></span> … </p> Directions: <br /> <div itemprop="recipeInstructions"> 1. Cut and peel apples<br /> 2. Mix sugar and cinnamon. Use additional sugar for tart apples. <br /> … </div></div>Result
Specifications
| Specification |
|---|
| HTML # attr-itemscope |
See also
- Other different global attributes
- Other microdata related global attributes: