Semantics, structure, and APIs of HTML documents

Documents

Every XML and HTML document in an HTML UA is represented by a {{Document}} object. [[!DOM]] The {{Document}} object's [=Document/URL=] is defined in the DOM specification. It is initially set when the {{Document}} object is created, but that can change during the lifetime of the {{Document}} object; for example, it changes when the user [=navigates=] to a [=url/fragment=] on the page and when the {{History/pushState()}} method is called with a new [=url/URL=]. [[!DOM]]

Interactive user agents typically expose the {{Document}} object's [=Document/URL=] in their user interface. This is the primary mechanism by which a user can tell if a site is attempting to impersonate another.

When a {{Document}} is created by a [=concept/script=] using the {{DOMImplementation/createDocument()}} or {{DOMImplementation/createHTMLDocument()}} APIs, the {{Document}} is both [=ready for post-load tasks=] and [=completely loaded=] immediately. The document's referrer is a string (representing a [=url/URL=]) that can be set when the {{Document}} is created. If it is not explicitly set, then its value is the empty string. Each {{Document}} object has a reload override flag that is originally unset. The flag is set by the {{Document/open()|document.open()}} and {{Document/write()|document.write()}} methods in certain situations. When the flag is set, the {{Document}} also has a reload override buffer which is a Unicode string that is used as the source of the document when it is reloaded. When the user agent is to perform an overridden reload, given a [=source browsing context=], it must act as follows: 1. Let |source| be the value of the [=browsing context=]'s [=active document=]'s [=reload override buffer=]. 2. Let |address| be the [=browsing context=]'s [=active document=]'s [=document url|URL=]. 3. Let |HTTPS state| be the HTTPS state of the [=browsing context=]'s [=active document=]. 4. Let |referrer policy| be the referrer policy of the [=browsing context=]'s [=active document=]. 4. Let |CSP list| be the CSP list of the [=browsing context=]'s [=active document=]. 5. [=Navigate=] the [=browsing context=] to a new [=response=] whose [=response/body=] is |source|, [=response/header list=] is Referrer-Policy/|referrer policy|, [=response/CSP list=] is |CSP list| and [=response/HTTPS state=] is |HTTPS state|, with the [=exceptions enabled flag=] set and [=replacement enabled=]. The [=source browsing context=] is that given to the [=overridden reload=] algorithm. When the [=navigate=] algorithm creates a {{Document}} object for this purpose, set that {{Document}}'s [=reload override flag=] and set its [=reload override buffer=] to |source|. Rethrow any exceptions. When it comes time to set the document's address in the [=navigation algorithm=], use |address| as the [=override URL=].

The Document object

The DOM specification defines a {{Document}} interface, which this specification extends significantly:
    enum DocumentReadyState { "loading", "interactive", "complete" };

    typedef (HTMLScriptElement or SVGScriptElement) HTMLOrSVGScriptElement;

    [OverrideBuiltins]
    partial interface Document {
      // resource metadata management
      [PutForwards=href, Unforgeable] readonly attribute Location? location;
      attribute USVString domain;
      readonly attribute USVString referrer;
      attribute USVString cookie;
      readonly attribute DOMString lastModified;
      readonly attribute DocumentReadyState readyState;

      // DOM tree accessors
      getter object (DOMString name);
      [CEReactions] attribute DOMString title;
      attribute DOMString dir;
      attribute HTMLElement? body;
      readonly attribute HTMLHeadElement? head;
      [SameObject] readonly attribute HTMLCollection images;
      [SameObject] readonly attribute HTMLCollection embeds;
      [SameObject] readonly attribute HTMLCollection plugins;
      [SameObject] readonly attribute HTMLCollection links;
      [SameObject] readonly attribute HTMLCollection forms;
      [SameObject] readonly attribute HTMLCollection scripts;
      NodeList getElementsByName(DOMString elementName);
      readonly attribute HTMLOrSVGScriptElement? currentScript; // classic scripts in a document tree only

      // dynamic markup insertion
      Document open(optional DOMString type = "text/html", optional DOMString replace = "");
      WindowProxy open(DOMString url, DOMString name, DOMString features, optional boolean replace = false);
      [CEReactions] void close();
      [CEReactions] void write(DOMString... text);
      [CEReactions] void writeln(DOMString... text);

      // user interaction
      readonly attribute WindowProxy? defaultView;
      readonly attribute Element? activeElement;
      boolean hasFocus();
      [CEReactions] attribute DOMString designMode;
      [CEReactions] boolean execCommand(DOMString commandId, optional boolean showUI = false, optional DOMString value = "");
      boolean queryCommandEnabled(DOMString commandId);
      boolean queryCommandIndeterm(DOMString commandId);
      boolean queryCommandState(DOMString commandId);
      boolean queryCommandSupported(DOMString commandId);
      DOMString queryCommandValue(DOMString commandId);

      // special event handler IDL attributes that only apply to Document objects
      [LenientThis] attribute EventHandler onreadystatechange;
    };
    Document implements GlobalEventHandlers;
    Document implements DocumentAndElementEventHandlers;
  
The {{Document}} has an HTTPS state (an [=HTTPS state value=]), initially "none", which represents the security properties of the network channel used to deliver the {{Document}}'s data. The {{Document}} has a referrer policy (a [=referrer policy=]), initially the empty string, which represents the default [=referrer policy=] used by [=fetches=] initiated by the {{Document}}. The {{Document}} has a CSP list, which is a CSP list containing all of the [=Content Security Policy=] objects active for the document. The list is empty unless otherwise specified.

The {{Document}} has a module map, which is a [=module map=], initially empty.

Resource metadata management

: |document| . {{Document/referrer}} :: Returns the [=Document/URL=] of the {{Document}} from which the user navigated to this one, unless it was blocked or there was no such document, in which case it returns the empty string. The <{link/noreferrer}> link type can be used to block the referrer.
The referrer attribute must return [=the document's referrer=].
: |document| . {{Document/cookie}} [ = |value| ] :: Returns the HTTP cookies that apply to the {{Document}}. If there are no cookies or cookies can't be applied to this resource, the empty string will be returned. Can be set, to add a new cookie to the element's set of HTTP cookies. If the contents are [=sandboxed into a unique origin=] (e.g., in an <{iframe}> with the <{iframe/sandbox}> attribute), a "{{SecurityError}}" {{DOMException}} will be thrown on getting and setting.
The cookie attribute represents the cookies of the resource identified by the document's [=Document/URL=]. A {{Document}} object that falls into one of the following conditions is a cookie-averse {{Document}} object: * A {{Document}} that has no [=browsing context=]. * A {{Document}} whose [=Document/URL=]'s [=url/scheme=] is not a [=network scheme=]. On getting, if the document is a [=cookie-averse=] {{Document}} object, then the user agent must return the empty string. Otherwise, if the {{Document}}'s [=concept/origin=] is an [=opaque origin=], the user agent must throw a "{{SecurityError}}" {{DOMException}}. Otherwise, the user agent must return the [=cookie-string=] for the document's [=Document/URL=] for a "non-HTTP" API, decoded using [=UTF-8 decode without BOM=]. [[!COOKIES]] (This is a fingerprinting vector.) On setting, if the document is a [=cookie-averse=] {{Document}} object, then the user agent must do nothing. Otherwise, if the {{Document}}'s [=concept/origin=] is an [=opaque origin=], the user agent must throw a "{{SecurityError}}" {{DOMException}}. Otherwise, the user agent must act as it would when [=receiving a set-cookie-string=] for the document's [=Document/URL=] via a "non-HTTP" API, consisting of the new value [=encoded as UTF-8=]. [[!COOKIES]] [[!ENCODING]]

Since the {{Document/cookie}} attribute is accessible across frames, the path restrictions on cookies are only a tool to help manage which cookies are sent to which parts of the site, and are not in any way a security feature.

The {{Document/cookie}} attribute's getter and setter synchronously access shared state. Since there is no locking mechanism, other browsing contexts in a multiprocess user agent can modify cookies while scripts are running. A site could, for instance, try to read a cookie, increment its value, then write it back out, using the new value of the cookie as a unique identifier for the session; if the site does this twice in two different browser windows at the same time, it might end up using the same "unique" identifier for both sessions, with potentially disastrous effects.


: |document| . {{Document/lastModified}} :: Returns the date of the last modification to the document, as reported by the server, in the form "MM/DD/YYYY hh:mm:ss", in the user's local time zone. If the last modification date is not known, the current time is returned instead.
The lastModified attribute, on getting, must return the date and time of the {{Document}}'s source file's last modification, in the user's local time zone, in the following format: 1. The month component of the date. 2. A U+002F SOLIDUS character (/). 3. The day component of the date. 4. A U+002F SOLIDUS character (/). 5. The year component of the date. 6. A U+0020 SPACE character. 7. The hours component of the time. 8. A U+003A COLON character (:). 9. The minutes component of the time. 10. A U+003A COLON character (:). 11. The seconds component of the time. All the numeric components above, other than the year, must be given as two [=ASCII digits=] representing the number in base ten, zero-padded if necessary. The year must be given as the shortest possible string of four [=ASCII digits=] representing the number in base ten, zero-padded if necessary. The {{Document}}'s source file's last modification date and time must be derived from relevant features of the networking protocols used, e.g., from the value of the HTTP Last-Modified header of the document, or from metadata in the file system for local files. If the last modification date and time are not known, the attribute must return the current date and time in the above format.
: |document| . {{Document/readyState}} :: Returns "{{DocumentReadyState/loading}}" while the {{Document}} is loading, "{{DocumentReadyState/interactive}}" once it is finished parsing but still loading sub-resources, and "{{DocumentReadyState/complete}}" once it has loaded. The {{global/readystatechange}} event fires on the {{Document}} object when this value changes.
Each document has a current document readiness. When a {{Document}} object is created, it must have its [=current document readiness=] set to the string "{{DocumentReadyState/loading}}" if the document is associated with an [=HTML parser=], an [=XML parser=], or an XSLT processor, and to the string "{{DocumentReadyState/complete}}" otherwise. Various algorithms during page loading affect this value. When the value is set, the user agent must [=fire an event=] named {{global/readystatechange}} at the {{Document}} object. A {{Document}} is said to have an active parser if it is associated with an [=HTML parser=] or an [=XML parser=] that has not yet been [=stop parsing|stopped=] or [=aborted=]. The readyState IDL attribute must, on getting, return the [=current document readiness=].

DOM tree accessors

The <{html}> element of a document is its [=document element=], if it's an <{html}> element, and null otherwise.
: |document| . {{Document/head}} :: Returns the <{head}> element.
The <{head}> element of a document is the first <{head}> element that is a child of the <{html}> element, if there is one, or null otherwise. The head attribute, on getting, must return the <{head}> element of the document (a <{head}> element or null).
: |document| . {{Document/title}} [ = |value| ] :: Returns the document's title, as given by the <{title}> element for HTML and as given by the SVG title element for SVG. Can be set, to update the document's title. If there is no appropriate element to update, the new value is ignored.
The <{title}> element of a document is the first <{title}> element in the document (in [=tree order=]), if there is one, or null otherwise. The title attribute must, on getting, run the following algorithm: 1. If the [=document element=] is an SVG <{svg}> element, then let |value| be the [=child text content=] of the first SVG title element that is a child of the [=document element=]. [[!SVG11]] 2. Otherwise, let |value| be the [=child text content=] of the <{title}> element, or the empty string if the <{title}> element is null. 3. [=Strip and collapse white space=] in |value|. 4. Return |value|. On setting, the steps corresponding to the first matching condition in the following list must be run:
: If the [=document element=] is an SVG <{svg}> element :: 1. If there is an SVG title element that is a child of the [=document element=], let |element| be the first such element. 2. Otherwise: 1. Let |element| be the result of [=creating an element=] given the [=document element=]'s [=node document=], SVG title, and the [=SVG namespace=]. 2. Insert |element| as the first child of the [=document element=]. 3. Act as if the {{Node/textContent}} IDL attribute of |element| was set to the new value being assigned. : If the [=document element=] is in the [=HTML namespace=] :: 1. If the <{title}> element is null and the <{head}> element is null, then abort these steps. 2. If the <{title}> element is non-null, let |element| be the <{title}> element. 3. Otherwise: 1. Let |element| be the result of [=creating an element=] given the [=document element=]'s [=node document=], <{title}>, and the [=HTML namespace=]. 2. [=Append=] |element| to the <{head}> element. 4. Act as if the {{Node/textContent}} IDL attribute of |element| was set to the new value being assigned. : Otherwise :: Do nothing.

: |document| . {{Document/body}} [ = |value| ] :: Returns the <{body}> element. Can be set, to replace the <{body}> element. If the new value is not a <{body}> or <{frameset}> element, this will throw a "{{HierarchyRequestError}}" {{DOMException}}.
The <{body}> element of a document is the first child of the <{html}> element that is either a <{body}> element or a <{frameset}> element. If there is no such element, it is null. The body attribute, on getting, must return the <{body}> element of the document (either a <{body}> element, a <{frameset}> element, or null). On setting, the following algorithm must be run: 1. If the new value is not a <{body}> or <{frameset}> element, then throw a "{{HierarchyRequestError}}" {{DOMException}} and abort these steps. 2. Otherwise, if the new value is the same as the <{body}> element, do nothing. Abort these steps. 3. Otherwise, if the <{body}> element is not null, then [=replace=] the <{body}> element with the new value within the <{body}> element's parent and abort these steps. 4. Otherwise, if there is no [=document element=], throw a "{{HierarchyRequestError}}" {{DOMException}} and abort these steps. 5. Otherwise, the <{body}> element is null, but there's a [=document element=]. [=Append=] the new value to the [=document element=].
: |document| . {{Document/images}} :: Returns an {{HTMLCollection}} of the <{img}> elements in the {{Document}}. : |document| . {{Document/embeds}} : |document| . {{Document/plugins}} :: Return an {{HTMLCollection}} of the <{embed}> elements in the {{Document}}. : |document| . {{Document/links}} :: Returns an {{HTMLCollection}} of the <{a}> and <{area}> elements in the {{Document}} that have <{links/href}> attributes. : |document| . {{Document/forms}} :: Return an {{HTMLCollection}} of the <{form}> elements in the {{Document}}. : |document| . {{Document/scripts}} :: Return an {{HTMLCollection}} of the <{script}> elements in the {{Document}}.
The images attribute must return an {{HTMLCollection}} rooted at the {{Document}} node, whose filter matches only <{img}> elements. The embeds attribute must return an {{HTMLCollection}} rooted at the {{Document}} node, whose filter matches only <{embed}> elements. The plugins attribute must return the same object as that returned by the {{Document/embeds}} attribute. The links attribute must return an {{HTMLCollection}} rooted at the {{Document}} node, whose filter matches only <{a}> elements with <{links/href}> attributes and <{area}> elements with <{links/href}> attributes. The forms attribute must return an {{HTMLCollection}} rooted at the {{Document}} node, whose filter matches only <{form}> elements. The scripts attribute must return an {{HTMLCollection}} rooted at the {{Document}} node, whose filter matches only <{script}> elements.
: |collection| = |document| . {{Document/getElementsByName()|getElementsByName}}(|name|) :: Returns a {{NodeList}} of elements in the {{Document}} that have a name attribute with the value |name|.
The getElementsByName(|name|) method takes a string |name|, and must return a [=live=] {{NodeList}} containing all the [=HTML elements=] in that document that have a name attribute whose value is equal to the |name| argument (in a [=case-sensitive=] manner), in [=tree order=]. When the method is invoked on a {{Document}} object again with the same argument, the user agent may return the same as the object returned by the earlier call. In other cases, a new {{NodeList}} object must be returned.
: |document| . {{Document/currentScript}} :: Returns the <{script}> element, or the SVG script element, that is currently executing, as long as the element represents a [=classic script=]. In the case of reentrant script execution, returns the one that most recently started executing amongst those that have not yet finished executing. Returns null if the {{Document}} is not currently executing a <{script}> element or SVG script element (e.g., because the running script is an event handler, or a timeout), or if the currently executing <{script}> or SVG script element represents a [=module script=].
The currentScript attribute, on getting, must return the value to which it was most recently initialized. When the {{Document}} is created, the {{Document/currentScript}} must be initialized to null.

This API has fallen out of favor in the implementor and standards community, as it globally exposes <{script}> or SVG script elements. As such, it is not available in newer contexts, such as when running [=module scripts=] or when running scripts in a shadow tree.


The {{Document}} interface [=support named properties|supports named properties=]. The [=supported property names=] of a {{Document}} object |document| at any moment consist of the following, in [=tree order=] according to the element that contributed them, ignoring later duplicates, and with values from <{global/id}> attributes coming before values from name attributes when the same element contributes both: * the value of the name content attribute for all [=exposed=] <{embed}>, <{form}>, <{iframe}>, <{img}>, and [=exposed=] <{object}> elements that have a non-empty name content attribute and are [=in a document tree=] with |document| as their [=root=]; * the value of the <{global/id}> content attribute for all [=exposed=] <{object}> elements that have a non-empty <{global/id}> content attribute and are [=in a document tree=] with |document| as their [=root=]; * the value of the <{global/id}> content attribute for all <{img}> elements that have both a non-empty <{global/id}> content attribute and a non-empty name content attribute, and are [=in a document tree=] with |document| as their [=root=]. To determine the value of a named property |name| for a {{Document}}, the user agent must return the value obtained using the following steps: 1. Let |elements| be the list of [=named elements=] with the name |name| that are [=in a document tree=] with the {{Document}} as their [=root=].

There will be at least one such element, by definition.

2. If |elements| has only one element, and that element is an <{iframe}> element, and that <{iframe}> element's [=nested browsing context=] is not null, then return the {{WindowProxy}} object of the element's [=nested browsing context=]. 3. Otherwise, if |elements| has only one element, return that element. 4. Otherwise return an {{HTMLCollection}} rooted at the {{Document}} node, whose filter matches only [=named elements=] with the name |name|. Named elements with the name |name|, for the purposes of the above algorithm, are those that are either: * [=exposed=] <{embed}>, <{form}>, <{iframe}>, <{img}>, or [=exposed=] <{object}> elements that have a name content attribute whose value is |name|, or * [=exposed=] <{object}> elements that have an <{global/id}> content attribute whose value is |name|, or * <{img}> elements that have an <{global/id}> content attribute whose value is |name|, and that have a non-empty name content attribute present also. An <{embed}> or <{object}> element is said to be exposed if it has no [=exposed=] <{object}> ancestor, and, for <{object}> elements, is additionally either not showing its [=fallback content=] or has no <{object}> or <{embed}> descendants.

The {{Document/dir}} attribute on the {{Document}} interface is defined along with the <{global/dir}> content attribute.

Elements

Semantics

Elements, attributes, and attribute values in HTML are defined (by this specification) to have certain meanings (semantics). For example, the <{ol}> element represents an ordered list, and the <{global/lang}> attribute represents the language of the content. These definitions allow HTML processors, like web browsers and search engines, to present documents and applications consistently in different contexts.
In this example the HTML headings may be presented as large text in a desktop browser, or standard size text in bold in a mobile browser. In both cases the semantic information remains the same - that the <{h1}> and <{h2}> elements represent headings. <!DOCTYPE html> <html lang="en"> <head> <title>Favorite books</title> </head> <body> <header> <img src="logo.png" alt="Favorite books logo"> </header> <main> <h1>Favorite books</h1> <p>These are a few of my favorite books.</p> <h2>White Teeth</h2> <p>The award winning debut novel by Zadie Smith</p> <h2>The Hitchhiker's Guide to the Galaxy</h2> <p>A trilogy of five books by Douglas Adams.</p> </main> </body> </html>
This semantic information is critical to assistive technologies. For example, a screen reader will query the browser for semantic information and use that information to present the document or application in synthetic speech. In some cases assistive technologies use semantic information to provide additional functionality. A speech recognition tool might provide a voice command for moving focus to the start of the <{main}> element for example. When the appropriate HTML element or attribute is not used, it deprives HTML processors of valuable semantic information.
In this example styling may be used to create a visual representation of headings and other components, but because the appropriate HTML elements have not been used there is little semantic information available to web browsers, search engines and assistive technologies. <!DOCTYPE html> <html lang="en"> <head> <title>Favorite books</title> </head> <body> <header> <img src="logo.png" alt="Favorite books logo"> </header> <main> <span class="largeHeading">Favorite books</span> <p>These are a few of my favorite books.</p> <span class="smallHeading">White Teeth</span> <p>The award winning debut novel by Zadie Smith</p> <span class="smallHeading">The Hitchhiker's Guide to the Galaxy</span> <p>A trilogy of five books by Douglas Adams.</p> </main> </body> </html>
A document can change dynamically while it is being processed. Scripting and other mechanisms can be used to change attribute values, text, or the entire document structure. The semantics of a document are therefore based on the document's state at a particular instance in time, but may also change in response to external events. User agents must update their presentation of the document to reflect these changes.

DOM nodes whose [=node document=] does not have a [=browsing context=] are exempt from all document conformance requirements other than [=the HTML syntax=] requirements and [=the XML syntax=] requirements.

In this example the <{audio}> element is used to play a music track. The <{audio/controls}> attribute is used to show the user agent player, and as the music plays the controls are updated to indicate progress. The available semantic information is updated in response to these changes. <audio src="comfortablynumb.mp3" controls>

Elements in the DOM

The nodes representing [=HTML elements=] in the DOM must implement, and expose to scripts, the interfaces listed for them in the relevant sections of this specification. This includes [=HTML elements=] in [=XML documents=], even when those documents are in another context (e.g., inside an XSLT transform). Elements in the DOM represent things; that is, they have intrinsic meaning, also known as semantics.

For example, an <{ol}> element represents an ordered list.

The basic interface, from which all the [=HTML elements=]' interfaces inherit, and which must be used by elements that have no additional requirements, is the {{HTMLElement}} interface.
    [HTMLConstructor]
    interface HTMLElement : Element {
      // metadata attributes
      [CEReactions] attribute DOMString title;
      [CEReactions] attribute DOMString lang;
      [CEReactions] attribute boolean translate;
      [CEReactions] attribute DOMString dir;

      // user interaction
      [CEReactions] attribute boolean hidden;
      void click();
      [CEReactions] attribute DOMString accessKey;
      [CEReactions] attribute boolean draggable;
      [CEReactions] attribute boolean spellcheck;
      void forceSpellCheck();
      [CEReactions, TreatNullAs=EmptyString] attribute DOMString innerText;
    };
    HTMLElement implements GlobalEventHandlers;
    HTMLElement implements DocumentAndElementEventHandlers;
    HTMLElement implements ElementContentEditable;

    // Note: intentionally not [HTMLConstructor]
    interface HTMLUnknownElement : HTMLElement { };
  
The {{HTMLElement}} interface holds methods and attributes related to a number of disparate features, and the members of this interface are therefore described in various different sections of this specification. The {{HTMLUnknownElement}} interface must be used for [=HTML elements=] that are not defined by this specification (or [=other applicable specifications=]). The [=element interface=] for an element with name |name| in the [=HTML namespace=] is determined as follows: 1. If |name| is <{applet}>, <{bgsound}>, <{blink}>, <{isindex}>, <{multicol}>, <{nextid}>, or <{spacer}>, then return {{HTMLUnknownElement}}. 2. If |name| is <{acronym}>, <{basefont}>, <{big}>, <{center}>, <{nobr}>, <{noembed}>, <{noframes}>, <{plaintext}>, <{rb}>, <{rtc}>, <{strike}>, or <{tt}>, then return {{HTMLElement}}. 3. If |name| is <{listing}> or <{xmp}>, then return {{HTMLPreElement}}. 4. Otherwise, if this specification defines an interface appropriate for the [=element type=] corresponding to the local name |name|, then return that interface. 5. If [=other applicable specifications=] define an appropriate interface for |name|, then return the interface they define. 6. If |name| is a [=valid custom element name=], then return {{HTMLElement}}. 7. Return {{HTMLUnknownElement}}.

The use of {{HTMLElement}} instead of {{HTMLUnknownElement}} in the case of [=valid custom element names=] is done to ensure that any potential future [=upgrades=] only cause a linear transition of the element's prototype chain, from {{HTMLElement}} to a subclass, instead of a lateral one, from {{HTMLUnknownElement}} to an unrelated subclass.

Features shared between HTML and SVG elements are defined in the {{HTMLOrSVGElement}} interface mixin:
    interface mixin HTMLOrSVGElement {
      [SameObject] readonly attribute DOMStringMap dataset;
      attribute DOMString nonce;

      [CEReactions] attribute long tabIndex;
      void focus(optional FocusOptions options);
      void blur();
    };

    HTMLElement includes HTMLOrSVGElement;
    SVGElement includes HTMLOrSVGElement;
  

The CustomElementRegistry interface

Each {{Window}} object is associated with a unique instance of a {{CustomElementRegistry}} object, allocated when the {{Window}} object is created.

Custom element registries are associated with {{Window}} objects, instead of {{Document}} objects, since each custom element constructor inherits from the {{HTMLElement}} interface, and there is exactly one {{HTMLElement}} interface per {{Window}} object.

The {{Window/customElements}} attribute of the {{Window}} interface returns the {{CustomElementRegistry}} object for that {{Window}} object.
interface CustomElementRegistry {
[CEReactions] void define(DOMString name, Function constructor, optional ElementDefinitionOptions options);
any get(DOMString name);
Promise<void> whenDefined(DOMString name);
};

dictionary ElementDefinitionOptions {
DOMString extends;
};
Every {{CustomElementRegistry}} has:
window . {{customElements}} . {{define()|define(name}}, constructor)
Defines a new autonomous custom element, mapping the given name to the given constructor.
window . {{customElements}} . {{define()|define(name, constructor), { extends: baseLocalName })}}
Defines a new customized built-in element, mapping the given name to the given constructor for the element type identified by the supplied baseLocalName. A "{{NotSupportedError}}" {{DOMException}} will be thrown upon trying to extend a custom element or an unknown element.
window . {{customElements}} . {{get}}(name)
Retrieves the custom element constructor defined for the given name. Returns undefined if there is no custom element definition with the given name.
window . {{customElements}} . {{whenDefined()|whenDefined(name)}}
Returns a promise that will be fulfilled when a custom element becomes defined with the name |name|. (If such a custom element is already defined, the returned promise will be immediately fulfilled.) Returns a promise rejected with a "{{SyntaxError}}" {{DOMException}} if |name| is not a valid custom element name.
Element definition is the process of adding a custom element definition to the {{CustomElementRegistry}}. This is accomplished by the {{define()}} method. When invoked, the {{define()|define(name, constructor, options)}} method must run these steps:

  1. If IsConstructor(constructor) is false, then throw a {{TypeError}} and abort these steps.

  2. If name is not a valid custom element name, then throw a "{{SyntaxError}}" {{DOMException}} and abort these steps.

  3. If this {{CustomElementRegistry}} contains an entry with name name, then throw a "{{NotSupportedError}} {{DOMException}} and abort these steps.

  4. If this {{CustomElementRegistry}} contains an entry with constructor constructor, then throw a "{{NotSupportedError}}" {{DOMException}} and abort these steps.

  5. Let localName be name.

  6. Let extends be the value of the extends member of options, or null if no such member exists.

  7. If extends is not null, then:

    1. If extends is a valid custom element name, then throw a "{{NotSupportedError}}" {{DOMException}}.

    2. If the element interface for extends and the HTML namespace is {{HTMLUnknownElement}} (e.g., if extends does not indicate an element definition in this specification), then throw a "{{NotSupportedError}}" {{DOMException}}.

    3. Set localName to extends.

  8. If this {{CustomElementRegistry}}'s element definition is running flag is set, then throw a "{{NotSupportedError}}" {{DOMException}} and abort these steps.

  9. Set this {{CustomElementRegistry}}'s element definition is running flag.

  10. Run the following substeps while catching any exceptions:

    1. Let prototype be Get(constructor, "prototype"). Rethrow any exceptions.

    2. If Type(prototype) is not Object, then throw a TypeError exception.

    3. Let lifecycleCallbacks be a map with the four keys "connectedCallback", "disconnectedCallback", "adoptedCallback", and "attributeChangedCallback", each of which belongs to an entry whose value is null.

    4. For each of the four keys callbackName in lifecycleCallbacks, in the order listed in the previous step:

      1. Let callbackValue be {{get}}(prototype, callbackName). Rethrow any exceptions.

      2. If callbackValue is not undefined, then set the value of the entry in lifecycleCallbacks with key callbackName to the result of converting callbackValue to the Web IDL {{Function}} callback type. Rethrow any exceptions from the conversion.

    5. Let observedAttributes be an empty sequence<DOMString>.

    6. If the value of the entry in lifecycleCallbacks with key "attributeChangedCallback" is not null, then:

      1. Let observedAttributesIterable be Get(constructor, "observedAttributes"). Rethrow any exceptions.

      2. If observedAttributesIterable is not undefined, then set observedAttributes to the result of converting observedAttributesIterable to a sequence<DOMString>. Rethrow any exceptions from the conversion.

    Then, perform the following substep, regardless of whether the above steps threw an exception or not:

    1. Unset this {{CustomElementRegistry}}'s element definition is running flag.

    Finally, if the first set of substeps threw an exception, then rethrow that exception, and terminate this algorithm. Otherwise, continue onward.

  11. Let definition be a new custom element definition with name name, local name localName, constructor constructor, prototype prototype, observed attributes observedAttributes, and lifecycle callbacks lifecycleCallbacks.

  12. Add definition to this {{CustomElementRegistry}}.

  13. Let document be this {{CustomElementRegistry}}'s relevant global object's associated Document.

  14. Let upgrade candidates be all elements that are shadow-including descendants of document, whose namespace is the HTML namespace and whose local name is localName, in shadow-including tree order. Additionally, if extends is non-null, only include elements whose is value is equal to name.

  15. For each element element in upgrade candidates, enqueue a custom element upgrade reaction given element and definition.

  16. If this {{CustomElementRegistry}}'s when-defined promise map contains an entry with key name:

    1. Let promise be the value of that entry.

    2. Resolve promise with undefined.

    3. Delete the entry with key name from this {{CustomElementRegistry}}'s when-defined promise map.

When invoked, the get(name) method must run these steps:

  1. If this {{CustomElementRegistry}} contains an entry with name name, then return that entry's constructor.

  2. Otherwise, return undefined.

When invoked, the {{whenDefined()|whenDefined(name)}} method must run these steps:

  1. If name is not a valid custom element name, then return a new promise rejected with a "{{SyntaxError}}" {{DOMException}} and abort these steps.

  2. If this {{CustomElementRegistry}} contains an entry with name name, then return a new promise resolved with undefined and abort these steps.

  3. Let map be this {{CustomElementRegistry}}'s when-defined promise map.

  4. If map does not contain an entry with key name, create an entry in map with key name and whose value is a new promise.

  5. Let promise be the value of the entry in map with key name.

  6. Return promise.

The {{whenDefined()}} method can be used to avoid performing an action until all appropriate custom elements are defined. In this example, we combine it with the :defined pseudo-class to hide a dynamically-loaded article's contents until all the autonomous custom elements it uses are defined.

articleContainer.hidden = true; fetch(articleURL) .then(response => response.text()) .then(text => { articleContainer.innerHTML = text; return Promise.all( [...articleContainer.querySelectorAll(":not(:defined)")] .map(el => customElements.whenDefined(el.localName)) ); }) .then(() => { articleContainer.hidden = false; });

Upgrades

To upgrade an element, given a custom element definition definition and an element element, run the following steps:

  1. If element is custom, abort these steps.

    This can occur due to reentrant invocation of this algorithm, as in the following example:

    <!DOCTYPE html> <x-foo id="a"></x-foo> <x-foo id="b"></x-foo> <script> // Defining enqueues upgrade reactions for both "a" and "b" customElements.define("x-foo", class extends HTMLElement { constructor() { super(); const b = document.querySelector("#b"); b.remove(); // While this constructor is running for "a", "b" is still // undefined, and so inserting it into the document will enqueue a // second upgrade reaction for "b" in addition to the one enqueued // by defining x-foo. document.body.appendChild(b); } }) </script>

    This step will thus bail out the algorithm early when upgrade an element is invoked with "b" a second time.

  2. If element's custom element state is "failed", then abort these steps.

  3. For each attribute in element's attribute list, in order, enqueue a custom element callback reaction with element, callback name "attributeChangedCallback", and an argument list containing attribute's local name, null, attribute's value, and attribute's namespace.

  4. If element is connected, then enqueue a custom element callback reaction with element, callback name "connectedCallback", and an empty argument list.

  5. Add element to the end of definition's construction stack.

  6. Let C be definition's constructor.

  7. Let constructResult be Construct(C).

    If C non-conformantly uses an API decorated with the [{{CEReactions}}] extended attribute, then the reactions enqueued at the beginning of this algorithm will execute during this step, before C finishes and control returns to this algorithm. Otherwise, they will execute after C and the rest of the upgrade process finishes.

  8. Remove the last entry from the end of definition's construction stack.

    Assuming C calls super() and that the call succeeds, this will be the already constructed marker that replaced the element pushed at the beginning of this algorithm. (The HTML element constructor carries out this replacement.)

    If C does not call super() (i.e. it is not conformant), or if any step in the HTML element constructor throws, then this entry will still be element.

  9. If constructResult is an abrupt completion, then:

    1. Set element's custom element state to "failed".

    2. Return constructResult (i.e., rethrow the exception), and terminate these steps.

  10. If SameValue(constructResult.[[\value]], element) is false, then throw an "{{InvalidStateError}}" {{DOMException}} and terminate these steps.

    This can occur if C constructs another instance of the same custom element before calling super(), or if C uses JavaScript's return-override feature to return an arbitrary object from the constructor.

  11. Set element's custom element state to "custom".

  12. Set element's custom element definition to definition.

To try to upgrade an element, given as input an element element, run the following steps:

  1. Let definition be the result of looking up a custom element definition given element's node document, element's namespace, element's local name, and element's is value.

  2. If definition is not null, then enqueue a custom element upgrade reaction given element and definition.

Custom element reactions

A custom element can react to certain occurrences by running author code. These reactions are called custom element reactions. The way in which custom element reactions are invoked is done with special care, to avoid running author code during the middle of delicate operations. Effectively, they are delayed until "just before returning to user script". This means that for most purposes they appear to execute synchronously, but in the case of complicated composite operations (like cloning, or range manipulation), they will instead be delayed until after all the relevant user agent processing steps have completed, and then run together as a batch. Additionally, the precise ordering of these reactions is managed by a stack-of-queues system, described below. The intention behind this system is to guarantee that custom element reactions are always invoked in the same order as their triggering actions, at least within the local context of a single custom element. (Because custom element reaction code can perform its own mutations, it is not possible to give a global ordering guarantee across multiple elements.)
Each unit of related similar-origin browsing contexts has a custom element reactions stack, which is initially empty. The current element queue is the element queue at the top of the custom element reactions stack. Each item in the stack is an element queue, which is initially empty as well. Each item in an element queue is an element. (The elements are not necessarily custom yet, since this queue is used for upgrades as well.) Each custom element reactions stack has an associated backup element queue, which is an initially empty element queue. Elements are pushed onto the backup element queue during operations that affect the DOM without going through an API decorated with [{{CEReactions}}], or through the parser's create an element for the token algorithm. An example of this is a user-initiated editing operation which modifies the descendants or attributes of an editable element. To prevent reentrancy when processing the backup element queue, each custom element reactions stack also has a processing the backup element queue flag, initially unset. All elements have an associated custom element reaction queue, initially empty. Each item in the custom element reaction queue is of one of two types: This is all summarised in the following schematic diagram: A custom element reactions stack consists of a stack of element queues. Zooming in on a particular queue, we see that it contains a number of elements (in our example, <x-a>, then <x-b>, then <x-c>). Any particular element in the queue then has a custom element reaction queue. Zooming in on the custom element reaction queue, we see that it contains a variety of queued-up reactions (in our example, upgrade, then attribute changed, then another attribute changed, then connected). To enqueue an element on the appropriate element queue, given an element element, run the following steps:
  1. If the custom element reactions stack is empty, then:
    1. Add element to the backup element queue.
    2. If the processing the backup element queue flag is set, abort this algorithm.
    3. Set the processing the backup element queue flag.
    4. Queue a microtask to perform the following steps:
      1. Invoke custom element reactions in the backup element queue.
      2. Unset the processing the backup element queue flag.
  2. Otherwise, add element to the current element queue.
To enqueue a custom element callback reaction, given a custom element element, a callback name callbackName, and a list of arguments args, run the following steps:
  1. Let definition be element's custom element definition.

  2. Let callback be the value of the entry in definition's lifecycle callbacks with key callbackName.

  3. If callback is null, then abort these steps.

  4. If callbackName is "attributeChangedCallback", then:

    1. Let attributeName be the first element of args.

    2. If definition's observed attributes does not contain attributeName, then abort these steps.

  5. Add a new callback reaction to element's custom element reaction queue, with callback function callback and arguments args.

  6. Enqueue an element on the appropriate element queue given element.

To enqueue a custom element upgrade reaction, given an element element and custom element definition definition, run the following steps:

  1. Add a new upgrade reaction to element's custom element reaction queue, with custom element definition definition.

  2. Enqueue an element on the appropriate element queue given element.

To invoke custom element reactions in an element queue queue, run the following steps:

  1. For each custom element element in queue:

    1. Let reactions be element's custom element reaction queue.

    2. Repeat until reactions is empty:

      1. Remove the first element of reactions, and let reaction be that element. Switch on reaction's type:

        upgrade reaction
        Upgrade element using reaction's custom element definition.
        callback reaction
        Invoke reaction's callback function with reaction's arguments, and with element as the callback this value.

        If this throws any exception, then report the exception.


The [CEReactions] IDL extended attribute is to ensure custom element reactions are triggered appropriately. It indicates that the relevant algorithm is to be supplemented with additional steps to appropriately track and invoke custom element reactions. The [{{CEReactions}}] extended attribute must take no arguments, and must not appear on anything other than an operation, attribute, setter, or deleter. Additionally, it must not appear on {{readonly}} attributes, unless the readonly attribute is also annotated with [PutForwards]. Operations, attributes, setters, or deleters annotated with the [{{CEReactions}}] extended attribute must run the following steps surrounding the main algorithm specified for the operation, setter, deleter, or for the attribute's setter:
Before executing the algorithm's steps
Push a new element queue onto the custom element reactions stack.
After executing the algorithm's steps
Pop the element queue from the custom element reactions stack, and invoke custom element reactions in that queue.
The intent behind this extended attribute is somewhat subtle. One way of accomplishing its goals would be to say that every operation, attribute, setter, and deleter on the platform should have these steps inserted, and to allow implementers to optimize away unnecessary cases (where no DOM mutation is possible that could cause custom element reactions to occur). However, this could lead to non-interoperable implementations if implementations do not invoke these steps in some cases. Explicitly annotating all relevant IDL constructs helps ensure interoperable behavior, by identifying all cases where these steps are necessary.
Any nonstandard APIs introduced by the user agent that could modify the DOM in such a way as to enqueue a custom element callback reaction or enqueue a custom element upgrade reaction, for example by modifying any attributes or child elements, must also be decorated with the [{{CEReactions}}] attribute.

As of the time of this writing, the following nonstandard or not-yet-standardized APIs are known to fall into this category:

HTML: HTML element constructors

To support custom elements, all HTML elements have special constructor behavior. The [HTMLConstructor] IDL extended attribute indicates that the interface object for the given interface will have a specific behavior, as defined in detail below.

The [{{HTMLConstructor}}] extended attribute must take no arguments, and must not appear on anything other than an interface. It must appear only once on an interface, and the interface must not be annotated with the [{{Constructor!!extended-attribute}}] or [{{NoInterfaceObject}}] extended attributes. (However, the interface may be annotated with [{{NamedConstructor}}]; there is no conflict there.) It must not be used on a callback interface.

Interface objects for interfaces annotated with the [{{HTMLConstructor}}] extended attribute must run the following steps as the function body behavior for both \[[Call]] and \[[Construct]] invocations of the corresponding JavaScript function object. When invoked with \[[Call]], newTarget is undefined, and the algorithm will throw. When invoked with \[[Construct]], the \[[Construct]] newTarget parameter provides the NewTarget value.

  1. Let registry be the current global object's {{CustomElementRegistry}} object.
  2. If NewTarget is equal to the active function object, then throw a {{TypeError}} and abort these steps.
    This can occur when a custom element is defined using an element interface as its constructor:
    customElements.define("bad-1", HTMLButtonElement);
    new HTMLButtonElement();          // (1)
    document.createElement("bad-1");  // (2)
    
    In this case, during the execution of {{HTMLButtonElement}} (either explicitly, as in (1), or implicitly, as in (2)), both the active function object and NewTarget are {{HTMLButtonElement}}. If this check was not present, it would be possible to create an instance of {{HTMLButtonElement}} whose local name was bad-1.
  3. Let definition be the entry in registry with constructor equal to NewTarget. If there is no such definition, then throw a {{TypeError}} and abort these steps.

    Since there can be no entry in registry whose constructor is undefined, this step also prevents HTML element constructors from being called as functions (since in that case NewTarget will be undefined).

  4. If definition's local name is equal to definition's name (i.e., definition is for an autonomous custom element), then:
    1. If the active function object is not {{HTMLElement}}, then throw a {{TypeError}} and abort these steps.
      This can occur when a custom element is defined to not extend any local names, but inherits from a non-{{HTMLElement}} class:
      customElements.define("bad-2", class Bad2 extends HTMLParagraphElement {});
      
      In this case, during the (implicit) super() call that occurs when constructing an instance of Bad2, the active function object is {{HTMLParagraphElement}}, not {{HTMLElement}}.
  5. Otherwise (i.e., if definition is for a customized built-in element):
    1. Let valid local names be the list of local names for elements defined in this specification or in other applicable specifications that use the active function object as their element interface.
    2. If valid local names does not contain definition's local name, then throw a {{TypeError}} and abort these steps.
      This can occur when a custom element is defined to extend a given local name but inherits from the wrong class:
      customElements.define("bad-3", class Bad3 extends HTMLQuoteElement {}, { extends: "p" });
      
      In this case, during the (implicit) super() call that occurs when constructing an instance of Bad3, valid local names is the list containing <{q}> and <{blockquote}>, but definition's local name is <{p}>, which is not in that list.
  6. Let prototype be definition's prototype.

  7. If definition's construction stack is empty, then:

    1. Let element be a new element that implements the interface to which the active function object corresponds, with no attributes, namespace set to the HTML namespace, local name set to definition's local name, and node document set to the current global object's associated Document.

    2. Perform element.[[\SetPrototypeOf]](prototype). Rethrow any exceptions.

    3. Set element's custom element state to "custom".

    4. Set element's custom element definition to definition.

    5. Return element.

    This occurs when author script constructs a new custom element directly, e.g. via new MyCustomElement().

  8. Let element be the last entry in definition's construction stack.
  9. If element is an already constructed marker, then throw an "{{InvalidStateError}}" {{DOMException}} and abort these steps.
    This can occur when the author code inside the custom element constructor non-conformantly creates another instance of the class being constructed, before calling super():

    let doSillyThing = false;
    
    class DontDoThis extends HTMLElement {
      constructor() {
       if (doSillyThing) {
         doSillyThing = false;
         new DontDoThis();
         // Now the construction stack will contain an already constructed marker.
       }
    
       // This will then fail with an "InvalidStateError" DOMException:
       super();
      }
    }
    
    This can also occur when author code inside the custom element constructor non-conformantly calls super() twice, since per the JavaScript specification, this actually executes the superclass constructor (i.e. this algorithm) twice, before throwing an error: class DontDoThisEither extends HTMLElement { constructor() { super(); // This will throw, but not until it has already called into the HTMLElement constructor super(); } }
  10. Perform element.[[\SetPrototypeOf]](prototype). Rethrow any exceptions.
  11. Replace the last entry in definition's construction stack with an already constructed marker.
  12. Return element.

    This step is normally reached when upgrading a custom element; the existing element is returned, so that the super() call inside the custom element constructor assigns that existing element to this.


In addition to the constructor behavior implied by [{{HTMLConstructor}}], some elements also have named constructors (which are really factory functions with a modified prototype property).
Named constructors for HTML elements can also be used in an extends clause when defining a custom element constructor: class AutoEmbiggenedImage extends Image { constructor(width, height) { super(width * 10, height * 10); } } customElements.define("auto-embiggened", AutoEmbiggenedImage, { extends: "img" }); const image = new AutoEmbiggenedImage(15, 20); console.assert(image.width === 150); console.assert(image.height === 200);

Element definitions

Each element in this specification has a definition that includes the following information: : Categories :: A list of [=categories=] to which the element belongs. These are used when defining the [=content models=] for each element. : Contexts in which this element can be used :: A non-normative description of where the element can be used. This information is redundant with the content models of elements that allow this one as a child, and is provided only as a convenience.

For simplicity, only the most specific expectations are listed. For example, an element that is both [=flow content=] and [=phrasing content=] can be used anywhere that either [=flow content=] or [=phrasing content=] is expected, but since anywhere that [=flow content=] is expected, [=phrasing content=] is also expected (since all [=phrasing content=] is [=flow content=]), only "where [=phrasing content=] is expected" will be listed. : Content model :: A normative description of what content must be included as children and descendants of the element. : Tag omission in text/html :: A non-normative description of whether, in the [[#text-html|text/html]] syntax, the [=start tag|start=] and [=end tag|end=] tags can be omitted. This information is redundant with the normative requirements given in the [=omitted|optional tags=] section, and is provided in the element definitions only as a convenience. : Content attributes :: A normative list of attributes that may be specified on the element (except where otherwise disallowed), along with non-normative descriptions of those attributes. (The content to the left of the dash is normative, the content to the right of the dash is not.) : Allowed ARIA role attribute values :: A non normative list of [[#aria-role-attribute|ARIA role attribute]] values that may be specified on the element (except where otherwise disallowed). Each value is linked to a non normative description. : Allowed ARIA state and property attributes :: Links to the [=Global aria-* attributes=] list and the [[#allowed-aria-roles-states-and-properties|allowed roles, states and properties]] table as described in the [[#state-and-property-attributes|state and property attributes]] section. : DOM interface :: A normative definition of a DOM interface that such elements must implement. This is then followed by a description of what the element [=represents=], along with any additional normative conformance criteria that may apply to authors and implementations. Examples are sometimes also included.

Attributes
An attribute value is a string. Except where otherwise specified, attribute values on [=HTML elements=] may be any string value, including the empty string, and there is no restriction on what text can be specified in such attribute values.

Content models

Each element defined in this specification has a content model: a description of the element's expected contents. An [=HTML element=] must have contents that match the requirements described in the element's content model. The contents of an element are its children in the DOM.

When a <{template}> element is being parsed, its children are assigned to the [=template contents=] (a separate {{DocumentFragment}} assigned to the element when the element is created), rather than its children.

The [=space characters=] are always allowed between elements. User agents represent these characters between elements in the source markup as {{Text}} nodes in the DOM. Empty {{Text}} nodes and {{Text}} nodes consisting of just sequences of those characters are considered inter-element white space. [=Inter-element white space=], comment nodes, and processing instruction nodes must be ignored when establishing whether an element's contents match the element's content model or not, and must be ignored when following algorithms that define document and element semantics.

Thus, an element |A| is said to be preceded or followed by a second element |B| if |A| and |B| have the same parent node and there are no other element nodes or {{Text}} nodes (other than [=inter-element white space=]) between them. Similarly, a node is the only child of an element if that element contains no other nodes other than [=inter-element white space=], comment nodes, and processing instruction nodes.

Authors must not use [=HTML elements=] anywhere except where they are explicitly allowed, as defined for each element, or as explicitly required by other specifications. For XML compound documents, these contexts could be inside elements from other namespaces, if those elements are defined as providing the relevant contexts.
For example, the Atom specification defines a content element. When its <{atom/type}> attribute has the value xhtml, the Atom specification requires that it contain a single HTML <{div}> element. Thus, a <{div}> element is allowed in that context, even though this is not explicitly normatively stated by this specification. [[RFC4287]]
In addition, [=HTML elements=] may be orphan nodes (i.e., without a parent node).
For example, creating a <{td}> element and storing it in a global variable in a script is conforming, even though <{td}> elements are otherwise only supposed to be used inside <{tr}> elements.
      var data = {
        name: "Banana",
        cell: document.createElement('td'),
      };
    
The "nothing" content model
When an element's content model is nothing, the element must contain no {{Text}} nodes (other than [=inter-element white space=]) and no element nodes.

Most HTML elements whose content model is "nothing" are also, for convenience, [=void elements=] (elements that have no [=end tag=] in the [[#syntax|HTML syntax]]). However, these are entirely separate concepts.

Kinds of content
Each element in HTML falls into zero or more categories that group elements with similar characteristics together. The following broad categories are used in this specification:

Some elements also fall into other categories, which are defined in other parts of this specification.

These categories are related as follows:

Sectioning content, heading content, phrasing content, embedded content, and interactive content are all types of flow content. Metadata is sometimes flow content. Metadata and interactive content are sometimes phrasing content. Embedded content is also a type of phrasing content, and sometimes is interactive content. Other categories are also used for specific purposes. For instance, form controls are specified using a number of categories to define common requirements. Some elements have unique requirements and do not fit into any particular category.
Metadata content
Metadata content is content that sets up the presentation or behavior of the rest of the content, or that sets up the relationship of the document with other documents, or that conveys other "out of band" information. Elements from other namespaces whose semantics are primarily metadata-related (e.g., RDF) are also [=metadata content=].
Thus, in the XML serialization, one can use RDF, like this: <html xmlns="http://www.w3.org/1999/xhtml" xmlns:r="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> <head> <title>Hedral's Home Page</title> <r:RDF> <Person xmlns="http://www.w3.org/2000/10/swap/pim/contact#" r:about="https://hedral.example.com/#"> <fullName>Cat Hedral</fullName> <mailbox r:resource="mailto:hedral@example.com" /> <personalTitle>Sir</personalTitle> </Person> </r:RDF> </head> <body> <h1>My home page</h1> <p>I like playing with string, I guess. Sister says squirrels are fun too so sometimes I follow her to play with them.</p> </body> </html> This isn't possible in the HTML serialization, however.
Flow content
Most elements that are used in the body of documents and applications are categorized as flow content.
Sectioning content
Sectioning content is content that defines the scope of [=headings=] and [[#the-footer-element|footers]]. Each [=sectioning content=] element potentially has a heading and an [=outline=]. See the section on [[#headings-and-sections|headings and sections]] for further details.

There are also certain elements that are [=sectioning roots=]. These are distinct from [=sectioning content=], but they can also have an [=outline=].

Heading content
Heading content defines the header of a section (whether explicitly marked up using [=sectioning content=] elements, or implied by the heading content itself).
Phrasing content
Phrasing content is the text of the document, as well as elements that mark up that text at the intra-paragraph level. Runs of [=phrasing content=] form [=paragraphs=].

Most elements that are categorized as phrasing content can only contain elements that are themselves categorized as phrasing content, not any flow content.

Text, in the context of content models, means either nothing, or {{Text}} nodes. [=Text=] is sometimes used as a content model on its own, but is also [=phrasing content=], and can be [=inter-element white space=] (if the {{Text}} nodes are empty or contain just [=space characters=]). {{Text}} nodes and attribute values must consist of [=Unicode characters=], must not contain U+0000 characters, must not contain permanently undefined Unicode characters (noncharacters), and must not contain [=control characters=] other than [=space characters=]. This specification includes extra constraints on the exact value of {{Text}} nodes and attribute values depending on their precise context. For elements in HTML, the constraints of the [=Text=] [=content model=] also depends on the [=kind of element=]. For instance, an "<" inside a <{textarea}> element does not need to be escaped in HTML because <{textarea}> is an [=escapable raw text=] element. (This does not apply to XHTML. In XHTML, the [=kind of element=] doesn't affect the constraints of the [=Text=] [=content model=].)
Embedded content
Embedded content is content that imports another resource into the document, or content from another vocabulary that is [=document/inserted into the document=]. Elements that are from namespaces other than the [=HTML namespace=] and that convey content but not metadata, are [=embedded content=] for the purposes of the content models defined in this specification. (For example, MathML, or SVG.) Some embedded content elements can have fallback content: content that is to be used when the external resource cannot be used (e.g., because it is of an unsupported format). The element definitions state what the fallback is, if any.
Interactive content
Interactive content is content that is specifically intended for user interaction. The <{global/tabindex}> attribute can also make any element into [=interactive content=].
Palpable content
As a general rule, elements whose content model allows any [=flow content=] or [=phrasing content=] should have at least one node in its contents that is palpable content and that does not have the <{global/hidden}> attribute specified.

[=Palpable content=] makes an element non-empty by providing either some descendant non-empty [=text=], or else something users can hear (<{audio}> elements) or view (<{video}> or <{img}> or <{canvas}> elements) or otherwise interact with (for example, interactive form controls).

This requirement is not a hard requirement, however, as there are many cases where an element can be empty legitimately, for example when it is used as a placeholder which will later be filled in by a script, or when the element is part of a template and would on most pages be filled in but on some pages is not relevant. Conformance checkers are encouraged to provide a mechanism for authors to find elements that fail to fulfill this requirement, as an authoring aid. The following elements are palpable content:
Script-supporting elements
Script-supporting elements are those that do not [=represent=] anything themselves (i.e., they are not rendered), but are used to support scripts, e.g., to provide functionality for the user. The following elements are script-supporting elements:
Transparent content models
Some elements are described as transparent; they have "transparent" in the description of their content model. The content model of a [=transparent=] element is derived from the content model of its parent element: the elements required in the part of the content model that is "transparent" are the same elements as required in the part of the content model of the parent of the transparent element in which the transparent element finds itself.
For instance, an <{ins}> element inside a <{ruby}> element cannot contain an <{rt}> element, because the part of the <{ruby}> element's content model that allows <{ins}> elements is the part that allows [=phrasing content=], and the <{rt}> element is not [=phrasing content=].

In some cases, where transparent elements are nested in each other, the process has to be applied iteratively.

Consider the following markup fragment: <p> <object> <ins> <map> <a href="/">Apples</a> </map> </ins> </object> </p> To check whether "Apples" is allowed inside the <{a}> element, the content models are examined. The <{a}> element's content model is transparent, as is the <{map}> element's, as is the <{ins}> element's, as is the part of the <{object}> element's in which the <{ins}> element is found. The <{object}> element is found in the <{p}> element, whose content model is [=phrasing content=]. Thus, "Apples" is allowed, as text is phrasing content.
When a transparent element has no parent, then the part of its content model that is "transparent" must instead be treated as accepting any [=flow content=].
Paragraphs

The term [=paragraph=] as defined in this section is used for more than just the definition of the <{p}> element. The [=paragraph=] concept defined here is used to describe how to interpret documents. The <{p}> element is merely one of several ways of marking up a [=paragraph=].

A paragraph is typically a run of [=phrasing content=] that forms a block of text with one or more sentences that discuss a particular topic, as in typography, but can also be used for more general thematic grouping. For instance, an address is also a paragraph, as is a byline, or a stanza in a poem.
In the following example, there are two paragraphs in a section. There is also a heading, which contains phrasing content that is not a paragraph. Note how the comments and [=inter-element white space=] do not form paragraphs. <section> <h2>Example of paragraphs</h2> This is the <em>first</em> paragraph in this example. <p>This is the second.</p> <!-- This is not a paragraph. --> </section>
Paragraphs in [=flow content=] are defined relative to what the document looks like without the <{a}>, <{ins}>, <{del}>, and <{map}> elements complicating matters, since those elements, with their hybrid content models, can straddle paragraph boundaries, as shown in the first two examples below.

Generally, having elements straddle paragraph boundaries is best avoided. Maintaining such markup can be difficult.

The following example takes the markup from the earlier example and puts <{ins}> and <{del}> elements around some of the markup to show that the text was changed (though in this case, the changes admittedly don't make much sense). Notice how this example has exactly the same paragraphs as the previous one, despite the <{ins}> and <{del}> elements — the <{ins}> element straddles the heading and the first paragraph, and the <{del}> element straddles the boundary between the two paragraphs. <section> <ins><h1>Example of paragraphs</h1> This is the <em>first</em> paragraph in</ins> this example<del>. <p>This is the second.</p></del> <!-- This is not a paragraph. --> </section>
Let |view| be a view of the DOM that replaces all <{a}>, <{ins}>, <{del}>, and <{map}> elements in the document with their contents. Then, in |view|, for each run of sibling [=phrasing content=] nodes uninterrupted by other types of content, in an element that accepts content other than [=phrasing content=] as well as [=phrasing content=], let |first| be the first node of the run, and let |last| be the last node of the run. For each such run that consists of at least one node that is neither [=embedded content=] nor [=inter-element white space=], a paragraph exists in the original DOM from immediately before |first| to immediately after |last|. (Paragraphs can thus span across <{a}>, <{ins}>, <{del}>, and <{map}> elements.) Conformance checkers may warn authors of cases where they have paragraphs that overlap each other (this can happen with <{object}>, <{video}>, <{audio}>, and <{canvas}> elements, and indirectly through elements in other namespaces that allow HTML to be further embedded therein, like SVG <{svg}> or MathML <{math}>). A [=paragraph=] is also formed explicitly by <{p}> elements.

The <{p}> element can be used to wrap individual paragraphs when there would otherwise not be any content other than phrasing content to separate the paragraphs from each other.

In the following example, the link spans half of the first paragraph, all of the heading separating the two paragraphs, and half of the second paragraph. It straddles the paragraphs and the heading. <header> Welcome! <a href="about.html"> This is home of... <h1>The Falcons!</h1> The Lockheed Martin multirole jet fighter aircraft! </a> This page discusses the F-16 Fighting Falcon's innermost secrets. </header> Here is another way of marking this up, this time showing the paragraphs explicitly, and splitting the one link element into three: <header> <p>Welcome! <a href="about.html">This is home of...</a></p> <h1><a href="about.html">The Falcons!</a></h1> <p><a href="about.html">The Lockheed Martin multirole jet fighter aircraft!</a> This page discusses the F-16 Fighting Falcon's innermost secrets.</p> </header>
It is possible for paragraphs to overlap when using certain elements that define fallback content. For example, in the following section: <section> <h2>My Cats</h2> You can play with my cat simulator. <object data="cats.sim"> To see the cat simulator, use one of the following links: <ul> <li><a href="cats.sim">Download simulator file</a> <li><a href="https://sims.example.com/watch?v=LYds5xY4INU">Use online simulator</a> </ul> Alternatively, upgrade to the Mellblom Browser. </object> I'm quite proud of it. </section> There are five paragraphs:
    1. The paragraph that says "You can play with my cat simulator. object I'm quite proud of it.", where object is the <{object}> element. 2. The paragraph that says "To see the cat simulator, use one of the following links:". 3. The paragraph that says "Download simulator file". 4. The paragraph that says "Use online simulator". 5. The paragraph that says "Alternatively, upgrade to the Mellblom Browser.".
The first paragraph is overlapped by the other four. A user agent that supports the "cats.sim" resource will only show the first one, but a user agent that shows the fallback will confusingly show the first sentence of the first paragraph as if it was in the same paragraph as the second one, and will show the last paragraph as if it was at the start of the second sentence of the first paragraph. To avoid this confusion, explicit <{p}> elements can be used. For example: <section> <h2>My Cats</h2> <p>You can play with my cat simulator.</p> <object data="cats.sim"> <p>To see the cat simulator, use one of the following links:</p> <ul> <li><a href="cats.sim">Download simulator file</a> <li><a href="https://sims.example.com/watch?v=LYds5xY4INU">Use online simulator</a> </ul> <p>Alternatively, upgrade to the Mellblom Browser.</p> </object> <p>I'm quite proud of it.</p> </section>

Global attributes

The following attributes are common to and may be specified on all [=HTML elements=] (even those not defined in this specification): These attributes are only defined by this specification as attributes for [=HTML elements=]. When this specification refers to elements having these attributes, elements from namespaces that are not defined as having these attributes must not be considered as being elements with these attributes.
For example, in the following XML fragment, the "bogus" element does not have a <{global/dir}> attribute as defined in this specification, despite having an attribute with the literal name "<{global/dir}>". Thus, [=the directionality=] of the inner-most <{span}> element is 'rtl', inherited from the <{div}> element indirectly through the "bogus" element. <div xmlns="http://www.w3.org/1999/xhtml" dir="rtl"> <bogus xmlns="https://example.net/ns" dir="ltr"> <span xmlns="http://www.w3.org/1999/xhtml"> </span> </bogus> </div>

When specified on [=HTML elements=], the class attribute's value must be a [=set of space-separated tokens=] representing the various classes that the element belongs to. The DOM specification defines additional user agent requirements for this attribute. [[DOM]]
Assigning classes to an element affects class matching in selectors in CSS, the {{Document/getElementsByClassName()}} method in the DOM, and other such features. There are no additional restrictions on the tokens authors can use in the <{global/class}> attribute, but authors are encouraged to use values that describe the nature of the content, rather than values that describe the desired presentation of the content.
When specified on [=HTML elements=], the id attribute value must be unique amongst all the [=IDs=] in the element's [=tree=] and must contain at least one character. The value must not contain any [=space characters=]. The DOM specification defines additional user agent requirements for this attribute. [[DOM]]
The <{global/id}> attribute specifies its element's [=id|unique identifier (ID)=]. There are no other restrictions on what form an ID can take; in particular, IDs can consist of just digits, start with a digit, start with an underscore, consist of just punctuation, etc. An element's [=unique identifier=] can be used for a variety of purposes, most notably as a way to link to specific parts of a document using fragment, as a way to target an element when scripting, and as a way to style a specific element from CSS.
Identifiers are opaque strings. Particular meanings should not be derived from the value of the <{global/id}> attribute. When specified on an [=HTML element=] the is attribute identifies the element as a customized built-in element. Its value must be a valid custom element name. Changing the value of the <{global/is}> attribute after the [=create an element|element is created=] does not change an element's behaviour. There are no conformance requirements for the slot attribute specific to [=HTML elements=]. The DOM specification defines requirements for this attribute. [[DOM]]

The <{global/slot}> attribute is used for elements in shadow trees, to assign a slot for the element. The slot will be assigned to the <{slot}> element whose <{slot/name}> attribute matches the value of the <{global/slot}> attribute.


To enable assistive technology products to expose a more fine-grained interface than is otherwise possible with HTML elements and attributes, a set of annotations for assistive technology products can be specified (the ARIA <{aria/role}> and [=global aria-* attributes|aria-*=] attributes). [[!wai-aria-1.1]]
The following [=event handler content attributes=] may be specified on any [=HTML element=]:

The attributes marked with an asterisk have a different meaning when specified on <{body}> elements as those elements expose [=event handlers=] of the {{Window}} object with the same names.

While these attributes apply to all elements, they are not useful on all elements. For example, only [=media elements=] will ever receive a {{media/volumechange}} event fired by the user agent.


[=Custom data attributes=] (e.g., data-foldername or data-msgid) can be specified on any [=HTML element=], to store custom data specific to the page.
In [=HTML documents=], elements in the [=HTML namespace=] may have an <{xmlns/xmlns}> attribute specified, if, and only if, it has the exact value "http://www.w3.org/1999/xhtml". This does not apply to [=XML documents=].

In HTML, the <{xmlns/xmlns}> attribute has absolutely no effect. It is basically a talisman. It is allowed merely to make migration to and from XML mildly easier. When parsed by an [=HTML parser=], the attribute ends up in no namespace, not the "http://www.w3.org/2000/xmlns/" namespace like namespace declaration attributes in XML do.

In XML, an <{xmlns/xmlns}> attribute is part of the namespace declaration mechanism, and an element cannot actually have an <{xmlns/xmlns}> attribute in no namespace specified.


The XML specification also allows the use of the <{xml/space|xml:space}> attribute in the [=XML namespace=] on any element in an [=XML document=]. This attribute has no effect on [=HTML elements=], as the default behavior in HTML is to preserve white space. [[!XML]]

There is no way to serialize the <{xml/space|xml:space}> attribute on [=HTML elements=] in the [[#text-html|text/html]] syntax.

The <{global/title}> attribute
The title attribute [=represents=] advisory information for the element, such as would be appropriate for a tooltip. On a link, this could be the title or a description of the target resource; on an image, it could be the image credit or a description of the image; on a paragraph, it could be a footnote or commentary on the text; on a citation, it could be further information about the source; on [=interactive content=], it could be a label for, or instructions for, use of the element; and so forth. The value is text.
Relying on the <{global/title}> attribute is currently discouraged as many user agents do not expose the attribute in an accessible manner as required by this specification (e.g., requiring a pointing device, such as a mouse, to cause a tooltip to appear excludes keyboard-only users and touch-only users, such as anyone with a modern phone or tablet).
If this attribute is omitted from an element, then it implies that the <{global/title}> attribute of the nearest ancestor [=HTML element=] with a <{global/title}> attribute set is also relevant to this element. Setting the attribute overrides this, explicitly stating that the advisory information of any ancestors is not relevant to this element. Setting the attribute to the empty string indicates that the element has no advisory information. If the <{global/title}> attribute's value contains U+000A LINE FEED (LF) characters, the content is split into multiple lines. Each U+000A LINE FEED (LF) character represents a line break.
Caution is advised with respect to the use of newlines in <{global/title}> attributes. For instance, the following snippet actually defines an abbreviation's expansion with a line break in it: <p> My logs show that there was some interest in <abbr title="Hypertext Transport Protocol">HTTP</abbr> today. </p>
Some elements, such as <{link}>, <{abbr}>, and <{input}>, define additional semantics for the <{global/title}> attribute beyond the semantics described above. The advisory information of an element is the value that the following algorithm returns, with the algorithm being aborted once a value is returned. When the algorithm returns the empty string, then there is no advisory information. 1. If the element has a <{global/title}> attribute, then return its value. 2. Otherwise, if the element has a parent element, then return the parent element's [=advisory information=]. 3. Otherwise, return the empty string. User agents should inform the user when elements have [=advisory information=], otherwise the information would not be discoverable.
The title IDL attribute must [=reflect=] the <{global/title}> content attribute.
The <{global/lang}> and <{xml/lang|xml:lang}> attributes
The lang attribute (in no namespace) specifies the primary language for the element's contents and for any of the element's attributes that contain text. Its value must be a valid BCP 47 language tag, or the empty string. Setting the attribute to the empty string indicates that the primary language is unknown. [[!BCP47]] The lang attribute in the [=XML namespace=] is defined in XML. [[!XML]] If these attributes are omitted from an element, then the language of this element is the same as the language of its parent element, if any. The <{global/lang}> attribute in no namespace may be used on any [=HTML element=]. The <{global/lang}> attribute in the [=XML namespace=] may be used on [=HTML elements=] in [=XML documents=], as well as elements in other namespaces if the relevant specifications allow it (in particular, MathML and SVG allow <{global/lang}> attributes in the [=XML namespace=] to be specified on their elements). If both the <{global/lang}> attribute in no namespace and the <{global/lang}> attribute in the [=XML namespace=] are specified on the same element, they must have exactly the same value when compared in an [=ASCII case-insensitive=] manner. Authors must not use the <{global/lang}> attribute in the [=XML namespace=] on [=HTML elements=] in [=HTML documents=]. To ease migration to and from XHTML, authors may specify an attribute in no namespace with no prefix and with the literal localname "<{xml/lang|xml:lang}>" on [=HTML elements=] in [=HTML documents=], but such attributes must only be specified if a <{global/lang}> attribute in no namespace is also specified, and both attributes must have the same value when compared in an [=ASCII case-insensitive=] manner.

The attribute in no namespace with no prefix and with the literal localname "<{xml/lang|xml:lang}>" has no effect on language processing.

The language of [=HTML documents=] is indicated using a <{global/lang}> attribute (on the <{html}> element itself, to indicate the primary language of the document, and on individual elements, to indicate a change in language). It provides an explicit indication to user agents about the language of content in order to enable language specific behavior. For example, use of an appropriate language dictionary; selection of an appropriate font or glyphs for characters shared between different languages; or in the case of screen readers and similar assistive technologies with voice output, pronunciation of content using the correct voice / language library. Incorrect or absent <{global/lang}> attributes can produce unexpected results in other circumstances, as they are also used to determine quotation marks for <{q}> elements, styling such as hyphenation, case conversion, line-breaking, and spell-checking in some editors, etc. Setting the <{global/lang}> attribute to a language which does not match the language of the document or document parts will result in some users being unable to understand the content.

To determine the language of a node, user agents must look at the nearest ancestor element (including the element itself if the node is an element) that has a <{global/lang}> attribute in the [=XML namespace=] set or is an [=HTML element=] and has a <{global/lang}> in no namespace attribute set. That attribute specifies the language of the node (regardless of its value). If both the <{global/lang}> attribute in no namespace and the <{global/lang}> attribute in the [=XML namespace=] are set on an element, user agents must use the <{global/lang}> attribute in the [=XML namespace=], and the <{global/lang}> attribute in no namespace must be [=ignored=] for the purposes of determining the element's language. If node's [=inclusive ancestors=] do not have either attribute set, but there is a [=pragma-set default language=] set, then that is the language of the node. If there is no [=pragma-set default language=] set, then language information from a higher-level protocol (such as HTTP), if any, must be used as the final fallback language instead. In the absence of any such language information, and in cases where the higher-level protocol reports multiple languages, the language of the node is unknown, and the corresponding language tag is the empty string.

For example, if a document is delivered over HTTP and the Content-Language HTTP header is specified with a value "en", then for any element in the document that does not itself have a <{global/lang}> attribute nor any ancestor of that element, the fallback language for the element will be English. If the value of the Content-Language header was "de, fr, it" then the language of the node is unknown. This article provides some additional guidance on the use of HTTP headers, and <{meta}> elements for providing language information.

If the resulting value is not a recognized language tag, then it must be treated as an unknown language having the given language tag, distinct from all other languages. For the purposes of round-tripping or communicating with other services that expect language tags, user agents should pass unknown language tags through unmodified, and tagged as being BCP 47 language tags, so that subsequent services do not interpret the data as another type of language description. [[!BCP47]]

Thus, for instance, an element with lang="xyzzy" would be matched by the selector :lang(xyzzy) (e.g., in CSS), but it would not be matched by :lang(abcde), even though both are equally invalid. Similarly, if a Web browser and screen reader working in unison communicated about the language of the element, the browser would tell the screen reader that the language was "xyzzy", even if it knew it was invalid, just in case the screen reader actually supported a language with that tag after all. Even if the screen reader supported both BCP 47 and another syntax for encoding language names, and in that other syntax the string "xyzzy" was a way to denote the Belarusian language, it would be *incorrect* for the screen reader to then start treating text as Belarusian, because "xyzzy" is not how Belarusian is described in BCP 47 codes (BCP 47 uses the code "be" for Belarusian).

If the resulting value is the empty string, then it must be interpreted as meaning that the language of the node is explicitly unknown.
User agents may use the element's language to determine proper processing or rendering (e.g., in the selection of appropriate fonts or pronunciations, for dictionary selection, or for the user interfaces of form controls such as date pickers).
The lang IDL attribute must [=reflect=] the <{global/lang}> content attribute in no namespace.
The <{global/translate}> attribute
The translate attribute is an [=enumerated attribute=] that is used to specify whether an element's attribute values and the values of its {{Text}} node children are to be translated when the page is localized, or whether to leave them unchanged. The attribute's keywords are the empty string, yes, and no. The empty string and the yes keyword map to the yes state. The no keyword maps to the no state. In addition, there is a third state, the inherit state, which is the [=missing value default=] (and the [=invalid value default=]). Each element (even non-HTML elements) has a translation mode, which is in either the [=translate-enabled=] state or the [=no-translate=] state. If an [=HTML element=]'s <{global/translate}> attribute is in the yes state, then the element's [=translation mode=] is in the [=translate-enabled=] state; otherwise, if the element's <{global/translate}> attribute is in the no state, then the element's [=translation mode=] is in the [=no-translate=] state. Otherwise, either the element's <{global/translate}> attribute is in the inherit state, or the element is not an [=HTML element=] and thus does not have a <{global/translate}> attribute; in either case, the element's [=translation mode=] is in the same state as its parent element's, if any, or in the [=translate-enabled=] state, if the element is a [=document element=]. When an element is in the translate-enabled state, the element's [=translatable attributes=] and the values of its {{Text}} node children are to be translated when the page is localized. When an element is in the no-translate state, the element's attribute values and the values of its {{Text}} node children are to be left as-is when the page is localized, e.g., because the element contains a person's name or a name of a computer program. The following attributes are translatable attributes: Other specifications may define other attributes that are also [=translatable attributes=]. For example, ARIA would define the <{aria/aria-label}> attribute as translatable.
The translate IDL attribute must, on getting, return true if the element's [=translation mode=] is [=translate-enabled=], and false otherwise. On setting, it must set the content attribute's value to "yes" if the new value is true, and set the content attribute's value to "no" otherwise.
In this example, everything in the document is to be translated when the page is localized, except the sample keyboard input and sample program output: <!DOCTYPE html> <html> <!-- default on the document element is translate="yes" --> <head> <title>The Bee Game</title> <!-- implied translate="yes" inherited from ancestors --> </head> <body> <p>The Bee Game is a text adventure game in English.</p> <p>When the game launches, the first thing you should do is type <kbd translate="no">eat honey</kbd>. The game will respond with:</p> <pre><samp translate="no">Yum yum! That was some good honey!</samp></pre> </body> </html>
The <{xml/base|xml:base}> attribute (XML only)
The xml:base attribute is defined in XML Base. [[!XMLBASE]] The <{xml/base|xml:base}> attribute may be used on [=HTML elements=] of [=XML documents=]. Authors must not use the <{xml/base|xml:base}> attribute on [=HTML elements=] in [=HTML documents=].
The <{global/dir}> attribute
The dir attribute specifies the element's text directionality. The attribute is an [=enumerated attribute=] with the following keywords and states: : The ltr keyword, which maps to the ltr state :: Indicates that the contents of the element are explicitly directionally isolated left-to-right text. : The rtl keyword, which maps to the rtl state :: Indicates that the contents of the element are explicitly directionally isolated right-to-left text. : The auto keyword, which maps to the auto state :: Indicates that the contents of the element are explicitly directionally isolated text, but that the direction is to be determined programmatically using the contents of the element (as described below).

The heuristic used by this state is very crude (it just looks at the first character with a strong directionality, in a manner analogous to the Paragraph Level determination in the bidirectional algorithm). Authors are urged to only use this value as a last resort when the direction of the text is truly unknown and no better server-side heuristic can be applied. [[!BIDI]]

For <{textarea}> and <{pre}> elements, the heuristic is applied on a per-paragraph level.

The attribute has no [=invalid value default=] and no [=missing value default=].
The directionality of an element (any element, not just an [=HTML element=]) is either 'ltr' or 'rtl', and is determined as per the first appropriate set of steps from the following list:
: If the element's <{global/dir}> attribute is in the ltr state : If the element is a [=document element=] and the <{global/dir}> attribute is not in a defined state (i.e., it is not present or has an invalid value) : If the element is an <{input}> element whose <{input/type}> attribute is in the <{input/Telephone}> state, and the <{global/dir}> attribute is not in a defined state (i.e., it is not present or has an invalid value) :: [=The directionality=] of the element is 'ltr'. : If the element's <{global/dir}> attribute is in the rtl state :: [=The directionality=] of the element is 'rtl'. : If the element is an <{input}> element whose <{input/type}> attribute is in the <{input/Text}>, <{input/Search}>, <{input/Telephone}>, <{input/URL}>, or <{input/E-mail}> state, and the <{global/dir}> attribute is in the auto state : If the element is a <{textarea}> element and the <{global/dir}> attribute is in the auto state :: If the element's [=attribute value|value=] contains a character of bidirectional character type AL or R, and there is no character of bidirectional character type L anywhere before it in the element's [=attribute value|value=], then [=the directionality=] of the element is 'rtl'. [[!BIDI]] Otherwise, if the element's [=attribute value|value=] is not the empty string, or if the element is a [=document element=], [=the directionality=] of the element is 'ltr'. Otherwise, [=the directionality=] of the element is the same as the element's parent element's [=directionality=]. : If the element's <{global/dir}> attribute is in the auto state : If the element is a <{bdi}> element and the <{global/dir}> attribute is not in a defined state (i.e., it is not present or has an invalid value) :: Find the first character in [=tree order=] that matches the following criteria: * The character is from a {{Text}} node that is a descendant of the element whose [=directionality=] is being determined. * The character is of bidirectional character type L, AL, or R. [[!BIDI]] * The character is not in a {{Text}} node that has an ancestor element that is a descendant of the element whose [=directionality=] is being determined and that is either: If such a character is found and it is of bidirectional character type AL or R, [=the directionality=] of the element is 'rtl'. If such a character is found and it is of bidirectional character type L, [=the directionality=] of the element is 'ltr'. Otherwise, if the element is a [=document element=], [=the directionality=] of the element is 'ltr'. Otherwise, [=the directionality=] of the element the same as the element's parent element's [=directionality=]. : If the element has a parent element and the <{global/dir}> attribute is not in a defined state (i.e., it is not present or has an invalid value) :: [=The directionality=] of the element is the same as the element's parent element's [=directionality=].

Since the <{global/dir}> attribute is only defined for [=HTML elements=], it cannot be present on elements from other namespaces. Thus, elements from other namespaces always just inherit their [=directionality=] from their parent element, or, if they don't have one, default to 'ltr'.

This attribute has rendering requirements involving the bidirectional algorithm.


The directionality of an attribute of an [=HTML element=], which is used when the text of that attribute is to be included in the rendering in some manner, is determined as per the first appropriate set of steps from the following list:
: If the attribute is a [=directionality-capable attribute=] and the element's <{global/dir}> attribute is in the auto state :: Find the first character (in logical order) of the attribute's value that is of bidirectional character type L, AL, or R. [[!BIDI]] If such a character is found and it is of bidirectional character type AL or R, the [=directionality of the attribute=] is 'rtl'. Otherwise, the [=directionality of the attribute=] is 'ltr'. : Otherwise :: The [=directionality of the attribute=] is the same as [=the element's directionality=].
The following attributes are directionality-capable attributes:
: |document| . {{Document/dir}} [ = |value| ] :: Returns the <{html}> element's <{global/dir}> attribute's value, if any. Can be set, to either 'ltr', 'rtl', or 'auto' to replace the <{html}> element's <{global/dir}> attribute's value. If there is no <{html}> element, returns the empty string and ignores new values.
The dir IDL attribute on an element must [=reflect=] the <{global/dir}> content attribute of that element, [=limited to only known values=]. The dir IDL attribute on {{Document}} objects must [=reflect=] the <{global/dir}> content attribute of the <{html}> element, if any, [=limited to only known values=]. If there is no such element, then the attribute must return the empty string and do nothing on setting.

Authors are strongly encouraged to use the <{global/dir}> attribute to indicate text direction rather than using CSS, since that way their documents will continue to render correctly even in the absence of CSS (e.g., as interpreted by search engines).

This markup fragment is of an IM conversation. <p dir="auto" class="u1"><b><bdi>Student</bdi>:</b> How do you write "What's your name?" in Arabic?</p> <p dir="auto" class="u2"><b><bdi>Teacher</bdi>:</b> ما اسمك؟</p> <p dir="auto" class="u1"><b><bdi>Student</bdi>:</b> Thanks.</p> <p dir="auto" class="u2"><b><bdi>Teacher</bdi>:</b> That's written "شكرًا".</p> <p dir="auto" class="u2"><b><bdi>Teacher</bdi>:</b> Do you know how to write "Please"?</p> <p dir="auto" class="u1"><b><bdi>Student</bdi>:</b> "من فضلك", right?</p> Given a suitable style sheet and the default alignment styles for the <{p}> element, namely to align the text to the start edge of the paragraph, the resulting rendering could be as follows: Each paragraph rendered as a separate block, with the paragraphs left-aligned except the second paragraph and the last one, which would  be right aligned, with the usernames ('Student' and 'Teacher' in this example) flush right, with a colon to their left, and the text first to the left of that. As noted earlier, the 'auto' value is not a panacea. The final paragraph in this example is misinterpreted as being right-to-left text, since it begins with an Arabic character, which causes the "right?" to be to the left of the Arabic text.
The style attribute
All [=HTML elements=] may have the <{global/style}> content attribute set. This is a [=style attribute=] as defined by the CSS Style Attributes specification. [[!CSS-STYLE-ATTR]] In user agents that support CSS, the attribute's value must be parsed when the attribute is added or has its value changed, according to the rules given for [=style attributes=]. [[!CSS-STYLE-ATTR]] However, if the [=Should element's inline behavior be blocked by Content Security Policy?=] algorithm returns "Blocked" when executed upon the attribute's {{Element|element}} and "style attribute", and the attribute's value, then the style rules defined in the attribute's value must not be applied to the {{Element|element}}. [[!CSP3]] Documents that use <{global/style}> attributes on any of their elements must still be comprehensible and usable if those attributes were removed.

In particular, using the <{global/style}> attribute to hide and show content, or to convey meaning that is otherwise not included in the document, is non-conforming. (To hide and show content, use the <{global/hidden}> attribute.)


: |element| . {{ElementCSSInlineStyle/style}} :: Returns a {{CSSStyleDeclaration}} object for the element's <{global/style}> attribute.
The {{ElementCSSInlineStyle/style}} IDL attribute is defined in the CSS Object Model (CSSOM) specification. [[!CSSOM]]
In the following example, the words that refer to colors are marked up using the <{span}> element and the <{global/style}> attribute to make those words show up in the relevant colors in visual media. <p> My suit is <span style="color: green; background: transparent">green</span>. My eyes are <span style="color: blue; background: transparent">blue</span>. </p>
Embedding custom non-visible data with the <{global/data-*}> attributes
A custom data attribute is an attribute in no namespace whose name starts with the string "data-", has at least one character after the hyphen, is [=XML-compatible=], and contains no [=uppercase ASCII letters=].

All attribute names on [=HTML elements=] in [=HTML documents=] get ASCII-lowercased automatically, so the restriction on ASCII uppercase letters doesn't affect such documents.

[=Custom data attributes=] are intended to store custom data private to the page or application, for which there are no more appropriate attributes or elements. These attributes are not intended for use by software that is not known to the administrators of the site that uses the attributes. For generic extensions that are to be used by multiple independent tools, either this specification should be extended to provide the feature explicitly, or a technology like microdata should be used (with a standardized vocabulary).
For instance, a site about music could annotate list items representing tracks in an album with custom data attributes containing the length of each track. This information could then be used by the site itself to allow the user to sort the list by track length, or to filter the list for tracks of certain lengths. <ol> <li data-length="2m11s">Beyond The Sea</li> ... </ol> It would be inappropriate, however, for the user to use generic software not associated with that music site to search for tracks of a certain length by looking at this data. This is because these attributes are intended for use by the site's own scripts, and are not a generic extension mechanism for publicly-usable metadata.
Similarly, a page author could write markup that provides information for a translation tool that they are intending to use:
      <p>
        The third <span data-mytrans-de="Anspruch">claim</span> covers the case of <span translate="no">HTML</span> markup.
      </p>
    
In this example, the "data-mytrans-de" attribute gives specific text for the MyTrans product to use when translating the phrase "claim" to German. However, the standard <{global/translate}> attribute is used to indicate that "HTML" is to remain unchanged in all languages. When a standard attribute is available, there is no need for a [=custom data attribute=] to be used.
Every [=HTML element=] may have any number of [=custom data attributes=] specified, with any value. Authors should carefully design such extensions so that when the attributes are ignored and any associated CSS dropped, the page is still usable. User agents must not derive any implementation behavior from these attributes or values. Specifications intended for user agents must not define these attributes to have any meaningful values. JavaScript libraries may use the [=custom data attributes=], as they are considered to be part of the page on which they are used. Authors of libraries that are reused by many authors are encouraged to include their name in the attribute names, to reduce the risk of clashes. Where it makes sense, library authors are also encouraged to make the exact name used in the attribute names customizable, so that libraries whose authors unknowingly picked the same name can be used on the same page, and so that multiple versions of a particular library can be used on the same page even when those versions are not mutually compatible.
For example, a library called "DoQuery" could use attribute names like data-doquery-range, and a library called "jJo" could use attributes names like data-jjo-range. The jJo library could also provide an API to set which prefix to use (e.g. J.setDataPrefix("j2"), making the attributes have names like data-j2-range).

: |element| . {{HTMLElement/dataset}} :: Returns a {{DOMStringMap}} object for the element's <{global/data-*}> attributes. Hyphenated names are converted to dromedary-case (which is the same as camel-case except the initial letter is not uppercased). For example, data-foo-bar="" becomes element.dataset.fooBar.
The dataset IDL attribute provides convenient accessors for all the <{global/data-*}> attributes on an element. On getting, the {{HTMLElement/dataset}} IDL attribute must return a {{DOMStringMap}} whose associated element is this element. The {{DOMStringMap}} interface is used for the {{HTMLElement/dataset}} attribute. Each {{DOMStringMap}} has an associated element.
    [OverrideBuiltins]
    interface DOMStringMap {
      getter DOMString (DOMString name);
      [CEReactions] setter void (DOMString name, DOMString value);
      [CEReactions] deleter void (DOMString name);
    };
  
To get a {{DOMStringMap}}'s name-value pairs, run the following algorithm: 1. Let |list| be an empty list of name-value pairs. 2. For each content attribute on the {{DOMStringMap}}'s [=associated element=] whose first five characters are the string "data-" and whose remaining characters (if any) do not include any [=uppercase ASCII letters=], in the order that those attributes are listed in the element's [=element attribute|attribute list=], add a name-value pair to |list| whose name is the attribute's name with the first five characters removed and whose value is the attribute's value. 3. For each name in |list|, for each U+002D HYPHEN-MINUS character (-) in the name that is followed by a [=lowercase ASCII letter=], remove the U+002D HYPHEN-MINUS character (-) and replace the character that followed it by the same character in [=ASCII uppercase=]. 4. Return |list|. The [=supported property names=] on a {{DOMStringMap}} object at any instant are the names of each pair returned from [=DOMStringMap/__getter__()|getting the DOMStringMap's name-value pairs=] at that instant, in the order returned. To [=determine the value of a named property=] |name| for a {{DOMStringMap}}, return the value component of the name-value pair whose name component is |name| in the list returned from [=DOMStringMap/__getter__()|getting the DOMStringMap's name-value pairs=]. To [=set the value of a new named property=] or [=set the value of an existing named property=] for a {{DOMStringMap}}, given a property name |name| and a new value |value|, run the following steps: 1. If |name| contains a U+002D HYPHEN-MINUS character (-) followed by a [=lowercase ASCII letter=], then throw a "{{SyntaxError}}" {{DOMException}} and abort these steps. 2. For each [=uppercase ASCII letter=] in |name|, insert a U+002D HYPHEN-MINUS character (-) before the character and replace the character with the same character in [=ASCII lowercase=]. 3. Insert the string data- at the front of |name|. 4. If |name| does not match the XML [=xml/Name=] production, throw an "{{InvalidCharacterError}}" {{DOMException}} and abort these steps. 5. [=Set an attribute value=] for the {{DOMStringMap}}'s [=associated element=] using |name| and |value|. To [=delete an existing named property=] |name| for a {{DOMStringMap}}, run the following steps: 1. For each [=uppercase ASCII letter=] in |name|, insert a U+002D HYPHEN-MINUS character (-) before the character and replace the character with the same character in [=ASCII lowercase=]. 2. Insert the string data- at the front of |name|. 3. [=Remove an attribute by name=] given |name|, and the {{DOMStringMap}}'s [=associated element=].

This algorithm will only get invoked by the Web IDL specification for names that are given by the earlier algorithm for [=DOMStringMap/__getter__()|getting the DOMStringMap's name-value pairs=]. [[!WEBIDL]]

If a Web page wanted an element to represent a space ship, e.g., as part of a game, it would have to use the <{global/class}> attribute along with <{global/data-*}> attributes: <div class="spaceship" data-ship-id="92432" data-weapons="laser 2" data-shields="50%" data-x="30" data-y="10" data-z="90"> <button class="fire" onclick="spaceships[this.parentNode.dataset.shipId].fire()"> Fire </button> </div> Notice how the hyphenated attribute name becomes dromedary-cased in the API.
Given the following fragment and elements with similar constructions: <img class="tower" id="tower5" data-x="12" data-y="5" data-ai="robotarget" data-hp="46" data-ability="flames" src="towers/rocket.png" alt="Rocket Tower"> ...one could imagine a function splashDamage() that takes some arguments, the first of which is the element to process:
      function splashDamage(node, x, y, damage) {
        if (node.classList.contains('tower') && // checking the 'class' attribute
            node.dataset.x == x && // reading the 'data-x' attribute
            node.dataset.y == y) { // reading the 'data-y' attribute
          var hp = parseInt(node.dataset.hp); // reading the 'data-hp' attribute
          hp = hp - damage;
          if (hp < 0) {
            hp = 0;
            node.dataset.ai = 'dead'; // setting the 'data-ai' attribute
            delete node.dataset.ability; // removing the 'data-ability' attribute
          }
          node.dataset.hp = hp; // setting the 'data-hp' attribute
        }
      }
    

The {{HTMLElement/innerText}} IDL attribute

: |element| . {{HTMLElement/innerText}} [ = value ] :: Returns the element's text content "as rendered". Can be set, to replace the element's children with the given value, but with line breaks converted to <{br}> elements.
On getting, the innerText attribute must follow these steps: 1. If this element is not [=being rendered=], or if the user agent is a non-CSS user agent, then return the same value as the {{Node/textContent}} IDL attribute on this element. 2. Compute a list of items each of which is a string or a positive integer (a |required line break count|), by applying the following recursive procedure to each child node |node| of this element in [=tree order=], and then concatenating the results to a single list of items.

Intuitively, a |required line break count| item means that a certain number of line breaks appear at that point, but they can be collapsed with the line breaks induced by adjacent |required line break count| items, reminiscent to CSS margin-collapsing.

1. Let |items| be the result of recursively applying this procedure to each child of |node| in [=tree order=], and then concatenating the results to a single list of items. 2. If |node|'s [=computed value=] of 'visibility' is not "visible", then let the result of these substeps be |items| and abort these substeps. 3. If |node| has no associated CSS box, then let the result of these substeps be |items| and abort these substeps. For the purpose of this step, the following elements must act as described if the [=computed value=] of the 'display' property is not "none":

Items can be non-empty due to "display: contents".

4. If |node| is a {{Text}} node, then for each CSS text box produced by |node|, in content order, compute the text of the box after application of the CSS 'white-space' processing rules and 'text-transform' rules, let the result of these substeps be a list of the resulting strings, and abort these substeps. The CSS 'white-space' processing rules are slightly modified: collapsible spaces at the end of lines are always collapsed, but they are only removed if the line is the last line of the block, or it ends with a <{br}> element. Soft hyphens should be preserved. [[CSS-TEXT-3]] 5. If |node| is a <{br}> element, then append a string containing a single U+000A LINE FEED (LF) character to |items|. 6. If |node|'s [=computed value=] of 'display' is ''display/table-cell'', and |node|'s CSS box is not the last ''table-cell'' box of its enclosing ''table-row'' box, then append a string containing a single U+0009 CHARACTER TABULATION (tab) character to |items|. 7. If |node|'s [=computed value=] of 'display' is ''display/table-cell'', and |node|'s CSS box is not the last ''table-cell'' box of the nearest ancestor ''display/table'' box, then append a string containing a single U+000A LINE FEED (LF) character to |items|. 8. If |node| is a <{p}> element, then add 2 (a |required line break count|) at the beginning and end of |items|. 9. If |node|'s [=used value=] of 'display' is block-level or ''display/table-caption'', then add 1 (a |required line break count|) at the beginning and end of |items|. [[CSS-DISPLAY-3]]

Floats and absolutely-positioned elements fall into this category.

10. Let the result of these substeps be |items|. 3. Delete any string items whose strings are empty. 4. Delete any runs of consecutive |required line break count| items at the start or end of the list. 5. Replace each remaining run of consecutive |required line break count| items with a string consisting of as many U+000A LINE FEED (LF) characters as the maximum of the values in the |required line break count| items. 6. Return the concatenation of the string |items|.

Note that descendant nodes of most replaced elements (e.g., <{textarea}>, <{input}>, and <{video}> — but not <{button}>) are not rendered by CSS, strictly speaking, and therefore have no CSS boxes for the purposes of this algorithm.

On setting, the {{HTMLElement/innerText}} attribute must follow these steps: 1. Let |document| be this element's [=node document=]. 2. Let |fragment| be a new {{DocumentFragment}} object whose [=node document=] is |document|. 3. Let |input| be the given value. 4. Let |pointer| be a pointer into |input|, initially pointing at the start of the string. 5. Let |text| be the empty string. 6. While |pointer| is not past the end of |input|: 1. [=Collect a sequence of characters=] that are not U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters. Set |text| to the collected characters. 2. If |text| is not the empty string, then [=append=] a new {{Text}} node whose {{CharacterData/data}} is |text| and [=node document=] is |document| to |fragment|. 3. While |pointer| is not past the end of |input|, and the character at |position| is either a U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) character: 1. If the character at |position| is a U+000D CARRIAGE RETURN (CR) character and the next character is a U+000A LINE FEED (LF) character, then advance |position| to the next character in |input|. 2. Advance |position| to the next character in |input|. 3. [=Append=] the result of [=creating an element=] given |document|, <{br}>, and the [=HTML namespace=] to |fragment|. 7. [=Replace all=] with |fragment| within this element.

Requirements relating to the bidirectional algorithm

Authoring conformance criteria for bidirectional-algorithm formatting characters
[=Text content=] in [=HTML elements=] with {{Text}} nodes in their contents, and text in attributes of [=HTML elements=] that allow free-form text, may contain characters in the ranges U+202A to U+202E and U+2066 to U+2069 (the bidirectional-algorithm formatting characters). [[!BIDI]]

Authors are encouraged to use the <{global/dir}> attribute, the <{bdo}> element, and the <{bdi}> element, rather than maintaining the bidirectional-algorithm formatting characters manually. The bidirectional-algorithm formatting characters interact poorly with CSS.

User agent conformance criteria
User agents must implement the Unicode bidirectional algorithm to determine the proper ordering of characters when rendering documents and parts of documents. [[!BIDI]] The mapping of HTML to the Unicode bidirectional algorithm must be done in one of three ways. Either the user agent must implement CSS, including in particular the CSS 'unicode-bidi', 'direction', and 'content' properties, and must have, in its user agent style sheet, the rules using those properties given in this specification's [[#rendering|rendering]] section, or, alternatively, the user agent must act as if it implemented just the aforementioned properties and had a user agent style sheet that included all the aforementioned rules, but without letting style sheets specified in documents override them, or, alternatively, the user agent must implement another styling language with equivalent semantics. [[CSS-WRITING-MODES-3]] [[CSS3-CONTENT]]

The following elements and attributes have requirements defined by the [[#rendering|rendering]] section that, due to the requirements in this section, are requirements on all user agents (not just those that [=support the suggested default rendering=]):

WAI-ARIA and HTML Accessibility API Mappings

ARIA Authoring Requirements
Authors may use the ARIA <{aria/role}> and <{aria/aria-*}> attributes on [=HTML elements=], in accordance with the requirements described in the ARIA specifications, except where these conflict with the requirements specified in ARIA in HTML [[!html-aria]]. These exceptions are intended to prevent authors from making assistive technology products report nonsensical states that do not represent the actual state of the document. [[!wai-aria-1.1]]

In the majority of cases setting an ARIA <{aria/role}> and/or <{aria/aria-*}> attribute that matches the default implicit ARIA semantics is unnecessary and not recommended as these properties are already set by the browser.

Authors are encouraged to make use of the following documents for guidance on using ARIA in HTML beyond that which is provided in this section: * [=Using ARIA=] - A practical guide for developers on how to add accessibility information to HTML elements using the Accessible Rich Internet Applications specification [[!wai-aria-1.1]]. * [=WAI-ARIA Authoring Practices 1.1=] - An author's guide to understanding and implementing Accessible Rich Internet Applications.
Conformance Checker Implementation Requirements
Conformance checkers are required to implement document conformance requirements for use of the ARIA <{aria/role}> and <{aria/aria-*}> attributes on [=HTML elements=], as defined in ARIA in HTML. [[!html-aria]]
User Agent Implementation Requirements
User agents must implement ARIA semantics on all [=HTML elements=], as defined in the ARIA specifications [[!wai-aria-1.1]] and [[!core-aam-1.1]]. User agents must implement Accessibility API semantics on all [=HTML elements=], as defined in the HTML Accessibility API Mappings specification [[!html-aam-1.0]]. The ARIA attributes defined in the ARIA specifications do not have any effect on CSS [=pseudo-class=] matching, user interface modalities that don't use assistive technologies, or the default actions of user interaction events as described in this specification.
ARIA Role Attribute
Every [=HTML element=] may have an ARIA <{aria/role}> attribute specified. This is an ARIA Role attribute as defined by [[!wai-aria-1.1]]. The attribute, if specified, must have a value that is a [=set of space-separated tokens=]; each token must be a non-abstract role defined in the WAI-ARIA specification [[!wai-aria-1.1]]. The WAI-ARIA role that an [=HTML element=] has assigned to it is the first non-abstract role found in the list of values generated when the <{aria/role}> attribute is split on spaces.
State and Property Attributes
Every [=HTML element=] may have ARIA state and property attributes specified. These attributes are defined by [[!wai-aria-1.1]]. A subset of the ARIA State and Property attributes are defined as "Global States and Properties" in the [[!wai-aria-1.1]] specification. These attributes, if specified, must have a value that is the ARIA value type in the "Value" field of the definition for the state or property, mapped to the appropriate HTML value type according to [[!wai-aria-1.1]]. ARIA State and Property attributes can be used on any element. They are not always meaningful, however, and in such cases user agents might not perform any processing aside from including them in the DOM. State and property attributes are processed according to the requirements of the HTML Accessibility API Mappings specification [[!html-aam-1.0]], as well as [[!wai-aria-1.1]] and, as defined in the ARIA specifications [[!WAI-ARIA]] and [[!core-aam-1.1]].
Allowed ARIA roles, states and properties
This section is non-normative.

The following table provides an informative reference to the ARIA roles, states and properties permitted for use in HTML. Links to ARIA roles, states and properties in the table reference the normative definitions in the [[!wai-aria-1.1]] specification.

ARIA Roles, States and Properties
Role Description Required Properties Supported Properties
any [=global aria-* attributes=] can be used on any HTML element. none
    * <{aria/aria-atomic}> * <{aria/aria-busy}> (state) * <{aria/aria-controls}> * <{aria/aria-current}> (state) * <{aria/aria-describedby}> * <{aria/aria-details}> * <{aria/aria-disabled}> (state) * <{aria/aria-dropeffect}> * <{aria/aria-errormessage}> * <{aria/aria-flowto}> * <{aria/aria-grabbed}> (state) * <{aria/aria-haspopup}> * <{aria/aria-hidden}> (state) * <{aria/aria-invalid}> (state) * <{aria/aria-keyshortcuts}> * <{aria/aria-label}> * <{aria/aria-labelledby}> * <{aria/aria-live}> * <{aria/aria-owns}> * <{aria/aria-relevant}> * <{aria/aria-roledescription}>
alert A message with important, and usually time-sensitive, information. See related alertdialog and status. none
    * <{aria/aria-expanded}> (state)
alertdialog A type of dialog that contains an alert message, where initial focus goes to an element within the dialog. See related alert and dialog. none
    * <{aria/aria-expanded}> (state) * <{aria/aria-modal}>
application A structure containing one or more focusable elements requiring user input, such as keyboard or gesture events, that do not follow a standard interaction pattern supported by a widget role. none
    * <{aria/aria-expanded}> (state)
article A section of a page that consists of a composition that forms an independent part of a document, page, or site. none
    * <{aria/aria-expanded}> (state)
banner A region that contains mostly site-oriented content, rather than page-specific content. none
    * <{aria/aria-expanded}> (state)
button An input that allows for user-triggered actions when clicked or pressed. See related link. none
    * <{aria/aria-expanded}> (state) * <{aria/aria-pressed}> (state)
checkbox A checkable input that has three possible values: true, false, or mixed.
    * <{aria/aria-checked}> (state)
none
cell A cell in a tabular container. none
    * <{aria/aria-colspan}> * <{aria/aria-rowindex}> * <{aria/aria-rowspan}>
columnheader A cell containing header information for a column. none
    * <{aria/aria-sort}> * <{aria/aria-readonly}> * <{aria/aria-required}> * <{aria/aria-selected}> (state) * <{aria/aria-expanded}> (state) * <{aria/aria-colspan}> * <{aria/aria-rowindex}> * <{aria/aria-rowspan}>
combobox A presentation of a select; usually similar to a textbox where users can type ahead to select an option, or type to enter arbitrary text as a new item in the list. See related listbox.
    * <{aria/aria-controls}> * <{aria/aria-expanded}> (state)
    * <{aria/aria-autocomplete}> * <{aria/aria-required}> * <{aria/aria-activedescendant}> * <{aria/aria-orientation}>
complementary A supporting section of the document, designed to be complementary to the main content at a similar level in the DOM hierarchy, but remains meaningful when separated from the main content. none
    * <{aria/aria-expanded}> (state)
contentinfo A large perceivable region that contains information about the parent document. none
    * <{aria/aria-expanded}> (state)
definition A definition of a term or concept. none
    * <{aria/aria-expanded}> (state)
dialog A dialog is an application window that is designed to interrupt the current processing of an application in order to prompt the user to enter information or require a response. See related alertdialog. none
    * <{aria/aria-expanded}> (state) * <{aria/aria-modal}>
directory A list of references to members of a group, such as a static table of contents. none
    * <{aria/aria-expanded}> (state)
document A region containing related information that is declared as document content, as opposed to a web application. none
    * <{aria/aria-expanded}> (state)
feed A scrollable list of articles where scrolling may cause articles to be added to or removed from either end of the list. none
    * <{aria/aria-expanded}> (state)
figure A perceivable section of content that typically contains a graphical document, images, code snippets, or example text. none
    * <{aria/aria-expanded}> (state)
form A landmark region that contains a collection of items and objects that, as a whole, combine to create a form. See related search. none
    * <{aria/aria-expanded}> (state)
grid A grid is an interactive control which contains cells of tabular data arranged in rows and columns, like a table. none
    * <{aria/aria-level}> * <{aria/aria-multiselectable}> * <{aria/aria-readonly}> * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-colcount}> * <{aria/aria-rowcount}>
gridcell A cell in a grid or treegrid. none
    * <{aria/aria-readonly}> * <{aria/aria-required}> * <{aria/aria-selected}> (state) * <{aria/aria-expanded}> (state) * <{aria/aria-colspan}> * <{aria/aria-rowindex}> * <{aria/aria-rowspan}>
group A set of user interface objects which are not intended to be included in a page summary or table of contents by assistive technologies. none
    * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state)
heading A heading for a section of the page. none
    * <{aria/aria-level}> * <{aria/aria-expanded}> (state)
img A container for a collection of elements that form an image. none
    * <{aria/aria-expanded}> (state)
link An interactive reference to an internal or external resource that, when activated, causes the user agent to navigate to that resource. See related button. none
    * <{aria/aria-expanded}> (state)
list A group of non-interactive list items. See related listbox. none
    * <{aria/aria-expanded}> (state)
listbox A widget that allows the user to select one or more items from a list of choices. See related combobox and list. none
    * <{aria/aria-multiselectable}> * <{aria/aria-required}> * <{aria/aria-expanded}> (state) * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
listitem A single item in a list or directory. none
    * <{aria/aria-level}> * <{aria/aria-posinset}> * <{aria/aria-setsize}> * <{aria/aria-expanded}> (state)
log A type of live region where new information is added in meaningful order and old information may disappear. See related marquee. none
    * <{aria/aria-expanded}> (state)
main The main content of a document. none
    * <{aria/aria-expanded}> (state)
marquee A type of live region where non-essential information changes frequently. See related log. none
    * <{aria/aria-expanded}> (state)
MathML math Content that represents a mathematical expression. none
    * <{aria/aria-expanded}> (state)
menu A type of widget that offers a list of choices to the user. none
    * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
menubar A presentation of menu that usually remains visible and is usually presented horizontally. none
    * <{aria/aria-expanded}> (state) * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
menuitem An option in a group of choices contained by a menu or menubar. none
    * <{aria/aria-posinset}> * <{aria/aria-setsize}>
menuitemcheckbox A checkable menuitem that has three possible values: true, false, or mixed.
    * <{aria/aria-checked}> (state)
    * <{aria/aria-posinset}> * <{aria/aria-setsize}>
menuitemradio A checkable menuitem in a group of menuitemradio roles, only one of which can be checked at a time.
    * <{aria/aria-checked}> (state)
    * <{aria/aria-posinset}> * <{aria/aria-selected}> (state) * <{aria/aria-setsize}>
navigation A collection of navigational elements (usually links) for navigating the document or related documents. none
    * <{aria/aria-expanded}> (state)
none An element whose implicit native role semantics will not be mapped to the accessibility API. See synonym presentation. none none
note A section whose content is parenthetic or ancillary to the main content of the resource. none
    * <{aria/aria-expanded}> (state)
option A selectable item in a select list. none
    * <{aria/aria-checked}> (state) * <{aria/aria-posinset}> * <{aria/aria-selected}> (state) * <{aria/aria-setsize}>
presentation An element whose implicit native role semantics will not be mapped to the accessibility API. none none
progressbar An element that displays the progress status for tasks that take a long time. none
    * <{aria/aria-valuemax}> * <{aria/aria-valuemin}> * <{aria/aria-valuenow}> * <{aria/aria-valuetext}>
radio A checkable input in a group of radio roles, only one of which can be checked at a time.
    * <{aria/aria-checked}> (state)
    * <{aria/aria-posinset}> * <{aria/aria-selected}> (state) * <{aria/aria-setsize}>
radiogroup A group of radio buttons. none
    * <{aria/aria-required}> * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
region A large perceivable section of a web page or document, that the author feels is important enough to be included in a page summary or table of contents, for example, an area of the page containing live sporting event statistics. none
    * <{aria/aria-expanded}> (state)
row A row of cells in a grid. none
    * <{aria/aria-level}> * <{aria/aria-selected}> (state) * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-colindex}> * <{aria/aria-rowindex}>
rowgroup A group containing one or more row elements in a grid. none
    * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state)
rowheader A cell containing header information for a row in a grid. none
    * <{aria/aria-sort}> * <{aria/aria-readonly}> * <{aria/aria-required}> * <{aria/aria-selected}> (state) * <{aria/aria-expanded}> (state) * <{aria/aria-colspan}> * <{aria/aria-rowspan}> * <{aria/aria-rowindex}>
scrollbar A graphical object that controls the scrolling of content within a viewing area, regardless of whether the content is fully displayed within the viewing area.
    * <{aria/aria-controls}> * <{aria/aria-orientation}> * <{aria/aria-valuemax}> * <{aria/aria-valuemin}> * <{aria/aria-valuenow}>
    * <{aria/aria-expanded}> (state)
search A landmark region that contains a collection of items and objects that, as a whole, combine to create a search facility. See related form. none
    * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
searchbox A type of textbox intended for specifying search criteria. none
    * <{aria/aria-activedescendant}> * <{aria/aria-autocomplete}> * <{aria/aria-multiline}> * <{aria/aria-placeholder}> * <{aria/aria-readonly}> * <{aria/aria-required}>
separator A divider that separates and distinguishes sections of content.
    * <{aria/aria-valuemax}> (if focusable) * <{aria/aria-valuemin}> (if focusable) * <{aria/aria-valuenow}> (if focusable)
    * <{aria/aria-valuetext}> (if focusable) * <{aria/aria-orientation}>
slider A user input where the user selects a value from within a given range.
    * <{aria/aria-valuemax}> * <{aria/aria-valuemin}> * <{aria/aria-valuenow}>
    * <{aria/aria-orientation}> * <{aria/aria-valuetext}>
spinbutton A form of range that expects the user to select from among discrete choices.
    * <{aria/aria-valuemax}> * <{aria/aria-valuemin}> * <{aria/aria-valuenow}>
    * <{aria/aria-required}> * <{aria/aria-valuetext}>
status A container whose content is advisory information for the user but is not important enough to justify an alert, often but not necessarily presented as a status bar. See related alert. none
    * <{aria/aria-expanded}> (state)
switch A type of checkbox that represents on/off values, as opposed to checked/unchecked values.
    * <{aria/aria-checked}> (state)
none
tab A grouping label providing a mechanism for selecting the tab content that is to be rendered to the user. none
    * <{aria/aria-selected}> (state) * <{aria/aria-expanded}> (state)
table A section containing data arranged in rows and columns. The table role is intended for tabular containers which are not interactive. none
    * <{aria/aria-colcount}> * <{aria/aria-rowcount}>
tablist A list of tab elements, which are references to tabpanel elements. none
    * <{aria/aria-level}> * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
tabpanel A container for the resources associated with a tab, where each tab is contained in a tablist. none
    * <{aria/aria-expanded}> (state)
term A word or phrase with a corresponding definition. See related definition. none none
textbox Input that allows free-form text as its value. none
    * <{aria/aria-activedescendant}> * <{aria/aria-autocomplete}> * <{aria/aria-multiline}> * <{aria/aria-placeholder}> * <{aria/aria-readonly}> * <{aria/aria-required}>
timer A type of live region containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point. none
    * <{aria/aria-expanded}> (state)
toolbar A collection of commonly used function buttons represented in compact visual form. none
    * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
tooltip A contextual popup that displays a description for an element. none
    * <{aria/aria-expanded}> (state)
tree A type of list that may contain sub-level nested groups that can be collapsed and expanded. none
    * <{aria/aria-multiselectable}> * <{aria/aria-required}> * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-orientation}>
treegrid A grid whose rows can be expanded and collapsed in the same manner as for a tree. none
    * <{aria/aria-level}> * <{aria/aria-multiselectable}> * <{aria/aria-readonly}> * <{aria/aria-activedescendant}> * <{aria/aria-expanded}> (state) * <{aria/aria-required}> * <{aria/aria-orientation}> * <{aria/aria-colcount}> * <{aria/aria-rowcount}>
treeitem An option item of a tree. This is an element within a tree that may be expanded or collapsed if it contains a sub-level group of treeitems. none
    * <{aria/aria-level}> * <{aria/aria-posinset}> * <{aria/aria-setsize}> * <{aria/aria-expanded}> (state) * <{aria/aria-checked}> (state) * <{aria/aria-selected}> (state)