1. Introduction
1.1. Background
This section is non-normative.
HTML is the World Wide Web’s core markup language. Originally, HTML was primarily designed as a language for semantically describing scientific documents. Its general design, however, has enabled it to be adapted, over the subsequent years, to describe a number of other types of documents and even applications.
1.2. Audience
This section is non-normative.
This specification is intended for authors of documents and scripts that use the features defined in this specification, implementors of tools that operate on pages that use the features defined in this specification, and individuals wishing to establish the correctness of documents or implementations with respect to the requirements of this specification.
This document is probably not suited to readers who do not already have at least a passing familiarity with Web technologies, as in places it sacrifices clarity for precision, and brevity for completeness. More approachable tutorials and authoring guides can provide a gentler introduction to the topic.
In particular, familiarity with the basics of DOM is necessary for a complete understanding of some of the more technical parts of this specification. An understanding of Web IDL, HTTP, XML, Unicode, character encodings, JavaScript, and CSS will also be helpful in places but is not essential.
1.3. Scope
This section is non-normative.
This specification is limited to providing a semantic-level markup language and associated semantic-level scripting APIs for authoring accessible pages on the Web ranging from static documents to dynamic applications.
The scope of this specification does not include providing mechanisms for media-specific customization of presentation (although default rendering rules for Web browsers are included at the end of this specification, and several mechanisms for hooking into CSS are provided as part of the language).
The scope of this specification is not to describe an entire operating system. In particular, hardware configuration software, image manipulation tools, and applications that users would be expected to use with high-end workstations on a daily basis are out of scope. In terms of applications, this specification is targeted specifically at applications that would be expected to be used by users on an occasional basis, or regularly but from disparate locations, with low CPU requirements. Examples of such applications include online purchasing systems, searching systems, games (especially multiplayer online games), public telephone books or address books, communications software (e-mail clients, instant messaging clients, discussion software), document editing software, etc.
1.4. History
This section is non-normative.
For its first five years (1990-1995), HTML went through a number of revisions and experienced a number of extensions, primarily hosted first at CERN, and then at the IETF.
With the creation of the W3C, HTML’s development changed venue again. A first abortive attempt at extending HTML in 1995 known as HTML 3.0 then made way to a more pragmatic approach known as HTML 3.2, which was completed in 1997. HTML 4.01 quickly followed later that same year.
The following year, the W3C membership decided to stop evolving HTML and instead begin work on an XML-based equivalent, called XHTML. This effort started with a reformulation of HTML 4.01 in XML, known as XHTML 1.0, which added no new features except the new serialization, and which was completed in 2000. After XHTML 1.0, the W3C’s focus turned to making it easier for other working groups to extend XHTML, under the banner of XHTML Modularization. In parallel with this, the W3C also worked on a new language that was not compatible with the earlier HTML and XHTML languages, calling it XHTML 2.0.
Around the time that HTML’s evolution was stopped in 1998, parts of the API for HTML developed by browser vendors were specified and published under the name DOM Level 1 (in 1998) and DOM Level 2 Core and DOM Level 2 HTML (starting in 2000 and culminating in 2003). These efforts then petered out, with some DOM Level 3 specifications published in 2004 but the working group being closed before all the Level 3 drafts were completed.
In 2003, the publication of XForms, a technology which was positioned as the next generation of Web forms, sparked a renewed interest in evolving HTML itself, rather than finding replacements for it. This interest was borne from the realization that XML’s deployment as a Web technology was limited to entirely new technologies (like RSS and later Atom), rather than as a replacement for existing deployed technologies (like HTML).
A proof of concept to show that it was possible to extend HTML 4.01’s forms to provide many of the features that XForms 1.0 introduced, without requiring browsers to implement rendering engines that were incompatible with existing HTML Web pages, was the first result of this renewed interest. At this early stage, while the draft was already publicly available, and input was already being solicited from all sources, the specification was only under Opera Software’s copyright.
The idea that HTML’s evolution should be reopened was tested at a W3C workshop in 2004, where some of the principles that underlie the HTML work (described below), as well as the aforementioned early draft proposal covering just forms-related features, were presented to the W3C jointly by Mozilla and Opera. The proposal was rejected on the grounds that the proposal conflicted with the previously chosen direction for the Web’s evolution; the W3C staff and membership voted to continue developing XML-based replacements instead.
Shortly thereafter, Apple, Mozilla, and Opera jointly announced their intent to continue working on the effort under the umbrella of a new venue called the WHATWG. A public mailing list was created, and the draft was moved to the WHATWG site. The copyright was subsequently amended to be jointly owned by all three vendors, and to allow reuse of the specification.
The WHATWG was based on several core principles, in particular that technologies need to be backwards compatible, that specifications and implementations need to match even if this means changing the specification rather than the implementations, and that specifications need to be detailed enough that implementations can achieve complete interoperability without reverse-engineering each other.
The latter requirement in particular required that the scope of the HTML specification include what had previously been specified in three separate documents: HTML 4.01, XHTML 1.1, and DOM Level 2 HTML. It also meant including significantly more detail than had previously been considered the norm.
In 2006, the W3C indicated an interest to participate in the development of HTML 5.0 after all, and in 2007 formed a working group chartered to work with the WHATWG on the development of the HTML specification. Apple, Mozilla, and Opera allowed the W3C to publish the specification under the W3C copyright, while keeping a version with the less restrictive license on the WHATWG site.
For a number of years, both groups then worked together under the same editor: Ian Hickson. In 2011, the groups came to the conclusion that they had different goals: the W3C wanted to draw a line in the sand for features for a HTML 5.0 Recommendation, while the WHATWG wanted to continue working on a Living Standard for HTML, continuously maintaining the specification and adding new features. In mid 2012, a new editing team was introduced at the W3C to take care of creating a HTML 5.0 Recommendation and prepare a Working Draft for the next HTML version.
Since then, the W3C Web Platform WG has been cherry picking patches from the WHATWG that resolved bugs registered on the W3C HTML specification or more accurately represented implemented reality in user agents. At time of publication of this document, patches from the WHATWG HTML specification have been merged until January 12, 2016. The W3C HTML editors have also added patches that resulted from discussions and decisions made by the W3C Web Platform WG as well a bug fixes from bugs not shared by the WHATWG.
A separate document is published to document the differences between the HTML specified in this document and the language described in the HTML 4.01 specification. [HTML5-DIFF]
1.5. Design notes
This section is non-normative.
It must be admitted that many aspects of HTML appear at first glance to be nonsensical and inconsistent.
HTML, its supporting DOM APIs, as well as many of its supporting technologies, have been developed over a period of several decades by a wide array of people with different priorities who, in many cases, did not know of each other’s existence.
Features have thus arisen from many sources, and have not always been designed in especially consistent ways. Furthermore, because of the unique characteristics of the Web, implementation bugs have often become de-facto, and now de-jure, standards, as content is often unintentionally written in ways that rely on them before they can be fixed.
Despite all this, efforts have been made to adhere to certain design goals. These are described in the next few subsections.
1.5.1. Serializability of script execution
This section is non-normative.
To avoid exposing Web authors to the complexities of multithreading, the HTML and DOM APIs are
designed such that no script can ever detect the simultaneous execution of other scripts. Even
with workers
, the intent is that the behavior of implementations
can be thought of as completely serializing the execution of all scripts in all browsing contexts.
1.5.2. Compliance with other specifications
This section is non-normative.
This specification interacts with and relies on a wide variety of other specifications. In certain circumstances, unfortunately, conflicting needs have led to this specification violating the requirements of these other specifications. Whenever this has occurred, the transgressions have each been noted as a "willful violation", and the reason for the violation has been noted.
1.5.3. Extensibility
This section is non-normative.
HTML has a wide array of extensibility mechanisms that can be used for adding semantics or behaviours in a way that will not conflict with future development of the Web Platform:
-
Authors can create custom elements to provide new behaviours.
-
Authors can use the
class
attribute to annotate elements for processing. This is the primary mechanism used by CSS. -
Authors can annotate elements using the
data-*=""
attributes. These are guaranteed not to be touched by browsers, and allow scripts to include data on HTML elements that scripts can then look for and process. This is the valid and recommended practice for custom elements. -
Authors can use the
meta name="" content=""
mechanism to include page-wide metadata by registering extensions to the predefined set of metadata names. -
Authors can use the
rel=""
mechanism to annotate links with specific meanings by registering extensions to the predefined set of link types. This is used by microformats -
Authors can embed raw data using the
script type=""
mechanism with a custom type, for further handling by inline or server-side scripts. [JSON-LD] does this. -
Authors can extend APIs using the JavaScript prototyping mechanism. This is widely used by script libraries.
-
Authors can use RDFa [html-rdfa] or [microdata] to annotate content.
When extending HTML authors should consider whether the new functionality is accessible to users with disabilities, and whether it risks degrading the privacy and security of users. In addition, considering internationalization is important wherever users provide data. These best-practice design considerations are part of the development of the HTML specification.
1.6. HTML vs XML Syntax
This section is non-normative.
This specification defines an abstract language for describing documents and applications, and some APIs for interacting with in-memory representations of resources that use this language.
The in-memory representation is known as "DOM HTML", or "the DOM" for short.
There are various concrete syntaxes that can be used to transmit resources that use this abstract language, two of which are defined in this specification.
The first such concrete syntax is the HTML syntax. This is the format suggested for most authors.
It is compatible with most legacy Web browsers. If a document is transmitted with the text/html
MIME type, then it will be processed as an
HTML document by Web browsers. This specification defines the latest version of the HTML syntax,
known simply as "HTML".
The second concrete syntax is the XHTML syntax, which is an application of XML. When a document
is transmitted with an XML MIME type, such as application/xhtml+xml
, then it is treated as an
XML document by Web browsers, to be parsed by an XML processor. Authors are reminded that the
processing for XML and HTML differs; in particular, even minor syntax errors will prevent a
document labeled as XML from being rendered fully, whereas they would be ignored in the HTML
syntax. This specification defines the latest version of the XHTML syntax, known simply as
"XHTML".
The DOM, the HTML syntax, and the XHTML syntax cannot all represent the same content. For
example, namespaces cannot be represented using the HTML syntax, but they are supported in the
DOM and in the XHTML syntax. Similarly, documents that use the noscript
feature can
be represented using the HTML syntax, but cannot be represented with the DOM or in the XHTML
syntax. Comments that contain the string "-->
" can only be represented in the
DOM, not in the HTML and XHTML syntaxes.
1.7. Structure of this specification
This section is non-normative.
This specification is divided into the following major sections:
- §1 Introduction
-
Non-normative materials providing a context for the HTML specification.
- §2 Common infrastructure
-
The conformance classes, algorithms, definitions, and the common underpinnings of the rest of the specification.
- §3 Semantics, structure, and APIs of HTML documents
-
Documents are built from elements. These elements form a tree using the DOM. This section defines the features of this DOM, as well as introducing the features common to all elements, and the concepts used in defining elements.
- §4 The elements of HTML
-
Each element has a predefined meaning, which is explained in this section. Rules for authors on how to use the element, along with user agent requirements for how to handle each element, are also given. This includes large signature features of HTML such as video playback and subtitles, form controls and form submission, and a 2D graphics API known as the HTML canvas.
- §5 User interaction
-
HTML documents can provide a number of mechanisms for users to interact with and modify content, which are described in this section, such as how focus works, and drag-and-drop.
- §6 Loading Web pages
-
HTML documents do not exist in a vacuum — this section defines many of the features that affect environments that deal with multiple pages, such as Web browsers and offline caching of Web applications.
- §7 Web application APIs
-
This section introduces basic features for scripting of applications in HTML.
- §8 The HTML syntax
- §9 The XML syntax
-
All of these features would be for naught if they couldn’t be represented in a serialized form and sent to other people, and so these sections define the syntaxes of HTML and XHTML, along with rules for how to parse content using those syntaxes.
- §10 Rendering
-
This section defines the default rendering rules for Web browsers.
There are also some appendices, listing §11 Obsolete features and §12 IANA considerations, and several indices.
1.7.1. How to read this specification
This specification should be read like all other specifications. First, it should be read cover-to-cover, multiple times. Then, it should be read backwards at least once. Then it should be read by picking random sections from the contents list and following all the cross-references.
As described in the conformance requirements section below, this specification describes conformance criteria for a variety of conformance classes. In particular, there are conformance requirements that apply to producers, for example authors and the documents they create, and there are conformance requirements that apply to consumers, for example Web browsers. They can be distinguished by what they are requiring: a requirement on a producer states what is allowed, while a requirement on a consumer states how software is to act.
foo
attribute’s value must be a valid integer" is a
requirement on producers, as it lays out the allowed values; in contrast, the requirement "the foo
attribute’s value must be parsed using the rules for parsing integers"
is a requirement on consumers, as it describes how to process the content. Requirements on producers have no bearing whatsoever on consumers.
1.7.2. Typographic conventions
This is a note.
This is a warning.
interface Example { // this is an IDL definition };
- variable = object .
method
( [ optionalArgument ] ) - This is a note to authors describing the usage of an interface.
/* this is a CSS fragment */
The defining instance of a term is marked up like this. Uses of that term are marked up like this or like this.
The defining instance of an element, attribute, or API is marked up like this
. References to that element, attribute, or API
are marked up like this
.
Other code fragments are marked up like this
.
Byte sequences with bytes in the range 0x00 to 0x7F, inclusive, are marked up like this
.
Variables are marked up like this.
In an algorithm, steps in synchronous sections are marked with ⌛.
In some cases, requirements are given in the form of lists with conditions and corresponding requirements. In such cases, the requirements that apply to a condition are always the first set of requirements that follow the condition, even in the case of there being multiple sets of conditions for those requirements. Such cases are presented as follows:
- This is a condition
- This is another condition
- This is the requirement that applies to the conditions above.
- This is a third condition
- This is the requirement that applies to the third condition.
1.8. Privacy concerns
This section is non-normative.
Some features of HTML trade user convenience for a measure of user privacy.
In general, due to the Internet’s architecture, a user can be distinguished from another by the user’s IP address. IP addresses do not perfectly match to a user; as a user moves from device to device, or from network to network, their IP address will change; similarly, NAT routing, proxy servers, and shared computers enable packets that appear to all come from a single IP address to actually map to multiple users. Technologies such as onion routing can be used to further anonymize requests so that requests from a single user at one node on the Internet appear to come from many disparate parts of the network.
However, the IP address used for a user’s requests is not the only mechanism by which a user’s requests could be related to each other. Cookies, for example, are designed specifically to enable this, and are the basis of most of the Web’s session features that enable you to log into a site with which you have an account.
There are other mechanisms that are more subtle. Certain characteristics of a user’s system can be used to distinguish groups of users from each other; by collecting enough such information, an individual user’s browser’s "digital fingerprint" can be computed, which can be as good, if not better, than an IP address in ascertaining which requests are from the same user.
Grouping requests in this manner, especially across multiple sites, can be used for both benign (and even arguably positive) purposes, as well as for malevolent purposes. An example of a reasonably benign purpose would be determining whether a particular person seems to prefer sites with dog illustrations as opposed to sites with cat illustrations (based on how often they visit the sites in question) and then automatically using the preferred illustrations on subsequent visits to participating sites. Malevolent purposes, however, could include governments combining information such as the person’s home address (determined from the addresses they use when getting driving directions on one site) with their apparent political affiliations (determined by examining the forum sites that they participate in) to determine whether the person should be prevented from voting in an election.
Since the malevolent purposes can be remarkably evil, user agent implementors are encouraged to consider how to provide their users with tools to minimize leaking information that could be used to fingerprint a user.
Unfortunately, as the first paragraph in this section implies, sometimes there is great benefit to be derived from exposing the very information that can also be used for fingerprinting purposes, so it’s not as easy as simply blocking all possible leaks. For instance, the ability to log into a site to post under a specific identity requires that the user’s requests be identifiable as all being from the same user. More subtly, though, information such as how wide text is, which is necessary for many effects that involve drawing text onto a canvas (e.g., any effect that involves drawing a border around the text) also leaks information that can be used to group a user’s requests. (In this case, by potentially exposing, via a brute force search, which fonts a user has installed, information which can vary considerably from user to user.)
Features in this specification which can be used to fingerprint the user are marked as
this paragraph is.
Other features in the platform can be used for the same purpose, though, including, though not limited to:
-
The exact list of which features a user agents supports.
-
The maximum allowed stack depth for recursion in script.
-
Features that describe the user’s environment, like Media Queries and the
Screen
object. [MEDIAQ] [CSSOM-VIEW] -
The user’s time zone.
1.9. A quick introduction to HTML
This section is non-normative.
A basic HTML document looks like this:
<!DOCTYPE html> <html> <head> <title>Document title</title> </head> <body> <h1>Document heading</h1> <p>This is a paragraph of text.</p> <p> <a href="another-html-document.html"> Link text for a link to another-html-document.html </a> </p> <!-- this is a comment --> </body> </html>
HTML documents consist of a tree of elements and text. Each element is denoted in the source by
a start tag, such as "body
", and an end tag, such as "/body
".
(Certain start tags and end tags can in certain cases be omitted and are implied by
other tags.)
Tags have to be nested such that elements are all completely within each other, without overlapping:
<!-- incorrect tag nesting --> <h1> <a href="this-html-document.html">Document heading that is a link to this document </h1> </a> <!-- appropriate tag nesting --> <h1> <a href="this-html-document.html">Document heading that is a link to this document</a> </h1>
This specification defines a set of elements that can be used in HTML, along with rules about the ways in which the elements can be nested.
Elements can have attributes, which control how the elements work. In the example below, there
is a hyperlink, formed using the a
element and its href
attribute:
<a href="demo.html">demo link</a>
Attributes are placed inside the start tag, and consist of a name and a value, separated by an
"=
" character. The attribute value can remain unquoted if it doesn’t contain space characters or any of "
'
`
=
<
or >
. Otherwise, it has to be quoted using either single or
double quotes. The value, along with the "=
" character, can be omitted altogether if
the value is the empty string.
<!-- empty attributes --> <input name=address disabled> <input name="address" disabled=""> <!-- attributes with a value --> <input name=address maxlength=200> <input name='address' maxlength='200'> <input name="address" maxlength="200">
HTML user agents (e.g., Web browsers) then parse this markup, turning it into a DOM (Document Object Model) tree. A DOM tree is an in-memory representation of a document.
DOM trees contain several kinds of nodes, in particular a DocumentType
node, Element
nodes, Text
nodes, Comment
nodes, and in some cases ProcessingInstruction
nodes.
The basic HTML document example, at the top of this section would be turned into the following DOM tree:
The document
element of this tree is the html
element, which is the element always found
in that position in HTML documents. It contains two elements, head
and body
, as well as a Text
node between them.
There are many more Text
nodes in the DOM tree than one would initially expect, because the
source contains a number of spaces (represented here by "␣") and line breaks ("⏎")
that all end up as Text
nodes in the DOM. However, for historical reasons not all of the
spaces and line breaks in the original markup appear in the DOM. In particular, all the white
space before head
start tag ends up being dropped silently, and all the white space after
the body
end tag ends up placed at the end of the body
.
The head
element contains a title
element, which itself contains a Text
node with
the text "Document title". Similarly, the body
element contains an h1
element, a p
element, and a comment.
This DOM tree can be manipulated from scripts in the page. Scripts (typically in JavaScript)
are small programs that can be embedded using the script
element or using event handler content attributes. For example, here is a form with a script that sets the
value of the form’s output
element to say "Hello World".
<form name="main"> Result: <output name="result"></output> <script> document.forms.main.elements.result.value = 'Hello World'; </script> </form>
Each element in the DOM tree is represented by an object, and these objects have APIs so that
they can be manipulated. For instance, a link (e.g., the a
element in the tree above) can
have its "href
" attribute changed in several ways:
var a = document.links[0]; // obtain the first link in the document a.href = 'sample.html'; // change the destination URL of the link a.protocol = 'https'; // change just the scheme part of the URL a.setAttribute('href', 'http://example.com/'); // change the content attribute directly
Since DOM trees are used as the way to represent HTML documents when they are processed and presented by implementations (especially interactive implementations like Web browsers), this specification is mostly phrased in terms of DOM trees, instead of the markup described above.
HTML documents represent a media-independent description of interactive content. HTML documents might be rendered to a screen, or through a speech synthesizer, or on a braille display. To influence exactly how such rendering takes place, authors can use a styling language such as CSS.
In the following example, the page has been made yellow-on-blue using CSS.
<!DOCTYPE html> <html> <head> <title>Document title</title> <style> body { background: blue; color: yellow; } </style> </head> <body> <h1>Styled page</h1> <p>The document has yellow text and a blue background.</p> </body> </html>
For more details on how to use HTML, authors are encouraged to consult tutorials and guides. Some of the examples included in this specification might also be of use, but the novice author is cautioned that this specification, by necessity, defines the language with a level of detail that might be difficult to understand at first.
1.9.1. Writing secure applications with HTML
This section is non-normative.
When HTML is used to create interactive sites, care needs to be taken to avoid introducing vulnerabilities through which attackers can compromise the integrity of the site itself or of the site’s users.
A comprehensive study of this matter is beyond the scope of this document, and authors are strongly encouraged to study the matter in more detail. However, this section attempts to provide a quick introduction to some common pitfalls in HTML application development.
The security model of the Web is based on the concept of "origins", and correspondingly many of the potential attacks on the Web involve cross-origin actions. [ORIGIN]
- Not validating user input
- Cross-site scripting (XSS)
- SQL injection
- Cross-site scripting (XSS)
-
When accepting untrusted input, e.g., user-generated content such as text comments, values in URL parameters, messages from third-party sites, etc, it is imperative that the data be validated before use, and properly escaped when displayed. Failing to do this can allow a hostile user to perform a variety of attacks. These attacks may range from the potentially benign, such as providing bogus user information like a negative age, to the serious, such as running scripts every time a user looks at a page that includes the information, potentially propagating the attack in the process, to the catastrophic, such as deleting all data in the server.
When writing filters to validate user input, it is imperative that filters always be safelist-based, allowing known-safe constructs and disallowing all other input. Blocklist-based filters that disallow known-bad inputs and allow everything else are not secure, as not everything that is bad is yet known (for example, because it might be invented in the future).
For example, suppose a page looked at its URL’s query string to determine what to display, and the site then redirected the user to that page to display a message, such as:<ul> <li><a href="message.cgi?say=Hello">Say Hello</a></li> <li><a href="message.cgi?say=Welcome">Say Welcome</a></li> <li><a href="message.cgi?say=Kittens">Say Kittens</a></li> </ul>
If the message was just displayed to the user without escaping, a hostile attacker could then craft a URL that contained a script element:
http://example.com/message.cgi?say=%3Cscript%3Ealert%28%27Oh%20no%21%27%29%3C/script%3E
If the attacker then convinced a victim user to visit this page, a script of the attacker’s choosing would run on the page. Such a script could do any number of hostile actions, limited only by what the site offers: if the site is an e-commerce shop, for instance, such a script could cause the user to unknowingly make many unwanted purchases.
This is called a cross-site scripting attack.
There are many constructs that can be used to try to trick a site into executing code. Here are some that authors are encouraged to consider when writing safelist filters:
-
When allowing harmless-seeming elements like
img
, it is important to safelist any provided attributes as well. If one allowed all attributes then an attacker could, for instance, use theonload
attribute to run arbitrary script. -
When allowing URLs to be provided (e.g., for links), the scheme of each URL also needs to be explicitly safelisted, as there are many schemes that can be abused. The most prominent example is "
javascript:
", but user agents can implement (and indeed, have historically implemented) others. -
Allowing a
base
element to be inserted means anyscript
elements in the page with relative links can be hijacked, and similarly that any form submissions can get redirected to a hostile site.
-
- Cross-site request forgery (CSRF)
-
If a site allows a user to make form submissions with user-specific side-effects, for example posting messages on a forum under the user’s name, making purchases, or applying for a passport, it is important to verify that the request was made by the user intentionally, rather than by another site tricking the user into making the request unknowingly.
This problem exists because HTML forms can be submitted to other origins.
Sites can prevent such attacks by populating forms with user-specific hidden tokens, or by checking
Origin
headers on all requests. - Clickjacking
-
A page that provides users with an interface to perform actions that the user might not wish to perform needs to be designed so as to avoid the possibility that users can be tricked into activating the interface.
One way that a user could be so tricked is if a hostile site places the victim site in a small
iframe
and then convinces the user to click, for instance by having the user play a reaction game. Once the user is playing the game, the hostile site can quickly position theiframe
under the mouse cursor just as the user is about to click, thus tricking the user into clicking the victim site’s interface.To avoid this, sites that do not expect to be used in frames are encouraged to only enable their interface if they detect that they are not in a frame (e.g., by comparing the
window
object to the value of thetop
attribute).
1.9.2. Common pitfalls to avoid when using the scripting APIs
This section is non-normative.
Scripts in HTML have "run-to-completion" semantics, meaning that the browser will generally run the script uninterrupted before doing anything else, such as firing further events or continuing to parse the document.
On the other hand, parsing of HTML files happens incrementally, meaning that the parser can pause at any point to let scripts run. This is generally a good thing, but it does mean that authors need to be careful to avoid hooking event handlers after the events could have possibly fired.
There are two techniques for doing this reliably: use event handler content attributes, or create the element and add the event handlers in the same script. The latter is safe because, as mentioned earlier, scripts are run to completion before further events can fire.
img
elements and the load
event. The event could fire as soon as the element
has been parsed, especially if the image has already been cached (which is common).
Here, the author uses the onload
handler on an img
element to catch the load
event:
<img src="games.png" alt="Games" onload="gamesLogoHasLoaded(event)">
If the element is being added by script, then so long as the event handlers are added in the same script, the event will still not be missed:
<script> var img = new Image(); img.src = 'games.png'; img.alt = 'Games'; img.onload = gamesLogoHasLoaded; // The following would also work // img.addEventListener('load', gamesLogoHasLoaded, false); </script>
However, if the author first created the img
element and then in a separate script added
the event listeners, there’s a chance that the load
event would be fired in
between, leading it to be missed:
<!-- Do not use this style, it has a race condition! --> <img id="games" src="games.png" alt="Games"> <!-- The 'load' event might fire here while the parser is taking a break, in which case you will not see it! --> <script> var img = document.getElementById('games'); img.onload = gamesLogoHasLoaded; // might never fire! </script>
1.9.3. How to catch mistakes when writing HTML: validators and conformance checkers
This section is non-normative.
Authors are encouraged to make use of conformance checkers (also known as validators) to catch common mistakes. The W3C provides a number of online validation services, including the Nu Markup Validation Service.
1.10. Conformance requirements for authors
This section is non-normative.
Unlike previous versions of the HTML specification, this specification defines in some detail the required processing for invalid documents as well as valid documents.
However, even though the processing of invalid content is in most cases well-defined, conformance requirements for documents are still important: in practice, interoperability (the situation in which all implementations process particular content in a reliable and identical or equivalent way) is not the only goal of document conformance requirements. This section details some of the more common reasons for still distinguishing between a conforming document and one with errors.
1.10.1. Presentational markup
This section is non-normative.
The majority of presentational features from previous versions of HTML are no longer allowed. Presentational markup in general has been found to have a number of problems:
- The use of presentational elements leads to poorer accessibility
-
While it is possible to use presentational markup in a way that provides users of assistive technologies (ATs) with an acceptable experience (e.g., using ARIA), doing so is significantly more difficult than doing so when using semantically-appropriate markup. Furthermore, even using such techniques doesn’t help make pages accessible for non-AT, non-graphical users, such as users of text-mode browsers.
Using media-independent markup, on the other hand, provides an easy way for documents to be authored in such a way that they are "accessible" for more users (e.g., users of text browsers).
- Higher cost of maintenance
-
It is significantly easier to maintain a site written in such a way that the markup is style-independent. For example, changing the color of a site that uses
<font color="">
throughout requires changes across the entire site, whereas a similar change to a site based on CSS can be done by changing a single file. - Larger document sizes
-
Presentational markup tends to be much more redundant, and thus results in larger document sizes.
For those reasons, presentational markup has been removed from HTML in this version. This change should not come as a surprise; HTML 4.0 deprecated presentational markup many years ago and provided a mode (HTML Transitional) to help authors move away from presentational markup; later, XHTML 1.1 went further and obsoleted those features altogether.
The only remaining presentational markup features in HTML are the style
attribute
and the style
element. Use of the style
attribute is somewhat discouraged in
production environments, but it can be useful for rapid prototyping (where its rules can be
directly moved into a separate style sheet later) and for providing specific styles in unusual
cases where a separate style sheet would be inconvenient. Similarly, the style
element can
be useful in syndication or for page-specific styles, but in general an external style sheet
is likely to be more convenient when the styles apply to multiple pages.
It is also worth noting that some elements that were previously presentational have been
redefined in this specification to be media-independent: b
, i
, hr
, s
, small
, and u
.
1.10.2. Syntax errors
This section is non-normative.
The syntax of HTML is constrained to avoid a wide variety of problems.
- Unintuitive error-handling behavior
-
Certain invalid syntax constructs, when parsed, result in DOM trees that are highly unintuitive.
- Errors with optional error recovery
-
To allow user agents to be used in controlled environments without having to implement the more bizarre and convoluted error handling rules, user agents are permitted to fail whenever encountering a parse error.
- Errors where the error-handling behavior is not compatible with streaming user agents
-
Some error-handling behavior, such as the behavior for the
table
hr
... example mentioned above, are incompatible with streaming user agents (user agents that process HTML files in one pass, without storing state). To avoid interoperability problems with such user agents, any syntax resulting in such behavior is considered invalid. - Errors that can result in infoset coercion
-
When a user agent based on XML is connected to an HTML parser, it is possible that certain invariants that XML enforces, such as element or attribute names never contain multiple colons, will be violated by an HTML file. Handling this can require that the parser coerce the HTML DOM into an XML-compatible infoset. Most syntax constructs that require such handling are considered invalid. (Comments containing two consecutive hyphens, or ending with a hyphen, are exceptions that are allowed in the HTML syntax.)
- Errors that result in disproportionately poor performance
-
Certain syntax constructs can result in disproportionately poor performance. To discourage the use of such constructs, they are typically made non-conforming.
For example, the following markup results in poor performance, since all the unclosedi
elements have to be reconstructed in each paragraph, resulting in progressively more elements in each paragraph:<p><i>He dreamt. <p><i>He dreamt that he ate breakfast. <p><i>Then lunch. <p><i>And finally dinner.
The resulting DOM for this fragment would be:
- Errors involving fragile syntax constructs
-
There are syntax constructs that, for historical reasons, are relatively fragile. To help reduce the number of users who accidentally run into such problems, they are made non-conforming.
For example, the parsing of certain named character references in attributes happens even with the closing semicolon being omitted. It is safe to include an ampersand followed by letters that do not form a named character reference, but if the letters are changed to a string that does form a named character reference, they will be interpreted as that character instead.In this fragment, the attribute’s value is "
?bill&ted
":<a href="?bill&ted">Bill and Ted</a>
However, in the following fragment the attribute’s value is actually "
?art©
", not the intended "?art©
". This is because even without the final semicolon, "©
" is handled the same as "©
" and is interpreted as "©
":<a href="?art©">Art and Copy</a>
To avoid this problem, all named character references are required to end with a semicolon. Uses of named character references without a semicolon are flagged as errors.
The correct way to express the above cases are as follows:
<a href="?bill&ted">Bill and Ted</a> <!-- While &ted is not a named character, providing consistency in escaping ampersands will remove ambiguity over best practice, and will ensure that if &ted ever becomes a named character, it will not break such fragments. -->
<a href="?art&copy">Art and Copy</a> <!-- The & has to be escaped, since © is a named character reference -->
- Errors involving known interoperability problems in legacy user agents
-
Certain syntax constructs are known to cause especially subtle or serious problems in legacy user agents, and are therefore marked as non-conforming to help authors avoid them.
For example, this is why the U+0060 GRAVE ACCENT character (`) is not allowed in unquoted attributes. In certain legacy user agents, it is sometimes treated as a quote character.
Another example of this is the DOCTYPE, which is required to trigger no-quirks mode, because the behavior of legacy user agents in quirks mode is often largely undocumented.
- Errors that risk exposing authors to security attacks
-
Certain restrictions exist purely to avoid known security problems.
For example, the restriction on using UTF-7 exists purely to avoid authors falling prey to a known cross-site-scripting attack using UTF-7. [RFC2152]
- Cases where the author’s intent is unclear
-
Markup where the author’s intent is very unclear is often made non-conforming. Correcting these errors early makes later maintenance easier.
- Cases that are likely to be typos
-
When a user makes a simple typo, it is helpful if the error can be caught early, as this can save the author a lot of debugging time. This specification therefore usually considers it an error to use element names, attribute names, and so forth, that do not match the names defined in this specification.
For example, if the author typed
<capton>
instead ofcaption
, this would be flagged as an error and the author could correct the typo immediately. - Errors that could interfere with new syntax in the future
-
In order to allow the language syntax to be extended in the future, certain otherwise harmless features are disallowed.
For example, attributes in end tags are ignored currently, but they are invalid, in case a future change to the language makes use of that syntax feature without conflicting with already-deployed (and valid!) content.
Some authors find it helpful to be in the practice of always quoting all attributes and always including all optional tags, preferring the consistency derived from such custom over the minor benefits of terseness afforded by making use of the flexibility of the HTML syntax. To aid such authors, conformance checkers can provide modes of operation wherein such conventions are enforced.
1.10.3. Restrictions on content models and on attribute values
This section is non-normative.
Beyond the syntax of the language, this specification also places restrictions on how elements and attributes can be specified. These restrictions are present for similar reasons:
- Errors involving content with dubious semantics
-
To avoid misuse of elements with defined meanings, content models are defined that restrict how elements can be nested when such nestings would be of dubious value.
For example, this specification disallows nesting a
section
element inside akbd
element, since it is highly unlikely for an author to indicate that an entire section should be keyed in. - Errors that involve a conflict in expressed semantics
-
Similarly, to draw the author’s attention to mistakes in the use of elements, clear contradictions in the semantics expressed are also considered conformance errors.
In the fragments below, for example, the semantics are nonsensical: a separator cannot simultaneously be a cell, nor can a radio button be a progress bar.<hr role="cell">
<input type="radio" role="progressbar">
Another example is the restrictions on the content models of the
ul
element, which only allowsli
element children. Lists, by definition, consist of zero or more list items, so if aul
element contains something other than anli
element, it’s not clear what was meant. - Cases where the default styles are likely to lead to confusion
-
Certain elements have default styles or behaviors that make certain combinations likely to lead to confusion. Where these have equivalent alternatives without this problem, the confusing combinations are disallowed.
For example,div
elements are rendered as block boxes, andspan
elements as inline boxes. Putting a block box in an inline box is unnecessarily confusing; since either nesting justdiv
elements, or nesting justspan
elements, or nestingspan
elements insidediv
elements all serve the same purpose as nesting adiv
element in aspan
element, but only the latter involves a block box in an inline box, the latter combination is disallowed.Some transparent elements, such as
a
,del
, andins
, are inline box elements, but allow for nesting of block box elements.<a href="https://example.com"> <h2>An interesting news story</h2> <p>You’re going to want to read this...</p> </a> <ins> <p>My new paragraph.</p> </ins> <del> <ul> <li>My old list.</li> </ul> </del>
The above shows how
a
,ins
, anddel
elements may contain block box elements. For additional examples and information, review these elements and other transparent elements.Another example would be the way interactive content cannot be nested. For example, abutton
element cannot contain a descendanttextarea
element. This is because the default behavior of nesting interactive elements would be highly confusing to users. Rather than nesting these elements, they could instead be styled with CSS to be visually placed side by side.<!-- Invalid --> <button type="submit"> <textarea>Confused?</textarea> </button> <!-- Valid --> <textarea>Type Here</textarea> <button type="submit"> Submit Here </button>
- Errors that indicate a likely misunderstanding of the specification
-
Sometimes, something is disallowed because allowing it would likely cause author confusion.
For example, setting the
disabled
attribute to the value "false
" is disallowed, because despite the appearance of meaning that the element is enabled, it in fact means that the element is disabled (what matters for implementations is the presence of the attribute, not its value). - Errors involving limits that have been imposed merely to simplify the language
-
Some conformance errors simplify the language that authors need to learn.
For example, the
area
element’sshape
attribute, despite accepting both "circ
" and "circle
" values in practice as synonyms, disallows the use of the "circ
" value, so as to simplify tutorials and other learning aids. There would be no benefit to allowing both, and it would cause extra confusion when teaching the language. - Errors that involve peculiarities of the parser
-
Certain elements are parsed in somewhat eccentric ways (typically for historical reasons), and their content model restrictions are intended to avoid exposing the author to these issues.
For example, aform
element isn’t allowed inside phrasing content, because when parsed as HTML, aform
element’s start tag will imply ap
element’s end tag. Thus, the following markup results in two paragraphs, not one:<p>Welcome. <form><label>Name:</label> <input></form>
It is parsed exactly like the following:
<p>Welcome. </p> <form><label>Name:</label> <input></form>
- Errors that would likely result in scripts failing in hard-to-debug ways
-
Some errors are intended to help prevent script problems that would be hard to debug.
This is why, for instance, it is non-conforming to have two
id
attributes with the same value. Duplicate IDs lead to the wrong element being selected, with sometimes disastrous effects whose cause is hard to determine. - Errors that waste authoring time
-
Some constructs are disallowed because historically they have been the cause of a lot of wasted authoring time, and by encouraging authors to avoid making them, authors can save time in future efforts.
For example, a
script
element’ssrc
attribute causes the element’s contents to be ignored. However, this isn’t obvious, especially if the element’s contents appear to be executable script — which can lead to authors spending a lot of time trying to debug the inline script without realizing that it is not executing. To reduce this problem, this specification makes it non-conforming to have executable script in ascript
element when thesrc
attribute is present. This means that authors who are validating their documents are less likely to waste time with this kind of mistake. - Errors that involve areas that affect authors migrating to and from XHTML
-
Some authors like to write files that can be interpreted as both XML and HTML with similar results. Though this practice is discouraged in general due to the myriad of subtle complications involved (especially when involving scripting, styling, or any kind of automated serialization), this specification has a few restrictions intended to at least somewhat mitigate the difficulties. This makes it easier for authors to use this as a transitionary step when migrating between HTML and XHTML.
For example, there are somewhat complicated rules surrounding the
lang
andxml:lang
attributes intended to keep the two synchronized.Another example would be the restrictions on the values of
xmlns
attributes in the HTML serialization, which are intended to ensure that elements in conforming documents end up in the same namespaces whether processed as HTML or XML. - Errors that involve areas reserved for future expansion
-
As with the restrictions on the syntax intended to allow for new syntax in future revisions of the language, some restrictions on the content models of elements and values of attributes are intended to allow for future expansion of the HTML vocabulary.
For example, limiting the values of the
target
attribute that start with an U+005F LOW LINE character (_) to only specific predefined values allows new predefined values to be introduced at a future time without conflicting with author-defined values. - Errors that indicate a mis-use of other specifications
-
Certain restrictions are intended to support the restrictions made by other specifications.
For example, requiring that attributes that take media query lists use only valid media query lists reinforces the importance of following the conformance rules of that specification.
1.11. Suggested reading
This section is non-normative.
The following documents might be of interest to readers of this specification.
- Character Model for the World Wide Web 1.0: Fundamentals [CHARMOD]
-
This Architectural Specification provides authors of specifications, software developers, and content developers with a common reference for interoperable text manipulation on the World Wide Web, building on the Universal Character Set, defined jointly by the Unicode specification and ISO/IEC 10646. Topics addressed include use of the terms "character", "encoding" and "string", a reference processing model, choice and identification of character encodings, character escaping, and string indexing.
- Unicode Security Considerations [UNICODE-SECURITY]
-
Because Unicode contains such a large number of characters and incorporates the varied writing systems of the world, incorrect usage can expose programs or systems to possible security attacks. This is especially important as more and more products are internationalized. This document describes some of the security considerations that programmers, system analysts, standards developers, and users should take into account, and provides specific recommendations to reduce the risk of problems.
- Web Content Accessibility Guidelines (WCAG) 2.1 [WCAG21]
-
Web Content Accessibility Guidelines (WCAG) 2.1 covers a wide range of recommendations for making Web content more accessible. Following these guidelines will make content more accessible to a wider range of people with disabilities, including blindness and low vision, deafness and hearing loss, limited movement, speech disabilities, photosensitivity, and combinations of these, and some accommodation for learning disabilities and cognitive limitations; but will not address every user need for people with these disabilities. These guidelines address accessibility of web content on desktops, laptops, tablets, and mobile devices. Following these guidelines will also often make Web content more usable to users in general.
WCAG 2.1 extends Web Content Accessibility Guidelines 2.0 [WCAG20], which was published as a W3C Recommendation December 2008. Content that conforms to WCAG 2.1 also conforms to WCAG 2.0, and therefore to policies that reference WCAG 2.0.
- Authoring Tool Accessibility Guidelines (ATAG) 2.0 [ATAG20]
-
This specification provides guidelines for designing Web content authoring tools that are more accessible for people with disabilities. An authoring tool that conforms to these guidelines will promote accessibility by providing an accessible user interface to authors with disabilities as well as by enabling, supporting, and promoting the production of accessible Web content by all authors.
- User Agent Accessibility Guidelines (UAAG) 2.0 [UAAG20]
-
This document provides guidelines for designing user agents that lower barriers to Web accessibility for people with disabilities. User agents include browsers and other types of software that retrieve and render Web content. A user agent that conforms to these guidelines will promote accessibility through its own user interface and through other internal facilities, including its ability to communicate with other technologies (especially assistive technologies). Furthermore, all users, not just users with disabilities, should find conforming user agents to be more usable.
- HTML Accessibility APIs Mappings 1.0 [html-aam-1.0]
-
Defines how user agents map HTML 5.1 elements and attributes to platform accessibility APIs. Documenting these mappings promotes interoperable exposure of roles, states, properties, and events implemented by accessibility APIs and helps to ensure that this information appears in a manner consistent with author intent.
2. Common infrastructure
2.1. Terminology
This specification refers to both HTML and XML attributes and IDL attributes, often in the same context. When it is not clear which is being referred to, they are referred to as content attributes for HTML and XML attributes, and IDL attributes for those defined on IDL interfaces. Similarly, the term "properties" is used for both JavaScript object properties and CSS properties. When these are ambiguous they are qualified as object properties and CSS properties respectively.
Generally, when the specification states that a feature applies to the HTML syntax or the XHTML syntax, it also includes the other. When a feature specifically only applies to one of the two languages, it is called out by explicitly stating that it does not apply to the other format, as in "for HTML, ... (this does not apply to XHTML)".
This specification uses the term document to refer to any use
of HTML, ranging from short static documents to long essays or reports with rich multimedia, as
well as to fully-fledged interactive applications. The term is used to refer both to Document
objects and their descendant DOM trees, and to serialized byte streams using the HTML syntax or XHTML syntax, depending on context.
In the context of the DOM structures, the terms HTML document and XML document are used as defined in the DOM specification, and refer specifically to
two different modes that Document
objects can find themselves in. [DOM] (Such uses are
always hyperlinked to their definition.)
In the context of byte streams, the term HTML document refers to resources labeled as text/html
, and the term XML document refers to
resources labeled with an XML MIME type.
The term XHTML document is used to refer to both Documents in the XML document mode that contains element nodes in the HTML namespace, and byte streams labeled with an XML MIME type that contain elements from the HTML namespace, depending on context.
For simplicity, terms such as shown, displayed, and visible might sometimes be used when referring to the way a document is rendered to the user. These terms are not meant to imply a visual medium; they must be considered to apply to other media in equivalent ways.
When an algorithm B says to return to another algorithm A, it implies that A called B. Upon returning to A, the implementation must continue from where it left off in calling B. Some algorithms run in parallel; this means that the algorithm’s subsequent steps are to be run, one after another, at the same time as other logic in the specification (e.g., at the same time as the event loop). This specification does not define the precise mechanism by which this is achieved, be it time-sharing cooperative multitasking, fibers, threads, processes, using different hyperthreads, cores, CPUs, machines, etc. By contrast, an operation that is to run immediately must interrupt the currently running task, run itself, and then resume the previously running task.
The term "transparent black" refers to the color with red, green, blue, and alpha channels all set to zero.
2.1.1. Resources
The specification uses the term supported when referring to whether a user agent has an implementation capable of decoding the semantics of an external resource. A format or type is said to be supported if the implementation can process an external resource of that format or type without critical aspects of the resource being ignored. Whether a specific resource is supported can depend on what features of the resource’s format are in use.
For example, a PNG image would be considered to be in a supported format if its pixel data could be decoded and rendered, even if, unbeknownst to the implementation, the image also contained animation data.
An MPEG-4 video file would not be considered to be in a supported format if the compression format used was not supported, even if the implementation could determine the dimensions of the movie from the file’s metadata.
What some specifications, in particular the HTTP specification, refer to as a representation is referred to in this specification as a resource. [HTTP]
The term MIME type is used to refer to what is sometimes called an Internet media type in protocol literature. The term media type in this specification is used to refer to the type of media intended for presentation, as used by the CSS specifications. [RFC2046] [MEDIAQ]
A string is a valid MIME type if it matches the media-type
rule. In particular, a valid MIME type may include MIME type parameters. [HTTP]
A string is a valid MIME type with no parameters if it matches the media-type
rule, but does not contain any U+003B SEMICOLON
characters (;). In other words, if it consists only of a type and subtype, with no MIME Type
parameters. [HTTP]
The term HTML MIME type is used to refer to the MIME type text/html
.
A resource’s critical subresources are those that the resource needs to have available to be correctly processed. Which resources are considered critical or not is defined by the specification that defines the resource’s format.
2.1.2. XML compatibility
To ease migration from HTML to XHTML, user agents conforming to this specification will place
elements in HTML in the http://www.w3.org/1999/xhtml
namespace, at least for the
purposes of the DOM and CSS. The term "HTML elements",
when used in this specification, refers to any element in that namespace, and thus refers to both
HTML and XHTML elements.
Except where otherwise stated, all elements defined or mentioned in this specification are in the HTML namespace ("http://www.w3.org/1999/xhtml
"), and all attributes defined or
mentioned in this specification have no namespace.
The term element type is used to refer to the set of elements that have
a given local name and namespace. For example, button
elements are elements with the element
type button
, meaning they have the local name "button
" and (implicitly as
defined above) the HTML namespace.
Attribute names are said to be XML-compatible if they match the Name
production defined in XML and they contain no U+003A COLON
characters (:). [XML]
The term XML MIME type is used to refer to the MIME types text/xml
, application/xml
, and any MIME type whose subtype ends
with the four characters "+xml
". [RFC7303]
2.1.3. DOM trees
When it is stated that some element or attribute is ignored, or treated as some other value, or handled as if it was something else, this refers only to the processing of the node after it is in the DOM. A user agent must not mutate the DOM in such situations.
A content attribute is said to change value only if its new value is different than its previous value; setting an attribute to a value it already has does not change it.
The term empty, when used for an attribute value, Text
node, or
string means that the length of the text is zero (i.e., not even containing spaces or control
characters).
An element’s child text content is the concatenation of the data of all the Text
nodes that are children of the element (ignoring any other nodes such as
comments or elements), in tree order.
A node A is inserted into a node B when the insertion steps are invoked with A as the argument and A’s new parent is B. Similarly, a node A is removed from a node B when the removing steps are invoked with A as the removedNode argument and B as the oldParent argument.
A node is inserted into a document when the insertion steps are invoked with it as the argument and it is now in a document tree. Analogously, a node is removed from a document when the removing steps are invoked with it as the argument and it is now no longer in a document tree.
2.1.4. Scripting
The construction "a Foo
object", where Foo
is actually an interface,
is sometimes used instead of the more accurate "an object implementing the interface Foo
".
An IDL attribute is said to be getting when its value is being retrieved (e.g., by author script), and is said to be setting when a new value is assigned to it.
If a DOM object is said to be live, then the attributes and methods on that object must operate on the actual underlying data, not a snapshot of the data.
In the contexts of events, the terms fire and dispatch are used as defined in the
DOM specification: firing an event means to create and dispatch it, and dispatching an event means to follow the steps that propagate the event through the
tree. The term trusted event is used to refer to events whose isTrusted
attribute is initialized to true. [DOM]
2.1.5. Plugins
The term plugin refers to a user-agent defined set of content
handlers that can be used by the user agent. The content handlers can take part in the user
agent’s rendering of a Document
object, but that neither act as child browsing contexts of the Document
nor introduce any Node
objects to the Document
's DOM.
Typically such content handlers are provided by third parties, though a user agent can also designate built-in content handlers as plugins.
A user agent must not consider the types text/plain
and application/octet-stream
as having a registered plugin.
One example of a plugin would be a PDF viewer that is instantiated in a browsing context when the user navigates to a PDF file. This would count as a plugin regardless of whether the party that implemented the PDF viewer component was the same as that which implemented the user agent itself. However, a PDF viewer application that launches separate from the user agent (as opposed to using the same interface) is not a plugin by this definition.
This specification does not define a mechanism for interacting with plugins, as it is expected to be user-agent- and platform-specific. Some user agents might opt to support a plugin mechanism such as the Netscape Plugin API; others might use remote content converters or have built-in support for certain types. Indeed, this specification doesn’t require user agents to support plugins at all. [NPAPI]
A plugin can be secured if it honors the semantics of the sandbox
attribute.
For example, a secured plugin would prevent its contents from creating pop-up windows when the
plugin is instantiated inside a sandboxed iframe
.
Browsers should take extreme care when interacting with external content intended for plugins. When third-party software is run with the same privileges as the user agent itself, vulnerabilities in the third-party software become as dangerous as if they were vulnerabilities of the user agent itself.
Since different users having different sets of plugins provides a fingerprinting vector
that increases the chances of users being uniquely identified, user agents are encouraged to
support the exact same set of plugins for each user.
2.1.6. Character encodings
A character encoding, or just encoding where that is not ambiguous, is a defined way to convert between byte streams and Unicode strings, as defined in the WHATWG Encoding specification. An encoding has an encoding name and one or more encoding labels, referred to as the encoding’s name and labels in the Encoding specification. [ENCODING]
A UTF-16 encoding is UTF-16BE or UTF-16LE. [ENCODING]
An ASCII-compatible encoding is any encoding that is not a UTF-16 encoding. [ENCODING]
Since support for encodings that are not defined in the WHATWG Encoding specification is prohibited, UTF-16 encodings are the only encodings that this specification needs to treat as not being ASCII-compatible encodings.
The term code unit is used as defined in the Web IDL specification: a 16
bit unsigned integer, the smallest atomic component of a DOMString
. (This is a
narrower definition than the one used in Unicode, and is not the same as a code point.) [WEBIDL]
The term Unicode code point means a Unicode scalar value where possible, and an isolated surrogate code point when not. When a conformance requirement is defined in terms of characters or Unicode code points, a pair of code units consisting of a high surrogate followed by a low surrogate must be treated as the single code point represented by the surrogate pair, but isolated surrogates must each be treated as the single code point with the value of the surrogate. [UNICODE]
In this specification, the term character, when not qualified as Unicode character, is synonymous with the term Unicode code point.
The term Unicode character is used to mean a Unicode scalar value (i.e. any Unicode code point that is not a surrogate code point). [UNICODE]
The code-unit length of a string is the number of code units in that string.
This complexity results from the historical decision to define the DOM API in terms of 16 bit (UTF-16) code units, rather than in terms of Unicode characters.
2.2. Conformance requirements
All diagrams, examples, and notes in this specification are non-normative, as are all sections explicitly marked non-normative. Everything else in this specification is normative.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this document are to be interpreted as described in RFC2119. The key word "OPTIONALLY" in the normative parts of this document is to be interpreted with the same normative meaning as "MAY" and "OPTIONAL". For readability, these words do not appear in all uppercase letters in this specification. [RFC2119]
Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.
To eat an orange, the user must: 1. Peel the orange. 2. Separate each slice of the orange. 3. Eat the orange slices.
...it would be equivalent to the following:
To eat an orange: 1. The user must peel the orange. 2. The user must separate each slice of the orange. 3. The user must eat the orange slices.
Here the key word is "must".
The former (imperative) style is generally preferred in this specification for stylistic reasons.
Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in this specification are intended to be easy to follow, and not intended to be performant.)
2.2.1. Conformance classes
This specification describes the conformance criteria for user agents (relevant to implementors) and documents (relevant to authors and authoring tool implementors).
Conforming documents are those that comply with all the conformance criteria for documents. For readability, some of these conformance requirements are phrased as conformance requirements on authors; such requirements are implicitly requirements on documents: by definition, all documents are assumed to have had an author. (In some cases, that author may itself be a user agent — such user agents are subject to additional rules, as explained below.)
For example, if a requirement states that "authors must not use the foobar
element", it would imply that documents are not allowed to contain elements named foobar
.
There is no implied relationship between document conformance requirements and implementation conformance requirements. User agents are not free to handle non-conformant documents as they please; the processing model described in this specification applies to implementations regardless of the conformity of the input documents.
User agents fall into several (overlapping) categories with different conformance requirements.
- Web browsers and other interactive user agents
-
Web browsers that support the XHTML syntax must process elements and attributes from the HTML namespace found in XML documents as described in this specification, so that users can interact with them, unless the semantics of those elements have been overridden by other specifications.
A conforming XHTML processor would, upon finding an XHTML
script
element in an XML document, execute the script contained in that element. However, if the element is found within a transformation expressed in XSLT (assuming the user agent also supports XSLT), then the processor would instead treat thescript
element as an opaque element that forms part of the transform.Web browsers that support the HTML syntax must process documents labeled with an HTML MIME type as described in this specification, so that users can interact with them.
User agents that support scripting must also be conforming implementations of the IDL fragments in this specification, as described in the Web IDL specification. [WEBIDL]
Unless explicitly stated, specifications that override the semantics of HTML elements do not override the requirements on DOM objects representing those elements. For example, the
script
element in the example above would still implement theHTMLScriptElement
interface. - Non-interactive presentation user agents
-
User agents that process HTML and XHTML documents purely to render non-interactive versions of them must comply to the same conformance criteria as Web browsers, except that they are exempt from requirements regarding user interaction.
Typical examples of non-interactive presentation user agents are printers (static user agents) and overhead displays (dynamic user agents). It is expected that most static non-interactive presentation user agents will also opt to lack scripting support.
A non-interactive but dynamic presentation user agent would still execute scripts, allowing forms to be dynamically submitted, and so forth. However, since the concept of "focus" is irrelevant when the user cannot interact with the document, the user agent would not need to support any of the focus-related DOM APIs.
- Visual user agents that support the suggested default rendering
-
User agents, whether interactive or not, may be designated (possibly as a user option) as supporting the suggested default rendering defined by this specification.
This is not required. In particular, even user agents that do implement the suggested default rendering are encouraged to offer settings that override this default to improve the experience for the user, e.g., changing the color contrast, using different focus styles, or otherwise making the experience more accessible and usable to the user.
User agents that are designated as supporting the suggested default rendering must, while so designated, implement the rules in §10 Rendering. That section defines the behavior that user agents are expected to implement.
- User agents with no scripting support
-
Implementations that do not support scripting (or which have their scripting features disabled entirely) are exempt from supporting the events and DOM interfaces mentioned in this specification. For the parts of this specification that are defined in terms of an events model or in terms of the DOM, such user agents must still act as if events and the DOM were supported.
Scripting can form an integral part of an application. Web browsers that do not support scripting, or that have scripting disabled, might be unable to fully convey the author’s intent.
- Conformance checkers
-
Conformance checkers must verify that a document conforms to the applicable conformance criteria described in this specification. Automated conformance checkers are exempt from detecting errors that require interpretation of the author’s intent (for example, while a document is non-conforming if the content of a
blockquote
element is not a quote, conformance checkers running without the input of human judgement do not have to check thatblockquote
elements only contain quoted material).Conformance checkers must check that the input document conforms when parsed without a browsing context (meaning that no scripts are run, and that the parser’s scripting flag is disabled), and should also check that the input document conforms when parsed with a browsing context in which scripts execute, and that the scripts never cause non-conforming states to occur other than transiently during script execution itself. (This is only a "SHOULD" and not a "MUST" requirement because it has been proven to be impossible. [COMPUTABLE])
The term "HTML validator" can be used to refer to a conformance checker that itself conforms to the applicable requirements of this specification.
XML DTDs cannot express all the conformance requirements of this specification. Therefore, a validating XML processor and a DTD cannot constitute a conformance checker. Also, since neither of the two authoring formats defined in this specification are applications of SGML, a validating SGML system cannot constitute a conformance checker either.To put it another way, there are three types of conformance criteria:
-
Criteria that can be expressed in a DTD.
-
Criteria that cannot be expressed by a DTD, but can still be checked by a machine.
-
Criteria that can only be checked by a human.
A conformance checker must check for the first two. A simple DTD-based validator only checks for the first class of errors and is therefore not a conforming conformance checker according to this specification.
-
- Data mining tools
-
Applications and tools that process HTML and XHTML documents for reasons other than to either render the documents or check them for conformance should act in accordance with the semantics of the documents that they process.
A tool that generates document outlines but increases the nesting level for each paragraph and does not increase the nesting level for each section would not be conforming.
- Authoring tools and markup generators
-
Authoring tools and markup generators must generate conforming documents. Conformance criteria that apply to authors also apply to authoring tools, where appropriate.
Authoring tools are exempt from the strict requirements of using elements only for their specified purpose, but only to the extent that authoring tools are not yet able to determine author intent. However, authoring tools must not automatically misuse elements or encourage their users to do so.
For example, it is not conforming to use an
address
element for arbitrary contact information; that element can only be used for marking up contact information for the author of the document or section. However, since an authoring tool is likely unable to determine the difference, an authoring tool is exempt from that requirement. This does not mean, though, that authoring tools can useaddress
elements for any block of italics text (for instance); it just means that the authoring tool doesn’t have to verify, if a user inserts contact information for a section or something else.In terms of conformance checking, an editor has to output documents that conform to the same extent that a conformance checker will verify.
When an authoring tool is used to edit a non-conforming document, it may preserve the conformance errors in sections of the document that were not edited during the editing session (i.e., an editing tool is allowed to round-trip erroneous content). However, an authoring tool must not claim that the output is conformant if errors have been so preserved.
Authoring tools are expected to come in two broad varieties: tools that work from structure or semantic data, and tools that work on a What-You-See-Is-What-You-Get media-specific editing basis (WYSIWYG).
The former is the preferred mechanism for tools that author HTML, since the structure in the source information can be used to make informed choices regarding which HTML elements and attributes are most appropriate.
However, WYSIWYG tools are legitimate. WYSIWYG tools should use elements they know are appropriate, and should not use elements that they do not know to be appropriate. This might in certain extreme cases mean limiting the use of flow elements to just a few elements, like
div
,b
,i
, andspan
and making liberal use of thestyle
attribute.All authoring tools, whether WYSIWYG or not, should make a best effort attempt at enabling users to create well-structured, semantically rich, media-independent content.
User agents may impose implementation-specific limits on otherwise unconstrained inputs, e.g., to
prevent denial of service attacks, to guard against running out of memory, or to work around
platform-specific limitations.
For compatibility with existing content and prior specifications, this specification describes two authoring formats: one based on XML (referred to as the XHTML syntax), and one using a custom format inspired by SGML (referred to as the HTML syntax). Implementations must support at least one of these two formats, although supporting both is encouraged.
Some conformance requirements are phrased as requirements on elements, attributes, methods or objects. Such requirements fall into two categories: those describing content model restrictions, and those describing implementation behavior. Those in the former category are requirements on documents and authoring tools. Those in the second category are requirements on user agents. Similarly, some conformance requirements are phrased as requirements on authors; such requirements are to be interpreted as conformance requirements on the documents that authors produce. (In other words, this specification does not distinguish between conformance criteria on authors and conformance criteria on documents.)
2.2.2. Dependencies
This specification relies on several other underlying specifications.
- Unicode and Encoding
-
The Unicode character set is used to represent textual data, and the Encoding specification defines requirements around character encodings. [UNICODE]
This specification introduces terminology based on the terms defined in those specifications, as described earlier.
The following terms are used as defined in the Encoding specification: [ENCODING]
-
Getting an encoding
-
Get an output encoding
-
The generic decode algorithm which takes a byte stream and an encoding and returns a character stream
-
The UTF-8 decode algorithm which takes a byte stream and returns a character stream, additionally stripping one leading UTF-8 Byte Order Mark (BOM), if any
-
The UTF-8 decode without BOM algorithm which is identical to UTF-8 decode except that it does not strip one leading UTF-8 Byte Order Mark (BOM)
-
The UTF-8 decode without BOM or fail algorithm which is identical to UTF-8 decode without BOM except that it returns failure upon encountering an error
-
The encode algorithm which takes a character stream and an encoding and returns a byte stream
-
The UTF-8 encode algorithm which takes a character stream and returns a byte stream.
-
- XML and related specifications
-
Implementations that support the XHTML syntax must support some version of XML, as well as its corresponding namespaces specification, because that syntax uses an XML serialization with namespaces. [XML] [XML-NAMES]
The attribute with the tag name
xml:space
in the XML namespace is defined by the XML specification. [XML]This specification also references the
<?xml-stylesheet?>
processing instruction, defined in the Associating Style Sheets with XML documents specification. [XML-STYLESHEET]This specification also non-normatively mentions the
XSLTProcessor
interface and itstransformToFragment()
andtransformToDocument()
methods. [XSLTP] - URLs
-
The following terms are defined in the WHATWG URL specification: [URL]
-
Origin of URLs
-
The URL parser and basic URL parser as well as these parser states:
-
URL record, as well as its individual components:
-
The URL serializer
-
The host parser
-
The host serializer
-
The domain to Unicode algorithm
-
Parse errors from the URL parser
A number of schemes and protocols are referenced by this specification also:
-
The
data:
scheme [RFC2397] -
The
http:
scheme [HTTP] -
The
https:
scheme [HTTP] -
The
mailto:
scheme [RFC6068] -
The
sms:
scheme [RFC5724] -
The
urn:
scheme [RFC8141]
Media fragment syntax is defined in the Media Fragments URI specification. [MEDIA-FRAGS]
- HTTP and related specifications
-
The following terms are defined in the HTTP specifications: [HTTP]
-
Accept
header -
Accept-Language
header -
Cache-Control
header -
Content-Disposition
header -
Content-Language
header -
Content-Length
header -
Last-Modified
header
The following terms are defined in the Cookie specification: [COOKIES]
-
cookie-string
The following term is defined in the Web Linking specification: [RFC8288]
-
- Fetch
-
The following terms are defined in the WHATWG Fetch specification: [FETCH]
-
the
RequestCredentials
enumeration -
response and its associated:
-
request and its associated:
The following terms are defined in Referrer Policy [REFERRERPOLICY]
- Web IDL
-
The IDL fragments in this specification must be interpreted as required for conforming IDL fragments, as described in the Web IDL specification. [WEBIDL]
The following terms are defined in the Web IDL specification:
-
Global environment associated with a platform object
-
Read only (when applied to arrays)
-
Converting between WebIDL types and JS types
The Web IDL specification also defines the following types that are used in Web IDL fragments in this specification:
The term throw in this specification is used as defined in the WebIDL specification. The following exception names are defined by WebIDL and used by this specification:
When this specification requires a user agent to create a
Date
object representing a particular time (which could be the special value Not-a-Number), the milliseconds component of that time, if any, must be truncated to an integer, and the time value of the newly createdDate
object must represent the resulting truncated time.For instance, given the time 23045 millionths of a second after 01:00 UTC on January 1st 2000, i.e., the time 2000-01-01T00:00:00.023045Z, then the
Date
object created representing that time would represent the same time as that created representing the time 2000-01-01T00:00:00.023Z, 45 millionths earlier. If the given time is NaN, then the result is aDate
object that represents a time value NaN (indicating that the object does not represent a specific instant of time). - JavaScript
-
Some parts of the language described by this specification only support JavaScript as the underlying scripting language. [ECMA-262]
The term "JavaScript" is used to refer to ECMA262, rather than the official term ECMAScript, since the term JavaScript is more widely known. Similarly, the MIME type used to refer to JavaScript in this specification is
text/javascript
, since that is the most commonly used type, despite it being an officially obsoleted type according to RFC 4329. [RFC4329]The following terms are defined in the JavaScript specification and used in this specification [ECMA-262]:
-
Well-Known Symbols, including:
-
@@hasInstance
-
@@isConcatSpreadable
-
@@toPrimitive
-
@@toStringTag
-
-
Well-Known Intrinsic Objects, including:
-
The FunctionBody production
-
The Module production
-
The Pattern production
-
The Script production
-
The Type notation
-
The Property Descriptor specification type
-
The Source Text Module Record specification type and its ModuleEvaluation and ModuleDeclarationInstantiation methods
-
The ArrayCreate abstract operation
-
The Call abstract operation
-
The Construct abstract operation
-
The CopyDataBlockBytes abstract operation
-
The CreateByteDataBlock abstract operation
-
The CreateDataProperty abstract operation
-
The DetachArrayBuffer abstract operation
-
The EnqueueJob abstract operation
-
The FunctionCreate abstract operation
-
The Get abstract operation
-
The GetActiveScriptOrModule abstract operation
-
The GetFunctionRealm abstract operation
-
The HasOwnProperty abstract operation
-
The HostEnsureCanCompileStrings abstract operation
-
The HostPromiseRejectionTracker abstract operation
-
The HostResolveImportedModule abstract operation
-
The InitializeHostDefinedRealm abstract operation
-
The IsAccessorDescriptor abstract operation
-
The IsCallable abstract operation
-
The IsConstructor abstract operation
-
The IsDataDescriptor abstract operation
-
The IsDetachedBuffer abstract operation
-
The NewObjectEnvironment abstract operation
-
The OrdinaryGetPrototypeOf abstract operation
-
The OrdinarySetPrototypeOf abstract operation
-
The OrdinaryIsExtensible abstract operation
-
The OrdinaryPreventExtensions abstract operation
-
The OrdinaryGetOwnProperty abstract operation
-
The OrdinaryDefineOwnProperty abstract operation
-
The OrdinaryGet abstract operation
-
The OrdinarySet abstract operation
-
The OrdinaryDelete abstract operation
-
The OrdinaryOwnPropertyKeys abstract operation
-
The ParseModule abstract operation
-
The ParseScript abstract operation
-
The RunJobs abstract operation
-
The SameValue abstract operation
-
The ScriptEvaluation abstract operation
-
The ToBoolean abstract operation
-
The ToString abstract operation
-
The ToUint32 abstract operation
-
The TypedArrayCreate abstract operation
-
The Abstract Equality Comparison algorithm
-
The Strict Equality Comparison algorithm
-
The
ArrayBuffer
object -
The
Date
object -
The
SyntaxError
object -
The
TypeError
object -
The
RangeError
object -
The
RegExp
object -
The typeof operator
- DOM
-
The Document Object Model (DOM) is a representation — a model — of a document and its content. The DOM is not just an API; the conformance criteria of HTML implementations are defined, in this specification, in terms of operations on the DOM. [DOM]
Implementations must support DOM and the events defined in UI Events, because this specification is defined in terms of the DOM, and some of the features are defined as extensions to the DOM interfaces. [DOM] [UIEVENTS]
In particular, the following features are defined in the DOM specification: [DOM]
-
Attr
interface -
Comment
interface -
DOMImplementation
interface -
Document
interface -
XMLDocument
interface -
DocumentFragment
interface -
DocumentType
interface -
DOMException
interface -
ChildNode
interface -
Element
interface -
Node
interface -
NodeList
interface -
ProcessingInstruction
interface -
Text
interface -
HTMLCollection
interface -
item()
method -
The terms collections and represented by the collection
-
DOMTokenList
interface -
createDocument()
method -
createHTMLDocument()
method -
createElement()
method -
createElementNS()
method -
getElementById()
method -
getElementsByClassName()
method -
appendChild()
method -
cloneNode()
method -
importNode()
method -
id
attribute -
textContent
attribute -
The tree concept
-
The tree order concept
-
The root concept
-
The inclusive ancestor concept
-
The document element concept
-
The in a document concept
-
The pre-insert, insert, append, remove, replace, and adopt algorithms for nodes
-
The insertion steps, removing steps, and adopting steps hooks
-
The attribute list concept.
-
The data of a text node.
-
Event
interface -
EventTarget
interface -
EventInit
dictionary type -
target
attribute -
currentTarget
attribute -
isTrusted
attribute -
initEvent()
method -
addEventListener()
method -
The
type
of an event -
The concept of an event listener and the event listeners associated with an
EventTarget
-
The encoding (herein the character encoding) and content type of a
Document
-
The distinction between XML documents and HTML documents
-
The terms quirks mode, limited-quirks mode, and no-quirks mode
-
The algorithm to clone a
Node
, and the concept of cloning steps used by that algorithm -
The concept of base URL change steps and the definition of what happens when an element is affected by a base URL change
-
The concept of an element’s unique identifier (ID)
-
The term supported tokens
-
The concept of a DOM range, and the terms start, end, and boundary point as applied to ranges.
-
The create an element algorithm
-
MutationObserver
interface and mutation observers in general
For example, to throw a
TimeoutError
exception, a user agent would construct a DOMException object whose type was the string "TimeoutError
" (and whose code was the number 23, for legacy reasons) and actually throw that object as an exception.The following features are defined in the UI Events specification: [UIEVENTS]
-
MouseEvent
interface and the following interface members:-
The
relatedTarget
attribute -
The
button
attribute -
The
ctrlKey
attribute -
The
shiftKey
attribute -
The
altKey
attribute -
The
metaKey
attribute -
The
getModifierState()
method
-
-
MouseEventInit
dictionary type -
The
FocusEvent
interface and itsrelatedTarget
attribute -
click event
-
dblclick event
-
mousedown event
-
mouseenter event
-
mouseleave event
-
mousemove event
-
mouseout event
-
mouseover event
-
mouseup event
-
wheel event
-
keydown event
-
keyup event
-
keypress event
The following features are defined in the Touch Events specification: [TOUCH-EVENTS]
-
Touch
interface -
Touch point concept
This specification sometimes uses the term
name
to refer to the event’stype
; as in, "an event namedclick
" or "if the event name iskeypress
". The terms "name" and "type" for events are synonymous.The following features are defined in the DOM Parsing and Serialization specification: [DOM-PARSING]
The
Selection
interface is defined in the Selection API specification. [SELECTION-API]User agents are also encouraged to implement the features described in the HTML Editing APIs and
UndoManager
and DOM Transaction specifications. [EDITING] [UNDO]The following parts of the Fullscreen specification are referenced from this specification, in part to define the rendering of
dialog
elements, and also to define how the Fullscreen API interacts with the sandboxing features in HTML: [FULLSCREEN]-
The top layer concept
-
The fully exit fullscreen algorithm
The High Resolution Time specification provides the
DOMHighResTimeStamp
typedef and thePerformance
object’snow()
method. [HR-TIME-2] -
- File API
-
This specification uses the following features defined in the File API specification: [FILEAPI]
-
FileList
interface -
The concept of a
Blob
's snapshot state -
The concept of read errors
- Indexed Database API
-
This specification uses cleanup Indexed Database transactions defined by the Indexed Database API specification. [INDEXEDDB]
- Media Source Extensions
-
The following terms are defined in the Media Source Extensions specification: [MEDIA-SOURCE]
-
MediaSource
interface -
Detaching from a media element
-
- Media Capture and Streams
-
The following term is defined in the Media Capture and Streams specification: [MEDIACAPTURE-STREAMS]
-
MediaStream
interface
-
- XMLHttpRequest
-
This specification references the XMLHttpRequest specification to describe how the two specifications interact and to use its
ProgressEvent
features. The following features and terms are defined in the XMLHttpRequest specification: [XHR]-
XMLHttpRequest
interface -
XMLHttpRequest.responseXML
attribute -
ProgressEvent
interface -
ProgressEvent.lengthComputable
attribute -
ProgressEvent.loaded
attribute -
ProgressEvent.total
attribute
-
- Server-Sent Events
-
This specification references
EventSource
which is specified in the Server-Sent Events specification [EVENTSOURCE] - Media Queries
-
Implementations must support the Media Queries language. [MEDIAQ]
- CSS modules
-
While support for CSS as a whole is not required of implementations of this specification (though it is encouraged, at least for Web browsers), some features are defined in terms of specific CSS requirements.
In particular, some features require that a string be parsed as a CSS <color> value. When parsing a CSS value, user agents are required by the CSS specifications to apply some error handling rules. These apply to this specification also. [CSS3COLOR] [CSS-2015]
For example, user agents are required to close all open constructs upon finding the end of a style sheet unexpectedly. Thus, when parsing the string "
rgb(0,0,0
" (with a missing close-parenthesis) for a color value, the close parenthesis is implied by this error handling rule, and a value is obtained (the color black). However, the similar construct "rgb(0,0,
" (with both a missing parenthesis and a missing "blue" value) cannot be parsed, as closing the open construct does not result in a viable value.The following terms and features are defined in the CSS specification: [CSS-2015]
-
viewport
-
replaced element
-
intrinsic dimensions
The term named color is defined in the CSS Color specification. [CSS3COLOR]
The terms intrinsic width and intrinsic height refer to the width dimension and the height dimension, respectively, of intrinsic dimensions.
The term paint source is used as defined in the CSS Image Values and Replaced Content specification to define the interaction of certain HTML elements with the CSS 'element()' function. [CSS3-IMAGES]
The term default object size is also defined in the CSS Image Values and Replaced Content specification. [CSS3-IMAGES]
Implementations that support scripting must support the CSS Object Model. The following features and terms are defined in the CSSOM specifications: [CSSOM] [CSSOM-VIEW]
-
cssText
attribute ofCSSStyleDeclaration
-
CSS style sheets and their properties: type, location, parent CSS style sheet, owner node, owner CSS rule, media, title, alternate flag, disabled flag, CSS rules, origin-clean flag
-
Alternative style sheet sets and the preferred style sheet set
-
The
resize
event -
The
scroll
event
The following features and terms are defined in the CSS Syntax specifications: [CSS-SYNTAX-3]
The following terms are defined in the Selectors specification: [SELECTORS4]
The feature <length> is defined in the CSS Values and Units specification. [CSS-VALUES]
The term style attribute is defined in the CSS Style Attributes specification. [CSS-STYLE-ATTR]
The term used value is defined in the CSS Cascading and Inheritance specification. [CSS-CASCADE-4]
The
CanvasRenderingContext2D
object’s use of fonts depends on the features described in the CSS Fonts and Font Loading specifications, including in particularFontFace
objects and the font source concept. [CSS-FONTS-3] [CSS-FONT-LOADING-3]The following interface is defined in the Geometry Interfaces Module specification: [GEOMETRY-1]
-
DOMMatrix
interface
-
- SVG
-
The
CanvasRenderingContext2D
object’s use of fonts depends on the features described in the CSS Fonts and Font Loading specifications, including in particularFontFace
objects and the font source concept. [CSS-FONTS-3] [CSS-FONT-LOADING-3]The following interface is defined in the SVG specification: [SVG11]
- WebGL
-
The following interface is defined in the WebGL specification: [WEBGL-1]
- WebGL2
-
The following interface is defined in the WebGL2 specification: [webgl-2]
- WebVTT
-
Implementations may support WebVTT as a text track format for subtitles, captions, chapter titles, metadata, etc, for media resources. [WEBVTT]
The following terms, used in this specification, are defined in the WebVTT specification:
- The WebSocket protocol
-
The following terms are defined in the WebSocket protocol specification: [RFC6455]
- ARIA
-
The
role
attribute is defined in the ARIA specification, as are the following roles: [wai-aria-1.1]alert
alertdialog
application
article
banner
button
cell
checkbox
columnheader
combobox
complementary
contentinfo
definition
dialog
directory
document
feed
figure
form
grid
gridcell
group
heading
img
link
list
listbox
listitem
log
main
marquee
math
menubar
navigation
none
note
option
presentation
progressbar
radio
radiogroup
region
row
rowgroup
rowheader
scrollbar
search
searchbox
separator
slider
spinbutton
status
switch
tab
table
tablist
tabpanel
term
textbox
timer
toolbar
tooltip
tree
treegrid
treeitem
In addition, the following
aria-*
content attributes are defined in the ARIA specification: [wai-aria-1.1]aria-activedescendant
aria-atomic
aria-autocomplete
aria-busy
aria-checked
aria-colcount
aria-colindex
aria-colspan
aria-controls
aria-current
aria-describedby
aria-details
aria-dialog
aria-disabled
aria-dropeffect
aria-errormessage
aria-expanded
aria-flowto
aria-grabbed
aria-haspopup
aria-invalid
aria-keyshortcuts
aria-label
aria-labelledby
aria-level
aria-live
aria-multiline
aria-multiselectable
aria-orientation
aria-owns
aria-placeholder
aria-posinset
aria-pressed
aria-readonly
aria-relevant
aria-required
aria-roledescription
aria-rowcount
aria-rowindex
aria-rowspan
aria-selected
aria-setsize
aria-sort
aria-valuemax
aria-valuemin
aria-valuenow
aria-valuetext
- Content Security Policy
-
The following terms are defined in Content Security Policy: [CSP3]
-
The parse a serialized Content Security Policy algorithm
-
The Initialize a global object’s CSP list algorithm
-
The Initialize a Document’s CSP list algorithm
-
The Should element’s inline behavior be blocked by Content Security Policy? algorithm
-
The
report-uri
,frame-ancestors
, andsandbox
directives -
The EnsureCSPDoesNotBlockStringCompilation abstract algorithm
-
The Is base allowed for Document? algorithm
-
The Should element be blocked a priori by Content Security Policy? algorithm
The following terms are defined in Content Security Policy: Document Features
- Service Workers
-
The following terms are defined in Service Workers: [SERVICE-WORKERS]
- Secure Contexts
-
The following term is defined in Secure Contexts: [SECURE-CONTEXTS]
- Payment Request API
-
The following term is defined in the Payment Request API specification: [PAYMENT-REQUEST]
-
PaymentRequest interface
-
- MathML
-
While support for MathML as a whole is not required by this specification (though it is encouraged, at least for Web browsers), certain features depend upon small parts of MathML being implemented. [MATHML]
The following features are defined in the MathML specification:
- SVG
-
While support for SVG as a whole is not required by this specification (though it is encouraged, at least for Web browsers), certain features depend upon parts of SVG being implemented.
Also, the SVG specifications do not reflect implementation reality. Implementations implement subsets of SVG 1.1 and SVG Tiny 1.2. Although it is hoped that the in-progress SVG 2 specification is a more realistic target for implementations, until that specification is ready, user agents that implement SVG must do so with the following willful violations and additions. [SVG11] [SVGTINY12] [SVG2]
User agents that implement SVG must not implement the following features from SVG 1.1:
-
The
tref
element -
The
cursor
element (use CSS’scursor
property instead) -
The font-defining SVG elements:
font
,glyph
,missing-glyph
,hkern
,vkern
,font-face
,font-face-src
,font-face-uri
,font-face-format
, andfont-face-name
(use CSS’s@font-face
instead) -
The
externalResourcesRequired
attribute -
The
enable-background
property -
The
contentScriptType
andcontentStyleType
attributes (use thetype
attribute on the SVGscript
andstyle
elements instead)
User agents that implement SVG must implement the following features from SVG Tiny 1.2:
-
The
non-scaling-stroke
value for thevector-effect
property -
The
class
attribute is allowed on all SVG elements -
The
tabindex
attribute is allowed on visible SVG elements -
The ARIA accessibility attributes are allowed on all SVG elements
The following features are defined in the SVG specifications:
-
SVGScriptElement
interface -
SVG
desc
element -
SVG
foreignObject
element -
SVG
script
element -
SVG
svg
element -
SVG
title
element
-
- Filter Effects
-
The following feature is defined in the Filter Effects specification:
This specification does not require support of any particular network protocol, style sheet language, scripting language, or any of the DOM specifications beyond those required in the list above. However, the language described by this specification is biased towards CSS as the styling language, JavaScript as the scripting language, and HTTP as the network protocol, and several features assume that those languages and protocols are in use.
A user agent that implements the HTTP protocol must implement the Web Origin Concept specification and the HTTP State Management Mechanism specification (Cookies) as well. [HTTP] [ORIGIN] [COOKIES]
This specification might have certain additional requirements on character encodings, image formats, audio formats, and video formats in the respective sections.
2.2.3. Extensibility
Vendor-specific proprietary user agent extensions to this specification are strongly discouraged. Documents must not use such extensions, as doing so reduces interoperability and fragments the user base, allowing only users of specific user agents to access the content in question.
If such extensions are nonetheless needed, e.g., for experimental purposes, then vendors are strongly urged to use one of the following extension mechanisms:
-
For markup-level features that can be limited to the XML serialization and need not be supported in the HTML serialization, vendors should use the namespace mechanism to define custom namespaces in which the non-standard elements and attributes are supported.
-
For markup-level features that are intended for use with the HTML syntax, extensions should be limited to new attributes of the form "
x-vendor-feature
", where vendor is a short string that identifies the vendor responsible for the extension, and feature is the name of the feature. New element names should not be created. Using attributes for such extensions exclusively allows extensions from multiple vendors to co-exist on the same element, which would not be possible with elements. Using the "x-vendor-feature
" form allows extensions to be made without risk of conflicting with future additions to the specification.For instance, a browser named "FerretBrowser" could use "ferret" as a vendor prefix, while a browser named "Mellblom Browser" could use "mb". If both of these browsers invented extensions that turned elements into scratch-and-sniff areas, an author experimenting with these features could write:<span x-ferret-smellovision x-ferret-smellcode="LEM01" x-mb-outputsmell x-mb-smell="lemon juice"> This smells of lemons! </span>
Attribute names beginning with the two characters "x-
" are reserved for
user agent use and are guaranteed to never be formally added to the HTML language. For
flexibility, attributes names containing underscores (the U+005F LOW LINE character) are also
reserved for experimental purposes and are guaranteed to never be formally added to the HTML
language.
Pages that use such attributes are by definition non-conforming.
For DOM extensions, e.g., new methods and IDL attributes, the new members should be prefixed by vendor-specific strings to prevent clashes with future versions of this specification.
For events, experimental event types should be prefixed with vendor-specific strings.
pleasold
" and
thus name the event "pleasoldgoingup
", possibly with an event handler attribute
named "onpleasoldgoingup
". All extensions must be defined so that the use of extensions neither contradicts nor causes the non-conformance of functionality defined in the specification.
fooTypeTime
" to a control’s DOM interface that returned
the time it took the user to select the current value of a control (say). On the other hand,
defining a new control that appears in a form’s elements
array would be in
violation of the above requirement, as it would violate the definition of elements
given in this specification. When adding new reflecting IDL attributes corresponding to content attributes of the form
"x-vendor-feature
", the IDL attribute should be named
"vendorFeature
" (i.e., the "x
" is dropped from
the IDL attribute’s name).
When vendor-neutral extensions to this specification are needed, either this specification can be updated accordingly, or an extension specification can be written that overrides the requirements in this specification. When someone applying this specification to their activities decides that they will recognize the requirements of such an extension specification, it becomes an applicable specification for the purposes of conformance requirements in this specification.
Someone could write a specification that defines any arbitrary byte stream as conforming, and then claim that their random junk is conforming. However, that does not mean that their random junk actually is conforming for everyone’s purposes: if someone else decides that the specification does not apply to their work, then they can quite legitimately say that the aforementioned random junk is just that, junk, and not conforming at all. As far as conformance goes, what matters in a particular community is what that community agrees is applicable.
applicable specification.
The conformance terminology for documents depends on the nature of the changes introduced by such applicable specifications, and on the content and intended interpretation of the document. Applicable specifications MAY define new document content (e.g., a foobar element), MAY prohibit certain otherwise conforming content (e.g., prohibit use of <table>s), or MAY change the semantics, DOM mappings, or other processing rules for content defined in this specification. Whether a document is or is not a conforming HTML document does not depend on the use of applicable specifications: if the syntax and semantics of a given conforming HTML document is unchanged by the use of applicable specification(s), then that document remains a conforming HTML document. If the semantics or processing of a given (otherwise conforming) document is changed by use of applicable specification(s), then it is not a conforming HTML document. For such cases, the applicable specifications SHOULD define conformance terminology.
As a suggested but not required convention, such specifications might define conformance terminology such as: "Conforming HTML+XXX document", where XXX is a short name for the applicable specification. (Example: "Conforming HTML+AutomotiveExtensions document").
a consequence of the rule given above is that certain syntactically correct HTML documents may not be conforming HTML documents in the presence of applicable specifications. (Example: the applicable specification defines <table> to be a piece of furniture — a document written to that specification and containing a <table> element is NOT a conforming HTML document, even if the element happens to be syntactically correct HTML.)
User agents must treat elements and attributes that they do not understand as semantically neutral; leaving them in the DOM (for DOM processors), and styling them according to CSS (for CSS processors), but not inferring any meaning from them.
When support for a feature is disabled (e.g., as an emergency measure to mitigate a security problem, or to aid in development, or for performance reasons), user agents must act as if they had no support for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature is accessed via an attribute in a Web IDL interface, the attribute itself would be omitted from the objects that implement that interface — leaving the attribute on the object but making it return null or throw an exception is insufficient.
2.2.4. Interactions with XPath and XSLT
Implementations of XPath 1.0 that operate on HTML documents parsed or created in the
manners described in this specification (e.g., as part of the document.evaluate()
API)
must act as if the following edit was applied to the XPath 1.0 specification.
First, remove this paragraph:
A QName in the node test is expanded into an expanded-name using the namespace
declarations from the expression context. This is the same way expansion is done for element
type names in start and end-tags except that the default namespace declared with xmlns
is not used: if the QName does not have a prefix, then the namespace
URI is null (this is the same way attribute names are expanded). It is an error if the QName has a prefix for which there is no namespace declaration in the expression context.
Then, insert in its place the following:
A QName in the node test is expanded into an expanded-name using the namespace declarations from the expression context. If the QName has a prefix, then there must be a namespace declaration for this prefix in the expression context, and the corresponding namespace URI is the one that is associated with this prefix. It is an error if the QName has a prefix for which there is no namespace declaration in the expression context.If the QName has no prefix and the principal node type of the axis is element, then the default element namespace is used. Otherwise if the QName has no prefix, the namespace URI is null. The default element namespace is a member of the context for the XPath expression. The value of the default element namespace when executing an XPath expression through the DOM3 XPath API is determined in the following way:
If the context node is from an HTML DOM, the default element namespace is "http://www.w3.org/1999/xhtml".
Otherwise, the default element namespace URI is null.
This is equivalent to adding the default element namespace feature of XPath 2.0 to XPath 1.0, and using the HTML namespace as the default element namespace for HTML documents. It is motivated by the desire to have implementations be compatible with legacy HTML content while still supporting the changes that this specification introduces to HTML regarding the namespace used for HTML elements, and by the desire to use XPath 1.0 rather than XPath 2.0.
This change is a willful violation of the XPath 1.0 specification, motivated by desire to have implementations be compatible with legacy content while still supporting the changes that this specification introduces to HTML regarding which namespace is used for HTML elements. [XPATH]
XSLT 1.0 processors outputting to a DOM when the output method is "html" (either explicitly or via the defaulting rule in XSLT 1.0) are affected as follows:
If the transformation program outputs an element in no namespace, the processor must, prior to constructing the corresponding DOM element node, change the namespace of the element to the HTML namespace, ASCII-lowercase the element’s local name, and ASCII-lowercase the names of any non-namespaced attributes on the element.
This requirement is a willful violation of the XSLT 1.0 specification, required because this specification changes the namespaces and case-sensitivity rules of HTML in a manner that would otherwise be incompatible with DOM-based XSLT transformations. (Processors that serialize the output are unaffected.) [XSLT]
This specification does not specify precisely how XSLT processing interacts with the HTML parser infrastructure (for example, whether an XSLT processor acts as if it puts any
elements into a stack of open elements). However, XSLT processors must stop parsing if they successfully complete, and must set the current document readiness first to
"interactive
" and then to "complete
" if they are aborted.
This specification does not specify how XSLT interacts with the navigation algorithm, how it fits in with the event loop, nor how error pages are to be handled (e.g., whether XSLT errors are to replace an incremental XSLT output, or are rendered inline, etc).
There are also additional non-normative comments regarding the interaction of XSLT and HTML in the script
element section,
and of XSLT, XPath, and HTML in the template
element section.
2.3. Case-sensitivity and string comparison
Comparing two strings in a case-sensitive manner means comparing them exactly, code point for code point.
Comparing two strings in an ASCII case-insensitive manner means comparing them exactly, code point for code point, except that the characters in the range U+0041 to U+005A (i.e., LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z) and the corresponding characters in the range U+0061 to U+007A (i.e., LATIN SMALL LETTER A to LATIN SMALL LETTER Z) are considered to also match.
Except where otherwise stated, string comparisons must be performed in a case-sensitive manner.
Converting a string to ASCII uppercase means replacing all characters in the range U+0061 to U+007A (i.e., LATIN SMALL LETTER A to LATIN SMALL LETTER Z) with the corresponding characters in the range U+0041 to U+005A (i.e., LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z).
Converting a string to ASCII lowercase means replacing all characters in the range U+0041 to U+005A (i.e., LATIN CAPITAL LETTER A to LATIN CAPITAL LETTER Z) with the corresponding characters in the range U+0061 to U+007A (i.e., LATIN SMALL LETTER A to LATIN SMALL LETTER Z).
A string pattern is a prefix match for a string s when pattern is not longer than s and truncating s to pattern’s length leaves the two strings as matches of each other.
2.4. Common microsyntaxes
There are various places in HTML that accept particular data types, such as dates or numbers. This section describes what the conformance criteria for content in those formats is, and how to parse them.
Implementors are strongly urged to carefully examine any third-party libraries they might consider using to implement the parsing of syntaxes described below. For example, date libraries are likely to implement error handling behavior that differs from what is required in this specification, since error-handling behavior is often not defined in specifications that describe date syntaxes similar to those used in this specification, and thus implementations tend to vary greatly in how they handle errors.
2.4.1. Common parser idioms
The space characters, for the purposes of this specification, are U+0020 SPACE, U+0009 CHARACTER TABULATION (tab), U+000A LINE FEED (LF), U+000C FORM FEED (FF), and U+000D CARRIAGE RETURN (CR).
The White_Space characters are those that have the Unicode property "White_Space" in
the Unicode PropList.txt
data file. [UNICODE]
This should not be confused with the "White_Space" value (abbreviated "WS") of the "Bidi_Class"
property in the Unicode.txt
data file.
The control characters are those whose Unicode "General_Category" property has the
value "Cc" in the Unicode UnicodeData.txt
data file. [UNICODE]
The uppercase ASCII letters are the characters in the range U+0041 LATIN CAPITAL LETTER A to U+005A LATIN CAPITAL LETTER Z.
The lowercase ASCII letters are the characters in the range U+0061 LATIN SMALL LETTER A to U+007A LATIN SMALL LETTER Z.
The ASCII letters are the characters that are either uppercase ASCII letters or lowercase ASCII letters.
The ASCII digits are the characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9).
The alphanumeric ASCII characters are those that are either uppercase ASCII letters, lowercase ASCII letters, or ASCII digits.
The ASCII hex digits are the characters in the ranges U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F, and U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F.
The uppercase ASCII hex digits are the characters in the ranges U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) and U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F only.
The lowercase ASCII hex digits are the characters in the ranges U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9) and U+0061 LATIN SMALL LETTER A to U+0066 LATIN SMALL LETTER F only.
Some of the micro-parsers described below follow the pattern of having an input variable that holds the string being parsed, and having a position variable pointing at the next character to parse in input.
For parsers based on this pattern, a step that requires the user agent to collect a sequence of characters means that the following algorithm must be run, with characters being the set of characters that can be collected:
-
Let input and position be the same variables as those of the same name in the algorithm that invoked these steps.
-
Let result be the empty string.
-
While position doesn’t point past the end of input and the character at position is one of the characters, append that character to the end of result and advance position to the next character in input.
-
Return result.
The step skip white space means that the user agent must collect a sequence of characters that are space characters. The collected characters are not used.
When a user agent is to strip line breaks from a string, the user agent must remove any U+000A LINE FEED (LF) and U+000D CARRIAGE RETURN (CR) characters from that string.
When a user agent is to strip leading and trailing white space from a string, the user agent must remove all space characters that are at the start or end of the string.
When a user agent is to strip and collapse white space in a string, it must replace any sequence of one or more consecutive space characters in that string with a single U+0020 SPACE character, and then strip leading and trailing white space from that string.
When a user agent has to strictly split a string on a particular delimiter character delimiter, it must use the following algorithm:
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let tokens be an ordered list of tokens, initially empty.
-
While position is not past the end of input:
-
Collect a sequence of characters that are not the delimiter character.
-
Append the string collected in the previous step to tokens.
-
Advance position to the next character in input.
-
-
Return tokens.
For the special cases of splitting a string on spaces and on commas, this algorithm does not apply (those algorithms also perform white space trimming).
2.4.2. Boolean attributes
A number of attributes are boolean attributes. The presence of a boolean attribute on an element represents the true value, and the absence of the attribute represents the false value.
If the attribute is present, its value must either be the empty string or a value that is an ASCII case-insensitive match for the attribute’s canonical name, with no leading or trailing white space.
A boolean attribute without a value assigned to it (e.g. checked) is implicitly equivalent to one that has the empty string assigned to it (i.e. checked=""). As a consequence, it represents the true value.
The values "true" and "false" are not allowed on boolean attributes. To represent a false value, the attribute has to be omitted altogether.
checked
and disabled
attributes are the boolean attributes.
<label><input type="checkbox" checked name="cheese" disabled> Cheese</label>
This could be equivalently written as this:
<label><input type="checkbox" checked="checked" name="cheese" disabled="disabled"> Cheese</label>
You can also mix styles:
<label><input type='checkbox' checked name=cheese disabled=""> Cheese</label>
2.4.3. Keywords and enumerated attributes
Some attributes are defined as taking one of a finite set of keywords. Such attributes are called enumerated attributes. The keywords are each defined to map to a particular state (several keywords might map to the same state, in which case some of the keywords are synonyms of each other; additionally, some of the keywords can be said to be non-conforming, and are only in the specification for historical reasons). In addition, two default states can be given. The first is the invalid value default, the second is the missing value default.
If an enumerated attribute is specified, the attribute’s value must be an ASCII case-insensitive match for one of the given keywords that are not said to be non-conforming, with no leading or trailing white space.
When the attribute is specified, if its value is an ASCII case-insensitive match for one of the given keywords then that keyword’s state is the state that the attribute represents. If the attribute value matches none of the given keywords, but the attribute has an invalid value default, then the attribute represents that state. Otherwise, if the attribute value matches none of the keywords but there is a missing value default state defined, then that is the state represented by the attribute. Otherwise, there is no default, and invalid values mean that there is no state represented.
When the attribute is not specified, if there is a missing value default state defined, then that is the state represented by the (missing) attribute. Otherwise, the absence of the attribute means that there is no state represented.
The empty string can be a valid keyword.
2.4.4. Numbers
2.4.4.1. Signed integers
A string is a valid integer if it consists of one or more ASCII digits, optionally prefixed with a U+002D HYPHEN-MINUS character (-).
A valid integer without a U+002D HYPHEN-MINUS (-) prefix represents the number that is represented in base ten by that string of digits. A valid integer with a U+002D HYPHEN-MINUS (-) prefix represents the number represented in base ten by the string of digits that follows the U+002D HYPHEN-MINUS, subtracted from zero.
The rules for parsing integers are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either an integer or an error.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let sign have the value "positive".
-
If position is past the end of input, return an error.
-
If the character indicated by position (the first character) is a U+002D HYPHEN-MINUS character (-):
-
Let sign be "negative".
-
Advance position to the next character.
-
If position is past the end of input, return an error.
Otherwise, if the character indicated by position (the first character) is a U+002B PLUS SIGN character (+):
-
Advance position to the next character. (The "
+
" is ignored, but it is not conforming.) -
If position is past the end of input, return an error.
-
-
If the character indicated by position is not an ASCII digit, then return an error.
-
Collect a sequence of characters that are ASCII digits, and interpret the resulting sequence as a base-ten integer. Let value be that integer.
-
If sign is "positive", return value, otherwise return the result of subtracting value from zero.
2.4.4.2. Non-negative integers
A string is a valid non-negative integer if it consists of one or more ASCII digits.
A valid non-negative integer represents the number that is represented in base ten by that string of digits.
The rules for parsing non-negative integers are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either zero, a positive integer, or an error.
-
Let input be the string being parsed.
-
Let value be the result of parsing input using the rules for parsing integers.
-
If value is an error, return an error.
-
If value is less than zero, return an error.
-
Return value.
2.4.4.3. Floating-point numbers
A string is a valid floating-point number if it consists of:
-
Optionally, a U+002D HYPHEN-MINUS character (-).
-
One or both of the following, in the given order:
-
A series of one or more ASCII digits.
-
Both of the following, in the given order:
-
A single U+002E FULL STOP character (.).
-
A series of one or more ASCII digits.
-
-
-
Optionally:
-
Either a U+0065 LATIN SMALL LETTER E character (e) or a U+0045 LATIN CAPITAL LETTER E character (E).
-
Optionally, a U+002D HYPHEN-MINUS character (-) or U+002B PLUS SIGN character (+).
-
A series of one or more ASCII digits.
-
A valid floating-point number represents the number obtained by multiplying the significand by ten raised to the power of the exponent, where the significand is the first number, interpreted as base ten (including the decimal point and the number after the decimal point, if any, and interpreting the significand as a negative number if the whole string starts with a U+002D HYPHEN-MINUS character (-) and the number is not zero), and where the exponent is the number after the E, if any (interpreted as a negative number if there is a U+002D HYPHEN-MINUS character (-) between the E and the number and the number is not zero, or else ignoring a U+002B PLUS SIGN character (+) between the E and the number if there is one). If there is no E, then the exponent is treated as zero.
The Infinity and Not-a-Number (NaN) values are not valid floating-point numbers.
The best representation of the number n as a floating-point number is the string obtained from running ToString(n). The abstract operation ToString is not uniquely determined. When there are multiple possible strings that could be obtained from ToString for a particular value, the user agent must always return the same string for that value (though it may differ from the value used by other user agents).
The rules for parsing floating-point number values are as given in the following algorithm. This algorithm must be aborted at the first step that returns something. This algorithm will return either a number or an error.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let value have the value 1.
-
Let divisor have the value 1.
-
Let exponent have the value 1.
-
If position is past the end of input, return an error.
-
If the character indicated by position is a U+002D HYPHEN-MINUS character (-):
-
Change value and divisor to -1.
-
Advance position to the next character.
-
If position is past the end of input, return an error.
Otherwise, if the character indicated by position (the first character) is a U+002B PLUS SIGN character (+):
-
Advance position to the next character. (The "
+
" is ignored, but it is not conforming.) -
If position is past the end of input, return an error.
-
-
If the character indicated by position is a U+002E FULL STOP (.), and that is not the last character in input, and the character after the character indicated by position is an ASCII digit, then set value to zero and jump to the step labeled fraction.
-
If the character indicated by position is not an ASCII digit, then return an error.
-
Collect a sequence of characters that are ASCII digits, and interpret the resulting sequence as a base-ten integer. Multiply value by that integer.
-
If position is past the end of input, jump to the step labeled conversion.
-
Fraction: If the character indicated by position is a U+002E FULL STOP (.), run these substeps:
-
Advance position to the next character.
-
If position is past the end of input, or if the character indicated by position is not an ASCII digit, U+0065 LATIN SMALL LETTER E (e), or U+0045 LATIN CAPITAL LETTER E (E), then jump to the step labeled conversion.
-
If the character indicated by position is a U+0065 LATIN SMALL LETTER E character (e) or a U+0045 LATIN CAPITAL LETTER E character (E), skip the remainder of these substeps.
-
Fraction loop: Multiply divisor by ten.
-
Add the value of the character indicated by position, interpreted as a base-ten digit (0..9) and divided by divisor, to value.
-
Advance position to the next character.
-
If position is past the end of input, then jump to the step labeled conversion.
-
If the character indicated by position is an ASCII digit, jump back to the step labeled fraction loop in these substeps.
-
-
If the character indicated by position is a U+0065 LATIN SMALL LETTER E character (e) or a U+0045 LATIN CAPITAL LETTER E character (E), run these substeps:
-
Advance position to the next character.
-
If position is past the end of input, then jump to the step labeled conversion.
-
If the character indicated by position is a U+002D HYPHEN-MINUS character (-):
-
Change exponent to -1.
-
Advance position to the next character.
-
If position is past the end of input, then jump to the step labeled conversion.
Otherwise, if the character indicated by position is a U+002B PLUS SIGN character (+):
-
Advance position to the next character.
-
If position is past the end of input, then jump to the step labeled conversion.
-
-
If the character indicated by position is not an ASCII digit, then jump to the step labeled conversion.
-
Collect a sequence of characters that are ASCII digits, and interpret the resulting sequence as a base-ten integer. Multiply exponent by that integer.
-
Multiply value by ten raised to the exponentth power.
-
-
Conversion: Let S be the set of finite IEEE 754 double-precision floating-point values except -0, but with two special values added: 21024 and -21024.
-
Let rounded-value be the number in S that is closest to value, selecting the number with an even significand if there are two equally close values. (The two special values 21024 and -21024 are considered to have even significands for this purpose.)
-
If rounded-value is 21024 or -21024, return an error.
-
Return rounded-value.
2.4.4.4. Percentages and lengths
The rules for parsing dimension values are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a number greater than or equal to 0.0, or an error; if a number is returned, then it is further categorized as either a percentage or a length.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
If position is past the end of input, return an error.
-
If the character indicated by position is a U+002B PLUS SIGN character (+), advance position to the next character.
-
If position is past the end of input, return an error.
-
If the character indicated by position is not an ASCII digit, then return an error.
-
Collect a sequence of characters that are ASCII digits, and interpret the resulting sequence as a base-ten integer. Let value be that number.
-
If position is past the end of input, return value as a length.
-
If the character indicated by position is a U+002E FULL STOP character (.):
-
Advance position to the next character.
-
If position is past the end of input, or if the character indicated by position is not an ASCII digit, then return value as a length.
-
Let divisor have the value 1.
-
Fraction loop: Multiply divisor by ten.
-
Add the value of the character indicated by position, interpreted as a base-ten digit (0..9) and divided by divisor, to value.
-
Advance position to the next character.
-
If position is past the end of input, then return value as a length.
-
If the character indicated by position is an ASCII digit, return to the step labeled fraction loop in these substeps.
-
-
If position is past the end of input, return value as a length.
-
If the character indicated by position is a U+0025 PERCENT SIGN character (%), return value as a percentage.
-
Return value as a length.
2.4.4.5. Non-zero percentages and lengths
The rules for parsing non-zero dimension values are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a number greater than 0.0, or an error; if a number is returned, then it is further categorized as either a percentage or a length.
-
Let input be the string being parsed.
-
Let value be the result of parsing input using the rules for parsing dimension values.
-
If value is an error, return an error.
-
If value is zero, return an error.
-
If value is a percentage, return value as a percentage.
-
Return value as a length.
2.4.4.6. Lists of floating-point numbers
A valid list of floating-point numbers is a number of valid floating-point numbers separated by U+002C COMMA characters, with no other characters (e.g. no space characters). In addition, there might be restrictions on the number of floating-point numbers that can be given, or on the range of values allowed.
The rules for parsing a list of floating-point numbers are as follows:
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let numbers be an initially empty list of floating-point numbers. This list will be the result of this algorithm.
-
Collect a sequence of characters that are space characters, U+002C COMMA, or U+003B SEMICOLON characters. This skips past any leading delimiters.
-
While position is not past the end of input:
-
Collect a sequence of characters that are not space characters, U+002C COMMA, U+003B SEMICOLON, ASCII digits, U+002E FULL STOP, or U+002D HYPHEN-MINUS characters. This skips past leading garbage.
-
Collect a sequence of characters that are not space characters, U+002C COMMA, or U+003B SEMICOLON characters, and let unparsed number be the result.
-
Let number be the result of parsing unparsed number using the rules for parsing floating-point number values.
-
If number is an error, set number to zero.
-
Append number to numbers.
-
Collect a sequence of characters that are space characters, U+002C COMMA, or U+003B SEMICOLON characters. This skips past the delimiter.
-
-
Return numbers.
2.4.4.7. Lists of dimensions
The rules for parsing a list of dimensions are as follows. These rules return a list of zero or more pairs consisting of a number and a unit, the unit being one of percentage, relative, and absolute.
-
Let raw input be the string being parsed.
-
If the last character in raw input is a U+002C COMMA character (,), then remove that character from raw input.
-
Split the string raw input on commas. Let raw tokens be the resulting list of tokens.
-
Let result be an empty list of number/unit pairs.
-
For each token in raw tokens, run the following substeps:
-
Let input be the token.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let value be the number 0.
-
Let unit be absolute.
-
If position is past the end of input, set unit to relative and jump to the last substep.
-
If the character at position is an ASCII digit, collect a sequence of characters that are ASCII digits, interpret the resulting sequence as an integer in base ten, and increment value by that integer.
-
If the character at position is a U+002E FULL STOP character (.), run these substeps:
-
Collect a sequence of characters consisting of space characters and ASCII digits. Let s be the resulting sequence.
-
Remove all space characters in s.
-
If s is not the empty string, run these subsubsteps:
-
Let length be the number of characters in s (after the spaces were removed).
-
Let fraction be the result of interpreting s as a base-ten integer, and then dividing that number by 10length.
-
Increment value by fraction.
-
-
-
If the character at position is a U+0025 PERCENT SIGN character (%), then set unit to percentage.
Otherwise, if the character at position is a U+002A ASTERISK character (*), then set unit to relative.
-
Add an entry to result consisting of the number given by value and the unit given by unit.
-
-
Return the list result.
2.4.5. Dates and times
This means that encoded dates will look like 1582-03-01, 0033-03-27, or 2016-03-01, and date-times will look like 1929-11-13T19:00Z, 0325-06-03T00:21+10:30. The format is approximately YYYY-MM-DDTHH:MM:SS.DD±HH:MM, although some parts are optional, for example to express a month and day as in a birthday, a time without time-zone information, and the like.
Times are expressed using the 24-hour clock, and it is an error to express leap seconds.
Dates are expressed in the proleptic Gregorian calendar between the proleptic year 0001, and the year 9999 inclusive. Other years cannot be encoded.
The proleptic Gregorian calendar is the calendar most common globally since around 1950, and is likely to be understood by almost everyone for dates between the years 1950 and 9999, and for many people for dates in the last few decades or centuries.
The Gregorian calendar was adopted officially in different countries at different times, between the years 1582 when it was proposed by Pope Gregory XIII as a replacement for the Julian calendar, and 1949 when it was adopted by the People’s republic of China.
For most practical purposes, dealing with the present, recent past, or the next few thousand years, this will work without problems. For dates before the adoption of the Gregorian Calendar - for example prior to 1917 in Russia or Turkey, prior to 1752 in Britain or the then British colonies of America, or prior to 1582 in Spain, the Spanish colonies in America, and the rest of the world, dates will not match those written at the time.
The use of the Gregorian calendar as an underlying encoding is a somewhat arbitrary choice. Many other calendars were or are in use, and the interested reader should look for information on the Web.
See also the discussion of date, time, and number formats in forms (for authors), implementation
notes regarding localization of form controls, and the time
element.
In the algorithms below, the number of days in month month of year year is: 31 if month is 1, 3, 5, 7, 8, 10, or 12; 30 if month is 4, 6, 9, or 11; 29 if month is 2 and year is a number divisible by 400, or if year is a number divisible by 4 but not by 100; and 28 otherwise. This takes into account leap years in the Gregorian calendar. [GREGORIAN]
When ASCII digits are used in the date and time syntaxes defined in this section, they express numbers in base ten.
While the formats described here are intended to be subsets of the corresponding ISO8601 formats, this specification defines parsing rules in much more detail than ISO8601. Implementors are therefore encouraged to carefully examine any date parsing libraries before using them to implement the parsing rules described below; ISO8601 libraries might not parse dates and times in exactly the same manner. [ISO8601]
Where this specification refers to the proleptic Gregorian calendar, it means the modern Gregorian calendar, extrapolated backwards to year 0001. A date in the proleptic Gregorian calendar, sometimes explicitly referred to as a proleptic-Gregorian date, is one that is described using that calendar even if that calendar was not in use at the time (or place) in question. [GREGORIAN]
2.4.5.1. Months
A month consists of a specific proleptic-Gregorian date with no time-zone information and no date information beyond a year and a month. [GREGORIAN]
A string is a valid month string representing a year year and month month if it consists of the following components in the given order:
-
Four ASCII digits, representing year, where year >= 1
-
A U+002D HYPHEN-MINUS character (-)
-
Two ASCII digits, representing the month month, in the range 1 ≤ month ≤ 12
For example, February 2005 is encoded 2005-02, and March of the year 33AD (as a proleptic
gregorian date) is encoded 0033-03
. The expression 325-03
does not mean March in the year 325, it is an error, because it does not have 4 digits for
the year.
The rules to parse a month string are as follows. This will return either a year and month, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a month component to obtain year and month. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Return year and month.
The rules to parse a month component, given an input string and a position, are as follows. This will return either a year and a month, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not at least four characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the year.
-
If year is not a number greater than zero, then fail.
-
If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the month.
-
If month is not a number in the range 1 ≤ month ≤ 12, then fail.
-
Return year and month.
2.4.5.2. Dates
A date consists of a specific proleptic-Gregorian date with no time-zone information, consisting of a year, a month, and a day. [GREGORIAN]
A string is a valid date string representing a year year, month month, and day day if it consists of the following components in the given order:
-
A valid month string, representing year and month
-
A U+002D HYPHEN-MINUS character (-)
-
Two ASCII digits, representing day, in the range 1 ≤ day ≤ maxday where maxday is the number of days in the month month and year year
For example, 29 February 2016 is encoded 2016-02-29, and 3 March of the year 33AD (as a
proleptic gregorian date) is encoded 0033-03-03
. The expression 325-03-03
does not mean 3 March in the year 325, it is an error, because
it does not have 4 digits for the year.
The rules to parse a date string are as follows. This will return either a date, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a date component to obtain year, month, and day. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Let date be the date with year year, month month, and day day.
-
Return date.
The rules to parse a date component, given an input string and a position, are as follows. This will return either a year, a month, and a day, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Parse a month component to obtain year and month. If this returns nothing, then fail.
-
Let maxday be the number of days in month month of year year.
-
If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the day.
-
If day is not a number in the range 1 ≤ day ≤ maxday, then fail.
-
Return year, month, and day.
2.4.5.3. Yearless dates
A yearless date consists of a Gregorian month and a day within that month, but with no associated year. [GREGORIAN]
A string is a valid yearless date string representing a month month and a day day if it consists of the following components in the given order:
-
Optionally, two U+002D HYPHEN-MINUS characters (-)
-
Two ASCII digits, representing the month month, in the range 1 ≤ month ≤ 12
-
A U+002D HYPHEN-MINUS character (-)
-
Two ASCII digits, representing day, in the range 1 ≤ day ≤ maxday where maxday is the number of days in the month month and any arbitrary leap year (e.g., 4 or 2000)
In other words, if the month is "02
", meaning February, then the day can
be 29, as if the year was a leap year.
For example, 29 February is encoded 02-29
, and 3 March is encoded 03-03
.
The rules to parse a yearless date string are as follows. This will return either a month and a day, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a yearless date component to obtain month and day. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Return month and day.
The rules to parse a yearless date component, given an input string and a position, are as follows. This will return either a month and a day, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Collect a sequence of characters that are U+002D HYPHEN-MINUS characters (-). If the collected sequence is not exactly zero or two characters long, then fail.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the month.
-
If month is not a number in the range 1 ≤ month ≤ 12, then fail.
-
Let maxday be the number of days in month month of any arbitrary leap year (e.g., 4 or 2000).
-
If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the day.
-
If day is not a number in the range 1 ≤ day ≤ maxday, then fail.
-
Return month and day.
2.4.5.4. Times
A time consists of a specific time with no time-zone information, consisting of an hour, a minute, a second, and a fraction of a second.
A string is a valid time string representing an hour hour, a minute minute, and a second second if it consists of the following components in the given order:
-
Two ASCII digits, representing hour, in the range 0 ≤ hour ≤ 23
-
A U+003A COLON character (:)
-
Two ASCII digits, representing minute, in the range 0 ≤ minute ≤ 59
-
If second is non-zero, or optionally if second is zero:
-
A U+003A COLON character (:)
-
Two ASCII digits, representing the integer part of second, in the range 0 ≤ s ≤ 59
-
If second is not an integer, or optionally if second is an integer:
-
A 002E FULL STOP character (.)
-
One, two, or three ASCII digits, representing the fractional part of second
-
-
The second component cannot be 60 or 61; leap seconds cannot be represented.
Times are encoded using the 24 hour clock, with optional seconds, and optional decimal fractions
of seconds. Thus 7.45pm is encoded as 19:45
. Note that parsing that time will return
19:45:00, or 7.45pm and zero seconds. 19:45:45.456
is 456 thousandths of
a second after 7.45pm and 45 seconds.
The rules to parse a time string are as follows. This will return either a time, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a time component to obtain hour, minute, and second. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Let time be the time with hour hour, minute minute, and second second.
-
Return time.
The rules to parse a time component, given an input string and a position, are as follows. This will return either an hour, a minute, and a second, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the hour.
-
If hour is not a number in the range 0 ≤ hour ≤ 23, then fail.
-
If position is beyond the end of input or if the character at position is not a U+003A COLON character, then fail. Otherwise, move position forwards one character.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the minute.
-
If minute is not a number in the range 0 ≤ minute ≤ 59, then fail.
-
Let second be a string with the value "0".
-
If position is not beyond the end of input and the character at position is a U+003A COLON, then run these substeps:
-
Advance position to the next character in input.
-
If position is beyond the end of input, or at the last character in input, or if the next two characters in input starting at position are not both ASCII digits, then fail.
-
Collect a sequence of characters that are either ASCII digits or U+002E FULL STOP characters. If the collected sequence is three characters long, or if it is longer than three characters long and the third character is not a U+002E FULL STOP character, or if it has more than one U+002E FULL STOP character, then fail. Otherwise, let second be the collected string.
-
-
Interpret second as a base-ten number (possibly with a fractional part). Let second be that number instead of the string version.
-
If second is not a number in the range 0 ≤ second < 60, then fail.
-
Return hour, minute, and second.
2.4.5.5. Floating dates and times
A floating date and time consists of a specific proleptic-Gregorian date, consisting of a year, a month, and a day, and a time, consisting of an hour, a minute, a second, and a fraction of a second, but expressed without a time zone. [GREGORIAN]
A string is a valid floating date and time string representing a date and time if it consists of the following components in the given order:
-
A valid date string representing the date
-
A U+0054 LATIN CAPITAL LETTER T character (T) or a U+0020 SPACE character
-
A valid time string representing the time
A string is a valid normalized floating date and time string representing a date and time if it consists of the following components in the given order:
-
A valid date string representing the date
-
A U+0054 LATIN CAPITAL LETTER T character (T)
-
A valid time string representing the time, expressed as the shortest possible string for the given time (e.g., omitting the seconds component entirely if the given time is zero seconds past the minute)
The rules to parse a floating date and time string are as follows. This will return either a date and time, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a date component to obtain year, month, and day. If this returns nothing, then fail.
-
If position is beyond the end of input or if the character at position is neither a U+0054 LATIN CAPITAL LETTER T character (T) nor a U+0020 SPACE character, then fail. Otherwise, move position forwards one character.
-
Parse a time component to obtain hour, minute, and second. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Let date be the date with year year, month month, and day day.
-
Let time be the time with hour hour, minute minute, and second second.
-
Return date and time.
2.4.5.6. Time zones
A time-zone offset consists of a signed number of hours and minutes.
A string is a valid time-zone offset string representing a time-zone offset if it consists of either:
-
A U+005A LATIN CAPITAL LETTER Z character (Z), allowed only if the time zone is UTC
-
Or, the following components, in the given order:
-
Either a U+002B PLUS SIGN character (+) or, if the time-zone offset is not zero, a U+002D HYPHEN-MINUS character (-), representing the sign of the time-zone offset
-
Two ASCII digits, representing the hours component hour of the time-zone offset, in the range 0 ≤ hour ≤ 23
-
Optionally, a U+003A COLON character (:)
-
Two ASCII digits, representing the minutes component minute of the time-zone offset, in the range 0 ≤ minute ≤ 59
-
This format allows for time-zone offsets from -23:59 to +23:59. In practice, however, right now the range of offsets of actual time zones is -12:00 to +14:00, and the minutes component of offsets of actual time zones is always either 00, 30, or 45. There is no guarantee that this will remain so forever, however; time zones are changed by countries at will and do not follow a standard.
See also the usage notes and examples in the global date and time section below for details on using time-zone offsets with historical times that predate the formation of formal time zones.
The rules to parse a time-zone offset string are as follows. This will return either a time-zone offset, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a time-zone offset component to obtain timezonehours and timezoneminutes. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Return the time-zone offset that is timezonehours hours and timezoneminutes minutes from UTC.
The rules to parse a time-zone offset component, given an input string and a position, are as follows. This will return either time-zone hours and time-zone minutes, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
If the character at position is a U+005A LATIN CAPITAL LETTER Z character (Z), then:
-
Let timezonehours be 0.
-
Let timezoneminutes be 0.
-
Advance position to the next character in input.
Otherwise, if the character at position is either a U+002B PLUS SIGN (+) or a U+002D HYPHEN-MINUS (-), then:
-
If the character at position is a U+002B PLUS SIGN (+), let sign be "positive". Otherwise, it’s a U+002D HYPHEN-MINUS (-); let sign be "negative".
-
Advance position to the next character in input.
-
Collect a sequence of characters that are ASCII digits. Let s be the collected sequence.
-
If s is exactly two characters long, then run these substeps:
-
Interpret s as a base-ten integer. Let that number be the timezonehours.
-
If position is beyond the end of input or if the character at position is not a U+003A COLON character, then fail. Otherwise, move position forwards one character.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the timezoneminutes.
If s is exactly four characters long, then run these substeps:
-
Interpret the first two characters of s as a base-ten integer. Let that number be the timezonehours.
-
Interpret the last two characters of s as a base-ten integer. Let that number be the timezoneminutes.
Otherwise, fail.
-
-
If timezonehours is not a number in the range 0 ≤ timezonehours ≤ 23, then fail.
-
If sign is "negative", then negate timezonehours.
-
If timezoneminutes is not a number in the range 0 ≤ timezoneminutes ≤ 59, then fail.
-
If sign is "negative", then negate timezoneminutes.
Otherwise, fail.
-
-
Return timezonehours and timezoneminutes.
2.4.5.7. Global dates and times
A global date and time consists of a specific proleptic-Gregorian date, consisting of a year, a month, and a day, and a time, consisting of an hour, a minute, a second, and a fraction of a second, expressed with a time-zone offset, consisting of a signed number of hours and minutes. [GREGORIAN]
A string is a valid global date and time string representing a date, time, and a time-zone offset if it consists of the following components in the given order:
-
A valid date string representing the date
-
A U+0054 LATIN CAPITAL LETTER T character (T) or a U+0020 SPACE character
-
A valid time string representing the time
-
A valid time-zone offset string representing the time-zone offset
Times in dates before the formation of UTC in the mid twentieth century must be expressed and interpreted in terms of UT1 (contemporary Earth mean solar time at the 0° longitude), not UTC (the approximation of UT1 that ticks in SI seconds). Time before the formation of time zones must be expressed and interpreted as UT1 times with explicit time zones that approximate the contemporary difference between the appropriate local time and the time observed at the location of Greenwich, London.
- "
0037-12-13 00:00Z
" -
Midnight "London time" (UTC) on the birthday of the Roman Emperor Nero. See below for further discussion on which date this actually corresponds to.
- "
1979-10-14T12:00:00.001-04:00
" -
One millisecond after noon on October 14th 1979, in the time zone in use on the east coast of the USA during daylight saving time.
- "
8592-01-01T02:09+02:09
" -
Midnight UTC on the 1st of January, 8592. The time zone associated with that time is two hours and nine minutes ahead of UTC, which is not currently a real time zone, but is nonetheless allowed.
Several things are notable about these dates:
-
Years with fewer than four digits have to be zero-padded. The date "37-12-13" is not a valid date.
-
If the "
T
" is replaced by a space, it must be a single space character. The string "2001-12-21 12:00Z
" (with two spaces between the components) would not be parsed successfully. -
To unambiguously identify a date it has to be first converted to the Gregorian calendar (e.g., from the Hijri, Jewish, Julian or other calendar). For example, the Roman Emperor Nero was born on the 15th of December 37 in the Julian Calendar, which is the 13th of December 37 in the proleptic Gregorian calendar.
-
The time and time-zone offset components are not optional.
-
Dates before the year one or after the year 9999 in the Gregorian calendar cannot be represented as a datetime in this version of HTML.
-
Time-zone offsets for a place may vary, for example due to daylight savings time.
The zone offset is not a complete time zone specification. When working with real date and time values, consider using a separate field for time zone, perhaps using IANA time zone IDs. [TIMEZONE]
A string is a valid normalized global date and time string representing a date, time, and a time-zone offset if it consists of the following components in the given order:
-
A valid date string representing the date converted to the UTC time zone
-
A U+0054 LATIN CAPITAL LETTER T character (T)
-
A valid time string representing the time converted to the UTC time zone and expressed as the shortest possible string for the given time (e.g., omitting the seconds component entirely if the given time is zero seconds past the minute)
-
A U+005A LATIN CAPITAL LETTER Z character (Z)
The rules to parse a global date and time string are as follows. This will return either a time in UTC, with associated time-zone offset information for round-tripping or display purposes, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Parse a date component to obtain year, month, and day. If this returns nothing, then fail.
-
If position is beyond the end of input or if the character at position is neither a U+0054 LATIN CAPITAL LETTER T character (T) nor a U+0020 SPACE character, then fail. Otherwise, move position forwards one character.
-
Parse a time component to obtain hour, minute, and second. If this returns nothing, then fail.
-
If position is beyond the end of input, then fail.
-
Parse a time-zone offset component to obtain timezonehours and timezoneminutes. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
Let time be the moment in time at year year, month month, day day, hours hour, minute minute, second second, subtracting timezonehours hours and timezoneminutes minutes. That moment in time is a moment in the UTC time zone.
-
Let timezone be timezonehours hours and timezoneminutes minutes from UTC.
-
Return time and timezone.
2.4.5.8. Weeks
A week consists of a week-year number and a week number representing a seven-day period starting on a Monday. Each week-year in this calendaring system has either 52 or 53 such seven-day periods, as defined below. The seven-day period starting on the Gregorian date Monday December 29th 1969 (1969-12-29) is defined as week number 1 in week-year 1970. Consecutive weeks are numbered sequentially. The week before the number 1 week in a week-year is the last week in the previous week-year, and vice versa. [GREGORIAN]
A week-year with a number year has 53 weeks if it corresponds to either a year year in the proleptic Gregorian calendar that has a Thursday as its first day (January 1st), or a year year in the proleptic Gregorian calendar that has a Wednesday as its first day (January 1st) and where year is a number divisible by 400, or a number divisible by 4 but not by 100. All other week-years have 52 weeks.
The week number of the last day of a week-year with 53 weeks is 53; the week number of the last day of a week-year with 52 weeks is 52.
The week-year number of a particular day can be different than the number of the year that contains that day in the proleptic Gregorian calendar. The first week in a week-year y is the week that contains the first Thursday of the Gregorian year y.
For modern purposes, a week as defined here is equivalent to ISO weeks as defined in ISO 8601. [ISO8601]
A string is a valid week string representing a week-year year and week week if it consists of the following components in the given order:
-
Four ASCII digits, representing year, where year >= 1
-
A U+002D HYPHEN-MINUS character (-)
-
A U+0057 LATIN CAPITAL LETTER W character (W)
-
Two ASCII digits, representing the week week, in the range 1 ≤ week ≤ maxweek, where maxweek is the week number of the last day of week-year year
The rules to parse a week string are as follows. This will return either a week-year number and week number, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not at least four characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the year.
-
If year is not a number greater than zero, then fail.
-
If position is beyond the end of input or if the character at position is not a U+002D HYPHEN-MINUS character, then fail. Otherwise, move position forwards one character.
-
If position is beyond the end of input or if the character at position is not a U+0057 LATIN CAPITAL LETTER W character (W), then fail. Otherwise, move position forwards one character.
-
Collect a sequence of characters that are ASCII digits. If the collected sequence is not exactly two characters long, then fail. Otherwise, interpret the resulting sequence as a base-ten integer. Let that number be the week.
-
Let maxweek be the week number of the last day of year year.
-
If week is not a number in the range 1 ≤ week ≤ maxweek, then fail.
-
If position is not beyond the end of input, then fail.
-
Return the week-year number year and the week number week.
2.4.5.9. Durations
A duration consists of a number of seconds.
Since months and seconds are not comparable (a month is not a precise number of seconds, but is instead a period whose exact length depends on the precise day from which it is measured) a duration as defined in this specification cannot include months (or years, which are equivalent to twelve months). Only durations that describe a specific number of seconds can be described.
A string is a valid duration string representing a duration t if it consists of either of the following:
-
A literal U+0050 LATIN CAPITAL LETTER P character followed by one or more of the following subcomponents, in the order given, where the number of days, hours, minutes, and seconds corresponds to the same number of seconds as in t:
-
One or more ASCII digits followed by a U+0044 LATIN CAPITAL LETTER D character, representing a number of days.
-
A U+0054 LATIN CAPITAL LETTER T character followed by one or more of the following subcomponents, in the order given:
-
One or more ASCII digits followed by a U+0048 LATIN CAPITAL LETTER H character, representing a number of hours.
-
One or more ASCII digits followed by a U+004D LATIN CAPITAL LETTER M character, representing a number of minutes.
-
The following components:
-
One or more ASCII digits, representing a number of seconds.
-
Optionally, a U+002E FULL STOP character (.) followed by one, two, or three ASCII digits, representing a fraction of a second.
-
A U+0053 LATIN CAPITAL LETTER S character.
-
-
This, as with a number of other date- and time-related microsyntaxes defined in this specification, is based on one of the formats defined in ISO 8601. [ISO8601]
-
-
One or more duration time components, each with a different duration time component scale, in any order; the sum of the represented seconds being equal to the number of seconds in t.
A duration time component is a string consisting of the following components:
-
Zero or more space characters.
-
One or more ASCII digits, representing a number of time units, scaled by the duration time component scale specified (see below) to represent a number of seconds.
-
If the duration time component scale specified is 1 (i.e., the units are seconds), then, optionally, a U+002E FULL STOP character (.) followed by one, two, or three ASCII digits, representing a fraction of a second.
-
Zero or more space characters.
-
One of the following characters, representing the duration time component scale of the time unit used in the numeric part of the duration time component:
- U+0057 LATIN CAPITAL LETTER W character
- U+0077 LATIN SMALL LETTER W character
-
Weeks. The scale is 604800.
- U+0044 LATIN CAPITAL LETTER D character
- U+0064 LATIN SMALL LETTER D character
-
Days. The scale is 86400.
- U+0048 LATIN CAPITAL LETTER H character
- U+0068 LATIN SMALL LETTER H character
-
Hours. The scale is 3600.
- U+004D LATIN CAPITAL LETTER M character
- U+006D LATIN SMALL LETTER M character
-
Minutes. The scale is 60.
- U+0053 LATIN CAPITAL LETTER S character
- U+0073 LATIN SMALL LETTER S character
-
Seconds. The scale is 1.
- U+0057 LATIN CAPITAL LETTER W character
-
Zero or more space characters.
This is not based on any of the formats in ISO 8601. It is intended to be a more human-readable alternative to the ISO 8601 duration format.
-
The rules to parse a duration string are as follows. This will return either a duration or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let months, seconds, and component count all be zero.
-
Let M-disambiguator be minutes.
This flag’s other value is months. It is used to disambiguate the "M" unit in ISO8601 durations, which use the same unit for months and minutes. Months are not allowed, but are parsed for future compatibility and to avoid misinterpreting ISO8601 durations that would be valid in other contexts.
-
If position is past the end of input, then fail.
-
If the character in input pointed to by position is a U+0050 LATIN CAPITAL LETTER P character, then advance position to the next character, set M-disambiguator to months, and skip white space.
-
Run the following substeps in a loop, until a step requiring the loop to be broken or the entire algorithm to fail is reached:
-
Let units be undefined. It will be assigned one of the following values: years, months, weeks, days, hours, minutes, and seconds.
-
Let next character be undefined. It is used to process characters from the input.
-
If position is past the end of input, then break the loop.
-
If the character in input pointed to by position is a U+0054 LATIN CAPITAL LETTER T character, then advance position to the next character, set M-disambiguator to minutes, skip white space, and return to the top of the loop.
-
Set next character to the character in input pointed to by position.
-
If next character is a U+002E FULL STOP character (.), then let N equal zero. (Do not advance position. That is taken care of below.)
Otherwise, if next character is an ASCII digit, then collect a sequence of characters that are ASCII digits, interpret the resulting sequence as a base-ten integer, and let N be that number.
Otherwise next character is not part of a number; fail.
-
If position is past the end of input, then fail.
-
Set next character to the character in input pointed to by position, and this time advance position to the next character. (If next character was a U+002E FULL STOP character (.) before, it will still be that character this time.)
-
If next character is a U+002E FULL STOP character (.), then run these substeps:
-
Collect a sequence of characters that are ASCII digits. Let s be the resulting sequence.
-
If s is the empty string, then fail.
-
Let length be the number of characters in s.
-
Let fraction be the result of interpreting s as a base-ten integer, and then dividing that number by 10length.
-
Increment N by fraction.
-
If position is past the end of input, then fail.
-
Set next character to the character in input pointed to by position, and advance position to the next character.
-
If next character is neither a U+0053 LATIN CAPITAL LETTER S character nor a U+0073 LATIN SMALL LETTER S character, then fail.
-
Set units to seconds.
Otherwise, run these substeps:
-
If next character is a space character, then skip white space, set next character to the character in input pointed to by position, and advance position to the next character.
-
If next character is a U+0059 LATIN CAPITAL LETTER Y character, or a U+0079 LATIN SMALL LETTER Y character, set units to years and set M-disambiguator to months.
If next character is a U+004D LATIN CAPITAL LETTER M character or a U+006D LATIN SMALL LETTER M character, and M-disambiguator is months, then set units to months.
If next character is a U+0057 LATIN CAPITAL LETTER W character or a U+0077 LATIN SMALL LETTER W character, set units to weeks and set M-disambiguator to minutes.
If next character is a U+0044 LATIN CAPITAL LETTER D character or a U+0064 LATIN SMALL LETTER D character, set units to days and set M-disambiguator to minutes.
If next character is a U+0048 LATIN CAPITAL LETTER H character or a U+0068 LATIN SMALL LETTER H character, set units to hours and set M-disambiguator to minutes.
If next character is a U+004D LATIN CAPITAL LETTER M character or a U+006D LATIN SMALL LETTER M character, and M-disambiguator is minutes, then set units to minutes.
If next character is a U+0053 LATIN CAPITAL LETTER S character or a U+0073 LATIN SMALL LETTER S character, set units to seconds and set M-disambiguator to minutes.
Otherwise if next character is none of the above characters, then fail.
-
-
Increment component count.
-
Let multiplier be 1.
-
If units is years, multiply multiplier by 12 and set units to months.
-
If units is months, add the product of N and multiplier to months.
Otherwise, run these substeps:
-
If units is weeks, multiply multiplier by 7 and set units to days.
-
If units is days, multiply multiplier by 24 and set units to hours.
-
If units is hours, multiply multiplier by 60 and set units to minutes.
-
If units is minutes, multiply multiplier by 60 and set units to seconds.
-
Forcibly, units is now seconds. Add the product of N and multiplier to seconds.
-
-
-
If component count is zero, fail.
-
If months is not zero, fail.
-
Return the duration consisting of seconds seconds.
2.4.5.10. Vaguer moments in time
A string is a valid date string with optional time if it is also one of the following:
The rules to parse a date or time string are as follows. The algorithm will return either a date, a time, a global date and time, or nothing. If at any point the algorithm says that it "fails", this means that it is aborted at that point and returns nothing.
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Set start position to the same position as position.
-
Set the date present and time present flags to true.
-
Parse a date component to obtain year, month, and day. If this fails, then set the date present flag to false.
-
If date present is true, and position is not beyond the end of input, and the character at position is either a U+0054 LATIN CAPITAL LETTER T character (T) or a U+0020 SPACE character, then advance position to the next character in input.
Otherwise, if date present is true, and either position is beyond the end of input or the character at position is neither a U+0054 LATIN CAPITAL LETTER T character (T) nor a U+0020 SPACE character, then set time present to false.
Otherwise, if date present is false, set position back to the same position as start position.
-
If the time present flag is true, then parse a time component to obtain hour, minute, and second. If this returns nothing, then fail.
-
If the date present and time present flags are both true, but position is beyond the end of input, then fail.
-
If the date present and time present flags are both true, parse a time-zone offset component to obtain timezonehours and timezoneminutes. If this returns nothing, then fail.
-
If position is not beyond the end of input, then fail.
-
If the date present flag is true and the time present flag is false, then let date be the date with year year, month month, and day day, and return date.
Otherwise, if the time present flag is true and the date present flag is false, then let time be the time with hour hour, minute minute, and second second, and return time.
Otherwise, let time be the moment in time at year year, month month, day day, hours hour, minute minute, second second, subtracting timezonehours hours and timezoneminutes minutes, that moment in time being a moment in the UTC time zone; let timezone be timezonehours hours and timezoneminutes minutes from UTC; and return time and timezone.
2.4.6. Colors
A simple color consists of three 8-bit numbers in the range 0..255, representing the red, green, and blue components of the color respectively, in the sRGB color space. [SRGB]
A string is a valid simple color if it is exactly seven characters long, and the first character is a U+0023 NUMBER SIGN character (#), and the remaining six characters are all ASCII hex digits, with the first two digits representing the red component, the middle two digits representing the green component, and the last two digits representing the blue component, in hexadecimal.
A string is a valid lowercase simple color if it is a valid simple color and doesn’t use any characters in the range U+0041 LATIN CAPITAL LETTER A to U+0046 LATIN CAPITAL LETTER F.
The rules for parsing simple color values are as given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a simple color or an error.
-
Let input be the string being parsed.
-
If input is not exactly seven characters long, then return an error.
-
If the first character in input is not a U+0023 NUMBER SIGN character (#), then return an error.
-
If the last six characters of input are not all ASCII hex digits, then return an error.
-
Let result be a simple color.
-
Interpret the second and third characters as a hexadecimal number and let the result be the red component of result.
-
Interpret the fourth and fifth characters as a hexadecimal number and let the result be the green component of result.
-
Interpret the sixth and seventh characters as a hexadecimal number and let the result be the blue component of result.
-
Return result.
The rules for serializing simple color values given a simple color are as given in the following algorithm:
-
Let result be a string consisting of a single U+0023 NUMBER SIGN character (#).
-
Convert the red, green, and blue components in turn to two-digit hexadecimal numbers using lowercase ASCII hex digits, zero-padding if necessary, and append these numbers to result, in the order red, green, blue.
-
Return result, which will be a valid lowercase simple color.
Some obsolete legacy attributes parse colors in a more complicated manner, using the rules for parsing a legacy color value, which are given in the following algorithm. When invoked, the steps must be followed in the order given, aborting at the first step that returns a value. This algorithm will return either a simple color or an error.
-
Let input be the string being parsed.
-
If input is the empty string, then return an error.
-
Strip leading and trailing white space from input.
-
If input is an ASCII case-insensitive match for the string "
transparent
", then return an error. -
If input is an ASCII case-insensitive match for one of the named colors, then return the simple color corresponding to that keyword. [CSS3COLOR]
CSS2 System Colors are not recognized.
-
If input is four characters long, and the first character in input is a U+0023 NUMBER SIGN character (#), and the last three characters of input are all ASCII hex digits, then run these substeps:
-
Let result be a simple color.
-
Interpret the second character of input as a hexadecimal digit; let the red component of result be the resulting number multiplied by 17.
-
Interpret the third character of input as a hexadecimal digit; let the green component of result be the resulting number multiplied by 17.
-
Interpret the fourth character of input as a hexadecimal digit; let the blue component of result be the resulting number multiplied by 17.
-
Return result.
-
-
Replace any characters in input that have a Unicode code point greater than U+FFFF (i.e., any characters that are not in the basic multilingual plane) with the two-character string "
00
". -
If input is longer than 128 characters, truncate input, leaving only the first 128 characters.
-
If the first character in input is a U+0023 NUMBER SIGN character (#), remove it.
-
Replace any character in input that is not an ASCII hex digit with the character U+0030 DIGIT ZERO (0).
-
While input’s length is zero or not a multiple of three, append a U+0030 DIGIT ZERO (0) character to input.
-
Split input into three strings of equal length, to obtain three components. Let length be the length of those components (one third the length of input).
-
If length is greater than 8, then remove the leading length-8 characters in each component, and let length be 8.
-
While length is greater than two and the first character in each component is a U+0030 DIGIT ZERO (0) character, remove that character and reduce length by one.
-
If length is still greater than two, truncate each component, leaving only the first two characters in each.
-
Let result be a simple color.
-
Interpret the first component as a hexadecimal number; let the red component of result be the resulting number.
-
Interpret the second component as a hexadecimal number; let the green component of result be the resulting number.
-
Interpret the third component as a hexadecimal number; let the blue component of result be the resulting number.
-
Return result.
2.4.7. Space-separated tokens
A set of space-separated tokens is a string containing zero or more words (known as tokens) separated by one or more space characters, where words consist of any string of one or more characters, none of which are space characters.
A string containing a set of space-separated tokens may have leading or trailing space characters.
An unordered set of unique space-separated tokens is a set of space-separated tokens where none of the tokens are duplicated.
An ordered set of unique space-separated tokens is a set of space-separated tokens where none of the tokens are duplicated but where the order of the tokens is meaningful.
Sets of space-separated tokens sometimes have a defined set of allowed values. When a set of allowed values is defined, the tokens must all be from that list of allowed values; other values are non-conforming. If no such set of allowed values is provided, then all values are conforming.
How tokens in a set of space-separated tokens are to be compared (e.g., case-sensitively or not) is defined on a per-set basis.
When a user agent has to split a string on spaces, it must use the following algorithm:
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let tokens be an ordered list of tokens, initially empty.
-
While position is not past the end of input:
-
Collect a sequence of characters that are not space characters.
-
Append the string collected in the previous step to tokens.
-
-
Return tokens.
2.4.8. Comma-separated tokens
A set of comma-separated tokens is a string containing zero or more tokens each separated from the next by a single U+002C COMMA character (,), where tokens consist of any string of zero or more characters, neither beginning nor ending with space characters, nor containing any U+002C COMMA characters (,), and optionally surrounded by space characters.
For instance, the string " a ,b, ,d d
" consists of four tokens:
"a", "b", the empty string, and "d d". Leading and trailing white space around each token
doesn’t count as part of the token, and the empty string can be a token.
Sets of comma-separated tokens sometimes have further restrictions on what consists a valid token. When such restrictions are defined, the tokens must all fit within those restrictions; other values are non-conforming. If no such restrictions are specified, then all values are conforming.
When a user agent has to split a string on commas, it must use the following algorithm:
-
Let input be the string being parsed.
-
Let position be a pointer into input, initially pointing at the start of the string.
-
Let tokens be an ordered list of tokens, initially empty.
-
Token: If position is past the end of input, jump to the last step.
-
Collect a sequence of characters that are not U+002C COMMA characters (,). Let s be the resulting sequence (which might be the empty string).
-
Append s to tokens.
-
If position is not past the end of input, then the character at position is a U+002C COMMA character (,); advance position past that character.
-
Jump back to the step labeled token.
-
Return tokens.
2.4.9. References
A valid hash-name reference to an element of type type is a
string consisting of a U+0023 NUMBER SIGN character (#) followed by a string which exactly matches
the value of the name
attribute of an element with type type in
the document.
The rules for parsing a hash-name reference to an element of type type, are as follows:
-
If the string being parsed does not contain a U+0023 NUMBER SIGN character, or if the first such character in the string is the last character in the string, then return null and abort these steps.
-
Let s be the string from the character immediately after the first U+0023 NUMBER SIGN character in the string being parsed up to the end of that string.
-
Return the first element of type type in tree order that has an
id
attribute or aname
attribute whose value is s.
2.4.10. Media queries
A string is a valid media query list if it matches the <media-query-list>
production of the Media Queries specification. [MEDIAQ]
A string matches the environment of the user if it is the empty string, a string consisting of only space characters, or is a media query list that matches the user’s environment according to the definitions given in the Media Queries specification. [MEDIAQ]
2.5. URLs
2.5.1. Terminology
A valid URL is a string that conforms to the authoring requirements for a valid url string. [URL]
scheme://host(port)/path
or a relative URL which is a path with optional fragment and query sections,
but this depends on the scheme used.
A host(port) is typically a domain or IP address, otionally followed by ":" and a number. Not all URL schemes require or even allow a host.
A path is typically a series of one or more Unicode strings separated by "/" characters.
The following are all valid URLs:
- this (relative URL)
- that/over#there (relative URL with fragment)
- https://example.com:8899/some/thing.there?perhaps (absolute https: URL)
- irc://irc.w3.org/#html (absolute irc: url)
- data:text/html;charset=utf-8;base64,PCFET0NUWVBFIGh0bWw+DQo8dGl0bGU+aGVsbG88L3RpdGxlPg== (a data: URL)
- mailto:user@ (a mailto: URL)
- The empty string
A string is a valid non-empty URL if it is a valid URL but it is not the empty string.
A string is a valid URL potentially surrounded by spaces if, after stripping leading and trailing white space from it, it is a valid URL.
A string is a valid non-empty URL potentially surrounded by spaces if, after stripping leading and trailing white space from it, it is a valid non-empty URL.
This specification defines the URL about:legacy-compat
as a
reserved, though unresolvable, about:
URL, for use in DOCTYPEs in HTML documents when needed for compatibility with XML tools. [RFC6694]
This specification defines the URL about:html-kind
as a reserved,
though unresolvable, about:
URL, that is used as an
identifier for kinds of media tracks. [RFC6694]
This specification defines the URL about:srcdoc
as a reserved,
though unresolvable, about:
URL, that is used as the document’s URL of iframe
srcdoc
documents. [RFC6694]
The fallback base URL of a Document
object is the absolute URL obtained by running these substeps:
-
If document is an
iframe
srcdoc
document, then return the document base URL of the Document’s browsing context’s browsing context container’s node document. -
If document’s URL is
about:blank
, and the Document’s browsing context has a creator browsing context, then return the creator base URL. -
Return document’s URL.
The document base URL of a Document
object is the absolute URL obtained by running these substeps:
-
If there is no
base
element that has anhref
attribute in theDocument
, then the document base URL is theDocument
's fallback base URL; abort these steps. -
Otherwise, the document base URL is the frozen base URL of the first
base
element in theDocument
that has anhref
attribute, in tree order.
2.5.2. Parsing URLs
Parsing a URL is the process of taking a URL string and obtaining the URL record that it implies. While this process is defined in the WHATWG URL specification, this specification defines a wrapper for convenience. [URL]
This wrapper is only useful when the character encoding for the URL parser has to match that of the document or environment settings object for legacy reasons. When that is not the case the URL parser can be used directly.
To parse a URL url, relative to either a document or environment settings object, the user agent must use the following steps. Parsing a URL either results in failure or a resulting URL string and resulting URL record.
-
Let encoding be document’s character encoding, if document was given, and environment settings object’s API URL character encoding otherwise.
-
Let baseURL be document’s base URL, if document was given, and environment settings object’s API base URL otherwise.
-
Let urlRecord be the result of applying the URL parser to url, with baseURL and encoding.
-
If urlRecord is failure, then abort these steps with an error.
-
Let urlString be the result of applying the URL serializer to urlRecord.
-
Return urlString as the resulting URL string and urlRecord as the resulting URL record.
2.5.3. Dynamic changes to base URLs
When a document’s document base URL changes, all elements in that document are affected by a base URL change.
The following are base URL change steps, which run when an element is affected by a base URL change (as defined by the DOM specification):
- If the element creates a hyperlink
-
If the URL identified by the hyperlink is being shown to the user, or if any
data derived from that URL is affecting the display, then the
href
attribute should be reparsed relative to the element’s node document and the UI updated appropriately.For example, the CSS :link/:visited pseudo-classes might have been affected.
- If the element is a
q
,blockquote
,ins
, ordel
element with acite
attribute - If the URL identified by the
cite
attribute is being shown to the user, or if any data derived from that URL is affecting the display, then the URL should be reparsed relative to the element’s node document and the UI updated appropriately. - Otherwise
-
The element is not directly affected.
For instance, changing the base URL doesn’t affect the image displayed by
img
elements, although subsequent accesses of thesrc
IDL attribute from script will return a new absolute URL that might no longer correspond to the image being shown.
2.6. Fetching resources
2.6.1. Terminology
User agents can implement a variety of transfer protocols, but this specification mostly defines behavior in terms of HTTP. [HTTP]
The HTTP GET method is equivalent to the default retrieval action of the protocol. For example, RETR in FTP. Such actions are idempotent and safe, in HTTP terms.
The HTTP response codes are equivalent to statuses in other protocols that have the same basic meanings. For example, a "file not found" error is equivalent to a 404 code, a server error is equivalent to a 5xx code, and so on.
The HTTP headers are equivalent to fields in other protocols that have the same basic meaning. For example, the HTTP authentication headers are equivalent to the authentication aspects of the FTP protocol.
A referrer source is either a Document
or a URL.
To create a potential-CORS request, given a url, corsAttributeState, and an optional same-origin fallback flag, run these steps:
-
Let mode be "
no-cors
" if corsAttributeState is No CORS, and "cors
" otherwise. -
If same-origin fallback flag is set and mode is "
no-cors
", set mode to "same-origin
". -
Let credentialsMode be "
include
". -
If corsAttributeState is Anonymous, set credentialsMode to "
same-origin
". -
Let request be a new request whose URL is url, destination is "
subresource
", mode is mode, credentials mode is credentialsMode, and whose use-URL-credentials flag is set.
2.6.2. Processing model
When a user agent is to fetch a resource or URL, optionally from an origin origin, optionally using a specific referrer source as an override referrer source, and optionally with any of a synchronous flag, a manual redirect flag, a force same-origin flag, and a block cookies flag, the following steps must be run. (When a URL is to be fetched, the URL identifies a resource to be obtained.)
-
If there is a specific override referrer source, and it is a URL, then let referrer be the override referrer source, and jump to the step labeled clean referrer.
-
Let document be the appropriate
Document
as given by the following list:- If there is a specific override referrer source
- The override referrer source.
- When navigating
- The active document of the source browsing context.
- When fetching resources for an element
- The element’s
Document
.
-
While document is an
iframe
srcdoc
document, let document be document’s browsing context’s browsing context container’sDocument
instead. -
If the origin of Document is not a scheme/host/port tuple, then set referrer to the empty string and jump to the step labeled Clean referrer.
-
Let referrer be document’s URL.
-
Clean referrer: Apply the URL parser to referrer and let parsed referrer be the resulting URL record.
-
Let referrer be the result of applying the URL serializer to parsed referrer, with the exclude fragment flag set.
-
If referrer is not the empty string, is not a
data:
URL, and is not the URL "about:blank
", then generate the address of the resource from which Request-URIs are obtained as required by HTTP for theReferer
(sic) header from referrer. [HTTP]Otherwise, the
Referer
(sic) header must be omitted, regardless of its value. -
If the algorithm was not invoked with the synchronous flag, perform the remaining steps in parallel.
-
If the
Document
with which any tasks queued by this algorithm would be associated doesn’t have an associated browsing context, then abort these steps. -
This is the main step.
If the resource is identified by an absolute URL, and the resource is to be obtained using an idempotent action (such as an HTTP GET or equivalent), and it is already being downloaded for other reasons (e.g., another invocation of this algorithm), and this request would be identical to the previous one (e.g., same
Accept
andOrigin
headers), and the user agent is configured such that it is to reuse the data from the existing download instead of initiating a new one, then use the results of the existing download instead of starting a new one.Otherwise, if the resource is identified by an absolute URL with a scheme that does not define a mechanism to obtain the resource (e.g., it is a
mailto:
URL) or that the user agent does not support, then act as if the resource was an HTTP 204 No Content response with no other metadata.Otherwise, if the resource is identified by the URL
about:blank
, then the resource is immediately available and consists of the empty string, with no metadata.Otherwise, at a time convenient to the user and the user agent, download (or otherwise obtain) the resource, applying the semantics of the relevant specifications (e.g., performing an HTTP GET or POST operation, or reading the file from disk, or expanding
data:
URLs, etc).For the purposes of the
Referer
(sic) header, use the address of the resource from which Request-URIs are obtained generated in the earlier step.For the purposes of the
Origin
header, if the fetching algorithm was explicitly initiated from an origin, then the origin that initiated the HTTP request is origin. Otherwise, this is a request from a "privacy-sensitive" context. [ORIGIN] -
If the algorithm was not invoked with the block cookies flag, and there are cookies to be set, update the cookies. [COOKIES]
-
If the fetched resource is an HTTP redirect or equivalent, then:
- If the force same-origin flag is set and the URL of the target of the redirect does not have the same origin as the URL for which the fetch algorithm was invoked
- Abort these steps and return failure from this algorithm, as if the remote host could not be contacted.
- If the manual redirect flag is set
- Continue, using the fetched resource (the redirect) as the result of the algorithm. If the calling algorithm subsequently requires the user agent to transparently follow the redirect, then the user agent must resume this algorithm from the main step, but using the target of the redirect as the resource to fetch, rather than the original resource.
- Otherwise
-
First, apply any relevant requirements for redirects (such as showing any appropriate
prompts). Then, redo main step, but using the target of the redirect as the
resource to fetch, rather than the original resource. For HTTP requests, the new request
must include the same headers as the original request, except for headers for which
other requirements are specified (such as the
Host
header). [HTTP]The HTTP specification requires that 301, 302, and 307 redirects, when applied to methods other than the safe methods, not be followed without user confirmation. That would be an appropriate prompt for the purposes of the requirement in the paragraph above. [HTTP]
-
If the algorithm was not invoked with the synchronous flag: When the resource is available, or if there is an error of some description, queue a task that uses the resource as appropriate. If the resource can be processed incrementally, as, for instance, with a progressively interlaced JPEG or an HTML file, additional tasks may be queued to process the data as it is downloaded. The task source for these tasks is the networking task source.
Otherwise, return the resource or error information to the calling algorithm.
If the user agent can determine the actual length of the resource being fetched for an
instance of this algorithm, and if that length is finite, then that length is the file’s size. Otherwise, the subject of the algorithm (that is, the resource being fetched)
has no known size. (For example, the HTTP Content-Length
header might
provide this information.)
The user agent must also keep track of the number of bytes downloaded for each instance of this algorithm. This number must exclude any out-of-band metadata, such as HTTP headers.
The navigation processing model handles redirects itself, overriding the redirection handling that would be done by the fetching algorithm.
Whether the type sniffing rules apply to the fetched resource depends on the algorithm that invokes the rules — they are not always applicable.
2.6.3. Encrypted HTTP and related security concerns
Anything in this specification that refers to HTTP also applies to HTTP-over-TLS, as represented
by URLs representing the https
scheme. [HTTP]
User agents should report certificate errors to the user and must either refuse to download resources sent with erroneous certificates or must act as if such resources were in fact served with no encryption.
User agents should warn the user that there is a potential problem whenever the user visits a page that the user has previously visited, if the page uses less secure encryption on the second visit.
Not doing so can result in users not noticing man-in-the-middle attacks.
If a user connects to a server with full encryption, but the page then refers to an external resource that has an expired certificate, then the user agent will act as if the resource was unavailable, possibly also reporting the problem to the user. If the user agent instead allowed the resource to be used, then an attacker could just look for "secure" sites that used resources from a different host and only apply man-in-the-middle attacks to that host, for example taking over scripts in the page.
If a user bookmarks a site that uses a CA-signed certificate, and then later revisits that site directly but the site has started using a self-signed certificate, the user agent could warn the user that a man-in-the-middle attack is likely underway, instead of simply acting as if the page was not encrypted.
2.6.4. Determining the type of a resource
The Content-Type metadata of a resource must be obtained and interpreted in a manner consistent with the requirements of the MIME Sniffing specification. [MIMESNIFF]
The computed type of a resource must be found in a manner consistent with the requirements given in the MIME Sniffing specification for finding the computed media type of the relevant sequence of octets. [MIMESNIFF]
The rules for sniffing images specifically and the rules for distinguishing if a resource is text or binary are also defined in the MIME Sniffing specification. Both sets of rules return a MIME type as their result. [MIMESNIFF]
It is imperative that the rules in the MIME Sniffing specification be followed exactly. When a user agent uses different heuristics for content type detection than the server expects, security problems can occur. For more details, see the MIME Sniffing specification. [MIMESNIFF]
2.6.5. Extracting character encodings from meta
elements
The algorithm for extracting a character encoding from a meta
element,
given a string s, is as follows. It either returns a character encoding or nothing.
-
Let position be a pointer into s, initially pointing at the start of the string.
-
Loop: Find the first seven characters in s after position that are an ASCII case-insensitive match for the word "
charset
". If no such match is found, return nothing and abort these steps. -
Skip any space characters that immediately follow the word "
charset
" (there might not be any). -
If the next character is not a U+003D EQUALS SIGN (=), then move position to point just before that next character, and jump back to the step labeled loop.
-
Skip any space characters that immediately follow the equals sign (there might not be any).
-
Process the next character as follows:
- If it is a U+0022 QUOTATION MARK character (") and there is a later U+0022 QUOTATION
MARK character (") in s
- If it is a U+0027 APOSTROPHE character (') and there is a later U+0027 APOSTROPHE character (') in s
- Return the result of getting an encoding from the substring that is between this character and the next earliest occurrence of this character.
- If it is an unmatched U+0022 QUOTATION MARK character (")
- If it is an unmatched U+0027 APOSTROPHE character (')
- If there is no next character
- If it is an unmatched U+0027 APOSTROPHE character (')
- Return nothing.
- Otherwise
- Return the result of getting an encoding from the substring that consists of this character up to but not including the first space character or U+003B SEMICOLON character (;), or the end of s, whichever comes first.
- If it is a U+0022 QUOTATION MARK character (") and there is a later U+0022 QUOTATION
MARK character (") in s
This algorithm is distinct from those in the HTTP specification (for example, HTTP doesn’t allow the use of single quotes and requires supporting a backslash-escape mechanism that is not supported by this algorithm). While the algorithm is used in contexts that, historically, were related to HTTP, the syntax as supported by implementations diverged some time ago. [HTTP]
2.6.6. CORS settings attributes
A CORS settings attribute is an enumerated attribute. The following table lists the keywords and states for the attribute — the keywords in the left column map to the states in the cell in the second column on the same row as the keyword.
Keyword | State | Brief description |
---|---|---|
anonymous
| Anonymous | Requests for the element will have their mode set to "cors " and
their credentials mode set to "same-origin ".
|
use-credentials
| Use Credentials | Requests for the element will have their mode set to "cors " and
their credentials mode set to "include ".
|
The empty string is also a valid keyword, and maps to the Anonymous state. The attribute’s invalid value default is the Anonymous state. For the purposes of reflection,
the canonical case for the Anonymous state is the anonymous
keyword. The missing value default, used when the attribute is omitted, is the No CORS state.
2.6.7. Referrer policy attributes
A referrer policy attribute is an enumerated attribute. Each referrer policy, including the empty string, is a keyword for this attribute, mapping to a state of the same name.
The attribute’s invalid value default and missing value default are both the empty string state.
The impact of these states on the processing model of various fetches is defined in more detail throughout this specification, in the WHATWG Fetch standard, and in Referrer Policy. [FETCH] [REFERRERPOLICY]
- First, the presence of a
noreferrer
link type; - Then, the value of a referrer policy attribute;
- Then, the presence of any
meta
element withname
attribute set toreferrer
. - Finally, the
HTTP header.Referrer-Policy
2.6.8. Nonce attributes
A nonce
content attribute represents a
cryptographic nonce ("number used once") which can be used by Content Security Policy to determine whether or not a given fetch will be allowed to proceed. The value is text. [CSP3]
Elements that have a nonce content attribute ensure that the
crytographic nonce is only exposed to script (and not to side-channels like CSS attribute
selectors) by extracting the value from the content attribute, moving it into an internal slot
named [[CryptographicNonce]]
, and exposing it to script via the HTMLOrSVGElement
interface defined below. Unless otherwise specified, the slot’s value
is the empty string.
- element . nonce
-
Returns the value of the element’s [[CryptographicNonce]] internal slot.
Can be set, to update that slot’s value.
The nonce
IDL attribute must, on
getting, return the value of this element’s [[CryptographicNonce]]; and on setting,
set this element’s [[CryptographicNonce]] to the given value.
Whenever an element including HTMLOrSVGElement
's nonce attribute is
set or changed, set this element’s [[CryptographicNonce]] to the given value.
Whenever an element including HTMLOrSVGElement
becomes connected to a browsing context, the
user agent must execute the following steps on the element:
-
Let CSP list be element’s shadow-including root’s CSP list.
-
If CSP list contains a header-delivered Content Security Policy, and element has a nonce content attribute attr whose value is not the empty string, then:
-
Set an attribute value for element using "nonce" and the empty string.
-
As each Document
's CSP list is append-only, user agents can optimize away the contains a header-delivered
Content Security Policy check by, for example, holding a flag on the Document
,
set when initializing a new document object.
The cloning steps for elements that include HTMLOrSVGElement
must set the [[CryptographicNonce]] slot on the copy
to the value of the slot on the element being cloned.
2.7. Common DOM interfaces
2.7.1. Reflecting content attributes in IDL attributes
Some IDL attributes are defined to reflect a particular content attribute. This means that on getting, the IDL attribute returns the current value of the content attribute, and on setting, the IDL attribute changes the value of the content attribute to the given value.
In general, on getting, if the content attribute is not present, the IDL attribute must act as if the content attribute’s value is the empty string; and on setting, if the content attribute is not present, it must first be added.
If a reflecting IDL attribute is a USVString
attribute whose content attribute
is defined to contain a URLs, then on getting, if the content attribute is
absent, the IDL attribute must return the empty string. Otherwise, the IDL attribute must parse the value of the content attribute relative to the element’s node document and
if that is successful, return the resulting URL string. If parsing fails, then the value of
the content attribute must be returned instead, converted to a USVString
. On setting, the content attribute must be set to the specified new
value.
If a reflecting IDL attribute is a DOMString
attribute whose content attribute is
an enumerated attribute, and the IDL attribute is limited to only known values,
then, on getting, the IDL attribute must return the conforming value associated with the state
the attribute is in (in its canonical case), if any, or the empty string if the attribute is in
a state that has no associated keyword value or if the attribute is not in a defined state (e.g.,
the attribute is missing and there is no missing value default). On setting, the
content attribute must be set to the specified new value.
If a reflecting IDL attribute is a nullable DOMString
attribute whose content
attribute is an enumerated attribute, then, on getting, if the corresponding content
attribute is in its missing value default then the IDL attribute must return null,
otherwise, the IDL attribute must return the conforming value associated with the state the
attribute is in (in its canonical case). On setting, if the new value is null, the content
attribute must be removed, and otherwise, the content attribute must be set to the specified new
value.
If a reflecting IDL attribute is a DOMString
or USVString
attribute but doesn’t fall into any of the above categories, then the getting and setting must be
done in a transparent, case-preserving manner.
If a reflecting IDL attribute is an enumeration attribute, then, on getting, if the corresponding content attribute’s value case-sensitively matches one of the enumerated values, then the IDL attribute must return the content attribute’s value; otherwise it must return the content attribute’s default value. On setting, the content attribute must be set to the specified new value.
If a reflecting IDL attribute is a boolean
attribute, then on getting the IDL
attribute must return true if the content attribute is set, and false if it is absent. On
setting, the content attribute must be removed if the IDL attribute is set to false, and must be
set to the empty string if the IDL attribute is set to true. (This corresponds to the rules for boolean content attributes.)
If a reflecting IDL attribute has a signed integer type (long
) then, on getting,
the content attribute must be parsed according to the rules for parsing signed integers,
and if that is successful, and the value is in the range of the IDL attribute’s type, the
resulting value must be returned. If, on the other hand, it fails or returns an out of range
value, or if the attribute is absent, then the default value must be returned instead, or 0 if
there is no default value. On setting, the given value must be converted to the shortest
possible string representing the number as a valid integer and then that string must be
used as the new content attribute value.
If a reflecting IDL attribute has a signed integer type (long
)
that is limited to only non-negative numbers then, on getting,
the content attribute
must be parsed according to the rules for parsing non-negative integers, and if that
is successful, and the value is in the range of the IDL attribute’s type, the resulting value
must be returned. If, on the other hand, it fails or returns an out of range value, or if the
attribute is absent, the default value must be returned instead, or -1 if there is no
default value. On setting, if the value is negative, the user agent must throw an IndexSizeError
exception. Otherwise, the given value must be converted to the
shortest possible string representing the number as a valid non-negative integer and then
that string must be used as the new content attribute value.
If a reflecting IDL attribute has an unsigned integer type (unsigned long
)
then, on getting, the content attribute must be parsed according to the rules for parsing
non-negative integers, and if that is successful, and the value is in the range 0 to
2147483647 inclusive, the resulting value must be returned. If, on the other hand, it fails or
returns an out of range value, or if the attribute is absent, the default value must be returned
instead, or 0 if there is no default value. On setting, first, if the new value is in the range
0 to 2147483647, then let n be the new value, otherwise let n be the
default value, or 0 if there is no default value; then, n must be converted to the
shortest possible string representing the number as a valid non-negative integer and that
string must be used as the new content attribute value.
If a reflecting IDL attribute has an unsigned integer type (unsigned long
) that is limited to only non-negative numbers greater than zero, then the
behavior is similar
to the previous case, but zero is not allowed. On getting, the content attribute must first be
parsed according to the rules for parsing non-negative integers, and if that is
successful, and the value is in the range 1 to 2147483647 inclusive, the resulting value must be
returned. If, on the other hand, it fails or returns an out of range value, or if the attribute
is absent, the default value must be returned instead, or 1 if there is no default value. On
setting, if the value is zero, the user agent must throw an IndexSizeError
exception. Otherwise, first, if the new value is in the range 1 to 2147483647, then let n be the new value, otherwise let n be the default value, or 1 if there is
no default value; then, n must be converted to the shortest possible string
representing the number as a valid non-negative integer and that string must be used as
the new content attribute value.
If a reflecting IDL attribute has a floating-point number type (double
or unrestricted double
), then, on getting, the content attribute must be parsed
according to the rules for parsing floating-point number values, and if that is
successful, the resulting value must be returned. If, on the other hand, it fails, or if the
attribute is absent, the default value must be returned instead, or 0.0 if there is no default
value. On setting, the given value must be converted to the best representation of the number as a floating-point number and then that string must be used as the new content attribute value.
If a reflecting IDL attribute has a floating-point number type (double
or unrestricted double
) that is limited to numbers greater than zero, then
the behavior is similar to the previous case, but zero and negative values are not allowed. On
getting, the content attribute must be parsed according to the rules for parsing
floating-point number values, and if that is successful and the value is greater than 0.0,
the resulting value must be returned. If, on the other hand, it fails or returns an out of range
value, or if the attribute is absent, the default value must be returned instead, or 0.0 if
there is no default value. On setting, if the value is less than or equal to zero, then the
value must be ignored. Otherwise, the given value must be converted to the best representation of the number as a floating-point number and then that string must be used as the new content attribute value.
The values Infinity and Not-a-Number (NaN) values throw an exception on setting, as defined in the Web IDL specification. [WEBIDL]
If a reflecting IDL attribute has the type DOMTokenList
, then on getting it must return a DOMTokenList
object whose associated element is the element in question and whose associated
attribute’s local name is the name of the attribute in question.
If a reflecting IDL attribute has the type HTMLElement
, or an interface that
descends from HTMLElement
, then, on getting, it must run the following algorithm
(stopping at the first point where a value is returned):
-
If the corresponding content attribute is absent, then the IDL attribute must return null.
-
Let candidate be the element that the
document.getElementById()
method would find when called on the content attribute’s element’s node document if it were passed as its argument the current value of the corresponding content attribute. -
If candidate is null, or if it is not type-compatible with the IDL attribute, then the IDL attribute must return null.
-
Otherwise, it must return candidate.
On setting, if the given element has an id
attribute, and has the same tree as the element of the attribute being set, and the given element is the
first element in that tree whose ID is the value of that id
attribute, then the content attribute must be set to the value of that id
attribute. Otherwise, the content attribute must be set to the empty string.
2.7.2. Collections
The HTMLFormControlsCollection
and HTMLOptionsCollection
interfaces are collections derived from the HTMLCollection
interface. The HTMLAllCollection
however, is independent as it has a variety of unique quirks that are not
desirable to inherit from HTMLCollection
.
2.7.2.1. The HTMLAllCollection
interface
The HTMLAllCollection
interface is used for the legacy document.all
attribute. It operates similarly to HTMLCollection
; it also supports a variety of
other legacy features required for web compatibility such as the ability to be invoked like a
function (legacycaller
).
All HTMLAllCollection
objects are rooted at a Document
and have a filter that
matches all elements, so the elements represented by the collection of an HTMLAllCollection
object consist of all the descendant elements of the root Document
.
[LegacyUnenumerableNamedProperties] interfaceHTMLAllCollection
{ readonly attribute unsigned long length; getter Element (unsigned longindex
); getter (HTMLCollection or Element)? namedItem(DOMStringname
); legacycaller (HTMLCollection or Element)? item(optional DOMStringnameOrItem
); };
- collection .
length
- Returns the number of elements in the collection.
- element = collection .
item
(index)- element = collection(index)
- element = collection[index]
- element = collection(index)
- Returns the item with index index from the collection (determined by tree order.
- element = collection .
item
(name)- collection = collection .
item
(name)- element = collection .
namedItem
(name)- collection = collection .
namedItem
(name)- element = collection(name)
- collection = collection(name)
- element = collection[name]
- collection = collection[name]
- collection = collection .
-
Returns the item with ID or name name from the collection.
If there are multiple matching items, then an
HTMLCollection
object containing all those elements is returned.The
name
attribute’s value provides a name forbutton
,input
,select
, andtextarea
. Similarly,iframe
'sname
,object
'sname
,meta
'sname
,map
'sname
, andform
'sname
attribute’s value provides a name for their respective elements. Only the elements mentioned have a name for the purpose of this method.
The object’s supported property indices are as defined for HTMLCollection
objects.
The supported property names consist of the non-empty values of all the id
and name attributes of all the elements represented by the collection, in tree order, ignoring later duplicates, with the id
of an element preceding its name if it
contributes both, they differ from each other, and neither is the duplicate of an earlier entry.
On getting, the length
attribute must
return the number of nodes represented by the collection.
The indexed property getter must return the result of getting the "all"-indexed element from this HTMLAllCollection
given the passed index.
The namedItem(name)
method
must return the result of getting the "all"-named element or elements from this HTMLAllCollection
given name.
The item(nameOrIndex)
method
must perform the following steps:
-
If nameOrIndex was not provided, return null.
-
Return the result of getting the "all"-named element or elements from this
HTMLAllCollection
given nameOrIndex.
The following elements are considered "all"-named elements: a
, button
, embed
, form
, frame
, frameset
, iframe
, img
, input
, map
, meta
, object
, select
, and textarea
.
To get the "all"-indexed element from an HTMLAllCollection
collection given an index index, return the element
with index index in collection, or null if there is no such element at index.
To get the "all"-named element or elements from an HTMLAllCollection
collection given a name name, run the
following algorithm:
-
If name is the empty string, return null.
-
Let subCollection be an
HTMLCollection
object rooted at the sameDocument
as collection, whose filter matches only elements that are either:-
"all"-named elements with a name attribute equal to name, or,
-
elements with an ID equal to name.
-
-
If there is exactly one element in subCollection, then return that element.
-
Otherwise, if subCollection is empty, return null.
-
Otherwise, return subCollection.
2.7.2.2. The HTMLFormControlsCollection
interface
The HTMLFormControlsCollection
interface is used for collections of listed elements in form
elements.
interfaceHTMLFormControlsCollection
: HTMLCollection { // inherits length and item() getter (RadioNodeList or Element)? namedItem(DOMStringname
); // shadows inherited namedItem() };
interface RadioNodeList
: NodeList {
attribute DOMString value;
};
- collection .
length
- Returns the number of elements in the collection.
- element = collection .
item
(index)- element = collection[index]
- Returns the item with index index from the collection. The items are sorted in tree order.
- element = collection .
namedItem
(name)- radioNodeList = collection .
namedItem
(name)- element = collection[name]
- radioNodeList = collection[name]
- radioNodeList = collection .
-
Returns the item with ID or
name
name from the collection.If there are multiple matching items, then a
RadioNodeList
object containing all those elements is returned. - radioNodeList .
value
[ = value ] -
Returns the value of the first checked radio button represented by the object.
Can be set, to check the first radio button with the given value represented by the object.
The object’s supported property indices are as defined for HTMLCollection
objects.
The supported property names consist of the non-empty values of all the id
and name
attributes of all the elements represented by the collection, in tree order, ignoring later duplicates, with the id
of an element preceding
its name
if it contributes both, they differ from each other, and neither is the
duplicate of an earlier entry.
The properties exposed in this way must be unenumerable.
The namedItem(name)
method must act according to the
following algorithm:
-
If name is the empty string, return null and stop the algorithm.
-
If, at the time the method is called, there is exactly one node in the collection that has either an
id
attribute or aname
attribute equal to name, then return that node and stop the algorithm. -
Otherwise, if there are no nodes in the collection that have either an
id
attribute or aname
attribute equal to name, then return null and stop the algorithm. -
Otherwise, create a new
RadioNodeList
object representing a live view of theHTMLFormControlsCollection
object, further filtered so that the only nodes in theRadioNodeList
object are those that have either anid
attribute or aname
attribute equal to name. The nodes in theRadioNodeList
object must be sorted in tree order. -
Return that
RadioNodeList
object.
Members of the RadioNodeList
interface inherited from the NodeList
interface must behave as they would on a NodeList
object.
The value
IDL attribute on the RadioNodeList
object, on
getting, must return the value returned by running the following steps:
-
Let element be the first element in tree order represented by the
RadioNodeList
object that is aninput
element whosetype
attribute is in theRadio Button
state and whose checkedness is true. Otherwise, let it be null. -
If element is null, return the empty string.
-
If element is an element with no
value
attribute, return the string "on
". -
Otherwise, return the value of element’s
value
attribute.
On setting, the value
IDL attribute must run the following steps:
-
If the new value is the string "
on
": let element be the first element in tree order represented by theRadioNodeList
object that is aninput
element whosetype
attribute is in theRadio Button
state and whosevalue
content attribute is either absent, or present and equal to the new value, if any. If no such element exists, then instead let element be null.Otherwise: let element be the first element in tree order represented by the
RadioNodeList
object that is aninput
element whosetype
attribute is in theRadio Button
state and whosevalue
content attribute is present and equal to the new value, if any. If no such element exists, then instead let element be null. -
If element is not null, then set its checkedness to true.
2.7.2.3. The HTMLOptionsCollection
interface
The HTMLOptionsCollection
interface is used for collections of option
elements. It is always rooted on a select
element and has
attributes and methods that manipulate that element’s descendants.
interfaceHTMLOptionsCollection
: HTMLCollection { // inherits item(), namedItem() attribute unsigned long length; // shadows inherited length setter void (unsigned longindex
, HTMLOptionElement?option
); void add((HTMLOptionElement or HTMLOptGroupElement)element
, optional (HTMLElement or long)?before
= null); void remove(longindex
); attribute long selectedIndex; };
- collection .
length
[ = value ] -
Returns the number of elements in the collection.
When set to a smaller number, truncates the number of
option
elements in the corresponding container.When set to a greater number, adds new blank
option
elements to that container. - element = collection .
item
(index)- element = collection[index]
- Returns the item with index index from the collection. The items are sorted in tree order.
- collection[index] = element
-
When index is a greater number than the number of items in the collection, adds
new blank
option
elements in the corresponding container.When set to null, removes the item at index index from the collection.
When set to an
option
element, adds or replaces it at index index from the collection. - element = collection .
namedItem
(name)- element = collection[name]
-
Returns the item with ID or
name
name from the collection.If there are multiple matching items, then the first is returned.
- collection .
add
(element [, before ] ) -
Inserts element before the node given by before.
The before argument can be a number, in which case element is inserted before the item with that number, or an element from the collection, in which case element is inserted before that element.
If before is omitted, null, or a number out of range, then element will be added at the end of the list.
This method will throw a
HierarchyRequestError
exception if element is an ancestor of the element into which it is to be inserted. - collection .
remove
(index) - Removes the item with index index from the collection.
- collection .
selectedIndex
[ = value ] -
Returns the index of the first selected item, if any, or -1 if there is no selected
item.
Can be set, to change the selection.
The object’s supported property indices are as defined for HTMLCollection
objects.
On getting, the length
attribute
must return the number of nodes represented by the collection.
On setting, the behavior depends on whether the new value is equal to, greater than, or less than
the number of nodes represented by the collection at that time. If the number is the same,
then setting the attribute must do nothing. If the new value is greater, then n new option
elements with no attributes and no child nodes must be appended to the select
element on which the HTMLOptionsCollection
is rooted, where n is the difference between the two numbers (new value minus old value). Mutation
events must be fired as if a DocumentFragment
containing the new option
elements had been inserted. If the new value is lower, then the last n nodes in the
collection must be removed from their parent nodes, where n is the difference between
the two numbers (old value minus new value).
Setting length
never removes or adds any optgroup
elements, and
never adds new children to existing optgroup
elements (though it can remove children from
them).
The supported property names consist of the non-empty values of all the id
and name
attributes of all the elements represented by the collection, in tree order, ignoring later duplicates, with the id
of an element preceding its name
if it contributes both, they differ from each other, and neither is the
duplicate of an earlier entry.
The properties exposed in this way must be unenumerable.
When the user agent is to set the value of a new indexed property or set the value of an existing indexed property for a given property index index to a new value value, it must run the following algorithm:
-
If value is null, invoke the steps for the
remove
method with index as the argument, and abort these steps. -
Let length be the number of nodes represented by the collection.
-
Let n be index minus length.
-
If n is greater than zero, then append a
DocumentFragment
consisting of n-1 newoption
elements with no attributes and no child nodes to theselect
element on which theHTMLOptionsCollection
is rooted. -
If n is greater than or equal to zero, append value to the
select
element. Otherwise, replace the indexth element in the collection by value.
The add(element, before)
method must act according
to the following algorithm:
-
If element is an ancestor of the
select
element on which theHTMLOptionsCollection
is rooted, then throw aHierarchyRequestError
exception and abort these steps. -
If before is an element, but that element isn’t a descendant of the
select
element on which theHTMLOptionsCollection
is rooted, then throw aNotFoundError
exception and abort these steps. -
If element and before are the same element, then return and abort these steps.
-
If before is a node, then let reference be that node. Otherwise, if before is an integer, and there is a beforeth node in the collection, let reference be that node. Otherwise, let reference be null.
-
If reference is not null, let parent be the parent node of reference. Otherwise, let parent be the
select
element on which theHTMLOptionsCollection
is rooted. -
Pre-insert element into parent node before reference.
The remove(index)
method
must act according to the following algorithm:
-
If the number of nodes represented by the collection is zero, abort these steps.
-
If index is not a number greater than or equal to 0 and less than the number of nodes represented by the collection, abort these steps.
-
Let element be the indexth element in the collection.
-
Remove element from its parent node.
The selectedIndex
IDL attribute must
act like the identically named attribute on the select
element on which the HTMLOptionsCollection
is rooted
2.7.3. The DOMStringList
interface
The DOMStringList
interface is a non-fashionable retro way of
representing a list of strings.
interface DOMStringList { readonly attribute unsigned long length; getter DOMString? item(unsigned longindex
); boolean contains(DOMStringstring
); };
New APIs must use sequence<DOMString>
or equivalent rather than DOMStringList
.
- strings .
length
-
Returns the number of strings in strings.
- strings[index]
- strings .
item()
(index) - strings .
-
Returns the string with index index from strings.
- strings .
contains()
(string) -
Returns true if strings contains string, and false otherwise.
Each DOMStringList
object has an associated list.
The supported property indices for a DOMStringList
object are the numbers zero to the
associated list’s size minus one. If its associated list is empty, it has no supported property indices.
The length
attribute’s getter must this DOMStringList
object’s associated list’s size.
The item(index)
method,
when invoked, must return the indexth item in this DOMStringList
object’s associated list,
or null if index plus one is less than this DOMStringList
object’s associated list’s size.
The contains(string)
method, when invoked, must return true if this DOMStringList
object’s associated list contains string, and false otherwise.
2.7.4. Garbage collection
There is an implied strong reference from any IDL attribute that returns a pre-existing object to that object.
window.document
attribute on the Window
object means that there is a strong reference
from a Window
object to its Document
object. Similarly, there is
always a strong reference from a Document
to any descendant nodes, and from any
node to its owner node document. 2.8. Namespaces
The HTML namespace is: http://www.w3.org/1999/xhtml
The MathML namespace is: http://www.w3.org/1998/Math/MathML
The SVG namespace is: http://www.w3.org/2000/svg
The XLink namespace is: http://www.w3.org/1999/xlink
The XML namespace is: http://www.w3.org/XML/1998/namespace
The XMLNS namespace is: http://www.w3.org/2000/xmlns/
Data mining tools and other user agents that perform operations on content without running scripts, evaluating CSS or XPath expressions, or otherwise exposing the resulting DOM to arbitrary content, may "support namespaces" by just asserting that their DOM node analogs are in certain namespaces, without actually exposing the above strings.
In the HTML syntax, namespace prefixes and namespace declarations do not have the same effect as in XML. For instance, the colon has no special meaning in HTML element names.
2.9. Safe passing of structured data
This section uses the terminology and typographic conventions from the JavaScript specification. [ECMA-262]
2.9.1. Serializable objects
Serializable objects support being serialized, and later deserialized, in a way
that is independent of any given JavaScript Realm. This allows them to be stored on
disk and later restored, or cloned across Document
and Worker
boundaries (including across
documents of different origins or in different event loops).
Not all objects are serializable objects, and not all aspects of objects that are serializable objects are necessarily preserved when they are serialized.
Platform objects can be serializable objects if they implement only interfaces decorated with the [Serializable]
IDL extended attribute. Such interfaces must also define the following algorithms:
- serialization steps, taking a platform object value, a Record serialized, and a boolean forStorage
-
A set of steps that serializes the data in value into fields of serialized. The resulting data serialized into serialized must be independent of any JavaScript Realm.
These steps may throw an exception if serialization is not possible.
These steps may perform a sub-serialization to serialize nested data structures. They should not call StructuredSerialize directly, as doing so will omit the important memory argument.
The introduction of these steps should omit mention of the forStorage argument if it is not relevant to the algorithm.
- deserialization steps, taking a Record serialized and a platform object value
-
A set of steps that deserializes the data in serialized, using it to set up value as appropriate. value will be a newly-created instance of the platform object type in question, with none of its internal data set up; setting that up is the job of these steps.
These steps may throw an exception if deserialization is not possible.
These steps may perform a sub-deserialization to deserialize nested data structures. They should not call StructuredDeserialize directly, as doing so will omit the important targetRealm and memory arguments.
It is up to the definition of individual platform objects to determine what data is serialized and deserialized by these steps. Typically the steps are very symmetric.
The [Serializable]
extended attribute must take no
arguments, and must not appear on anything other than an interface. It must appear only once on an
interface. It must not be used on a callback interface. If it appears on a partial interface or an
interface that is really a mixin, then it must also appear on the original or mixed-in-to
interface, and any supplied serialization steps and deserialization steps for the partial interface or mixin should be understood as being appended to those of
the original or mixed-in-to interface.
Person
, which had
associated with it two pieces of associated data:
-
a name value, which is a string;
-
and a best friend value, which is either another
Person
instance or null
We could then define Person
instances to be serializable objects by
annotating the Person
interface with the [Serializable]
extended attribute, and defining the following accompanying algorithms:
- serialization steps
-
-
Set serialized.[[Name]] to value’s associated name value.
-
Let serializedBestFriend be the sub-serialization of value’s associated best friend value.
-
Set serialized.[[BestFriend]] to serializedBestFriend.
-
- deserialization steps
-
-
Set value’s associated name value to serialized.[[Name]].
-
Let deserializedBestFriend be the sub-deserialization of serialized.[[BestFriend]].
-
Set value’s associated best friend value to deserializedBestFriend.
-
Objects defined in the JavaScript specification are handled by the StructuredSerialize abstract operation directly.
Originally, this specification defined the concept of "cloneable objects", which could be cloned from one JavaScript Realm to another. However, to better specify the behavior of certain more complex situations, the model was updated to make the serialization and deserialization explicit.
2.9.2. Transferable objects
Transferable objects support being transferred across event loops. Transferring is effectively recreating the object while sharing a reference to the underlying data and then detaching the object being transferred. This is useful to transfer ownership of expensive resources. Not all objects are transferable objects and not all aspects of objects that are transferable objects are necessarily preserved when transferred.
Transferring is an irreversible and non-idempotent operation. Once an object has been transferred, it cannot be transferred, or indeed used, again.
Platform objects can be transferable objects if they implement only interfaces decorated with the [Transferable]
IDL extended attribute. Such interfaces must also define the following algorithms:
- transfer steps, taking a platform object value and a Record dataHolder
-
A set of steps that transfers the data in value into fields of dataHolder. The resulting data held in dataHolder must be independent of any JavaScript Realm.
These steps may throw an exception if transferral is not possible.
- transfer-receiving steps, taking a Record dataHolder and a platform object value
-
A set of steps that receives the data in dataHolder, using it to set up value as appropriate. value will be a newly-created instance of the platform object type in question, with none of its internal data set up; setting that up is the job of these steps.
These steps may throw an exception if it is not possible to receive the transfer.
It is up to the definition of individual platform objects to determine what data is transferred by these steps. Typically the steps are very symmetric.
The [Transferable]
extended attribute must take no
arguments, and must not appear on anything other than an interface. It must appear only once on an
interface. It must not be used on a callback interface. If it appears on a partial interface or an
interface that is really a mixin, then it must also appear on the original or mixed-in-to
interface, and any supplied serialization steps and deserialization steps for the partial interface or mixin should be understood as being appended to those of
the original or mixed-in-to interface.
Platform objects that are transferable objects have a [[Detached]]
internal slot.
This is used to ensure that once a platform object has been transferred, it cannot be transferred again.
Objects defined in the JavaScript specification are handled by the StructuredSerializeWithTransfer abstract operation directly.
2.9.3. StructuredSerializeInternal ( value, forStorage [ , memory ] )
The StructuredSerializeInternal abstract operation takes as input a JavaScript value value and serializes it to a Realm-independent form, represented here as a Record. This serialized form has all the information necessary to later deserialize into a new JavaScript value in a different Realm.
This process can throw an exception, for example when trying to serialize un-serializable objects.
-
If memory was not supplied, let memory be an empty map.
The purpose of the memory map is to avoid serializing objects twice. This ends up preserving cycles and the identity of duplicate objects in graphs.
-
If memory[value] exists, then return memory[value].
-
Let deep be false.
-
If Type(value) is Undefined, Null, Boolean, String, or Number, then return { [[Type]]: "primitive", [[Value]]: value }.
-
If Type(value) is Symbol, then throw a "
DataCloneError
"DOMException
. -
Let serialized be an uninitialized value.
-
If value has a [[BooleanData]] internal slot, then set serialized to { [[Type]]: "Boolean", [[BooleanData]]: value.[[BooleanData]] }.
-
Otherwise, if value has a [[NumberData]] internal slot, then set serialized to { [[Type]]: "Number", [[NumberData]]: value.[[NumberData]] }.
-
Otherwise, if value has a [[StringData]] internal slot, then set serialized to { [[Type]]: "String", [[StringData]]: value.[[StringData]] }.
-
Otherwise, if value has a [[DateValue]] internal slot, then set serialized to { [[Type]]: "Date", [[DateValue]]: value.[[DateValue]] }.
-
Otherwise, if value has a [[RegExpMatcher]] internal slot, then set serialized to { [[Type]]: "RegExp", [[RegExpMatcher]]: value.[[RegExpMatcher]], [[OriginalSource]]: value.[[OriginalSource]], [[OriginalFlags]]: value.[[OriginalFlags]] }.
-
Otherwise, if value has an [[ArrayBufferData]] internal slot, then:
-
Let size be value.[[ArrayBufferByteLength]].
-
If ! IsSharedArrayBuffer(value) is true, then:
-
If forStorage is true, then throw a "
DataCloneError
"DOMException
. -
Set serialized to { [[Type]]: "SharedArrayBuffer", [[ArrayBufferData]]: value.[[ArrayBufferData]], [[ArrayBufferByteLength]]: size, [[AgentCluster]]: the current Realm Record’s corresponding agent cluster }.
-
-
Otherwise:
-
If ! IsDetachedBuffer(value) is true, then throw a "
DataCloneError
"DOMException
. -
Let dataCopy be ? CreateByteDataBlock(size).
This can throw a
RangeError
exception upon allocation failure. -
Perform ! CopyDataBlockBytes(dataCopy, 0, value.[[ArrayBufferData]], 0, size).
-
Set serialized to { [[Type]]: "ArrayBuffer", [[ArrayBufferData]]: dataCopy, [[ArrayBufferByteLength]]: size }.
-
-
-
Otherwise, if value has a [[ViewedArrayBuffer]] internal slot, then:
-
Let buffer be the value of value’s [[ViewedArrayBuffer]] internal slot.
-
Let bufferSerialized be ? StructuredSerializeInternal(buffer, forStorage, memory).
-
Assert: bufferSerialized.[[Type]] is "ArrayBuffer".
-
If value has a [[DataView]] internal slot, then set serialized to { [[Type]]: "ArrayBufferView", [[Constructor]]: "DataView", [[ArrayBufferSerialized]]: bufferSerialized, [[ByteLength]]: value.[[ByteLength]], [[ByteOffset]]: value.[[ByteOffset]] }.
-
Otherwise:
-
Assert: value has a [[TypedArrayName]] internal slot.
-
Set serialized to { [[Type]]: "ArrayBufferView", [[Constructor]]: value.[[TypedArrayName]], [[ArrayBufferSerialized]]: bufferSerialized, [[ByteLength]]: value.[[ByteLength]], [[ByteOffset]]: value.[[ByteOffset]], [[ArrayLength]]: value.[[ArrayLength]] }.
-
-
-
Otherwise, if value has [[MapData]] internal slot, then:
-
Set serialized to { [[Type]]: "Map", [[MapData]]: a new empty List }.
-
Set deep to true.
-
-
Otherwise, if value has [[SetData]] internal slot, then:
-
Set serialized to { [[Type]]: "Set", [[SetData]]: a new empty List }.
-
Set deep to true.
-
-
Otherwise, if value is an Array exotic object, then:
-
Let valueLenDescriptor be ? OrdinaryGetOwnProperty(value, "
length
"). -
Let valueLen be valueLenDescriptor.[[Value]].
-
Set serialized to { [[Type]]: "Array", [[Length]]: valueLen, [[Properties]]: a new empty List }.
-
Set deep to true.
-
-
Otherwise, if value is a platform object that is a serializable object:
-
If value has a [[Detached]] internal slot whose value is true, then throw a "
DataCloneError
"DOMException
. -
Let typeString be the identifier of the primary interface of value.
-
Set serialized to { [[Type]]: typeString }.
-
Set deep to true.
-
-
Otherwise, if value is a platform object, then throw a "
DataCloneError
"DOMException
. -
Otherwise, if IsCallable(value) is true, then throw a "
DataCloneError
"DOMException
. -
Otherwise, if value has any internal slot other than [[Prototype]] or [Extensible], then throw a "
DataCloneError
"DOMException
.For instance, a [[PromiseState]] or [[WeakMapData]] internal slot.
-
Otherwise, if value is an exotic object, then throw a "
DataCloneError
"DOMException
. -
Otherwise:
-
Set serialized to { [[Type]]: "Object", [[Properties]]: a new empty List }.
-
Set deep to true.
-
-
Set memory[value] to serialized.
-
If deep is true, then:
-
If value has a [[MapData]] internal slot, then:
-
Let copiedList be a new empty List.
-
For each Record { [[Key]], [[Value]] } entry of value.[[MapData]]:
-
For each Record { [[Key]], [[Value]] } entry of copiedList:
-
Let serializedKey be ? StructuredSerializeInternal(entry.[[Key]], forStorage, memory).
-
Let serializedValue be ? StructuredSerializeInternal(entry.[[Value]], forStorage, memory).
-
Append { [[Key]]: serializedKey, [[Value]]: serializedValue } to serialized.[[MapData]].
-
-
-
Otherwise, if value has a [[SetData]] internal slot, then:
-
Let copiedList be a new empty List.
-
For each entry of value.[[SetData]]:
-
If entry is not the special value empty, append entry to copiedList.
-
-
For each entry of copiedList:
-
Let serializedEntry be ? StructuredSerializeInternal(entry, forStorage, memory).
-
Append serializedEntry to serialized.[[SetData]].
-
-
-
Otherwise, if value is a platform object that is a serializable object, then perform the appropriate serialization steps given value, serialized, and forStorage.
The serialization steps may need to perform a sub-serialization. This is an operation which takes as input a value subValue, and returns StructuredSerializeInternal(subValue, forStorage, memory). (In other words, a sub-serialization is a specialization of StructuredSerializeInternal to be consistent within this invocation.)
-
Otherwise:
-
Let enumerableKeys be a new empty List.
-
For each key in ! value.[[OwnPropertyKeys]]():
-
For each key in enumerableKeys:
-
If ! HasOwnProperty(value, key) is true, then:
-
Let inputValue be ? value.[[Get]](key, value).
-
Let outputValue be ? StructuredSerializeInternal(inputValue, forStorage, memory).
-
Append { [[Key]]: key, [[Value]]: outputValue } to serialized.[[Properties]].
-
-
-
The key collection performed above is very similar to the JavaScript specification’s EnumerableOwnProperties operation, but crucially it uses the deterministic ordering provided by the [[OwnPropertyKeys]] internal method, instead of reordering the keys in an unspecified manner as EnumerableOwnProperties does. [ECMA-262]
-
-
Return serialized.
const o = {};o.myself = o;
it produces the following result:
{ \[[Type]]: "Object", \[[Properties]]: « { \[[Key]]: "myself", \[[Value]]: <a pointer to this whole structure> } » }
2.9.4. StructuredSerialize ( value )
-
Return ? StructuredSerializeInternal(value, false).
2.9.5. StructuredSerializeForStorage ( value )
-
Return ? StructuredSerializeInternal(value, true).
2.9.6. StructuredDeserialize ( serialized, targetRealm [ , memory ] )
The StructuredDeserialize abstract operation takes as input a Record serialized, which was previously produced by StructuredSerialize or StructuredSerializeForStorage, and deserializes it into a new JavaScript value, created in targetRealm.
This process can throw an exception, for example when trying to allocate memory for the new
objects (especially ArrayBuffer
objects).
-
If memory was not supplied, let memory be an empty map.
The purpose of the memory map is to avoid deserializing objects twice. This ends up preserving cycles and the identity of duplicate objects in graphs.
-
If memory[serialized] exists, then return memory[serialized].
-
Let deep be false.
-
Let value be an uninitialized value.
-
If serialized contains a [[TransferConsumed]] field, then:
-
Assert: serialized.[[TransferConsumed]] is false. (It must be impossible to get in a situation where StructuredDeserialize is being called multiple times on the same serialization, if that serialization contains transfer data holders.)
-
Set serialized.[[TransferConsumed]] to true.
-
If serialized.[[Type]] is "ArrayBuffer", then set value to a new ArrayBuffer object in targetRealm whose [[ArrayBufferData]] internal slot value is serialized.[[ArrayBufferData]], and whose [[ArrayBufferByteLength]] internal slot value is serialized.[[ArrayBufferByteLength]].
In cases where the original memory occupied by [[ArrayBufferData]] is accessible during the deserialization, this step is unlikely to throw an exception, as no new memory needs to be allocated: the memory occupied by [[ArrayBufferData]] is instead just getting transferred into the new ArrayBuffer. This could be true, for example, when both the source and target Realms are in the same process.
-
Otherwise:
-
Let interfaceName be serialized.[[Type]].
-
If the interface identified by interfaceName is not exposed in targetRealm, then throw a "
DataCloneError
"DOMException
. -
Set value to a new instance of the interface identified by interfaceName, created in targetRealm.
-
Perform the appropriate transfer-receiving steps for the interface identified by interfaceName given serialized and value.
-
-
-
Otherwise, if serialized.[[Type]] is "primitive", then set value to serialized.[[Value]].
-
Otherwise, if serialized.[[Type]] is "Boolean", then set value to a new Boolean object in targetRealm whose [[BooleanData]] internal slot value is serialized.[[BooleanData]].
-
Otherwise, if serialized.[[Type]] is "Number", then set value to a new Number object in targetRealm whose [[NumberData]] internal slot value is serialized.[[NumberData]].
-
Otherwise, if serialized.[[Type]] is "String", then set value to a new String object in targetRealm whose [[StringData]] internal slot value is serialized.[[StringData]].
-
Otherwise, if serialized.[[Type]] is "Date", then set value to a new Date object in targetRealm whose [[DateValue]] internal slot value is serialized.[[DateValue]].
-
Otherwise, if serialized.[[Type]] is "RegExp", then set value to a new RegExp object in targetRealm whose [[RegExpMatcher]] internal slot value is serialized.[[RegExpMatcher]], whose [[OriginalSource]] internal slot value is serialized.[[OriginalSource]], and whose [[OriginalFlags]] internal slot value is serialized.[[OriginalFlags]].
-
Otherwise, if serialized.[[Type]] is "SharedArrayBuffer", then:
-
If targetRealm’s corresponding agent cluster is not serialized.[[AgentCluster]], then throw a "
DataCloneError
"DOMException
. -
Otherwise, set value to a new SharedArrayBuffer object in targetRealm whose [[ArrayBufferData]] internal slot value is serialized.[[ArrayBufferData]] and whose [[ArrayBufferByteLength]] internal slot value is serialized.[[ArrayBufferByteLength]].
-
-
Otherwise, if serialized.[[Type]] is "ArrayBuffer", then set value to a new ArrayBuffer object in targetRealm whose [[ArrayBufferData]] internal slot value is serialized.[[ArrayBufferData]], and whose [[ArrayBufferByteLength]] internal slot value is serialized.[[ArrayBufferByteLength]].
If this throws an exception, then throw a "
DataCloneError
"DOMException
.This step might throw an exception if there is not enough memory available to create such an ArrayBuffer object.
-
Otherwise, if serialized.[[Type]] is "ArrayBufferView", then:
-
Let deserializedArrayBuffer be ? StructuredDeserialize(serialized.[[ArrayBufferSerialized]], targetRealm, memory).
-
If serialized.[[Constructor]] is "DataView", then set value to a new DataView object in targetRealm whose [[ViewedArrayBuffer]] internal slot value is deserializedArrayBuffer, whose [[ByteLength]] internal slot value is serialized.[[ByteLength]], and whose [[ByteOffset]] internal slot value is serialized.[[ByteOffset]].
-
Otherwise, set value to a new typed array object in targetRealm, using the constructor given by serialized.[[Constructor]], whose [[ViewedArrayBuffer]] internal slot value is deserializedArrayBuffer, whose \[TypedArrayName]] internal slot value is serialized.[[Constructor]], whose [[ByteLength]] internal slot value is serialized.[[ByteLength]], whose [[ByteOffset]] internal slot value is serialized.[[ByteOffset]], and whose [[ArrayLength]] internal slot value is serialized.[[ArrayLength]].
-
-
Otherwise, if serialized.[[Type]] is "Map", then:
-
Set value to a new Map object in targetRealm whose [[MapData]] internal slot value is a new empty List.
-
Set deep to true.
-
-
Otherwise, if serialized.[[Type]] is "Set", then:
-
Set value to a new Set object in targetRealm whose [[SetData]] internal slot value is a new empty List.
-
Set deep to true.
-
-
Otherwise, if serialized.[[Type]] is "Array", then:
-
Let outputProto be the %ArrayPrototype% intrinsic object in targetRealm.
-
Set value to ! ArrayCreate(serialized.[[Length]], outputProto).
-
Set deep to true.
-
-
Otherwise, if serialized.[[Type]] is "Object", then:
-
Set value to a new Object in targetRealm.
-
Set deep to true.
-
-
Otherwise:
-
Let interfaceName be serialized.[[Type]].
-
If the interface identified by interfaceName is not exposed in targetRealm, then throw a "
DataCloneError
"DOMException
. -
Set value to a new instance of the interface identified by interfaceName, created in targetRealm.
-
Set deep to true.
-
-
Set memory[serialized] to value.
-
If deep is true, then:
-
If serialized.[[Type]] is "Map", then:
-
For each Record { [[Key]], [[Value]] } entry of serialized.[[MapData]]:
-
Let deserializedKey be ? StructuredDeserialize(entry.[[Key]], targetRealm, memory).
-
Let deserializedValue be ? StructuredDeserialize(entry.[[Value]], targetRealm, memory).
-
Append { [[Key]]: deserializedKey, [Value]]: deserializedValue } to value.[[MapData]].
-
-
-
Otherwise, if serialized.[[Type]] is "Set", then:
-
For each entry of serialized.[[SetData]]:
-
Let deserializedEntry be ? StructuredDeserialize(entry, targetRealm, memory).
-
Append deserializedEntry to value.[[SetData]].
-
-
-
Otherwise, if serialized.[[Type]] is "Array" or "Object", then:
-
For each Record { [[Key]], [[Value]] } entry of serialized.[[Properties]]:
-
Let deserializedValue be ? StructuredDeserialize(entry.[[Value]], targetRealm, memory).
-
Let result be ! CreateDataProperty(value, entry.[[Key]], deserializedValue).
-
Assert: result is true.
-
-
-
Otherwise:
-
Perform the appropriate deserialization steps for the interface identified by serialized.[[Type]], given serialized and value.
The deserialization steps may need to perform a sub-deserialization. This is an operation which takes as input a previously-serialized Record subSerialized, and returns StructuredDeserialize(subSerialized, targetRealm, memory). (In other words, a sub-deserialization is a specialization of StructuredDeserialize to be consistent within this invocation.)
-
-
-
Return value.
2.9.7. StructuredSerializeWithTransfer ( value, transferList )
-
Let memory be an empty map.
In addition to how it is used normally by StructuredSerializeInternal, in this algorithm memory is also used to ensure that StructuredSerializeInternal ignores items in transferList, and let us do our own handling instead.
-
For each transferable of transferList:
-
If transferable has neither an [[ArrayBufferData]] internal slot nor a [[Detached]] internal slot, then throw a "
DataCloneError
"DOMException
. -
If transferable has an [[ArrayBufferData]] internal slot and either ! IsSharedArrayBuffer(transferable) is true or ! IsDetachedBuffer(transferable) is true, then throw a "
DataCloneError
"DOMException
. -
If transferable has a [[Detached]] internal slot and transferable.[[Detached]] is true, then throw a "
DataCloneError
"DOMException
. -
Let placeholder be a user-agent-defined placeholder object.
-
Set memory[transferable] to placeholder.
-
-
Let serialized be ? StructuredSerializeInternal(value, false, memory).
-
Let transferDataHolders be a new empty List.
-
For each transferable of transferList:
-
Let placeholder be memory[transferable].
-
Let dataHolder be an uninitialized value.
-
If transferable has an [[ArrayBufferData]] internal slot, then:
-
Set dataHolder to { [[TransferConsumed]]: false, [[Type]]: "ArrayBuffer", [[ArrayBufferData]]: transferable.[[ArrayBufferData]], [[ArrayBufferByteLength]]: transferable.[[ArrayBufferByteLength]] }.
-
Perform ! DetachArrayBuffer(transferable).
-
-
Otherwise:
-
Assert: transferable is a platform object that is a transferable object.
-
Let interfaceName be the identifier of the primary interface of transferable.
-
Set dataHolder to { [[TransferConsumed]]: false, [[Type]]: interfaceName }.
-
Perform the appropriate transfer steps for the interface identified by interfaceName, given transferable and dataHolder.
-
Set transferable.[[Detached]] to true.
-
-
Within serialized, replace all instances of placeholder with dataHolder.
-
Append dataHolder to transferDataHolders.
-
-
Return { [[Serialized]]: serialized, [[TransferDataHolders]]: transferDataHolders }.
2.9.8. StructuredDeserializeWithTransfer ( serializeWithTransferResult, targetRealm )
-
Let memory be an empty map.
In addition to how it is used normally by StructuredDeserialize, in this algorithm memory is also used to help us determine the list of transferred values.
-
Let deserialized be ? StructuredDeserialize(serializeWithTransferResult.[[Serialized]], targetRealm, memory).
-
Let transferredValues be a new empty List.
-
For each transferDataHolder of serializeWithTransferResult.[[TransferDataHolders]]:
-
Append memory[transferDataHolder] to transferredValues.
-
-
Return { [[Deserialized]]: deserialized, [[TransferredValues]]: transferredValues }.
2.9.9. Performing serialization and transferring from other specifications
Other specifications may use the abstract operations defined here. The following provides some guidance on when each abstract operation is typically useful, with examples.
- StructuredSerializeWithTransfer
- StructuredDeserializeWithTransfer
-
Cloning a value to another JavaScript Realm, with a transfer list, but where the target Realm is not known ahead of time. In this case the serialization step can be performed immediately, with the deserialization step delayed until the target Realm becomes known.
messagePort.postMessage()
uses this pair of abstract operations, as the destination Realm is not known until theMessagePort
has been shipped. - StructuredSerialize
- StructuredSerializeForStorage
- StructuredDeserialize
- StructuredSerializeForStorage
-
Creating a JavaScript Realm-independent snapshot of a given value which can be saved for an indefinite amount of time, and then reified back into a JavaScript value later, possibly multiple times.
StructuredSerializeForStorage can be used for situations where the serialization is anticipated to be stored in a persistent manner, instead of passed between Realms. It throws when attempting to serialize
SharedArrayBuffer
objects, since storing shared memory does not make sense. Similarly, it can throw or possibly have different behavior when given a platform object with custom serialization steps when the forStorage argument is true.history.pushState()
andhistory.replaceState()
use StructuredSerializeForStorage on author-supplied state objects, storing them as serialized state in the appropriate session history entry. Then, StructuredDeserialize is used so that thehistory.state
property can return a clone of the originally-supplied state object.broadcastChannel.postMessage()
uses StructuredSerialize on its input, then uses StructuredDeserialize multiple times on the result to produce a fresh clone for each destination being broadcast to. Note that transferring does not make sense in multi-destination situations.Any API for persisting JavaScript values to the filesystem would also use StructuredSerializeForStorage on its input and StructuredDeserialize on its output.
In general, call sites may pass in Web IDL values instead of JavaScript values; this is to be understood to perform an implicit conversion to the JavaScript value before invoking these algorithms.
This specification used to define a "structured clone" algorithm, and more recently a StructuredClone abstract operation. However, in practice all known uses of it were better served by separate serialization and deserialization steps, so it was removed.
Call sites that are not invoked as a result of author code synchronously calling into a user agent method must take care to properly prepare to run script and prepare to run a callback before invoking StructuredSerialize, StructuredSerializeForStorage, or StructuredSerializeWithTransfer abstract operations, if they are being performed on arbitrary objects. This is necessary because the serialization process can invoke author-defined accessors as part of its final deep-serialization steps, and these accessors could call into operations that rely on the entry and incumbent concepts being properly set up.
window.postMessage()
performs StructuredSerializeWithTransfer on its arguments, but is careful to do so
immediately, inside the synchronous portion of its algorithm. Thus it is able to use the
algorithms without needing to prepare to run script and prepare to run a callback.
In contrast, a hypothetical API that used StructuredSerialize to serialize some author-supplied object periodically, directly from a task on the event loop, would need to ensure it performs the appropriate preparations beforehand. As of this time, we know of no such APIs on the platform; usually it is simpler to perform the serialization ahead of time, as a synchronous consequence of author code.
3. Semantics, structure, and APIs of HTML documents
3.1. Documents
Every XML and HTML document in an HTML UA is represented by a Document
object. [DOM]
The Document
object’s 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 fragment on
the page and when the pushState()
method is called with a new URL. [DOM]
Interactive user agents typically expose the Document
object’s 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 script using the createDocument()
or 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) 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()
and 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:
-
Let source be the value of the browsing context's active document's reload override buffer.
-
Let address be the browsing context's active document's URL.
-
Let HTTPS state be the HTTPS state of the browsing context's active document.
-
Let referrer policy be the referrer policy of the browsing context's active document.
-
Let CSP list be the CSP list of the browsing context's active document.
-
Navigate the browsing context to a new response whose body is source, header list is
Referrer-Policy/
referrer policy, CSP list is CSP list and 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 aDocument
object for this purpose, set thatDocument
'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.
3.1.1. The Document
object
The DOM specification defines a Document
interface, which this specification extends
significantly:
enumDocumentReadyState
{"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 (DOMStringname
); [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(DOMStringelementName
); readonly attribute HTMLOrSVGScriptElement? currentScript; // classic scripts in a document tree only // dynamic markup insertion Document open(optional DOMStringtype
= "text/html", optional DOMStringreplace
= ""); WindowProxy open(DOMStringurl
, DOMStringname
, DOMStringfeatures
, optional booleanreplace
= 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(DOMStringcommandId
, optional booleanshowUI
= false, optional DOMStringvalue
= ""); boolean queryCommandEnabled(DOMStringcommandId
); boolean queryCommandIndeterm(DOMStringcommandId
); boolean queryCommandState(DOMStringcommandId
); boolean queryCommandSupported(DOMStringcommandId
); DOMString queryCommandValue(DOMStringcommandId
); // special event handler IDL attributes that only apply to Document objects [LenientThis] attribute EventHandleronreadystatechange
; }; 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.
3.1.2. Resource metadata management
- document .
referrer
-
Returns the 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
noreferrer
link type can be used to block the referrer.
The referrer
attribute must return the document’s referrer.
- 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 thesandbox
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 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 URL's 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 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 URL for a
"non-HTTP" API, decoded using UTF-8 decode without BOM. [COOKIES]
On setting, if the document is a cookie-averse Document
object, then the user agent must
do nothing. Otherwise, if the Document
's 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 URL via a "non-HTTP"
API, consisting of the new value encoded as UTF-8. [COOKIES] [ENCODING]
Since the 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 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 .
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:
-
The month component of the date.
-
A U+002F SOLIDUS character (/).
-
The day component of the date.
-
A U+002F SOLIDUS character (/).
-
The year component of the date.
-
A U+0020 SPACE character.
-
The hours component of the time.
-
A U+003A COLON character (:).
-
The minutes component of the time.
-
A U+003A COLON character (:).
-
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 .
readyState
-
Returns "
loading
" while theDocument
is loading, "interactive
" once it is finished parsing but still loading sub-resources, and "complete
" once it has loaded.The
readystatechange
event fires on theDocument
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 "loading
"
if the document is associated with an HTML parser, an XML parser, or an XSLT processor,
and to the string "complete
" otherwise. Various algorithms during page
loading affect this value. When the value is set, the user agent must fire an event named 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 stopped or aborted.
The readyState
IDL attribute must, on getting,
return the current document readiness.
3.1.3. DOM tree accessors
The html
element of a document is its document element, if it’s an html
element,
and null otherwise.
- 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 .
title
[ = value ] -
Returns the document’s title, as given by the
title
element for HTML and as given by the SVGtitle
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:
-
If the document element is an SVG
svg
element, then let value be the child text content of the first SVGtitle
element that is a child of the document element. [SVG11] -
Otherwise, let value be the child text content of the
title
element, or the empty string if thetitle
element is null. -
Strip and collapse white space in value.
-
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 -
-
If there is an SVG
title
element that is a child of the document element, let element be the first such element. -
Otherwise:
-
Let element be the result of creating an element given the document element's node document, SVG
title
, and the SVG namespace. -
Insert element as the first child of the document element.
-
-
Act as if the
textContent
IDL attribute of element was set to the new value being assigned.
-
- If the document element is in the HTML namespace
-
-
If the
title
element is null and thehead
element is null, then abort these steps. -
If the
title
element is non-null, let element be thetitle
element. -
Otherwise:
-
Let element be the result of creating an element given the document element's node document,
title
, and the HTML namespace.
-
-
Act as if the
textContent
IDL attribute of element was set to the new value being assigned.
-
- Otherwise
-
Do nothing.
- document .
body
[ = value ] -
Returns the
body
element.Can be set, to replace the
body
element.If the new value is not a
body
orframeset
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:
-
If the new value is not a
body
orframeset
element, then throw a "HierarchyRequestError
"DOMException
and abort these steps. -
Otherwise, if the new value is the same as the
body
element, do nothing. Abort these steps. -
Otherwise, if the
body
element is not null, then replace thebody
element with the new value within thebody
element’s parent and abort these steps. -
Otherwise, if there is no document element, throw a "
HierarchyRequestError
"DOMException
and abort these steps. -
Otherwise, the
body
element is null, but there’s a document element. Append the new value to the document element.
- document .
images
-
Returns an
HTMLCollection
of theimg
elements in theDocument
. - document .
embeds
- document .
plugins
- document .
-
Return an
HTMLCollection
of theembed
elements in theDocument
. - document .
links
-
Returns an
HTMLCollection
of thea
andarea
elements in theDocument
that havehref
attributes. - document .
forms
-
Return an
HTMLCollection
of theform
elements in theDocument
. - document .
scripts
-
Return an
HTMLCollection
of thescript
elements in theDocument
.
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 embeds
attribute.
The links
attribute must return an HTMLCollection
rooted at the Document
node, whose filter matches only a
elements with href
attributes and area
elements with 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 .
getElementsByName
(name) -
Returns a
NodeList
of elements in theDocument
that have aname
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 .
currentScript
-
Returns the
script
element, or the SVGscript
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 ascript
element or SVGscript
element (e.g., because the running script is an event handler, or a timeout), or if the currently executingscript
or SVGscript
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 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 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 id
attributes coming before values from name
attributes when the same element contributes both:
-
the value of the
name
content attribute for all exposedembed
,form
,iframe
,img
, and exposedobject
elements that have a non-emptyname
content attribute and are in a document tree with document as their root; -
the value of the
id
content attribute for all exposedobject
elements that have a non-emptyid
content attribute and are in a document tree with document as their root; -
the value of the
id
content attribute for allimg
elements that have both a non-emptyid
content attribute and a non-emptyname
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:
-
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.
-
If elements has only one element, and that element is an
iframe
element, and thatiframe
element’s nested browsing context is not null, then return theWindowProxy
object of the element’s nested browsing context. -
Otherwise, if elements has only one element, return that element.
-
Otherwise return an
HTMLCollection
rooted at theDocument
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 exposedobject
elements that have aname
content attribute whose value is name, or -
exposed
object
elements that have anid
content attribute whose value is name, or -
img
elements that have anid
content attribute whose value is name, and that have a non-emptyname
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 dir
attribute on the Document
interface is defined along with
the dir
content attribute.
3.2. Elements
3.2.1. 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 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.
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.
<!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.
audio
element is used to play a music track. The 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>
3.2.2. 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] interfaceHTMLElement
: 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] interfaceHTMLUnknownElement
: 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:
-
If name is
applet
,bgsound
,blink
,isindex
,multicol
,nextid
, orspacer
, then returnHTMLUnknownElement
. -
If name is
acronym
,basefont
,big
,center
,nobr
,noembed
,noframes
,plaintext
,rb
,rtc
,strike
, ortt
, then returnHTMLElement
. -
If name is
listing
orxmp
, then returnHTMLPreElement
. -
Otherwise, if this specification defines an interface appropriate for the element type corresponding to the local name name, then return that interface.
-
If other applicable specifications define an appropriate interface for name, then return the interface they define.
-
If name is a valid custom element name, then return
HTMLElement
. -
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 mixinHTMLOrSVGElement
{ [SameObject] readonly attribute DOMStringMapdataset
; attribute DOMStringnonce
; [CEReactions] attribute longtabIndex
; voidfocus
(optional FocusOptionsoptions
); voidblur
(); }; HTMLElement includes HTMLOrSVGElement; SVGElement includes HTMLOrSVGElement;
3.2.3. 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 customElements
attribute of the Window
interface returns the CustomElementRegistry
object for that Window
object.
interfaceCustomElementRegistry
{ [CEReactions] voiddefine
(DOMStringname
, Functionconstructor
, optional ElementDefinitionOptionsoptions
); anyget
(DOMStringname
); Promise<void>whenDefined
(DOMStringname
); }; dictionaryElementDefinitionOptions
{ DOMStringextends
; };
Every CustomElementRegistry
has:
- a set of custom element definitions, initially empty.
In general, algorithms in this specification look up elements in the registry by any of name, local name, or
constructor
. - an element definition is running flag, used to prevent reentrant invocations of element definition. It is initially unset.
-
a when-defined promise map, mapping valid custom element names to promises. It is used to implement the
whenDefined()
method.
- 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:
-
If IsConstructor(constructor) is false, then throw a
TypeError
and abort these steps. -
If name is not a valid custom element name, then throw a "
SyntaxError
"DOMException
and abort these steps. -
If this
CustomElementRegistry
contains an entry with name name, then throw a "NotSupportedError
DOMException
and abort these steps. -
If this
CustomElementRegistry
contains an entry with constructor constructor, then throw a "NotSupportedError
"DOMException
and abort these steps. -
Let localName be name.
-
Let extends be the value of the
extends
member of options, or null if no such member exists. -
If extends is not null, then:
-
If extends is a valid custom element name, then throw a "
NotSupportedError
"DOMException
. -
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
. -
Set localName to extends.
-
-
If this
CustomElementRegistry
's element definition is running flag is set, then throw a "NotSupportedError
"DOMException
and abort these steps. -
Set this
CustomElementRegistry
's element definition is running flag. -
Run the following substeps while catching any exceptions:
-
Let prototype be Get(constructor, "prototype"). Rethrow any exceptions.
-
If Type(prototype) is not Object, then throw a
TypeError
exception. -
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. -
For each of the four keys callbackName in lifecycleCallbacks, in the order listed in the previous step:
-
Let callbackValue be
get
(prototype, callbackName). Rethrow any exceptions. -
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.
-
-
Let observedAttributes be an empty
sequence<DOMString>
. -
If the value of the entry in lifecycleCallbacks with key "
attributeChangedCallback
" is not null, then:-
Let observedAttributesIterable be Get(constructor, "observedAttributes"). Rethrow any exceptions.
-
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:
-
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.
-
-
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.
-
Add definition to this
CustomElementRegistry
. -
Let document be this
CustomElementRegistry
's relevant global object’s associatedDocument
. -
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.
-
For each element element in upgrade candidates, enqueue a custom element upgrade reaction given element and definition.
-
If this
CustomElementRegistry
's when-defined promise map contains an entry with key name:-
Let promise be the value of that entry.
-
Resolve promise with undefined.
-
Delete the entry with key name from this
CustomElementRegistry
's when-defined promise map.
-
When invoked, the get(name)
method must run these steps:
-
If this
CustomElementRegistry
contains an entry with name name, then return that entry’s constructor. -
Otherwise, return undefined.
When invoked, the {{whenDefined()|whenDefined(name)}} method must run these steps:
-
If name is not a valid custom element name, then return a new promise rejected with a "
SyntaxError
"DOMException
and abort these steps. -
If this
CustomElementRegistry
contains an entry with name name, then return a new promise resolved with undefined and abort these steps. -
Let map be this
CustomElementRegistry
's when-defined promise map. -
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.
-
Let promise be the value of the entry in map with key name.
-
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; });
3.2.4. Upgrades
To upgrade an element, given a custom element definition definition and an element element, run the following steps:
-
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. -
If element’s custom element state is "
failed
", then abort these steps. -
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. -
If element is connected, then enqueue a custom element callback reaction with element, callback name "
connectedCallback
", and an empty argument list. -
Add element to the end of definition’s construction stack.
-
Let C be definition’s constructor.
-
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. -
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. -
If constructResult is an abrupt completion, then:
-
Set element’s custom element state to "
failed
". -
Return constructResult (i.e., rethrow the exception), and terminate these steps.
-
-
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’sreturn
-override feature to return an arbitrary object from the constructor. -
Set element’s custom element state to "
custom
". -
Set element’s custom element definition to definition.
To try to upgrade an element, given as input an element element, run the following steps:
-
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.
-
If definition is not null, then enqueue a custom element upgrade reaction given element and definition.
3.2.5. Custom element reactions
A custom element can react to certain occurrences by running author code. These reactions are called custom element reactions.
-
When upgraded, its constructor is run.
-
When it becomes connected, its
connectedCallback
is run. -
When it becomes disconnected, its
disconnectedCallback
is run. -
When it is adopted into a new document, its
adoptedCallback
is run. -
When any of its attributes are changed, appended, removed, or replaced, its
attributeChangedCallback
is run.
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:
-
An upgrade reaction, which upgrades the custom element and contains a custom element definition; or
-
A callback reaction, which will call a lifecycle callback, and contains a
Function
as well as a list of arguments.
This is all summarised in the following schematic diagram:
To enqueue an element on the appropriate element queue, given an element element, run the following steps:
-
If the custom element reactions stack is empty, then:
-
Add element to the backup element queue.
-
If the processing the backup element queue flag is set, abort this algorithm.
-
Set the processing the backup element queue flag.
-
Queue a microtask to perform the following steps:
-
Invoke custom element reactions in the backup element queue.
-
Unset the processing the backup element queue flag.
-
-
-
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:
-
Let definition be element’s custom element definition.
-
Let callback be the value of the entry in definition’s lifecycle callbacks with key callbackName.
-
If callback is null, then abort these steps.
-
If callbackName is "
attributeChangedCallback
", then:-
Let attributeName be the first element of args.
-
If definition’s observed attributes does not contain attributeName, then abort these steps.
-
-
Add a new callback reaction to element’s custom element reaction queue, with callback function callback and arguments args.
-
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:
-
Add a new upgrade reaction to element’s custom element reaction queue, with custom element definition definition.
-
Enqueue an element on the appropriate element queue given element.
To invoke custom element reactions in an element queue queue, run the following steps:
-
For each custom element element in queue:
-
Let reactions be element’s custom element reaction queue.
-
Repeat until reactions is empty:
-
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.
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:
-
HTMLElement
'souterText
IDL attribute -
HTMLInputElement
'swebkitdirectory
andincremental
IDL attributes -
HTMLLinkElement
'sdisabled
andscope
IDL attributes -
ShadowRoot
'sinnerHTML
IDL attribute
3.2.6. 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
] 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.
-
Let registry be the current global object’s
CustomElementRegistry
object. -
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 areHTMLButtonElement
. If this check was not present, it would be possible to create an instance ofHTMLButtonElement
whose local name wasbad-1
. -
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).
-
If definition’s local name is equal to definition’s name (i.e., definition is for an autonomous custom element), then:
-
If the active function object is not
HTMLElement
, then throw aTypeError
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 ofBad2
, the active function object isHTMLParagraphElement
, notHTMLElement
.
-
-
Otherwise (i.e., if definition is for a customized built-in element):
-
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.
-
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 ofBad3
, valid local names is the list containingq
andblockquote
, but definition’s local name isp
, which is not in that list.
-
-
Let prototype be definition’s prototype.
-
If definition’s construction stack is empty, then:
-
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
. -
Perform element.[[\SetPrototypeOf]](prototype). Rethrow any exceptions.
-
Set element’s custom element state to "
custom
". -
Set element’s custom element definition to definition.
-
Return element.
This occurs when author script constructs a new custom element directly, e.g. via
new MyCustomElement()
. -
-
Let element be the last entry in definition’s construction stack.
-
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 callingsuper()
: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 callssuper()
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(); } }
-
Perform element.[[\SetPrototypeOf]](prototype). Rethrow any exceptions.
-
Replace the last entry in definition’s construction stack with an already constructed marker.
-
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);
3.2.7. 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
syntax, the start and end tags can be omitted. This information is redundant with the normative requirements given in the 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 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 roles, states and properties table as described in the 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.
3.2.7.1. 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.
3.2.8. 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.
content
element. When its 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).
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'), };
3.2.8.1. 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 HTML syntax). However, these are entirely separate concepts.
3.2.8.2. 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.
3.2.8.2.1. 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.
<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.
3.2.8.2.2. Flow content
Most elements that are used in the body of documents and applications are categorized as flow content.
a
abbr
address
area
(if it is a descendant of amap
element)article
aside
audio
b
bdi
bdo
blockquote
br
button
canvas
cite
code
data
datalist
del
details
dfn
dialog
div
dl
em
embed
fieldset
figure
footer
form
h1
h2
h3
h4
h5
h6
header
hr
i
iframe
img
input
ins
kbd
label
link
(if it is allowed in the body)main
map
mark
- MathML
math
meter
nav
noscript
object
ol
output
p
picture
pre
progress
q
ruby
s
samp
script
section
select
small
span
strong
style
sub
sup
- SVG
svg
table
template
textarea
time
u
ul
var
video
wbr
- autonomous custom elements
- text
3.2.8.2.3. Sectioning content
Sectioning content is content that defines the scope of headings and footers.
Each sectioning content element potentially has a heading and an outline. See the section on 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.
3.2.8.2.4. 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).
3.2.8.2.5. 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.
a
abbr
area
(if it is a descendant of amap
element)audio
b
bdi
bdo
br
button
canvas
cite
code
data
datalist
del
dfn
em
embed
i
iframe
img
input
ins
kbd
label
link
(if it is allowed in the body)map
mark
- MathML
math
meter
noscript
object
output
picture
progress
q
ruby
s
samp
script
select
small
span
strong
sub
sup
- SVG
svg
template
textarea
time
u
var
video
wbr
- autonomous custom elements
- text
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.)
3.2.8.2.6. Embedded content
Embedded content is content that imports another resource into the document, or content from another vocabulary that is 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.
3.2.8.2.7. Interactive content
Interactive content is content that is specifically intended for user interaction.
a
(if thehref
attribute is present)audio
(if thecontrols
attribute is present)button
details
embed
iframe
img
(if theusemap
attribute is present)input
(if thetype
attribute is not in thestate)
label
select
textarea
video
(if thecontrols
attribute is present)
The tabindex
attribute can also make any element into interactive content.
3.2.8.2.8. 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 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:
a
abbr
address
article
aside
audio
(if thecontrols
attribute is present)b
bdi
bdo
blockquote
button
canvas
cite
code
data
details
dfn
div
dl
(if the element’s children include at least one name-value group)em
embed
fieldset
figure
footer
form
h1
h2
h3
h4
h5
h6
header
i
iframe
img
input
(if thetype
attribute is not in thestate)
ins
kbd
label
main
map
mark
- MathML
math
meter
nav
object
ol
(if the element’s children include at least oneli
element)output
p
pre
progress
q
ruby
s
samp
section
select
small
span
strong
sub
sup
- SVG
svg
table
textarea
time
u
ul
(if the element’s children include at least oneli
element)var
video
- autonomous custom elements
- text that is not inter-element white space
3.2.8.2.9. 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:
3.2.8.3. 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.
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.
<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.
3.2.8.4. 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.
<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.
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.
<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>
<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:
-
The paragraph that says "You can play with my cat simulator. object I’m quite proud of it.", where object is the
object
element. -
The paragraph that says "To see the cat simulator, use one of the following links:".
-
The paragraph that says "Download simulator file".
-
The paragraph that says "Use online simulator".
-
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>
3.2.9. 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.
bogus
" element does not have a dir
attribute as defined in this specification, despite having an attribute with the
literal name "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]
getElementsByClassName()
method in the DOM, and other such features.
There are no additional restrictions on the tokens authors can use in the 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]
id
attribute specifies its element’s 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 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 is
attribute after the 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 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 name
attribute matches the value of the 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 role
and 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 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
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
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
attribute is part of the namespace declaration
mechanism, and an element cannot actually have an xmlns
attribute in no namespace
specified.
The XML specification also allows the use of the 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
attribute on HTML elements in the text/html
syntax.
3.2.9.1. The 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.
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 title
attribute
of the nearest ancestor HTML element with a 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 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.
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 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.
-
If the element has a
title
attribute, then return its value. -
Otherwise, if the element has a parent element, then return the parent element’s advisory information.
-
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 title
content attribute.
3.2.9.2. The lang
and 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 lang
attribute in no namespace may be used on any HTML element.
The 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 lang
attributes in the XML namespace to be
specified on their elements). If both the lang
attribute in no namespace and the 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 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
" on HTML elements in HTML documents, but such attributes must only be specified if a 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
" has no effect on language processing.
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 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 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 lang
attribute in the XML namespace set or is an HTML element and has a lang
in no
namespace attribute set. That attribute specifies the language of the node (regardless of its
value).
If both the lang
attribute in no namespace and the lang
attribute in the XML namespace are set on an element, user agents must use the lang
attribute in the XML namespace, and the 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 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 lang
content attribute in no namespace.
3.2.9.3. The 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 translate
attribute is in the yes state, then the element’s translation mode is in the translate-enabled state; otherwise, if the element’s translate
attribute
is in the no state, then the element’s translation mode is in the no-translate state. Otherwise, either the element’s translate
attribute is in the inherit state, or the element is not an HTML element and thus does not have a 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:
-
content
onmeta
elements, if thename
attribute specifies a metadata name whose value is known to be translatable -
lang
on HTML elements; must be "translated" to match the language used in the translation -
srcdoc
oniframe
elements; must be parsed and recursively processed -
style
on HTML elements; must be parsed and recursively processed (e.g., for the values of content properties) -
title
on all HTML elements -
value
oninput
elements with atype
attribute in theButton
state or theReset Button
state
Other specifications may define other attributes that are also translatable attributes. For
example, ARIA would define the 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.
<!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>
3.2.9.4. The xml:base
attribute (XML only)
The xml:base
attribute is defined in XML
Base. [XMLBASE]
The xml:base
attribute may be used on HTML elements of XML documents.
Authors must not use the xml:base
attribute on HTML elements in HTML documents.
3.2.9.5. The 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
andpre
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
dir
attribute is in the ltr state- If the element is a document element and the
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 whosetype
attribute is in theTelephone
state, and thedir
attribute is not in a defined state (i.e., it is not present or has an invalid value) - If the element is a document element and the
-
The directionality of the element is 'ltr'.
- If the element’s
dir
attribute is in thertl
state -
The directionality of the element is 'rtl'.
- If the element is an
input
element whosetype
attribute is in theText
,Search
,Telephone
,URL
, orE-mail
state, and thedir
attribute is in the auto state- If the element is a
textarea
element and thedir
attribute is in the auto state - If the element is a
-
If the element’s 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 value, then the directionality of the element is 'rtl'. [BIDI]
Otherwise, if the element’s 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
dir
attribute is in the auto state- If the element is a
bdi
element and thedir
attribute is not in a defined state (i.e., it is not present or has an invalid value) - If the element is a
-
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
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 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
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:
-
content
onmeta
elements, if thename
attribute specifies a metadata name whose value is primarily intended to be human-readable rather than machine-readable -
title
on all HTML elements
- document .
dir
[ = value ] -
Returns the
html
element’sdir
attribute’s value, if any.Can be set, to either '
ltr
', 'rtl
', or 'auto
' to replace thehtml
element’sdir
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 dir
content attribute of that element, limited to only known values.
The dir
IDL attribute on Document
objects
must reflect the 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 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).
<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:
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.
3.2.9.6. The style
attribute
All HTML elements may have the 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
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
. [CSP3]
Documents that use style
attributes on any of their elements must still be
comprehensible and usable if those attributes were removed.
In particular, using the 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 attribute.)
- element .
style
-
Returns a
CSSStyleDeclaration
object for the element’sstyle
attribute.
The style
IDL attribute is defined in the CSS Object Model (CSSOM)
specification. [CSSOM]
span
element and the 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>
3.2.9.7. Embedding custom non-visible data with the 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).
<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.
<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 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.
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 .
dataset
-
Returns a
DOMStringMap
object for the element’sdata-*
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=""
becomeselement.dataset.fooBar
.
The dataset
IDL attribute provides convenient
accessors for all the data-*
attributes on an element. On getting, the dataset
IDL attribute must return a DOMStringMap
whose associated element is
this element.
The DOMStringMap
interface is used for the dataset
attribute. Each DOMStringMap
has an associated element.
[OverrideBuiltins] interfaceDOMStringMap
{ getter DOMString (DOMStringname
); [CEReactions] setter void (DOMStringname
, DOMStringvalue
); [CEReactions] deleter void (DOMStringname
); };
To get a DOMStringMap
's name-value pairs,
run the following algorithm:
-
Let list be an empty list of name-value pairs.
-
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 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. -
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.
-
Return list.
The supported property names on a DOMStringMap
object at any instant are the names
of each pair returned from 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 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:
-
If name contains a U+002D HYPHEN-MINUS character (-) followed by a lowercase ASCII letter, then throw a "
SyntaxError
"DOMException
and abort these steps. -
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.
-
Insert the string
data-
at the front of name. -
If name does not match the XML
Name
production, throw an "InvalidCharacterError
"DOMException
and abort these steps. -
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:
-
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.
-
Insert the string
data-
at the front of name. -
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 getting the DOMStringMap’s name-value pairs. [WEBIDL]
class
attribute along with 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.
<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 } }
3.2.10. The innerText
IDL attribute
- element .
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:
-
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
textContent
IDL attribute on this element. -
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.
-
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.
-
If node’s computed value of visibility is not "visible", then let the result of these substeps be items and abort these substeps.
-
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":
-
select
elements have an associated non-replaced inline CSS box whose child boxes include only those ofoptgroup
andoption
element child nodes; -
optgroup
elements have an associated non-replaced block-level CSS box whose child boxes include only those ofoption
element child nodes; and -
option
element have an associated non-replaced block-level CSS box whose child boxes are as normal for non-replaced block-level CSS boxes.
Items can be non-empty due to "display: contents".
-
-
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 abr
element. Soft hyphens should be preserved. [CSS-TEXT-3] -
If node is a
br
element, then append a string containing a single U+000A LINE FEED (LF) character to items. -
If node’s computed value of display is 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.
-
If node’s computed value of display is table-cell, and node’s CSS box is not the last table-cell box of the nearest ancestor table box, then append a string containing a single U+000A LINE FEED (LF) character to items.
-
If node is a
p
element, then add 2 (a required line break count) at the beginning and end of items. -
If node’s used value of display is block-level or 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.
-
Let the result of these substeps be items.
-
-
Delete any string items whose strings are empty.
-
Delete any runs of consecutive required line break count items at the start or end of the list.
-
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.
-
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 innerText
attribute must follow these steps:
-
Let document be this element’s node document.
-
Let fragment be a new
DocumentFragment
object whose node document is document. -
Let input be the given value.
-
Let pointer be a pointer into input, initially pointing at the start of the string.
-
Let text be the empty string.
-
While pointer is not past the end of input:
-
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.
-
If text is not the empty string, then append a new
Text
node whosedata
is text and node document is document to fragment. -
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:
-
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.
-
Advance position to the next character in input.
-
Append the result of creating an element given document,
br
, and the HTML namespace to fragment.
-
-
-
Replace all with fragment within this element.
3.2.11. Requirements relating to the bidirectional algorithm
3.2.11.1. 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 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.
3.2.11.2. 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 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 section that, due to the requirements in this section, are requirements on all user agents (not just those that support the suggested default rendering):
3.2.12. WAI-ARIA and HTML Accessibility API Mappings
3.2.12.1. ARIA Authoring Requirements
Authors may use the ARIA role
and 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 role
and/or aria-*
attribute that
matches the default implicit ARIA semantics is unnecessary and not recommended as these properties are already
set by the browser.
-
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.
3.2.12.2. Conformance Checker Implementation Requirements
Conformance checkers are required to implement document conformance requirements for use of the
ARIA role
and aria-*
attributes on HTML elements, as defined in ARIA in
HTML. [html-aria]
3.2.12.3. 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.
3.2.12.3.1. ARIA Role Attribute
Every HTML element may have an 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 role
attribute is split on spaces.
3.2.12.3.2. 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].
3.2.12.4. 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.
Role | Description | Required Properties | Supported Properties |
---|---|---|---|
any | global aria-* attributes can be used on any HTML element. | none |
|
alert
| A message with important, and usually time-sensitive, information. See related alertdialog and status .
| none |
|
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 |
|
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 |
|
article
| A section of a page that consists of a composition that forms an independent part of a document, page, or site. | none |
|
banner
| A region that contains mostly site-oriented content, rather than page-specific content. | none |
|
button
| An input that allows for user-triggered actions when clicked or pressed. See related link .
| none |
|
checkbox
| A checkable input that has three possible values: true, false, or mixed. |
| none |
cell
| A cell in a tabular container. | none | |
columnheader
| A cell containing header information for a column. | none | |
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 .
|
| |
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 |
|
contentinfo
| A large perceivable region that contains information about the parent document. | none |
|
definition
| A definition of a term or concept. | none |
|
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 |
|
directory
| A list of references to members of a group, such as a static table of contents. | none |
|
document
| A region containing related information that is declared as document content, as opposed to a web application. | none |
|
feed
| A scrollable list of articles where scrolling may cause articles to be added to or removed from either end of the list. | none |
|
figure
| A perceivable section of content that typically contains a graphical document, images, code snippets, or example text. | none |
|
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 |
|
grid
| A grid is an interactive control which contains cells of tabular data arranged in rows and columns, like a table. | none | |
gridcell
| A cell in a grid or treegrid. | none | |
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 |
|
heading
| A heading for a section of the page. | none |
|
img
| A container for a collection of elements that form an image. | none |
|
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 |
|
list
| A group of non-interactive list items. See related listbox .
| none |
|
listbox
| A widget that allows the user to select one or more items from a list of choices.
See related combobox and list .
| none | |
listitem
| A single item in a list or directory .
| none | |
log
| A type of live region where new information is added in meaningful order and old
information may disappear. See related marquee .
| none |
|
main
| The main content of a document. | none |
|
marquee
| A type of live region where non-essential information changes frequently.
See related log .
| none |
|
MathML math
| Content that represents a mathematical expression. | none |
|
menu
| A type of widget that offers a list of choices to the user. | none | |
menubar
| A presentation of menu that usually remains visible and is usually presented horizontally. | none |
|
menuitem
| An option in a group of choices contained by a menu or menubar .
| none | |
menuitemcheckbox
| A checkable menuitem that has three
possible values: true, false, or mixed.
|
| |
menuitemradio
| A checkable menuitem in a group of menuitemradio roles, only one of which
can be checked at a time.
|
|
|
navigation
| A collection of navigational elements (usually links) for navigating the document or related documents. | none |
|
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 |
|
option
| A selectable item in a select list. | none |
|
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 | |
radio
| A checkable input in a group of radio roles, only one of which can be checked at a time. |
|
|
radiogroup
| A group of radio buttons. | none | |
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 |
|
row
| A row of cells in a grid. | none |
|
rowgroup
| A group containing one or more row elements in a grid. | none |
|
rowheader
| A cell containing header information for a row in a grid. | none | |
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. |
| |
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 |
|
searchbox
| A type of textbox intended for specifying search criteria. | none | |
separator
| A divider that separates and distinguishes sections of content. |
|
|
slider
| A user input where the user selects a value from within a given range. | ||
spinbutton
| A form of range that expects the user to select from among discrete choices. | ||
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 |
|
switch
| A type of checkbox that represents on/off values, as opposed to checked/unchecked values. |
| none |
tab
| A grouping label providing a mechanism for selecting the tab content that is to be rendered to the user. | none |
|
table
| A section containing data arranged in rows and columns. The table role is intended for tabular containers which are not interactive. | none | |
tablist
| A list of tab elements, which are references to tabpanel elements. | none | |
tabpanel
| A container for the resources associated with a tab , where each tab is contained in a tablist .
| none |
|
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 | |
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 |
|
toolbar
| A collection of commonly used function buttons represented in compact visual form. | none | |
tooltip
| A contextual popup that displays a description for an element. | none |
|
tree
| A type of list that may contain sub-level nested groups that can be collapsed and expanded. | none | |
treegrid
| A grid whose rows can be expanded and collapsed in the same manner as for a tree. | none | |
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 |
|
4. The elements of HTML
4.1. The document element
4.1.1. The html
element
- Categories:
- None.
- Contexts in which this element can be used:
- As the document’s document element.
- Wherever a subdocument fragment is allowed in a compound document.
- Content model:
- A
head
element followed by abody
element. - Tag omission in text/html:
- An
html
element’s start tag can be omitted if the first thing inside thehtml
element is not a comment.- An
html
element’s end tag can be omitted if thehtml
element is not immediately followed by a comment. - An
- Content attributes:
- Global attributes.
manifest
— Application cache manifest. - Allowed ARIA role attribute values:
- None.
- Allowed ARIA state and property attributes:
- None.
- DOM interface:
-
interface
HTMLHtmlElement
: HTMLElement {};
The html
element represents the root of an HTML document.
Authors are encouraged to specify a lang
attribute on the root html
element, giving
the document’s language. This aids speech synthesis tools to determine what pronunciations to use,
translation tools to determine what rules to use, and so forth.
The manifest
attribute gives the address of the
document’s application cache manifest, if there is one. If the attribute is present,
the attribute’s value must be a valid non-empty URL potentially surrounded by spaces.
The manifest-based application cache feature is in the process of being removed from the Web platform. (This is a long process that takes many years.) Using the application cache feature at this time is highly discouraged. Use service workers instead. [SERVICE-WORKERS]
The manifest
attribute only has an effect during the early stages of document load.
Changing the attribute dynamically thus has no effect (and thus, no DOM API is provided for this
attribute).
For the purposes of application cache selection, later base
elements
cannot affect the parsing of URLs in manifest
attributes, as the
attributes are processed before those elements are seen.
The window.applicationCache
IDL attribute provides scripted
access to the offline application cache mechanism.
It is recommended to keep the usage of attributes and their values defined on the html
element to a minimum to allow for proper detection of the character encoding declaration within the first 1024 bytes.
html
element in the following example declares that the document’s language is English.
<!DOCTYPE html> <html lang="en"> <head> <title>Swapping Songs</title> </head> <body> <h1>Swapping Songs</h1> <p>Tonight I swapped some of the songs I wrote with some friends, who gave me some of the songs they wrote. I love sharing my music.</p> </body> </html>
4.2. Document metadata
4.2.1. The head
element
- Categories:
- None.
- Contexts in which this element can be used:
- As the first element in an
html
element. - Content model:
- If the document is an
iframe
srcdoc
document or if title information is available from a higher-level protocol: Zero or more elements of metadata content, of which no more than one is atitle
element and no more than one is abase
element.- Otherwise: One or more elements of metadata content, of which exactly one is a
title
element and no more than one is abase
element. - Otherwise: One or more elements of metadata content, of which exactly one is a
- Tag omission in text/html:
- A
head
element’s start tag may be omitted if the element is empty, or if the first thing inside thehead
element is an element.- A
head
element’s end tag may be omitted if thehead
element is not immediately followed by a space character or a comment. - A
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLHeadElement
: HTMLElement {};
The head
element represents a collection of metadata for the Document
.
head
element can be large or small. Here is an
example of a very short one:
<!DOCTYPE html> <html lang="en"> <head> <title>A document with a short head</title> </head> <body> ...
Here is an example of a longer one:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <base href="https://www.example.com/"> <title>An application with a long head</title> <link rel="stylesheet" href="default.css"> <link rel="stylesheet alternate" href="big.css" title="Big Text"> <script src="support.js"></script> <meta name="application-name" content="long headed application"> </head> <body> ...
The title
element is a required child in most situations, but when a higher-level
protocol provides title information, e.g., in the Subject line of an e-mail when HTML is
used as an e-mail authoring format, the title
element can be omitted.
It is recommended to keep the usage of attributes and their values defined on the head
element to a minimum to allow for proper detection of the character encoding declaration within the first 1024 bytes.
4.2.2. The title
element
- Categories:
- Metadata content.
- Contexts in which this element can be used:
- In a
head
element containing no othertitle
elements. - Content model:
- Text that is not inter-element white space.
- Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLTitleElement
: HTMLElement { attribute DOMString text; };
The title
element represents the document’s title or name. Authors should use
titles that identify their documents even when they are used out of context, for example in
a user’s history or bookmarks, or in search results. The document’s title is often different
from its first heading, since the first heading does not have to stand alone when taken out
of context.
There must be no more than one title
element per document.
If it’s reasonable for the Document
to have no title, then the title
element is
probably not required. See the head
element’s content model for a description of when
the element is required.
- title .
text
[ = value ] -
Returns the child text content of the element.
Can be set, to replace the element’s children with the given value.
The IDL attribute text
must return the child text content of the title
element. On setting, it must act the same way as
the textContent
IDL attribute.
<title>Introduction to The Mating Rituals of Bees</title> ... <h1>Introduction</h1> <p> This companion guide to the highly successful <cite>Introduction to Medieval Bee-Keeping</cite> book is...
The next page might be a part of the same site. Note how the title describes the subject matter unambiguously, while the first heading assumes the reader knows what the context is and therefore won’t wonder if the dances are Salsa or Waltz:
<title>Dances used during bee mating rituals</title> ... <h2>The Dances</h2>
The string to use as the document’s title is given by the document.title
IDL
attribute.
User agents should use the document’s title when referring to the document in their user
interface. When the contents of a title
element are used in this way, the directionality of that title
element should be used to set the
directionality of the document’s title in the user interface.
4.2.3. The base
element
- Categories:
- Metadata content.
- Contexts in which this element can be used:
- In a
head
element containing no otherbase
elements. - Content model:
- Nothing.
- Tag omission in text/html:
- No end tag.
- Content attributes:
- Global attributes
href
— Document base URLtarget
— Default browsing context for hyperlink navigation and §4.10.21 Form submission - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLBaseElement
: HTMLElement { attribute DOMString href; attribute DOMString target; };
The base
element allows authors to specify the document base URL for the purposes of §2.5.2 Parsing URLs, and the name of the default browsing context for the purposes of following hyperlinks. The element does not represent any content beyond this
information.
There must be no more than one base
element per document.
A base
element must have either an href
attribute, a target
attribute, or both.
The href
content attribute, if specified, must
contain a valid URL potentially surrounded by spaces.
A base
element, if it has an href
attribute, must come before any other elements in
the tree that have attributes defined as taking URLs, except the html
element (its manifest
attribute isn’t affected by base
elements).
If there are multiple base
elements with href
attributes, all but
the first are ignored.
The target
attribute, if specified, must contain
a valid browsing context name or keyword, which specifies which browsing context is to be used as the default when hyperlinks and forms in the Document
cause navigation.
A base
element, if it has a target
attribute, must come before any
elements in the tree that represent hyperlinks.
If there are multiple base
elements with target
attributes, all but
the first are ignored.
A base
element that is the first base
element with an href
content attribute in a document tree has a frozen base URL. The frozen base URL must be immediately set for an element whenever any of
the following situations occur:
-
The
base
element becomes the firstbase
element in tree order with anhref
content attribute in itsDocument
. -
The
base
element is the firstbase
element in tree order with anhref
content attribute in itsDocument
, and itshref
content attribute is changed.
To set the frozen base URL, for an element element:
-
Let document be element’s node document.
-
Let urlRecord be the result of parsing the value of element’s
href
content attribute with document’s fallback base URL, and document’s character encoding. (Thus thebase
element isn’t affected by itself.) -
Set elements’s frozen base URL to document’s fallback base URL, if urlRecord is failure or running Is base allowed for Document? on the resulting URL record and document returns "
Blocked
", and to urlRecord otherwise.
The href
IDL attribute, on getting, must
return the result of running the following algorithm:
-
Let document be element’s node document.
-
Let url be the value of the
href
attribute of thebase
element, if it has one, and the empty string otherwise. -
Let urlRecord be the result of parsing url with document’s fallback base url, and document’s character encoding. (Thus, the
base
element isn’t affected by otherbase
elements or itself). -
If urlRecord is failure, return url.
-
Return the serialization of urlRecord.
The href
IDL attribute, on setting, must set the href
content
attribute to the given new value.
The target
IDL attribute must reflect the content attribute of the same name.
base
element is used to set the document base URL:
<!DOCTYPE html> <html lang="en"> <head> <title>This is an example for the <base> element</title> <base href="https://www.example.com/news/index.html"> </head> <body> <p>Visit the <a href="archives.html">archives</a>.</p> </body> </html>
The link in the above example would be a link to
"https://www.example.com/news/archives.html
".
4.2.4. The link
element
- Categories:
- Metadata content.
- If the element is allowed in the body: flow content.
- If the element is allowed in the body: phrasing content.
- If the element is allowed in the body: flow content.
- Contexts in which this element can be used:
- Where metadata content is expected.
- In a
noscript
element that is a child of ahead
element.- If the element is allowed in the body: where phrasing content is expected.
- In a
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag.
- Content attributes:
- Global attributes
href
— Address of the hyperlinkcrossorigin
— How the element handles crossorigin requestsrel
— Relationship of this document (or subsection/topic) to the destination resourcerev
— Reverse link relationship of the destination resource to this document (or subsection/topic)media
— Applicable mediahreflang
— Language of the linked resourceintegrity
— Metadata used in Subresource Integrity checkstype
— Hint for the type of the referenced resourcereferrerpolicy
- Referrer policy for fetches initiated by the elementsizes
— Sizes of the icons (forrel
="icon
")as
— Destination for a preload request (forrel
="preload
")- Also, the
title
attribute has special semantics on this element: Title of the link; alternative style sheet set name. - Allowed ARIA role attribute values:
-
link
(default - do not set) - Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLLinkElement
: HTMLElement { [CEReactions] attribute USVString href; [CEReactions] attribute DOMString? crossOrigin; [CEReactions] attribute DOMString rel; [CEReactions] attribute DOMString rev; [CEReactions] attribute DOMString as; // (default "") [CEReactions, SameObject, PutForwards=value] readonly attribute DOMTokenList relList; [CEReactions] attribute DOMString media; [CEReactions] attribute DOMString hreflang; [CEReactions] attribute DOMString type; [CEReactions, SameObject, PutForwards=value] readonly attribute DOMTokenList sizes; [CEReactions] attribute DOMString referrerPolicy; }; HTMLLinkElement implements LinkStyle;
The link
element allows authors to link their document to other resources.
The destination of the link(s) is given by the href
attribute, which must be present and must
contain a valid non-empty URL potentially surrounded by spaces. If the href
attribute is absent, then the element does not define a link.
The crossorigin
attribute is a CORS settings attribute. It is intended for use with external resource links.
Along with the href
attribute, a link
element must have a rel
attribute
with a value that is a set of space-separated tokens (keywords).
These keywords identify the relationships the types of indicated links have to the document.
The allowed keywords and their meanings are defined in a later section. If the rel
attribute is absent, has no keywords, or if none of the keywords used are allowed
according to the definitions in this specification, then the link
element does not create
any links.
rel
's supported tokens are the keywords defined in HTML link types which are
allowed to be used with link
elements, impact the processing model, and are supported by
the user agent. A rel
must only include the tokens (keywords) outlined in the
table of supported tokens that the user agent implements the processing model for.
If a link
element has a rel
attribute that contains only keywords that are body-ok, then the element is said to be allowed in the body. This means
that the link
element can be used where phrasing content is expected.
Two categories of links can be created using the link
element: Links to external resources and hyperlinks. The link types section defines
whether a particular link type is an external resource or a hyperlink. One link
element can
create multiple links (of which some might be external resource links and some might
be hyperlinks); exactly which and how many links are created depends on the keywords given in
the rel
attribute. User agents must process the links on a per-link basis, not a
per-element basis.
Each link created for a link
element is handled separately. For instance, if there
are two link
elements with rel="stylesheet"
, they each count as a
separate external resource, and each is affected by its own attributes independently.
Similarly, if a single link
element has a rel
attribute with the value next stylesheet
, it creates both a hyperlink (for the next
keyword) and an external resource link (for the stylesheet
keyword), and
they are affected by other attributes (such as media
or title
)
differently.
link
element creates two hyperlinks (to the same page):
<link rel="author license" href="/about">
The two links created by this element are one whose semantic is that the target page has information about the current page’s author, and one whose semantic is that the target page has information regarding the license under which the current page is provided.
Hyperlinks created with the link
element and its rel
attribute apply to the
whole document. This contrasts with the rel
attribute of a
and area
elements,
which indicates the type of a link whose context is given by the link’s location within the
document.
The exact behavior for links to external resources depends on the exact relationship, as defined for the relevant link type. Some of the attributes control whether or not the external resource is to be applied (as defined below).
The media
attribute says which media the resource
applies to. The value must be a valid media query list.
The integrity
attribute represents the integrity metadata for requests which this element is responsible for. The value is text.
The attribute must not be specified on link
elements that do not have a rel
attribute that contains the stylesheet
keyword. [SRI]
The hreflang
attribute on the link
element
has the same semantics as the hreflang
attribute on the a
element.
The type
attribute gives the MIME type of
the linked resource. It is purely advisory. The value must be a valid mime type.
For external resource links, the type
attribute is used as a hint to user agents
so that they can avoid fetching resources they do not support.
The referrerpolicy
attribute is a referrer policy attribute. It is intended for use with external resource links,
where it helps set the referrer policy used when obtaining the external resource. [REFERRERPOLICY].
The title
attribute gives the title of the link.
With one exception, it is purely advisory. The value is text. The exception is for style sheet
links, where the title
attribute defines alternative style sheet sets.
The title
attribute on link
elements differs from the global title
attribute of most other elements in that a link without a title does not inherit the title of
the parent element: it merely has no title.
The sizes
attribute gives the sizes of icons
for visual media. Its value, if present, is merely advisory. User agents may use the value to
decide which icon(s) to use if multiple icons are available. If specified, the attribute must
have a value that is an unordered set of unique space-separated tokens which are ASCII case-insensitive. Each value must be either an ASCII case-insensitive match for
the string "any
", or a value that consists of two valid non-negative integers that do not have a leading U+0030 DIGIT ZERO (0) character and that are separated by a single
U+0078 LATIN SMALL LETTER X or U+0058 LATIN CAPITAL LETTER X character. The attribute must not be
specified on link
elements that do not have a rel
attribute that specifies the icon
keyword or the apple-touch-icon
keyword.
The apple-touch-icon
keyword is a registered extension to the predefined set of link types,
but user agents are not required to support it in any way.
The as
attribute specifies the potential destination for a preload request for the resource given by the href
attribute. It is an enumerated attribute. Each potential destination is a keyword for this attribute, mapping to a state of the same name. The attribute must be specified on link
elements that have a rel
attribute that contains the preload
keyword, but must not be specified on link
elements which do not. The processing model for how the as
attribute is used is given in the steps to obtain the resource.
The attribute does not have a missing value default or invalid value default, meaning that invalid or missing values for the attribute map to no state. This is accounted for in the processing model.
The IDL attributes href
, hreflang
, integrity
, media
, rel
, rev
, sizes
, and type
each must reflect the respective content attributes of the same name.
The crossOrigin
IDL attribute must reflect the crossorigin
content attribute, limited to only known values.
The referrerPolicy
IDL attribute must reflect the referrerpolicy
content attribute, limited to only known values.
The IDL attribute relList
must reflect the rel
content attribute.
The as
IDL attribute must reflect the as
content attribute, limited to only known values.
4.2.4.1. Processing the media
attribute
If the link is a hyperlink then the media
attribute is purely advisory, and
describes for which media the document in question was designed.
However, if the link is an external resource link, then the media
attribute
is prescriptive. The user agent must apply the external resource when the media
attribute’s value matches the environment and the other relevant conditions apply, and
must not apply it otherwise.
The default, if the media
attribute is omitted, is "all
", meaning that
by default links apply to all media.
The external resource might have further restrictions defined within that limit
its applicability. For example, a CSS style sheet might have some @media
blocks. This
specification does not override such further restrictions or requirements.
4.2.4.2. Processing the type
attribute
If type
attribute is present, then
the user agent must assume that the resource is of the given type (even if that is not a valid mime type, e.g., the empty string). If the attribute is omitted, but the external
resource link type has a default type defined, then the user agent must assume that the resource
is of that type. If the user agent does not support the given MIME type for the given link
relationship, then the user agent should not obtain the resource; if the user agent does
support the given MIME type for the given link relationship, then the user agent should obtain the resource at the appropriate time as specified for the external resource link’s particular type. If the attribute is omitted, and the external
resource link type does not have a default type defined, but the user agent would obtain the resource if the type was known and supported, then the user agent should obtain the
resource under the assumption that it will be supported.
User agents must not consider the type
attribute authoritative — upon
fetching the resource, user agents must not use the type
attribute to determine its
actual type. Only the actual type (as defined in the next paragraph) is used to determine
whether to apply the resource, not the aforementioned assumed type.
If the external resource link type defines rules for processing the resource’s Content-Type metadata, then those rules apply. Otherwise, if the resource is expected to be an image, user agents may apply the image sniffing rules, with the official type being the type determined from the resource’s Content-Type metadata, and use the resulting computed type of the resource as if it was the actual type. Otherwise, if neither of these conditions apply or if the user agent opts not to apply the image sniffing rules, then the user agent must use the resource’s Content-Type metadata to determine the type of the resource. If there is no type metadata, but the external resource link type has a default type defined, then the user agent must assume that the resource is of that type.
The stylesheet
link type defines rules for processing the resource’s Content-Type metadata.
Once the user agent has established the type of the resource, the user agent must apply the resource if it is of a supported type and the other relevant conditions apply, and must ignore the resource otherwise.
<link rel="stylesheet" href="A" type="text/plain"> <link rel="stylesheet" href="B" type="text/css"> <link rel="stylesheet" href="C">
...then a compliant user agent that supported only CSS style sheets would fetch the B and C
files, and skip the A file (since text/plain
is not the MIME type for CSS
style sheets).
For files B and C, it would then check the actual types returned by the server. For those that
are sent as text/css
, it would apply the styles, but for those labeled as text/plain
, or any other type, it would not.
If one of the two files was returned without a Content-Type metadata, or with a
syntactically incorrect type like Content-Type: "null"
, then the default type
for stylesheet
links would kick in. Since that default type is text/css
, the style sheet would nonetheless be applied.
4.2.4.3. Obtaining a resource from a link
element
For external resources that are represented in the DOM (for example, style sheets), the DOM representation must be made available (modulo cross-origin restrictions) even if the resource is not applied. To obtain the resource, the user agent must run the following steps:
-
If the
href
attribute’s value is the empty string, then return. -
Parse the URL given by the
href
attribute, relative to the element’s node document. If that fails, then return. Otherwise, let url be the resulting URL record. -
Let corsAttributeState be the current state of the element’s
crossorigin
content attribute. -
Let request be the result of creating a potential-CORS request given url, the empty string, and corsAttributeState.
-
Set request’s client to the
link
element’s node document’sWindow
object’s environment settings object. -
Set request’s cryptographic nonce metadata to the current value of the
link
element’s [[CryptographicNonce]] internal slot. -
Set request’s integrity metadata to the current value of the
link
element’sintegrity
content attribute. -
Set request’s referrer policy to the current state of the
link
element’sreferrerpolicy
attribute. -
If the
rel
attribute contains thepreload
keyword, then:-
Let as be the current state of the
as
attribute. -
If as is no state, then return.
-
Set request’s destination to the result of translating as.
-
-
Fetch request.
User agents may opt to only try to obtain such resources when they are needed, instead of pro-actively fetching all the external resources that are not applied.
The semantics of the protocol used (e.g., HTTP) must be followed when fetching external resources. (For example, redirects will be followed and 404 responses will cause the external resource to not be applied.)
Once the attempts to obtain the resource and its critical subresources are complete, the
user agent must, if the loads were successful, queue a task to fire an event named load
at the link
element, or, if the resource or one of its critical subresources failed to completely load for any reason (e.g., DNS error, HTTP 404
response, a connection being prematurely closed, unsupported Content-Type), queue a task to fire an event named error
at the link
element.
Non-network errors in processing the resource or its subresources (e.g., CSS parse errors, PNG
decoding errors) are not failures for the purposes of this paragraph.
The task source for these tasks is the DOM manipulation task source.
Unless otherwise specified for a given rel
keyword, the element must delay the load event of the element’s node document until all the
attempts to obtain the resource and its critical subresources are complete. (Resources
that the user agent has not yet attempted to obtain, e.g., because it is waiting for the resource
to be needed, do not delay the load event.)
4.2.4.4. Processing Link
headers
HTTP Link:
headers, if supported, must be assumed to come before any links in the
document, in the order that they were given in the HTTP message. These headers are distinct from HTML link types, and thus their semantics can be different from same-named HTML types.
4.2.4.5. Providing users with a means to follow hyperlinks created using the link
element
Interactive user agents may provide users with a means to follow the hyperlinks created
using the link
element, somewhere within their user interface. The exact interface is not
defined by this specification, but it could include the following information (obtained from the
element’s attributes, again as defined below), in some form or another (possibly simplified), for
each hyperlink created with each link
element in the document:
-
The relationship between this document and the resource (given by the
rel
attribute) -
The title of the resource (given by the
title
attribute). -
The address of the resource (given by the
href
attribute). -
The language of the resource (given by the
hreflang
attribute). -
The optimum media for the resource (given by the
media
attribute).
User agents could also include other information, such as the type of the resource (as given by
the type
attribute).
The activation behavior of link
elements that create hyperlinks is to
run the following steps:
-
If the
link
element’s node document is not fully active, then abort these steps. -
Follow the hyperlink created by the
link
element.
4.2.4.6. The LinkStyle
interface
The LinkStyle
interface is also implemented by this element. [CSSOM]
link
elements provide some style sheets:
<!-- a persistent style sheet --> <link rel="stylesheet" href="default.css"> <!-- the preferred alternate style sheet --> <link rel="stylesheet" href="green.css" title="Green styles"> <!-- some alternate style sheets --> <link rel="alternate stylesheet" href="contrast.css" title="High contrast"> <link rel="alternate stylesheet" href="big.css" title="Big fonts"> <link rel="alternate stylesheet" href="wide.css" title="Wide screen">
<link rel="alternate" href="/en/html" hreflang="en" type="text/html" title="English HTML"> <link rel="alternate" href="/fr/html" hreflang="fr" type="text/html" title="French HTML"> <link rel="alternate" href="/en/html/print" hreflang="en" type="text/html" media="print" title="English HTML (for printing)"> <link rel="alternate" href="/fr/html/print" hreflang="fr" type="text/html" media="print" title="French HTML (for printing)"> <link rel="alternate" href="/en/pdf" hreflang="en" type="application/pdf" title="English PDF"> <link rel="alternate" href="/fr/pdf" hreflang="fr" type="application/pdf" title="French PDF">
4.2.5. The meta
element
- Categories:
- Metadata content.
- Contexts in which this element can be used:
- If the
charset
attribute is present, or if the element’shttp-equiv
attribute is in the encoding declaration state: in ahead
element.- If the
http-equiv
attribute is present but not in the encoding declaration state: in ahead
element.- If the
http-equiv
attribute is present but not in the encoding declaration state: in anoscript
element that is a child of ahead
element.- If the
name
attribute is present: where metadata content is expected. - If the
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag.
- Content attributes:
- Global attributes
name
— Metadata namehttp-equiv
— Pragma directivecontent
— Value of the elementcharset
— Character encoding declaration - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLMetaElement
: HTMLElement { attribute DOMString name; attribute DOMString httpEquiv; attribute DOMString content; };
The meta
element represents various kinds of metadata that cannot be expressed using
the title
, base
, link
, style
, and script
elements.
The meta
element can represent document-level metadata with the name
attribute, pragma directives with the http-equiv
attribute, and the file’s character encoding declaration when an HTML document is
serialized to string form (e.g., for transmission over the network or for disk storage) with
the charset
attribute.
Exactly one of the name
, http-equiv
, and charset
attributes must be specified.
If either name
or http-equiv
is specified, then the content
attribute must also be specified. Otherwise, it must be omitted.
The charset
attribute specifies the character
encoding used by the document. This is a character encoding declaration. If the
attribute is present in an XML document, its value must be an ASCII case-insensitive match for the string "utf-8
".
The charset
attribute on the meta
element has no effect in XML
documents. It is allowed in order to facilitate migration to and from XHTML.
There must not be more than one meta
element with a charset
attribute
per document.
The content
attribute gives the value of the
document metadata or pragma directive when the element is used for those purposes. The allowed
values depend on the exact context, as described in subsequent sections of this specification.
<meta name="viewport" content="...">
allows authors to define specific viewport characteristics (such as the layout viewport’s width
and zoom factor) for their documents. Among these is the ability to prevent or restrict users
from being able to zoom, using content
values such as user-scalable="no"
or maximum-scale=1.0
. Authors should not suppress
or limit the ability of users to resize a document, as this causes accessibility and usability
issues.
<!-- DO NOT DO THIS --> <meta name="viewport" content=user-scalable="no"> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
There may be specific use cases where preventing users from zooming may be appropriate, such as map applications – where custom zoom functionality is handled via scripting. However, in general this practice should be avoided, and HTML conformance checking tools should display a warning if they encounter these values.
Note that most user agents now allow users to always zoom, regardless of any <meta name="viewport" content="...">
restrictions – either by default, or as a setting/option (which may however not be immediately apparent to users).
If a meta
element has a name
attribute, it sets document metadata. Document metadata is expressed in terms of name-value
pairs, the name
attribute on the meta
element giving the name, and the content
attribute on the same element giving the value. The name specifies what
aspect of metadata is being set; valid names and the meaning of their values are described in
the following sections. If a meta
element has no content
attribute, then the
value part of the metadata name-value pair is the empty string.
The name
and content
IDL attributes must reflect the respective content attributes of the same name. The IDL attribute httpEquiv
must reflect the content attribute http-equiv
.
4.2.5.1. Standard metadata names
This specification defines a few names for the name
attribute of the meta
element.
Names are case-insensitive, and must be compared in an ASCII case-insensitive manner.
application-name
-
The value must be a short free-form string giving the name of the Web application that the page represents. If the page is not a Web application, the
application-name
metadata name must not be used. Translations of the Web application’s name may be given, using thelang
attribute to specify the language of each name.There must not be more than one
meta
element with a given language and with itsname
attribute set to the valueapplication-name
per document.User agents may use the application name in UI in preference to the page’s
title
, since the title might include status messages and the like relevant to the status of the page at a particular moment in time instead of just being the name of the application.To find the application name to use given an ordered list of languages (e.g., British English, American English, and English), user agents must run the following steps:
-
Let languages be the list of languages.
-
Let default language be the language of the
Document
's document element, if any, and if that language is not unknown. -
If there is a default language, and if it is not the same language as any of the languages in languages, append it to languages.
-
Let winning language be the first language in languages for which there is a
meta
element in theDocument
that has itsname
attribute set to the valueapplication-name
and whose language is the language in question.If none of the languages have such a
meta
element, then abort these steps; there’s no given application name. -
Return the value of the
content
attribute of the firstmeta
element in theDocument
in tree order that has itsname
attribute set to the valueapplication-name
and whose language is winning language.
This algorithm would be used by a browser when it needs a name for the page, for instance, to label a bookmark. The languages it would provide to the algorithm would be the user’s preferred languages.
-
author
-
The value must be a free-form string giving the name of one of the page’s authors.
description
-
The value must be a free-form string that describes the page. The value must be appropriate for use in a directory of pages, e.g., in a search engine or list of bookmarks.
generator
-
The value must be a free-form string that identifies one of the software packages used to generate the document. This value must not be used on pages whose markup is not generated by software, e.g., pages whose markup was written by a user in a text editor.
Here is what a tool called "Frontweaver" could include in its output, in the page’shead
element, to identify itself as the tool used to generate the page:<meta name="generator" content="Frontweaver 8.2">
keywords
-
The value must be a set of comma-separated tokens, each of which is a keyword relevant to the page.
This page about typefaces on British motorways uses ameta
element to specify some keywords that users might use to look for the page:<!DOCTYPE html> <html lang="en-GB"> <head> <title>Typefaces on UK motorways</title> <meta name="keywords" content="british,type face,font,fonts,highway,highways"> </head> <body> ...
Many search engines do not consider such keywords, because this feature has historically been used unreliably and even misleadingly as a way to spam search engine results in a way that is not helpful for users.
To obtain the list of keywords that the author has specified as applicable to the page, the user agent must run the following steps:
-
Let keywords be an empty list.
-
For each
meta
element with aname
attribute and acontent
attribute and whosename
attribute’s value iskeywords
, run the following substeps:-
Split the value of the element’s
content
attribute on commas. -
Add the resulting tokens, if any, to keywords.
-
-
Remove any duplicates from keywords.
-
Return keywords. This is the list of keywords that the author has specified as applicable to the page.
User agents should not use this information when there is insufficient confidence in the reliability of the value.
For instance, it would be reasonable for a content management system to use the keyword information of pages within the system to populate the index of a site-specific search engine, but a large-scale content aggregator that used this information would likely find that certain users would try to game its ranking mechanism through the use of inappropriate keywords.
-
referrer
-
The value must be a referrer policy, which defines the default referrer policy for the
Document
. [REFERRERPOLICY]If any
meta
elements are inserted into the document or removed from the document, or existingmeta
elements have theirname
orcontent
attributes changed, user agents must run the following algorithm:-
Let candidate elements be the list of all
meta
elements that meet the following criteria, in tree order:- The element is in a document tree
- The element has a
name
attribute, whose value isreferrer
- The element has a
content
attribute, whose value is not the empty string - The element is a child of the
head
element of the document
-
For each element in candidate elements:
-
Let value be the value of element’s
content
attribute, converted to ASCII lowercase. -
If value is one of the values given in the first column of the following table, then set value to the value given in the second column:
Legacy value Referrer policy never
no-referrer
default
no-referrer-when-downgrade
always
unsafe-url
origin-when-crossorigin
origin-when-cross-origin
-
If value is a referrer policy, then set element’s node document’s referrer policy to policy.
-
The fact that these steps are applied for each element enables deployment of fallback values for older user agents. [REFERRERPOLICY]
-
4.2.5.2. Other metadata names
Extensions to the predefined set of metadata names may be registered in the WHATWG Wiki MetaExtensions page. [WHATWGWIKI]
Anyone is free to edit the WHATWG Wiki MetaExtensions page at any time to add a type. These new names must be specified with the following information:
- Keyword
-
The actual name being defined. The name should not be confusingly similar to any other defined name (e.g., differing only in case).
- Brief description
-
A short non-normative description of what the metadata name’s meaning is, including the format the value is required to be in.
- Specification
-
A link to a more detailed description of the metadata name’s semantics and requirements. It could be another page on the Wiki, or a link to an external page.
- Synonyms
-
A list of other names that have exactly the same processing requirements. Authors should not use the names defined to be synonyms, they are only intended to allow user agents to support legacy content. Anyone may remove synonyms that are not used in practice; only names that need to be processed as synonyms for compatibility with legacy content are to be registered in this way.
- Status
-
One of the following:
- Proposed
-
The name has not received wide peer review and approval. Someone has proposed it and is, or soon will be, using it.
- Ratified
-
The name has received wide peer review and approval. It has a specification that unambiguously defines how to handle pages that use the name, including when they use it in incorrect ways.
- Discontinued
-
The metadata name has received wide peer review and it has been found wanting. Existing pages are using this metadata name, but new pages should avoid it. The "brief description" and "specification" entries will give details of what authors should use instead, if anything.
If a metadata name is found to be redundant with existing values, it should be removed and listed as a synonym for the existing value.
If a metadata name is registered in the "proposed" state for a period of a month or more without being used or specified, then it may be removed from the registry.
If a metadata name is added with the "proposed" status and found to be redundant with existing values, it should be removed and listed as a synonym for the existing value. If a metadata name is added with the "proposed" status and found to be harmful, then it should be changed to "discontinued" status.
Anyone can change the status at any time, but should only do so in accordance with the definitions above.
Conformance checkers may use the information given on the WHATWG Wiki MetaExtensions page to establish if a value is allowed or not: values defined in this specification or marked as "proposed" or "ratified" must be accepted, whereas values marked as "discontinued" or not listed in either this specification or on the aforementioned page must be reported as invalid. Conformance checkers may cache this information (e.g., for performance reasons or to avoid the use of unreliable network connectivity).
When an author uses a new metadata name not defined by either this specification or the Wiki page, conformance checkers should offer to add the value to the Wiki, with the details described above, with the "proposed" status.
Metadata names whose values are to be URLs must not be proposed or accepted.
Links must be represented using the link
element, not the meta
element.
4.2.5.3. Pragma directives
When the http-equiv
attribute is specified on a meta
element,
the element is a pragma directive.
The http-equiv
attribute is an enumerated attribute. The following table
lists the keywords defined for this attribute. The states given in the first cell of the rows
with keywords give the states to which those keywords map. Some of the keywords are
non-conforming, as noted in the last column.
State | Keyword | Notes |
---|---|---|
Content Language | content-language
| Non-conforming |
Encoding declaration | content-type
| |
Default style | default-style
| |
Refresh | refresh
| |
Set-Cookie | set-cookie
| Non-conforming |
Content Security Policy | content-security-policy
|
When a meta
element is inserted into the document, if its http-equiv
attribute is present and represents one of the above states, then the
user agent must run the algorithm appropriate for that state, as described in the following
list:
- Content language state (
http-equiv="content-language"
) -
This feature is non-conforming. Authors are encouraged to use the
lang
attribute instead.This pragma sets the pragma-set default language. Until such a pragma is successfully processed, there is no pragma-set default language.
-
If the
meta
element has nocontent
attribute, then abort these steps. -
If the element’s
content
attribute contains a U+002C COMMA character (,) then abort these steps. -
Let input be the value of the element’s
content
attribute. -
Let position point at the first character of input.
-
Collect a sequence of characters that are not space characters.
-
Let candidate be the string that resulted from the previous step.
-
If candidate is the empty string, abort these steps.
-
Set the pragma-set default language to candidate.
If the value consists of multiple space-separated tokens, tokens after the first are ignored.
This pragma is not the same as the HTTP
Content-Language
header of the same name. HTTPContent-Language
values with more than one language tag will be rejected as invalid by this pragma. [HTTP] -
- Encoding declaration state (
http-equiv="content-type"
) -
The encoding declaration state is just an alternative form of setting the
charset
attribute: it is a character encoding declaration. This state’s user agent requirements are all handled by the parsing section of the specification.For
meta
elements with anhttp-equiv
attribute in the encoding declaration state, thecontent
attribute must have a value that is an ASCII case-insensitive match for a string that consists of the literal string "text/html;
", optionally followed by any number of space characters, followed by the literal string "charset=utf-8
".A document must not contain both a
meta
element with anhttp-equiv
attribute in the encoding declaration state and ameta
element with thecharset
attribute present.The encoding declaration state may be used in HTML documents and in XML Documents. If the encoding declaration state is used in XML Documents, the name of the character encoding must be an ASCII case-insensitive match for the string "
UTF-8
" (and the document is therefore forced to use UTF-8 as its encoding).The encoding declaration state has no effect in XML documents, and is only allowed in order to facilitate migration to and from XHTML.
- Default style state (
http-equiv="default-style"
) -
This pragma sets the name of the default alternative style sheet set.
-
If the
meta
element has nocontent
attribute, or if that attribute’s value is the empty string, then abort these steps. -
Set the preferred style sheet set to the value of the element’s
content
attribute. [CSSOM]
-
- Refresh state (
http-equiv="refresh"
) -
This pragma acts as timed redirect.
-
If another
meta
element with anhttp-equiv
attribute in the Refresh state has already been successfully processed (i.e., when it was inserted the user agent processed it and reached the step labeled end), then abort these steps. -
If the
meta
element has nocontent
attribute, or if that attribute’s value is the empty string, then abort these steps. -
Let input be the value of the element’s
content
attribute. -
Let position point at the first character of input.
-
Collect a sequence of characters that are ASCII digits, and parse the resulting string using the rules for parsing non-negative integers. If the sequence of characters collected is the empty string, then no number will have been parsed; abort these steps. Otherwise, let time be the parsed number.
-
Collect a sequence of characters that are ASCII digits and U+002E FULL STOP characters (.). Ignore any collected characters.
-
Let url be the
meta
element’s node document’s URL. -
If position is past the end of input, jump to the step labeled end.
-
If the character in input pointed to by position is not a U+003B SEMICOLON character (;), a U+002C COMMA character (,), or a space character, then abort these steps.
-
If the character in input pointed to by position is a U+003B SEMICOLON character (;), a U+002C COMMA character (,), then advance position to the next character.
-
If position is past the end of input, jump to the step labeled end.
-
Let url be equal to the substring of input from the character at position to the end of the string.
-
If the character in input pointed to by position is a U+0055 LATIN CAPITAL LETTER U character (U) or a U+0075 LATIN SMALL LETTER U character (u), then advance position to the next character. Otherwise, jump to the step labeled skip quotes.
-
If the character in input pointed to by position is a U+0052 LATIN CAPITAL LETTER R character (R) or a U+0072 LATIN SMALL LETTER R character (r), then advance position to the next character. Otherwise, jump to the step labeled Parse.
-
If the character in input pointed to by position is a U+004C LATIN CAPITAL LETTER L character (L) or a U+006C LATIN SMALL LETTER L character (l), then advance position to the next character. Otherwise, jump to the step labeled Parse.
-
If the character in input pointed to by position is a U+003D EQUALS SIGN (=), then advance position to the next character. Otherwise, jump to the step labeled Parse.
-
Skip quotes: If the character in input pointed to by position is either a U+0027 APOSTROPHE character (') or U+0022 QUOTATION MARK character ("), then let quote be that character, and advance position to the next character. Otherwise, let quote be the empty string.
-
Let url be equal to the substring of input from the character at position to the end of the string.
-
If quote is not the empty string, and there is a character in url equal to quote, then truncate url at that character, so that it and all subsequent characters are removed.
-
Parse: Parse url relative to the
meta
element’s node document. If that fails, abort these steps. Otherwise, let urlRecord be the resulting URL record. -
End: Perform one or more of the following steps:
-
After the refresh has come due (as defined below), if the user has not canceled the redirect and if the
meta
element’s node document’s active sandboxing flag set does not have the sandboxed automatic features browsing context flag set, navigate theDocument
's browsing context to urlRecord, with replacement enabled, and with theDocument
's browsing context as the source browsing context.For the purposes of the previous paragraph, a refresh is said to have come due as soon as the later of the following two conditions occurs:
-
At least time seconds have elapsed since the document has completely loaded, adjusted to take into account user or user agent preferences.
-
At least time seconds have elapsed since the
meta
element was inserted into the document, adjusted to take into account user or user agent preferences.
-
-
Provide the user with an interface that, when selected, navigates a browsing context to urlRecord, with the
Document
's browsing context as the source browsing context. -
Do nothing.
In addition, the user agent may, as with anything, inform the user of any and all aspects of its operation, including the state of any timers, the destinations of any timed redirects, and so forth.
-
For
meta
elements with anhttp-equiv
attribute in the Refresh state, thecontent
attribute must have a value consisting either of:-
just a valid non-negative integer, or
-
a valid non-negative integer, followed by a U+003B SEMICOLON character (;), followed by one or more space characters, followed by a substring that is an ASCII case-insensitive match for the string "
URL
", followed by a U+003D EQUALS SIGN character (=), followed by a valid URL that does not start with a literal U+0027 APOSTROPHE (') or U+0022 QUOTATION MARK (") character.
In the former case, the integer represents a number of seconds before the page is to be reloaded; in the latter case the integer represents a number of seconds before the page is to be replaced by the page at the given URL.
A news organization’s front page could include the following markup in the page’shead
element, to ensure that the page automatically reloads from the server every five minutes:<meta http-equiv="Refresh" content="300">
A sequence of pages could be used as an automated slide show by making each page refresh to the next page in the sequence, using markup such as the following:<meta http-equiv="Refresh" content="20; URL=page4.html">
- Set-Cookie state (
http-equiv="set-cookie"
) -
This pragma is non-conforming and has no effect.
User agents are required to ignore this pragma.
- Content security policy state (
http-equiv="content-security-policy"
) -
This pragma enforces a Content Security Policy on a
Document
. [CSP3]-
If the
meta
element is not a child of ahead
element, abort these steps. -
If the
meta
element has nocontent
attribute, or if that attribute’s value is the empty string, then abort these steps. -
Let policy be the result of executing Content Security Policy’s parse a serialized Content Security Policy algorithm on the
meta
element’scontent
attribute’s value, with a source of "meta", and a disposition of "enforce". -
Remove all occurrences of the
report-uri
,frame-ancestors
, andsandbox
directives from policy. -
Enforce the policy policy.
For
meta
elements with anhttp-equiv
attribute in the Content security policy state, thecontent
attribute must have a value consisting of a valid Content Security Policy, but must not contain anyreport-uri
,frame-ancestors
, orsandbox
directives. The Content Security Policy given in thecontent
attribute will be enforced upon the current document. [CSP3] -
-
There must not be more than one meta
element with any particular state in the
document at a time.
4.2.5.4. Specifying the document’s character encoding
A character encoding declaration is a mechanism by which the character encoding used to store or transmit a document is specified.
The only acceptable character encoding declaration for the modern web is UTF-8.
This must be identified by the character encoding label’s value being an ASCII case-insensitive match for the string "utf-8
".
Regardless of whether a character encoding declaration is present or not, the actual character encoding used to encode the document must be UTF-8. [ENCODING]
The following restrictions apply to character encoding declarations:
-
The character encoding declaration must be serialized without the use of character references or character escapes of any kind.
-
The element containing the character encoding declaration must be serialized completely within the first 1024 bytes of the document.
-
Due to a number of restrictions on
meta
elements, there can only be onemeta
-based character encoding declaration per document.
Authoring tools must default to using UTF-8 for newly-created documents. [ENCODING]
If an HTML document does not start with a BOM, and its encoding is not explicitly
given by Content-Type metadata, and the document is not an iframe
srcdoc
document,
then the encoding must be specified using a meta
element with a charset
attribute or a meta
element with an http-equiv
attribute in the encoding declaration state.
A character encoding declaration is required (either in the Content-Type metadata or explicitly in the file) even if the encoding is US-ASCII, because a character encoding is needed to process non-ASCII characters entered by the user in forms, in URLs generated by scripts, and so forth.
If the document is an iframe
srcdoc
document, the document must
not have a character encoding declaration. (In this case, the source is already decoded,
since it is part of the document that contained the iframe
.)
If an HTML document contains a meta
element with a charset
attribute or a meta
element with an http-equiv
attribute in the encoding declaration state, then the character
encoding used must be UTF-8.
Using non-UTF-8 encodings can have unexpected results on form submission and URL encodings, which use the document’s character encoding by default.
In XHTML, the XML declaration should be used for inline character encoding information, if necessary.
head
element):
<meta charset="utf-8">
In XML, the XML declaration would be used instead, at the very top of the markup:
<?xml version="1.0" encoding="utf-8"?>
4.2.6. The style
element
- Categories:
- Flow content.
- Metadata content.
- Contexts in which this element can be used:
- Where metadata content is expected.
- In a
noscript
element that is a child of ahead
element.- In the body, where flow content is expected.
- In a
- Content model:
- Depends on the value of the
type
attribute, but must match requirements described in prose below. - Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes
media
— Applicable mediatype
— Type of embedded resource- Also, the
title
attribute has special semantics on this element: Alternative style sheet set name. - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLStyleElement
: HTMLElement { attribute DOMString media; attribute DOMString type; }; HTMLStyleElement implements LinkStyle;
The style
element allows authors to embed style information in their documents. The style
element is one of several inputs to the styling processing model. The element
does not represent content for the user.
The type
attribute gives the styling language. If the attribute is
present, its value must be a valid mime type that designates a styling language. The charset
parameter must not be specified. The default value for the type
attribute, which is used if the attribute is absent, is "text/css
". [RFC2318]
When examining types to determine if they support the language, user agents must not ignore
unknown MIME parameters — types with unknown parameters must be assumed to be unsupported. The charset
parameter must be treated as an unknown parameter for the purpose of
comparing MIME types here.
The media
attribute says which media the styles apply to. The value must
be a valid media query list. The user agent must apply the styles when
the media
attribute’s value matches the environment and the other relevant
conditions apply, and must not apply them otherwise.
The styles might be further limited in scope, e.g., in CSS with the use of @media
blocks. This specification does not override such further restrictions or requirements.
The default, if the media
attribute is omitted, is "all
", meaning that
by default styles apply to all media.
A style
element should preferably be used in the head
of the document.
The use of style
in the body
of the document may cause restyling, trigger layout
and/or cause repainting, and hence, should be used with care.
The title
attribute on style
elements defines alternative style sheet sets. If the style
element has no title
attribute, then it has no title; the title
attribute of ancestors does not apply to
the style
element. [CSSOM]
The title
attribute on style
elements, like the title
attribute on link
elements, differs from the global title
attribute in
that a style
block without a title does not inherit the title of the parent
element: it merely has no title.
The textContent
of a style
element must match the style
production in the following ABNF, the character set for which is Unicode. [ABNF]
style = no-c-start *( c-start no-c-end c-end no-c-start ) no-c-start = < any string that doesn’t contain a substring that matches c-start > c-start = "<!--" no-c-end = < any string that doesn’t contain a substring that matches c-end > c-end = "-->"
The user agent must run the update a style
block algorithm that
applies for the style sheet language specified by the style
element’s type
attribute, passing it the element’s style data, whenever one of the following
conditions occur:
-
the element is popped off the stack of open elements of an HTML parser or XML parser,
-
the element is not on the stack of open elements of an HTML parser or XML parser, and it is inserted into a document or removed from a document,
-
the element is not on the stack of open elements of an HTML parser or XML parser, and one of its child nodes is modified by a script,
For styling languages that consist of pure text (as opposed to XML), a style
element’s style data is the child text content of the style
element (not any
other nodes such as comments or elements), in tree order. For XML-based styling
languages, the style data consists of all the child nodes of the style
element.
The update a style
block algorithm for CSS (text/css
) is as
follows:
-
Let element be the
style
element. -
If element has an associated CSS style sheet, remove the CSS style sheet in question.
-
If element is not in a
Document
, then abort these steps. -
If the Should element’s inline behavior be blocked by Content Security Policy? algorithm returns "
Blocked
" when executed upon thestyle
element, "style
", and thestyle
element’s style data, then abort these steps. [CSP3] -
create a CSS style sheet with the following properties:
- type
-
text/css
- owner node
-
element
- media
-
The
media
attribute of element.This is a reference to the (possibly absent at this time) attribute, rather than a copy of the attribute’s current value. The CSSOM specification defines what happens when the attribute is dynamically set, changed, or removed.
- title
-
The
title
attribute of element.Again, this is a reference to the attribute.
- alternate flag
-
Unset.
- origin-clean flag
-
Set.
- parent CSS style sheet
- owner CSS rule
-
null
- disabled flag
-
Left at its default value.
- CSS rules
-
Left uninitialized.
This specification does not define any other styling language’s update a style
block algorithm.
Once the attempts to obtain the style sheet’s critical subresources, if any, are
complete, or, if the style sheet has no critical subresources, once the style sheet has
been parsed and processed, the user agent must, if the loads were successful or there were none, queue a task to fire a simple event named load
at the style
element, or, if one of the style sheet’s critical subresources failed
to completely load for any reason (e.g., DNS error, HTTP 404 response, a connection being
prematurely closed, unsupported Content-Type), queue a task to fire a simple event named error
at the style
element. Non-network errors in processing the
style sheet or its subresources (e.g., CSS parse errors, PNG decoding errors) are not failures
for the purposes of this paragraph.
The task source for these tasks is the DOM manipulation task source.
The element must delay the load event of the element’s node document until all the attempts to obtain the style sheet’s critical subresources, if any, are complete.
This specification does not specify a style system, but CSS is expected to be supported by most Web browsers. [CSS-2015]
The media
, and type
IDL attributes must reflect the respective content
attributes of the same name.
The LinkStyle
interface is also implemented by this element. [CSSOM]
<!DOCTYPE html> <html> <head> <title>My favorite book</title> <style> body { color: black; background: white; } em { font-style: normal; color: red; } </style> </head> <body> <p>My <em>favorite</em> book of all time has <em>got</em> to be <cite>A Cat’s Life</cite>. It is a book by P. Rahmel that talks about the <i lang="la">Felis Catus</i> in modern human society.</p> </body> </html>
4.2.7. Interactions of styling and scripting
Style sheets, whether added by a link
element, a style
element, an <?xml-stylesheet?>
PI, an HTTP Link
header, or some other
mechanism, have a style sheet ready flag, which is initially unset.
When a style sheet is ready to be applied, its style sheet ready flag must be set. If the
style sheet referenced no other resources (e.g., it was an internal style sheet given by a style
element with no @import
rules), then the style rules must be immediately made available to script; otherwise, the style rules must only be made
available to script once the event loop reaches its update the rendering step.
A style sheet in the context of the Document
of an HTML parser or XML parser is
said to be a style sheet that is blocking scripts if the element was created by that Document
's parser, and the element is either a style
element or a link
element that
was an external resource link when the element was created by
the parser, and the element’s style sheet was enabled when the element was created by the parser,
and the element’s style sheet ready flag is not yet set, and, the last time the event loop reached step 1, the element was in that Document
, and the user
agent hasn’t given up on that particular style sheet yet. A user agent may give up on a style
sheet at any time.
Giving up on a style sheet before the style sheet loads, if the style sheet eventually does still load, means that the script might end up operating with incorrect information. For example, if a style sheet sets the color of an element to green, but a script that inspects the resulting style is executed before the sheet is loaded, the script will find that the element is black (or whatever the default color is), and might thus make poor choices (e.g., deciding to use black as the color elsewhere on the page, instead of green). Implementors have to balance the likelihood of a script using incorrect information with the performance impact of doing nothing while waiting for a slow network request to finish.
A Document
has a style sheet that is blocking scripts if there is either a style sheet that is blocking scripts in the context of that Document
, or
if that Document
is in a browsing context that has a parent browsing context, and the active document of that parent browsing context itself has a style sheet that is blocking scripts.
A Document
has no style sheet that is blocking scripts if it does not have a style sheet that is blocking scripts as defined in the previous paragraph.
4.3. Sections
4.3.1. The body
element
- Categories:
- Sectioning root.
- Contexts in which this element can be used:
- As the second element in an
html
element. - Content model:
- Flow content.
- Tag omission in text/html:
- A
body
element’s start tag may be omitted if the element is empty, or if the first thing inside thebody
element is not a space character or a comment, except if the first thing inside thebody
element is ameta
,link
,script
,style
, ortemplate
element.- A
body
element’s end tag may be omitted if thebody
element is not immediately followed by a comment. - A
- Content attributes:
- Global attributes
onafterprint
onbeforeprint
onbeforeunload
onhashchange
onlanguagechange
onmessage
onoffline
ononline
onpagehide
onpageshow
onpopstate
onrejectionhandled
onstorage
onunhandledrejection
onunload
- Allowed ARIA role attribute values:
-
document
role (default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default role. - Any
- DOM interface:
-
interface
HTMLBodyElement
: HTMLElement { }; HTMLBodyElement implements WindowEventHandlers;
The body
element represents the content of the document.
In conforming documents, there is only one body
element. The document.body
IDL attribute provides scripts with easy access to a document’s body
element.
Some DOM operations (for example, parts of the drag and drop model) are defined in terms
of "the body
element". This refers to a particular element in the DOM, as per the
definition of the term, and not any arbitrary body
element.
The body
element exposes as event handler content attributes a number of the event handlers of the Window
object. It also mirrors their event handler IDL attributes.
The onblur
, onerror
, onfocus
, onload
, onresize
, and onscroll
event handlers of the Window
object, exposed on the body
element, replace the generic event handlers with
the same names normally supported by HTML elements.
Thus, for example, a bubbling error
event dispatched on a child of the body
element of a Document
would first trigger the onerror
event handler content attributes of that element, then that of the root html
element, and only then would it trigger the onerror
event handler
content attribute on the body
element. This is because the event would bubble
from the target, to the body
, to the html
, to the Document
, to the Window
, and the event handler on the body
is watching the Window
not the body
. A regular event
listener attached to the body
using addEventListener()
, however, would
be run when the event bubbled through the body
and not when it reaches the Window
object.
<!DOCTYPE html> <html> <head> <title>Online or offline?</title> <script> function update(online) { document.getElementById('status').textContent = online ? 'Online' : 'Offline'; } </script> </head> <body ononline="update(true)" onoffline="update(false)" onload="update(navigator.onLine)"> <p>You are: <span id="status">(Unknown)</span></p> </body> </html>
4.3.2. The article
element
- Categories:
- Flow content.
- Sectioning content.
- Palpable content.
- Sectioning content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content, but with no
main
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
article
(default - do not set),application
,document
,feed
,main
,none
,presentation
orregion
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The article
element represents a complete, or self-contained, composition in a
document, page, application, or site. This could be a magazine, newspaper, technical or
scholarly article, an essay or report, a blog or other social media post.
A general rule is that the article
element is appropriate only if the element’s contents
would be listed explicitly in the document’s outline. Each article
should be identified,
typically by including a heading(h1
-h6
element) as a child of the article
element.
Assistive Technology may convey the semantics of the article
to users. This
information can provide a hint to users as to the type of content. For example the role
of the element, which in this case matches the element name "article",
can be announced by screen reader software when a user navigates to an article
element.
User Agents may also provide methods to navigate to article
elements.
An article
element may contain other nested elements to provide additional semantics
to different portions of the article
. For instance, an article
may consist of a header
that contains the primary heading of the article
,
with other elements to provide lead-in or meta content about the article
prose.
Additionally, an article may consist of various subsections that, together, form the complete
composition. These subsections may be implied by the use of appropriately ranked headings
(h1
-h6
elements), or may be explicitly set by use of a section
element or elements.
When article
elements are nested, the inner article
elements represent articles that
are in principle related to the contents of the outer article. For instance, a blog entry on a
site could consist of summaries of other blog entries in article
elements nested within
the article
element for the blog entry.
The following is an example of a blog post extract, marked up using the article
element:
<article> <header> <h2><a href="https://example.com/short-note/">Short note on wearing shorts</a></h2> <p><a href="https://example.com/short-note/#comments">6 comments</a></p> </header> <p> A fellow traveller posed an interesting question: Why do you wear shorts rather than longs? The short answer is that I enjoy wearing shorts, the long answer is... </p> <p> <a href="https://example.com/short-note/">Continue reading: Short note on wearing shorts</a> </p> </article>
The schema.org vocabulary can be used to provide more granular information about the type of article, using the CreativeWork - Article subtypes, other information such as the publication date for the article can also be provided.
article
element, with some schema.org annotations:
<article vocab="http://schema.org/" typeof="Article"> <header> <h2 property="name">The Very First Rule of Life</h2> <p property="datePublished"><time datetime="2018-02-07">3 days ago</time></p> </header> <div property="articleBody"> <p>Always check that your computer is plugged in before you complain it isn’t working.</p> </div> <footer> <a href="?comments=1">Show comments...</a> </footer> </article>
Here is that same blog post, but showing some of the comments:
<article> <header> <h2>The Very First Rule of Life</h2> <p><time datetime="2018-02-07">3 days ago</time></p> </header> <p>Always check that your computer is plugged in before you complain it isn’t working.</p> <section> <h3>Comments</h3> <ol> <li id="c1"> <p>Posted by: <span>George Washington</span> </p> <p><time datetime="2018-02-10">15 minutes ago</time></p> <p>Yeah! I’ve done that!</p> </li> <li id="c2"> <p>Posted by: <span>George Hammond</span> </p> <p><time datetime="2018-02-10">5 minutes ago</time></p> <p>Hey, you have the same first name as me.</p> </li> </ol> </section> </article>
Notice the use of an ordered list (ol
element) to organize the comments.
Also note these comments are considered a subsection of the article, identified
by the section
element they are nested within.
4.3.3. The section
element
- Categories:
- Flow content.
- Sectioning content.
- Palpable content.
- Sectioning content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
region
role (default - do not set),alert
,alertdialog
,application
,banner
,complementary
,contentinfo
,dialog
,document
,feed
,log
,main
,marquee
,navigation
,none
,presentation
,search
,status
ortabpanel
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
. - DPub Roles:
-
doc-abstract
,doc-acknowledgments
,doc-afterword
,doc-appendix
,doc-bibliography
,doc-chapter
,doc-colophon
,doc-conclusion
,doc-credit
,doc-credits
,doc-dedication
,doc-endnotes
,doc-epilogue
,doc-errata
,doc-example
,doc-foreword
,doc-index
,doc-introduction
,doc-notice
,doc-pagelist
,doc-part
,doc-preface
,doc-prologue
,doc-pullquote
,doc-qna
ordoc-toc
The section
element represents a generic section of a document or application.
A section, in this context, is a thematic grouping of content. Each section
should
be identified, typically by including a heading (h1
-h6
element) as a
child of the section
element.
Examples of sections would be chapters, the various tabbed pages in a tabbed dialog box, or the numbered sections of a thesis. A Web site’s home page could be split into sections for an introduction, news items, and contact information.
Unlike an article
, a section
may not be fully understandable if taken out of context
of its originating document or application. Authors are encouraged to use the article
element instead of the section
element when the content is a complete, or self-contained,
composition.
While the section
element represents a generic section of a document or application, it is not a generic container element. When a wrapping element is needed for styling
purposes, or as a convenience for scripting, authors are encouraged to use the div
element instead. A general rule is that the section
element is appropriate only if
the element’s contents would be listed explicitly in the document’s outline.
Assistive Technology may convey the semantics of the section
to users when the element has
an explicit label. This information can provide a hint to users as to the type of content.
For example the role
of the element, which in this case is "region", can be
announced by screen reader software when a user navigates to an section
element.
User Agents may also provide methods to navigate to section
elements.
The section
has an aria-label
attribute providing a brief description of the
contents. Assistive technology may convey the region
role along with the aria-label
value as a hint to users.
<article> <header> <h2>Apples</h2> <p>Tasty, delicious fruit!</p> </header> <p>The apple is the pomaceous fruit of the apple tree.</p> <section aria-label="Red apples."> <h3>Red Delicious</h3> <p>These bright red apples are found in many supermarkets.</p> </section> <section aria-label="Green apples."> <h3>Granny Smith</h3> <p>These juicy, green apples make a great filling for apple pies.</p> </section> </article>
section
there could
exist article
s, providing brief bios, academic achievements, and personal
note from the graduates.
<!DOCTYPE html> <html> <head> <title>Graduation Ceremony Summer 2022</title> </head> <body> <h1>Graduation</h1> <section> <h2>Ceremony</h2> <p>Opening Procession</p> <p>Speech by Valedictorian</p> <p>Speech by Class President</p> <p>Presentation of Diplomas</p> <p>Closing Speech by Headmaster</p> </section> <section> <h2>Graduates</h2> <ul> <li>Molly Carpenter</li> <li>Anastasia Luccio</li> <li>Ebenezar McCoy</li> <li>Karrin Murphy</li> <li>Thomas Raith</li> <li>Susan Rodriguez</li> </ul> <article> <h3>About Molly Carpenter</h3> <p> Molly was valedictorian of her class, graduating with a GPA of... </p> </article> ... </section> </body> </html>
article
element as part of an even larger document containing other books.
<style> section { border: double medium; margin: 2em; } section.chapter h3 { font: 2em Roboto, Helvetica Neue, sans-serif; } section.appendix h3 { font: small-caps 2em Roboto, Helvetica Neue, sans-serif; } </style> ... <article class="book"> <header> <h2>My Book</h2> <p>A sample with not much content</p> <p><small>Published by Example Publishing.</small></p> </header> <section class="chapter"> <h3>My First Chapter</h3> <p>This is the first of my chapters. It doesn’t say much.</p> <p>But it has two paragraphs!</p> </section> <section class="chapter"> <h3>It Continues: The Second Chapter</h3> <p>Bla dee bla, dee bla dee bla. Boom.</p> </section> <section class="chapter"> <h3>Chapter Three: A Further Example</h3> <p>It’s not like a battle between brightness and earthtones would go unnoticed.</p> <p>But it might ruin my story.</p> </section> <section class="appendix"> <h3>Appendix A: Overview of Examples</h3> <p>These are demonstrations.</p> </section> <section class="appendix"> <h3>Appendix B: Some Closing Remarks</h3> <p>Hopefully this long example shows that you <em>can</em> style sections, so long as they are used to indicate actual sections.</p> </section> </article>
4.3.4. The nav
element
- Categories:
- Flow content.
- Sectioning content.
- Palpable content.
- Sectioning content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content, but with no
main
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
navigation
role (default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default role. - Any
- DOM interface:
- Uses
HTMLElement
. - DPub Roles:
-
doc-index
,doc-pagelist
ordoc-toc
The nav
element represents a section of a page that links to other pages or to
parts within the page: a section with navigation links.
Assistive Technology may convey the semantics of the nav
to users. This information can
provide a hint to users as to the type of content. For example the role
of the
element, which in this case is "navigation", can be announced by screen reader software when
a user navigates to an nav
element. User Agents may also provide methods to navigate to nav
elements.
In cases where the content of a nav
element represents a list of items, use list
markup to aid understanding and navigation.
Not all groups of links on a page need to be in a nav
element — the element is
primarily intended for sections that consist of major navigation blocks. In particular, it is
common for footers to have a short list of links to various pages of a site, such as the terms
of service, the home page, and a copyright page. The footer
element alone is sufficient
for such cases; while a nav
element can be used in such cases, it is usually unnecessary.
User agents (such as screen readers) that are targeted at users who can benefit from navigation information being omitted in the initial rendering, or who can benefit from navigation information being immediately available, can use this element as a way to determine what content on the page to initially skip or provide on request (or both).
nav
elements, one for primary navigation
around the site, and one for secondary navigation around the page itself.
<body> <h1>The Wiki Center Of Exampland</h1> <nav> <ul> <li><a href="/">Home</a></li> <li><a href="/events">Current Events</a></li> </ul> </nav> <article> <header> <h2>Demos in Exampland</h2> <p>Written by A. N. Other.</p> </header> <nav> <ul> <li><a href="#public">Public demonstrations</a></li> <li><a href="#destroy">Demolitions</a></li> </ul> </nav> <div> <section id="public"> <h2>Public demonstrations</h2> </section> <section id="destroy"> <h2>Demolitions</h2> </section> </div> <footer> <p><a href="?edit">Edit</a> | <a href="?delete">Delete</a> | <a href="?Rename">Rename</a></p> </footer> </article> <footer> <p><small>© copyright 1998 Exampland Emperor</small></p> </footer> </body>
<body typeof="schema:Blog"> <header> <h1>Wake up sheeple!</h1> <p><a href="news.html">News</a> - <a href="blog.html">Blog</a> - <a href="forums.html">Forums</a></p> <p>Last Modified: <span property="schema:dateModified">2009-04-01</span></p> <nav> <h2>Navigation</h2> <ul> <li><a href="articles.html">Index of all articles</a></li> <li><a href="today.html">Things sheeple need to wake up for today</a></li> <li><a href="successes.html">Sheeple we have managed to wake</a></li> </ul> </nav> </header> <main> <article property="schema:blogPosts" typeof="schema:BlogPosting"> <header> <h2 property="schema:headline">My Day at the Beach</h2> </header> <section property="schema:articleBody"> <p>Today I went to the beach and had a lot of fun.</p> ... </section> <footer> <p>Posted <time property="schema:datePublished" datetime="2009-10-10">Thursday</time>.</p> </footer> </article> ... </main> <footer> <p>Copyright © <span property="schema:copyrightYear">2010</span> <span property="schema:copyrightHolder">The Example Company</span> </p> <p><a href="about.html">About</a> - <a href="policy.html">Privacy Policy</a> - <a href="contact.html">Contact Us</a></p> </footer> </body>
Notice the main
element being used to wrap the main content of the page. In this
case, all content other than the page header and footer.
You can also see microdata annotations in the above example that use the schema.org vocabulary to provide the publication date and other metadata about the blog post.
nav
element doesn’t have to contain a list, it can contain other kinds of content
as well. In this navigation block, links are provided in prose:
<nav> <h2>Navigation</h2> <p>You are on my home page. To the north lies <a href="/blog">my blog</a>, from whence the sounds of battle can be heard. To the east you can see a large mountain, upon which many <a href="/school">school papers</a> are littered. Far up this mountain you can spy a little figure who appears to be me, desperately scribbling out a <a href="/school/thesis">thesis</a>.</p> <p>To the west are several exits. One fun-looking exit is labeled <a href="https://games.example.com/">"games"</a>. Another more boring-looking exit is labeled <a href="https://isp.example.net/">ISP™</a>.</p> <p>To the south lies a dark and dank <a href="/about">contacts page</a>. Cobwebs cover its disused entrance, and at one point you see a rat run quickly out of the page.</p> </nav>
nav
is used in an e-mail application, to let the user switch folders:
<p><input type="button" value="Compose" onclick="compose()"></p> <nav> <h2>Folders</h2> <ul> <li><a href="/inbox" onclick="return openFolder(this.href)">Inbox</a> <span class="count"></span></li> <li><a href="/sent" onclick="return openFolder(this.href)">Sent</a></li> <li><a href="/drafts" onclick="return openFolder(this.href)">Drafts</a></li> <li><a href="/trash" onclick="return openFolder(this.href)">Trash</a></li> <li><a href="/customers" onclick="return openFolder(this.href)">Customers</a></li> </ul> </nav>
4.3.5. The aside
element
- Categories:
- Flow content.
- Sectioning content.
- Palpable content.
- Sectioning content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content, but with no
main
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
complementary
role (default - do not set),feed
,note
,presentation
,none
,region
orsearch
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
. - DPub Roles:
-
doc-example
,doc-footnote
,doc-pullquote
ordoc-tip
The aside
element represents a section of a page that consists of content that
is tangentially related to the content of the parenting sectioning content, and which
could be considered separate from that content. Such sections are often represented as sidebars
in printed typography.
The element can be used for typographical effects like pull quotes or sidebars, for advertising,
for groups of nav
elements, and for other content that is considered separate from
the main content of the nearest ancestor sectioning content.
Assistive Technology may convey the semantics of the aside
to users. This information can
provide a hint to users as to the type of content. For example the role
of
the element, which in this case is "complementary", can be announced by screen reader software
when a user navigates to an aside
element. User Agents may also provide methods to navigate
to aside
elements.
It’s not appropriate to use the aside
element just for parentheticals, since those
are part of the main flow of the document.
<aside> <h2>Switzerland</h2> <p>Switzerland, a land-locked country in the middle of geographic Europe, has not joined the geopolitical European Union, though it is a signatory to a number of European treaties.</p> </aside>
... <p>She later joined a large company, continuing on the same work.</p> <q>I love my job. People ask me what I do for fun when I’m not at work. But I’m paid to do my hobby, so I never know what to answer. Some people wonder what they would do if they didn’t have to work... but I know what I would do, because I was unemployed for a year, and I filled that time doing exactly what I do now.</q></p> <aside> <q> People ask me what I do for fun when I’m not at work. But I’m paid to do my hobby, so I never know what to answer. </q> </aside> <p>Of course her work — or should that be hobby? — isn’t her only passion. She also enjoys other pleasures.</p> ...
aside
can be used for blogrolls and other side
content on a blog:
<body> <header> <h1>My wonderful blog</h1> </header> <aside> <!-- this aside contains two sections that are tangentially related to the page, namely, links to other blogs, and links to blog posts from this blog --> <nav> <h2>My blogroll</h2> <ul> <li><a href="https://blog.example.com/">Example Blog</a></li> </ul> </nav> <nav> <h2>Archives</h2> <ol> <li><a href="/last-post">My last post</a></li> <li><a href="/first-post">My first post</a></li> </ol> </nav> </aside> <aside> <!-- this aside is tangentially related to the page also, it contains twitter messages from the blog author --> <h2>Twitter Feed</h2> <blockquote cite="https://twitter.example.net/t31351234"> I’m on vacation, writing my blog. </blockquote> <blockquote cite="https://twitter.example.net/t31219752"> I’m going to go on vacation soon. </blockquote> </aside> <article> <!-- this is a blog post --> <h2>My last post</h2> <p>This is my last post.</p> <footer> <p><a href="/last-post" rel="bookmark">Permalink</a></p> </footer> </article> <article> <!-- this is also a blog post --> <h2>My first post</h2> <p>This is my first post.</p> <aside> <!-- this aside is about the blog post, since it’s inside the <article> element; it would be wrong, for instance, to put the blogroll here, since the blogroll isn’t really related to this post specifically, only to the page as a whole --> <h1>Posting</h1> <p>While I’m thinking about it, I wanted to say something about posting. Posting is fun!</p> </aside> <footer> <p><a href="/first-post" rel="bookmark">Permalink</a></p> </footer> </article> <footer> <nav> <a href="/archives">Archives</a> — <a href="/about">About me</a> — <a href="/copyright">Copyright</a> </nav> </footer> </body>
4.3.6. The h1
, h2
, h3
, h4
, h5
, and h6
elements
- Categories:
- Flow content.
- Heading content.
- Palpable content.
- Heading content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
heading
role (default - do not set),none
,presentation
ortab
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLHeadingElement
: HTMLElement {}; - DPub Roles:
-
doc-subtitle
These elements represent headings for their sections.
These elements have a rank given by the number in their name. The h1
element has the highest rank, the h6
element has the lowest rank, and two
elements with the same name have equal rank.
Use the rank of heading elements to create the document outline.
<body> <h1>top level heading</h1> <section> <h2>2nd level heading</h2> <section> <h3>3nd level heading</h3> <section> <h4>4th level heading</h4> <section> <h5>5th level heading</h5> <section> <h6>6th level heading</h6> </section> </section> </section> </section> </section> </body>
The document outline would be the same if the section
elements were not used.
h1
–h6
elements must not be used to markup subheadings, subtitles,
alternative titles and taglines unless intended to be the heading for a new section or
subsection.
Instead use the markup patterns in the §4.13 Common idioms without dedicated elements section of
the specification.
Assistive technology often announces the presence and level of a heading to users, as a hint
to understand the structure of a document and construct a 'mental model' of its outline.
For example the role
of the element, which in this case is "heading" and the
heading level "1" to "6", can be announced by screen reader software when a user navigates to
an h1
–h6
element. User Agents may also provide methods to navigate to h1
–h6
elements.
<body> <h1>Let’s call it a draw(ing surface)</h1> <h2>Diving in</h2> <h2>Simple shapes</h2> <h2>Canvas coordinates</h2> <h3>Canvas coordinates diagram</h3> <h2>Paths</h2> </body>
<body> <h1>Let’s call it a draw(ing surface)</h1> <section> <h2>Diving in</h2> </section> <section> <h2>Simple shapes</h2> </section> <section> <h2>Canvas coordinates</h2> <section> <h3>Canvas coordinates diagram</h3> </section> </section> <section> <h2>Paths</h2> </section> </body>
Authors might prefer the former style for its terseness, or the latter style for its convenience in the face of heavy editing; which is best is purely an issue of preferred authoring style.
The two styles can be combined, for compatibility with legacy tools while still future-proofing for when that compatibility is no longer needed.
The semantics and meaning of the h1
–h6
elements are further
detailed in the section on §4.3.9 Headings and sections.
4.3.7. The header
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content, but with no
main
element descendants, orheader
,footer
elements that are not descendants of sectioning content which is a descendant of theheader
. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
banner
role (default - do not set),group
,none
orpresentation
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
. - DPub Roles:
-
doc-footnote
The header
element represents introductory content for its nearest ancestor main
element, sectioning content, or sectioning root element. A header
typically
contains a group of introductory or navigational aids.
When a header
element’s nearest ancestor sectioning root element is the body
element, and it is not a descendant of the main
element or a sectioning content element, then that header
is scoped to the body
element and represents mostly
site-oriented content, or introductory content for the page as a whole.
Assistive Technology may convey to users the semantics of the header
element when it applies
to the whole page. This information can provide a hint as to the type of content. For example,
the role
of the element, which in this case is "banner
", can be announced
by screen reader software when a user navigates to a header
element that is scoped to the body
element. User Agents may also provide methods to navigate to a header
element
scoped to the body
element.
A header
element is intended to usually contain the section’s heading
(an h1
–h6
element), but this is not required. The header
element
can also be used to wrap a section’s table of contents, a search form, or any relevant logos.
<header> <h1>Scalable Vector Graphics (SVG) 1.2</h1> <p>W3C Working Draft 27 October 2004</p> <dl> <dt>This version:</dt> <dd><a href="https://www.w3.org/TR/2004/WD-SVG12-20041027/">https://www.w3.org/TR/2004/WD-SVG12-20041027/</a></dd> </dl> </header>
The following snippet shows how one might use headers within a blog. The first header
provides introductory content for the page as a whole, and is scoped to the body
element. The second provides introductory content to the primary article of the page:
<body> <header> <nav> <a href="/">My Awesome blog</a> <ul> <li><a href="/new-articles">Latest</a></li> <li><a href="/old-articles">Archive</a></li> <li><a href="/contact">Contact</a></li> </ul> </nav> </header> <main> <article> <header> <h1> My great post! </h1> <p>Hello world!</p> </header> </article> </main> </body>
The next example shows a misuse of a header
, as its content does not represent an
introduction to its parent sectioning content:
<article> <h2>Spinning Straw into Gold</h2> <p>A primer on getting rich quick, while avoiding making horrible promises.</p> ... <header> <h3>Make a point to learn obscure names</h3> </header> ... </article>
Modifying the previous example, the following markup better aligns to the appropriate usage
for a header
. Now the content that appropriately introduces the article
is wrapped
within a header
, and the content that was previously in a header
is now
appropriately scoped to a subsection of the article
:
<article> <header> <h2>Spinning Straw into Gold</h2> <p>A primer on getting rich quick, while avoiding making horrible promises.</p> </header>This text will guide you through the necessary steps to complete this impossible task... <section> <header> <h3>Make a point to learn obscure names</h3> </header>
If you are tasked with guessing someone’s name, then it should be safe to assume that common names won’t get you far... </section> </article>
The header
element is not sectioning content; it doesn’t introduce a new section,
though headings within a header
will indicate new sections to the page.
h1
element, and two subsections
whose headings are given by h2
elements. The content after the header
element is still
part of the last subsection started in the header
element, because the header
element
doesn’t take part in the outline algorithm.
<body> <header> <h1>Little Green Guys With Guns</h1> <nav> <ul> <li><a href="/games">Games</a></li> <li><a href="/forum">Forum</a></li> <li><a href="/download">Download</a></li> </ul> </nav> <h2>Important News</h2> <!-- this starts a second subsection --> <!-- this is part of the subsection entitled "Important News" --> <p>To play today’s games you will need to update your client.</p> <h2>Games</h2> <!-- this starts a third subsection --> </header> <p>You have three active games:</p> <!-- this is still part of the subsection entitled "Games" --> ...
For cases where a developer wants to nest a header
or footer
within
another header
: The header
element can only contain a header
or footer
if they are themselves contained within sectioning content.
In this example, the article
has a header
which contains an aside
which itself
contains a header
. This is conforming as the descendant header
is contained within the aside
element.
<article> <header> <h1>Flexbox: The definitive guide</h1> <aside> <header> <h2>About the author: Wes McSilly</h2> <p><a href="./wes-mcsilly/">Contact him! (Why would you?)</a></p> </header> <p>Expert in nothing but Flexbox. Talented circus sideshow.</p> </aside> </header> <p><ins>The guide about Flexbox was supposed to be here, but it turned out Wes wasn’t a Flexbox expert either.</ins></p> </article>
4.3.8. The footer
element
- Categories:
-
- Contexts in which this element can be used:
-
Where flow content is expected.
- Content model:
-
Flow content, but with no
main
element descendants, orheader
,footer
elements that are not descendants of sectioning content which is a descendant of thefooter
. - Tag omission in text/html:
-
Neither tag is omissible
- Content attributes:
- Allowed ARIA role attribute values:
-
contentinfo
role (default - do not set),group
,none
orpresentation
. - Allowed ARIA state and property attributes:
-
Any
aria-*
attributes applicable to the allowed roles. - DOM interface:
-
Uses
HTMLElement
. - DPub Roles:
The footer
element represents a footer for its nearest ancestor main
element or sectioning content or sectioning root element. A footer typically
contains information about its section, such as who wrote it, links to related documents,
copyright data, and the like.
A footer
element can also contain entire sections representing appendices,
indexes, long colophons, verbose license agreements, and other such content.
When a footer
element’s nearest ancestor sectioning root element is the body
element, and it is not a descendant of the main
element or a sectioning content element, then that footer
is scoped to the body
element and represents a footer for
the page as a whole.
Assistive Technology may convey to users the semantics of the footer
element when it applies
to the whole page.
This information can provide a hint as to the type of content. For example, the role
of the element, which in this case is "content information", can be announced by screen reader
software when a user navigates to a footer
element that is scoped to the body
element.
User Agents may also provide methods to navigate to a footer
element scoped to the body
element.
Contact information for the author or editor of a section belongs in an address
element, possibly itself inside a footer
. Bylines and other information that could
be suitable for both a header
or a footer
can be placed in either (or neither).
Footers don’t necessarily have to appear at the end of a section, though they usually do.
The footer
element is not sectioning content; it doesn’t introduce a new section.
<body> <footer><a href="../">Back to index...</a></footer> <div> <h1>Example Page</h1> <p>This is an example</p> </div> <p>Some text explaining the example.</p> <footer><a href="../">Back to index...</a></footer> </body>
footer
element being used both for a site-wide
footer and for a section footer.
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>The Ramblings of a Scientist</title> </head> <body> <h1>The Ramblings of a Scientist</h1> <main> <article> <h2>Episode 15</h2> <video src="/fm/015.ogv" controls preload> <p><a href="/fm/015.ogv">Download video</a>.</p> </video> <footer> <!-- footer for article --> <p>Published <time datetime="2009-10-21T18:26-07:00">on 2009/10/21 at 6:26pm</time></p> </footer> </article> <article> <h2>My Favorite Trains</h2> <p>I love my trains. My favorite train of all time is a Köf.</p> <p>It is fun to see them pull some coal cars because they look so dwarfed in comparison.</p> <footer> <!-- footer for article --> <p>Published <time datetime="2009-09-15T14:54-07:00">on 2009/09/15 at 2:54pm</time></p> </footer> </article> </main> <footer> <!-- site wide footer --> <nav> <p> <a href="/credits.html">Credits</a> —<wbr><a href="/tos.html">Terms of Service</a> —<wbr><a href="/index.html">Blog Index</a> </p> </nav> <p>Copyright © 2009 Gordon Freeman</p> </footer> </body> </html>
This fragment shows the bottom of a page on a site with a "fat footer":
... <footer> <section> <h2>Articles</h2> <p> <img src="images/somersaults.jpeg" alt> Go to the gym with our somersaults class! Our teacher Jim takes you through the paces in this two-part article. <a href="articles/somersaults/1">Somersaults: Part 1</a>· <a href="articles/somersaults/2">Somersaults: Part 2</a>. </p> <p> <img src="images/kindplus.jpeg" alt> Tired of walking on the edge of a clif<!-- sic -->? Our guest writer Lara shows you how to bumble your way through the bars. <a href="articles/kindplus/1">Read more...</a> </p> <p> <img src="images/crisps.jpeg" alt> The chips are down, now all that’s left is a potato. What can you do with it? <a href="articles/crisps/1">Read more...</a> </p> </section> <nav> <ul> <li><a href="/about">About us...</a></li> <li><a href="/feedback">Send feedback!</a></li> <li><a href="/sitemap">Sitemap</a></li> </ul> </nav> <p> <small>Copyright © 2018 — <a href="/tos">Terms of Service</a></small> </p> </footer> </body>
4.3.9. Headings and sections
The h1
–h6
elements are headings.
The first element of heading content in an element of sectioning content represents the heading for that explicit section. Subsequent headings of equal or higher rank start new implied subsections that are part of the previous section’s parent section. Subsequent headings of lower rank start new implied subsections that are part of the previous one. In both cases, the element represents the heading of the implied section.
h1
–h6
elements must not be used to markup subheadings, subtitles,
alternative titles and taglines unless intended to be the heading for a new section or
subsection. Instead use the markup patterns in the §4.13 Common idioms without dedicated elements section of the specification.
Certain elements are said to be sectioning roots, including blockquote
and td
elements. These elements can have their own outlines, but the sections and
headings inside these elements do not contribute to the outlines of their ancestors.
Sectioning content elements are always considered subsections of their nearest ancestor sectioning root or their nearest ancestor element of sectioning content, whichever is nearest, regardless of what implied sections other headings may have created.
<body> <h1>Foo</h1> <h2>Bar</h2> <blockquote> <h3>Bla</h3> </blockquote> <p>Baz</p> <h2>Quux</h2> <section> <h3>Thud</h3> </section> <p>Grunt</p> </body>
...the structure would be:
-
Foo (heading of explicit
body
section, containing the "Grunt" paragraph)-
Bar (heading starting implied section, containing a block quote and the "Baz" paragraph)
-
Quux (heading starting implied section with no content other than the heading itself)
-
Thud (heading of explicit
section
section)
-
Notice how the section
ends the earlier implicit section so that a later paragraph
("Grunt") is back at the top level.
Sections may contain headings of a rank equal to their section nesting level. Authors should use headings of the appropriate rank for the section’s nesting level.
Authors are also encouraged to explicitly wrap sections in elements of sectioning content, instead of relying on the implicit sections generated by having multiple headings in one element of sectioning content.
<body> <h1>Apples</h1> <p>Apples are fruit.</p> <section> <h2>Taste</h2> <p>They taste lovely.</p> <h3>Sweet</h3> <p>Red apples are sweeter than green ones.</p> <h3>Color</h3> <p>Apples come in various colors.</p> </section> </body>
However, the same document would be more clearly expressed as:
<body> <h1>Apples</h1> <p>Apples are fruit.</p> <section> <h2>Taste</h2> <p>They taste lovely.</p> <section> <h3>Sweet</h3> <p>Red apples are sweeter than green ones.</p> </section> <section> <h3>Color</h3> <p>Apples come in various colors.</p> </section> </section> </body>
Both of the documents above are semantically identical and would produce the same outline in compliant user agents.
4.3.9.1. Creating an outline
There are currently no known native implementations of the outline algorithm in graphical browsers or assistive technology user agents, although the algorithm is implemented in other software such as conformance checkers and browser extensions. Additionally, there is an W3C HTML issue #1005 and W3C HTML issue #830). Any implementation and usage of these different proposals will be tracked, and may result in significant future changes to the outline algorithm.
Therefore, the outline algorithm cannot be relied upon to convey document structure
to users. Authors should use heading rank (h1
-h6
) to
convey document structure.
This section is non-normative
This section defines an algorithm for creating an outline for a sectioning content element or a sectioning root element. It is defined in terms of a walk over the nodes of a DOM tree, in tree order, with each node being visited when it is entered and when it is exited during the walk. Each time a node is visited, it can be seen as triggering an enter or exit event.
visitNode(node) onEnter(node) child = node.firstChild while(child != null) visitNode(child) child = child.nextSibling onExit(node)
...exemplifies how to recursively traverse the node tree and when to trigger the enter and exit events. See the JavaScript example for a possible, non-recursive JavaScript implementation.
The outline for a sectioning content element or a sectioning root element consists of a list of one or more potentially nested sections. The element for which an outline is created is said to be the outline’s owner.
A section is a container that corresponds to some nodes in the original DOM tree. Each section can have one heading associated with it, and can contain any number of further nested subsections. The algorithm for the outline also associates each node in the DOM tree with a particular section and potentially a heading. (The sections in the outline aren’t section elements, though some may correspond to such elements — they are merely conceptual sections.)
<body> <h1>A</h1> <p>B</p> <h2>C</h2> <p>D</p> <h2>E</h2> <p>F</p> </body>
...results in the following outline being created for the body
node (and thus the
entire document):
-
Section created for
body
node. Associated with heading "A". Also associated with paragraph "B". Nested sections:-
Section implied for first
h2
element. Associated with heading "C". Also associated with paragraph "D". No nested sections. -
Section implied for second
h2
element. Associated with heading "E". Also associated with paragraph "F". No nested sections.
-
The algorithm that must be followed during a walk of a DOM subtree rooted at a sectioning content element or a sectioning root element to determine that element’s outline is as follows:
-
Let current outline owner be null. (It holds the element whose outline is being created.)
-
Let current section be null. (It holds a pointer to a section, so that elements in the DOM can all be associated with a section.)
-
Create a stack to hold elements, which is used to handle nesting. Initialize this stack to empty.
-
Walk over the DOM in tree order, starting with the sectioning content element or sectioning root element at the root of the subtree for which an outline is to be created, and trigger the first relevant step below for each element as the walk enters and exits it.
- When exiting an element, if that element is the element at the top of the stack
-
The element being exited is a heading content element or an element with a
attribute.
Pop that element from the stack.
- If the top of the stack is a heading content element or an element with a
attribute
- Do nothing.
- When entering an element with a
attribute
- Push the element being entered onto the stack. (This causes the algorithm to skip that element and any descendants of the element.)
- When entering a sectioning content element
-
Run these steps:
-
If current outline owner is not null, run these substeps:
-
If the current section has no heading, create an implied heading and let that be the heading for the current section.
-
Push current outline owner onto the stack.
-
-
Let current outline owner be the element that is being entered.
-
Let current section be a newly created section for the current outline owner element.
-
Associate current outline owner with current section.
-
Let there be a new outline for the new current outline owner, initialized with just the new current section as the only section in the outline.
-
- When exiting a sectioning content element, if the stack is not empty
-
Run these steps:
-
If the current section has no heading, create an implied heading and let that be the heading for the current section.
-
Pop the top element from the stack, and let the current outline owner be that element.
-
Let current section be the last section in the outline of the current outline owner element.
-
Append the outline of the sectioning content element being exited to the current section. (This does not change which section is the last section in the outline.)
-
- When entering a sectioning root element
-
Run these steps:
-
If current outline owner is not null, push current outline owner onto the stack.
-
Let current outline owner be the element that is being entered.
-
Let current outline owner’s parent section be current section.
-
Let current section be a newly created section for the current outline owner element.
-
Let there be a new outline for the new current outline owner, initialized with just the new current section as the only section in the outline.
-
- When exiting a sectioning root element, if the stack is not empty
-
Run these steps:
-
If the current section has no heading, create an implied heading and let that be the heading for the current section.
-
Let current section be current outline owner’s parent section.
-
Pop the top element from the stack, and let the current outline owner be that element.
-
- When exiting a sectioning content element or a sectioning root element (when the stack is empty)
-
The current outline owner is the element being exited, and it is the sectioning content element or a sectioning root element at the root of the subtree for which an outline is being generated.
If the current section has no heading, create an implied heading and let that be the heading for the current section.
Skip to the next step in the overall set of steps. (The walk is over.)
- When entering a heading content element
-
If the current section has no heading, let the element being entered be the
heading for the current section.
Otherwise, if the heading of the last section of the outline of the current outline owner is an implied heading, or if the heading being entered has a rank equal to or higher than the heading of the last section of the outline of the current outline owner, then create a new section and append it to the outline of the current outline owner element, so that this new section is the new last section of that outline. Let current section be that new section. Let the element being entered be the new heading for the current section.
Otherwise, run these substeps:
-
Let candidate section be current section.
-
Heading loop: If the element being entered has a rank lower than the rank of the heading of the candidate section, then create a new section, and append it to candidate section. (This does not change which section is the last section in the outline.) Let current section be this new section. Let the element being entered be the new heading for the current section. Abort these substeps.
-
Let new candidate section be the section that contains candidate section in the outline of current outline owner.
-
Let candidate section be new candidate section.
-
Return to the step labeled heading loop.
Push the element being entered onto the stack. (This causes the algorithm to skip any descendants of the element.)
Recall that
h1
has the highest rank, andh6
has the lowest rank. -
- Otherwise
- Do nothing.
In addition, whenever the walk exits a node, after doing the steps above, if the node is not associated with a section yet, associate the node with the section current section.
-
Associate all non-element nodes that are in the subtree for which an outline is being created with the section with which their parent element is associated.
-
Associate all nodes in the subtree with the heading of the section with which they are associated, if any.
The tree of sections created by the algorithm above, or a proper subset thereof, must be used when generating document outlines, for example when generating tables of contents.
The outline created for the body
element of a Document
is the outline of the entire document.
When creating an interactive table of contents, entries should jump the user to the relevant sectioning content element, if the section was created for a real element in the original document, or to the relevant heading content element, if the section in the tree was generated for a heading in the above process.
Selecting the first section of the document therefore always takes the user to the top
of the document, regardless of where the first heading in the body
is to be
found.
The outline depth of a heading content element associated with a section section is the number of sections that are ancestors of section in the outermost outline that section finds itself in when
the outlines of its Document
's elements are created, plus 1. The outline depth of a heading content element not associated with a section is 1.
User agents should provide default headings for sections that do not have explicit section headings.
<body> <nav> <p><a href="/">Home</a></p> </nav> <p>Hello world.</p> <aside> <p>My cat is cute.</p> </aside> </body>
Although it contains no headings, this snippet has three sections: a document (the body
) with two subsections (a nav
and an aside
). A user
agent could present the outline as follows:
-
Untitled document
-
Navigation
-
Sidebar
-
These default headings ("Untitled document", "Navigation", "Sidebar") are not specified by this specification, and might vary with the user’s language, the page’s language, the user’s preferences, the user agent implementor’s preferences, etc.
function (root, enter, exit) { var node = root; start: while (node) { enter(node); if (node.firstChild) { node = node.firstChild; continue start; } while (node) { exit(node); if (node == root) { node = null; } else if (node.nextSibling) { node = node.nextSibling; continue start; } else { node = node.parentNode; } } } }
4.3.10. Usage summary
This section is non-normative.
Element | Purpose |
---|---|
Example | |
body
| |
<!DOCTYPE html> <html> <head> <title>Steve Hill’s Home Page</title> </head> <body> <p>Hard Trance is My Life.</p> </body> </html> | |
article
| |
<article> <h2>Masif tee</h2> <img src="/example.jpg" alt="Yellow smiley face with the caption 'masif'"> <p>My fave Masif tee so far!</p> <footer>Posted 2 days ago</footer> </article> <article> <h2>Masif’s birthday</h2> <img src="/example2.jpg" alt=""> <p>Happy 2nd birthday Masif Saturdays!!!</p> <footer>Posted 3 weeks ago</footer> </article> | |
section
| |
<h1>Biography</h1> <section> <h2>The facts</h2> <p>1500+ shows, 14+ countries</p> </section> <section> <h2>2010/2011 figures per year</h2> <p>100+ shows, 8+ countries</p> </section> | |
nav
| |
<nav> <ul> <li><a href="/">Home</a> <li><a href="/biog.html">Bio</a> <li><a href="/discog.html">Discog</a> </ul> </nav> | |
aside
| |
<h1>Music</h1> <p>As any burner can tell you, the event has a lot of trance.</p> <aside>You can buy the music we played at our <a href="buy.html">playlist page</a>.</aside> <p>This year we played a kind of trance that originated in Belgium, Germany, and the Netherlands in the mid 90s.</p> | |
h1 –h6
| A section heading |
<h1>The Guide To Music On The Playa</h1> <h2>The Main Stage</h2> <p>If you want to play on a stage, you should bring one.</p> <h2>Amplified Music</h2> <p>Amplifiers up to 300W or 90dB are welcome.</p> | |
header
| |
<article> <header> <h2>Hard Trance is My Life</h2> <p>By DJ Steve Hill and Technikal</p> </header> <p>The album with the amusing punctuation has red artwork.</p> </article> | |
footer
| |
<article> <h2>Hard Trance is My Life</h2> <p>The album with the amusing punctuation has red artwork.</p> <footer> <p>Artists: DJ Steve Hill and Technikal</p> </footer> </article> |
4.3.10.1. Article or section?
This section is non-normative.
A section
forms part of something else. An article
is its own thing. But
how does one know which is which? Mostly the real answer is "it depends on author intent".
For example, one could imagine a book with a "Granny Smith" chapter that just said "These juicy,
green apples make a great filling for apple pies."; that would be a section
because
there’d be lots of other chapters on (maybe) other kinds of apples.
On the other hand, one could imagine a tweet or tumblr post or newspaper
classified ad that just said "Granny Smith. These juicy, green apples make a great filling for
apple pies."; it would then be article
s because that was the whole thing.
Comments on an article are not part of the article
on which they are commenting, but are
related, therefore may be contained in their own nested article
.
4.4. Grouping content
4.4.1. The p
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- A
p
element’s end tag may be omitted if thep
element is immediately followed by anaddress
,article
,aside
,blockquote
,details
,div
,dl
,fieldset
,figcaption
,figure
,footer
,form
,h1
,h2
,h3
,h4
,h5
,h6
,header
,hr
,main
,nav
,ol
,p
,pre
,section
,table
, orul
, element, or if there is no more content in the parent element and the parent element is an HTML element that is not ana
,audio
,del
,ins
,map
,noscript
, orvideo
element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLParagraphElement
: HTMLElement {};
The p
element represents a block of content, a paragraph as defined in this specification.
The p
element should not be used when a more specific element, such as a list, is more appropriate.
p
elements.
When the parser finds them, it automatically closes the p
element - effectively inserting a </p>
tag.
These elements are: heading content, most sectioning roots and sectioning content, form
, fieldset
, table
, ol
, ul
, and legend
. Paragraphs are usually represented visually as blocks of text, separated from adjacent blocks by blank lines. However a style sheet or user agent may present paragraph breaks in a different manner, for instance using inline pilcrows (¶).
<p>The little kitten gently seated itself on a piece of carpet. Later in his life, this would be referred to as the time the cat sat on the mat.</p>
<p>There was once an example from Femley,<br> Whose markup was of dubious quality.<br> The validator complained,<br> So the author was pained,<br> To move the error from the markup to the rhyming.</p>;
<section> <!-- ... --> <p>Last modified: 2001-04-23</p> <p>Author: fred@example.com</p> </section>
However, it would be better marked-up as:
<section> <!-- ... --> <footer>Last modified: 2001-04-23</footer> <address>Author: fred@example.com</address> </section>
Or:
<section> <!-- ... --> <footer> <p>Last modified: 2001-04-23</p> <address>Author: fred@example.com</address> </footer> </section>
li
, ol
, and ul
) cannot be children of p
elements.
So to mark up a sentence that contains a list, like the following:
-
wizards,
-
faster-than-light travel, and
-
telepathy,
and is further discussed below.
it is important to remember that a paragraph in HTML does not have the semantic meaning of "a single idea" that is a usual part of how English grammar describes "paragraphs". Instead it is merely a default type of block-level structure for content. In the example above, there are five block-level structures: one before the list, one for each bullet, and one after the list.
<p>For instance, this fantastic sentence has bullets relating to</p> <ul> <li>wizards,</li> <li>faster-than-light travel, and</li> <li>telepathy,</li> </ul> <p>and is further discussed below.</p>
Authors wishing to conveniently style such "logical" paragraphs consisting of multiple
"structural" paragraphs can use the div
element instead of, or as well as the p
element.
<div>For instance, this fantastic sentence has bullets relating to <ul> <li>wizards,</li> <li>faster-than-light travel, and</li> <li>telepathy,</li> </ul> and is further discussed below.</div>
or
<div> <p>For instance, this fantastic sentence has bullets relating to</p> <ul> <li>wizards,</li> <li>faster-than-light travel, and</li> <li>telepathy,</li> </ul> <p>and is further discussed below.</p> </div>
These examples still have five structural blocks, but now the author can style just the div
instead of having to consider each part of the example separately.
4.4.2. The address
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content, but with no heading content descendants,
no sectioning content descendants, and no
main
,header
,footer
, oraddress
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The address
element represents contact information for a person, people or
organization. It should include physical and/or digital location/contact information, and a
means of identifying a person(s) or organization the information pertains to.
<address> <p>W3C on Twitter:</p> <p><a href="https://twitter.com/w3c">@w3c</a></p> </address>
Address, telephone and fax numbers for an organization:
<address> UNIVERSITY INTERSCHOLASTIC LEAGUE<br> 1701 Manor Road, Austin, TX 78722<br> Tel: (512) 471-5883 | Fax: (512) 471-5908 </address>
The address part of a form output:
... <label for="name">Name:</label> <input type="text" id="name"> <label for="hn">House number:</label> <input type="text" id="hn"> <label for="street">Street:</label> <input type="text" id="street"> ... <address> <p>Name: Hament Dhanji</p> <p>House number: 123</p> <p>Street: Example Road</p> ... </address>
Location of a cat:
<address> Lola the cat is at Latitude: 51.47852 Longitude: -0.1449519 </address>
The meaning and usage contexts of the address
element is broad. If developers wish
to provide more granular and specific semantics for the address
element, it is
suggested to use of any of the various semantic web metadata schemas.
<div vocab="http://schema.org/" typeof="LocalBusiness"> <h1><span property="name">Beachwear & Giftware</span></h1> <p property="description"> A superb collection of fine gifts and clothing to accent your stay in Mexico Beach. </p> <address property="address" typeof="PostalAddress"> <span property="streetAddress">123 Example Street</span> <span property="addressLocality">Mexico Beach</span>, <span property="addressRegion">FL</span> </address> Phone: <span property="telephone">(212) 664-7665</span> </div>
4.4.3. The hr
element
- Categories:
- Flow content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag.
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
separator
(default - do not set),none
orpresentation
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLHRElement
: HTMLElement {}; - DPub Roles:
-
doc-pagebreak
The hr
element represents a paragraph-level thematic break, such as a
scene change in a story, or a transition to another topic within a section of a reference book.
hr
element to separate topics within the section.
<section> <h1>Communication</h1> <p>There are various methods of communication. This section covers a few of the important ones used by the project.</p> <hr> <p>Communication stones seem to come in pairs and have mysterious properties:</p> <ul> <li>They can transfer thoughts in two directions once activated if used alone.</li> <li>If used with another device, they can transfer one’s consciousness to another body.</li> <li>If both stones are used with another device, the consciousnesses switch bodies.</li> </ul> <hr> <p>Radios use the electromagnetic spectrum in the meter range and longer.</p> <hr> <p>Signal flares use the electromagnetic spectrum in the nanometer range.</p> </section> <section> <h1>Food</h1> <p>All food at the project is rationed:</p> <dl> <dt>Potatoes</dt> <dd>Two per day</dd> <dt>Soup</dt> <dd>One bowl per day</dd> </dl> <hr> <p>Cooking is done by the chefs on a set rotation.</p> </section>
There is no need for an hr
element between the sections themselves, since the section
elements and the h1
elements imply thematic changes themselves.
hr
element.
<p>
Elizabeth told her the motives of her secrecy. She had been unwilling to mention Bingley; and the unsettled state of her own feelings had made her equally avoid the name of his friend. But now she would no longer conceal from her his share in Lydia’s marriage. All was acknowledged, and half the night spent in conversation.
</p>
<hr>
<p>
“Good gracious!” cried Mrs. Bennet, as she stood at a window the next morning, “if that disagreeable Mr. Darcy is not coming here again with our dear Bingley! What can he mean by being so tiresome as to be always coming here? I had no notion but he would go a-shooting, or something or other, and not disturb us with his company. What shall we do with him? Lizzy, you must walk out with him again, that he may not be in Bingley’s way.”
</p>
The hr
element does not affect the document’s outline.
4.4.4. The pre
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLPreElement
: HTMLElement {};
The pre
element represents a block of preformatted text, in which structure is
represented by typographic conventions rather than by elements.
In the HTML syntax, a leading newline character immediately following the pre
element start tag is stripped.
Some examples of cases where the pre
element could be used:
-
Including an e-mail, with paragraphs indicated by blank lines, lists indicated by lines prefixed with a bullet, and so on.
-
Including fragments of computer code, with structure indicated according to the conventions of that language.
-
Displaying ASCII art.
Authors are encouraged to consider how preformatted text will be experienced when the formatting is lost, as will be the case for users of speech synthesizers, braille displays, and the like. For cases like ASCII art, it is likely that an alternative presentation, such as a textual description, would be more universally accessible to the readers of the document.
To represent a block of computer code, the pre
element can be used with a code
element;
to represent a block of computer output the pre
element can be used with a samp
element.
Similarly, the kbd
element can be used within a pre
element to indicate text that the
user is to enter.
This element has rendering requirements involving the bidirectional algorithm.
<p>This is the <code>Panel</code> constructor:</p> <pre><code>function Panel(element, canClose, closeHandler) { this.element = element; this.canClose = canClose; this.closeHandler = function () { if (closeHandler) closeHandler() }; }</code></pre>
samp
and kbd
elements are mixed in the
contents of a pre
element to show a session of Zork I.
<pre><samp>You are in an open field west of a big white house with a boarded front door. There is a small mailbox here. ></samp> <kbd>open mailbox</kbd> <samp>Opening the mailbox reveals: A leaflet. ></samp></pre>
pre
element to preserve its
unusual formatting, which forms an intrinsic part of the poem itself.
<pre> maxling it is with a heart heavy that i admit loss of a feline so loved a friend lost to the unknown (night) ~cdr 11dec07</pre>
4.4.5. The blockquote
element
- Categories:
- Flow content.
- Sectioning root.
- Palpable content.
- Sectioning root.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
cite
- Link to the source of the quotation. - Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLQuoteElement
: HTMLElement { attribute DOMString cite; };The
HTMLQuoteElement
interface is also used by theq
element.
The blockquote
element represents content that is quoted from another source,
optionally with a citation which must be within a footer
or cite
element, and optionally with in-line changes such as annotations and abbreviations.
Content inside a blockquote
other than citations and in-line changes must be quoted
from another source, whose address, if it has one, may be cited in the cite
attribute.
In cases where a page contains contributions from multiple people, such as comments on a blog post, 'another source' can include text from the same page, written by another person.
If the cite
attribute is present, it must be a valid URL potentially surrounded by spaces. To obtain the corresponding citation link, the
value of the attribute must be parsed relative to the element’s node document.
User agents may allow users to follow such citation links, but they are primarily intended for
private use (e.g., by server-side scripts collecting statistics about a site’s use of
quotations), not for readers.
The cite
IDL attribute must reflect the element’s cite
content attribute.
The content of a blockquote
may be abbreviated, may have context added or may have
annotations. Any such additions or changes to quoted text must be indicated in the text (at the
text level). This may mean the use of notational conventions or explicit remarks, such as
"emphasis mine".
<blockquote> <p>[Fred] then said he liked [...] fish.</p> </blockquote>
Quotation marks may be used to delineate between quoted text and annotations within a blockquote
.
<figure> <blockquote> "That monster custom, who all sense doth eat Of habit’s devil," <abbr title="et cetera">&c.</abbr> not in Folio "What a falling off was there! From me, whose love was of that dignity That it went hand in hand even with the vow I made to her in marriage, and to decline Upon a wretch." </blockquote> <footer> — <cite class="title">Shakespeare manual</cite> by <cite class="author">Frederick Gard Fleay</cite>, p19 (in Google Books) </footer> </figure>
In the example above, the citation is contained within the footer
of a figure
element, this groups and associates the information, about the quote, with
the quote. The figcaption
element was not used, in this case, as a container for
the citation as it is not a caption.
Attribution for the quotation, may be placed inside the blockquote
element, but
must be within a cite
element for in-text attributions or within a footer
element.
footer
after the quoted text, to
clearly relate the quote to its attribution:
<blockquote> <p>I contend that we are both atheists. I just believe in one fewer god than you do. When you understand why you dismiss all the other possible gods, you will understand why I dismiss yours.</p> <footer>— <cite>Stephen Roberts</cite></footer> </blockquote>
cite
element on the last line of the quoted
text. Note that a link to the author is also included.
<blockquote> The people recognize themselves in their commodities; they find their soul in their automobile, hi-fi set, split-level home, kitchen equipment. — <cite><a href="https://en.wikipedia.org/wiki/Herbert_Marcuse">Herbert Marcuse</a></cite> </blockquote>
footer
after the quoted text, and metadata
about the reference has been added using the RDFA Lite syntax. [rdfa-lite]
<blockquote> <p>... she said she would not sign any deposition containing the word "amorous" instead of "advances". For her the difference was of crucial significance, and one of the reasons she had separated from her husband was that he had never been amorous but had consistently made advances.</p> <footer typeof="schema:Book"> <span property="schema:author">Heinrich Böll</span>, <span property="schema:name">The Lost Honor of Katharina Blum</span>, <span property="schema:datePublished">January 1, 1974</span> </footer> </blockquote>
There is no formal method for indicating the markup in a blockquote
is from a
quoted source. It is suggested that if the footer
or cite
elements are
included and these elements are also being used within a blockquote
to identify
citations, the elements from the quoted source could be annotated with metadata to identify
their origin, for example by using the class
attribute (a defined
extensibility mechanism).
cite
element, which is annotated
using the class
attribute:
<blockquote> <p>My favorite book is <cite class="from-source">At Swim-Two-Birds</cite></p> <footer>- <cite>Mike[tm]Smith</cite></footer> </blockquote>
The other examples below show other ways of showing attribution.
blockquote
element is used in conjunction with a figure
element
and its figcaption
:
<figure> <blockquote> <p>The truth may be puzzling. It may take some work to grapple with. It may be counterintuitive. It may contradict deeply held prejudices. It may not be consonant with what we desperately want to be true. But our preferences do not determine what’s true.</p> <p>We have a method, and that method helps us to reach not absolute truth, only asymptotic approaches to the truth — never there, just closer and closer, always finding vast new oceans of undiscovered possibilities. Cleverly designed experiments are the key.</p> </blockquote> <figcaption> <cite>Carl Sagan</cite>, in "<cite>Wonder and Skepticism</cite>", from the <cite>Skeptical Inquirer</cite> Volume 19, Issue 1 (January-February 1995) </figcaption> </figure>
cite
alongside blockquote
:
<p>His next piece was the aptly named <cite>Sonnet 130</cite>:</p> <blockquote cite="https://quotes.example.org/s/sonnet130.html"> <p>My mistress' eyes are nothing like the sun,<br> Coral is far more red, than her lips red,<br> ...
blockquote
to show what post a user
is replying to. The article
element is used for each post, to mark up the threading.
<article> <h1><a href="https://bacon.example.com/?blog=109431">Bacon on a crowbar</a></h1> <article> <header><strong>t3yw</strong> 12 points 1 hour ago</header> <p>I bet a narwhal would love that.</p> <footer><a href="?pid=29578">permalink</a></footer> <article> <header><strong>greg</strong> 8 points 1 hour ago</header> <blockquote> <p>I bet a narwhal would love that.</p> </blockquote> <p>Dude narwhals don’t eat bacon.</p> <footer><a href="?pid=29579">permalink</a></footer> <article> <header><strong>t3yw</strong> 15 points 1 hour ago</header> <blockquote> <blockquote> <p>I bet a narwhal would love that.</p> </blockquote> <p>Dude narwhals don’t eat bacon.</p> </blockquote> <p>Next thing you’ll be saying they don’t get capes and wizard hats either!</p> <footer><a href="?pid=29580">permalink</a></footer> <article> <header><strong>boing</strong> -5 points 1 hour ago</header> <p>narwhals are worse than ceiling cat</p> <footer><a href="?pid=29581">permalink</a></footer> </article> </article> </article> <article> <header><strong>fred</strong> 1 points 23 minutes ago</header> <blockquote> <p>I bet a narwhal would love that.</p> </blockquote> <p>I bet they’d love to peel a banana too.</p> <footer><a href="?pid=29582">permalink</a></footer> </article> </article> </article>
blockquote
for short snippets, demonstrating that
one does not have to use p
elements inside blockquote
elements:
<p>She began a list of quotations with the following:</p> <blockquote>It is a truth universally acknowledged, that a single man in possession of a good fortune, must be in want of a wife.</blockquote> <p>She continued with a number of similar quotes, ending with:</p> <blockquote>The person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.</blockquote> <p>We shall now discuss these points...
Examples of how to represent a conversation are shown in a
later section; it is not appropriate to use the cite
and blockquote
elements for this purpose.
4.4.6. The ol
element
- Categories:
- Flow content.
- If the element’s children include at least one
li
element: Palpable content. - If the element’s children include at least one
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Zero or more
li
and script-supporting elements. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
reversed
- Number the list backwards.start
- Ordinal value of the first itemtype
- Kind of list marker. - Allowed ARIA role attribute values:
-
list
role (default - do not set),directory
,group
,listbox
,menu
,menubar
,none
,presentation
,radiogroup
,tablist
,toolbar
ortree
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLOListElement
: HTMLElement { attribute boolean reversed; attribute long start; attribute DOMString type; };
The ol
element represents a list of items, where the items have been
intentionally ordered, such that changing the order would change the meaning of the document.
The items of the list are the li
element child nodes of the ol
element,
in tree order.
The reversed
attribute is a boolean attribute. If present, it indicates that the list is a descending list
(..., 3, 2, 1). If the attribute is omitted, the list is an ascending list (1, 2, 3, ...).
The start
attribute, if present, must be a valid integer giving the ordinal value of the first list item.
If the start
attribute is present, user agents must parse it as an integer,
in order to determine the attribute’s value. The default value, used if the attribute is
missing or if the value cannot be converted to a number according to the referenced algorithm,
is 1 if the element has no reversed
attribute, and is the number of child li
elements otherwise.
The first item in the list has the ordinal value given by the ol
element’s start
attribute, unless that li
element has a value
attribute with a value that can be successfully parsed, in which case it has the ordinal value given by that value
attribute.
Each subsequent item in the list has the ordinal value given by its value
attribute, if it has one, or, if it doesn’t, the ordinal value of the previous item, plus
one if the reversed
is absent, or minus one if it is present.
The type
attribute can be used to specify the
kind of marker to use in the list, in the cases where that matters (e.g., because items are to
be referenced by their number/letter). The attribute, if specified, must have a value that is a case-sensitive match for one of the characters given in the first cell of one of the rows
of the following table.
The type
attribute represents the state given in the cell in the second column of
the row whose first cell matches the attribute’s value; if none of the cells match, or if the
attribute is omitted, then the attribute represents the decimal state.
User agents should render the items of the list in a manner consistent with the state of the type
attribute of the ol
element. Numbers less than or equal to zero
should always use the decimal system regardless of the type
attribute.
For CSS user agents, a mapping for this attribute to the list-style-type CSS property is given in the §10 Rendering section (the mapping is straightforward: the states above have the same names as their corresponding CSS values).
It is possible to redefine the default CSS list styles used to implement this attribute in CSS user agents; doing so will affect how list items are rendered.
The reversed
, start
, and type
IDL attributes must reflect the respective content attributes of the same name. The start
IDL attribute has the
same default as its content attribute.
ol
element is therefore appropriate. Compare this list to the equivalent list in the ul
section to see an example of the same items using the ul
element.
<p>I have lived in the following countries (given in the order of when I first lived there):</p> <ol> <li>Switzerland</li> <li>United Kingdom</li> <li>United States</li> <li>Norway</li> </ol>
Note how changing the order of the list changes the meaning of the document. In the following example, changing the relative order of the first two items has changed the birthplace of the author:
<p>I have lived in the following countries (given in the order of when I first lived there):</p> <ol> <li>United Kingdom</li> <li>Switzerland</li> <li>United States</li> <li>Norway</li> </ol>
4.4.7. The ul
element
- Categories:
- Flow content.
- If the element’s children include at least one
li
element: Palpable content. - If the element’s children include at least one
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Zero or more
li
and script-supporting elements. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
list
role (default - do not set),directory
,group
,listbox
,menu
,menubar
,presentation
,radiogroup
,tablist
,toolbar
ortree
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLUListElement
: HTMLElement {};
The ul
element represents a list of items, where the order of the items is not
important — that is, where changing the order would not materially change the meaning of the
document.
The items of the list are the li
element child nodes of the ul
element.
ul
element is therefore appropriate. Compare this list to the equivalent list
in the ol
section to see an example of the same items using the ol
element.
<p>I have lived in the following countries:</p> <ul> <li>Norway</li> <li>Switzerland</li> <li>United Kingdom</li> <li>United States</li> </ul>
Note that changing the order of the list does not change the meaning of the document. The items in the snippet above are given in alphabetical order, but in the snippet below they are given in order of the size of their current account balance in 2007, without changing the meaning of the document whatsoever:
<p>I have lived in the following countries:</p> <ul> <li>Switzerland</li> <li>Norway</li> <li>United Kingdom</li> <li>United States</li> </ul>
4.4.8. The li
element
- Categories:
- None.
- Contexts in which this element can be used:
- Inside
ol
elements.- Inside
ul
elements. - Inside
- Content model:
- Flow content.
- Tag omission in text/html:
- An
li
element’s end tag may be omitted if theli
element is immediately followed by anotherli
element or if there is no more content in the parent element. - Content attributes:
- Global attributes
- If the element is not a child of an
ul
:value
- If the element is not a child of an
- Allowed ARIA role attribute values:
-
listitem
role (default - do not set),menuitem
,menuitemcheckbox
,menuitemradio
,option
,none
,presentation
,radio
,separator
,tab
ortreeitem
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLLIElement
: HTMLElement { attribute long value; }; - DPub Roles:
-
doc-biblioentry
ordoc-endnote
The li
element represents a list item. If its parent element is an ol
, or ul
,
then the element is an item of the parent element’s list, as defined for those elements.
Otherwise, the list item has no defined list-related relationship to any other li
element.
If the parent element is an ol
element, then the li
element has an ordinal value.
The value
attribute, if present, must be a valid integer giving the ordinal value of the list item.
If the value
attribute is present, user agents must parse it as an integer,
in order to determine the attribute’s value. If the attribute’s value cannot be converted to a
number, the attribute must be treated as if it was absent. The attribute has no default value.
The value
attribute is processed relative to the element’s parent ol
element (q.v.), if there is one. If there is not, the attribute has no effect.
The value
IDL attribute must reflect the value of the value
content attribute.
figure
element and its figcaption
element.
<figure> <figcaption>The top 10 movies of all time</figcaption> <ol> <li value="10"><cite>Josie and the Pussycats</cite>, 2001</li> <li value="9"><cite lang="sr">Црна мачка, бели мачор</cite>, 1998</li> <li value="8"><cite>A Bug’s Life</cite>, 1998</li> <li value="7"><cite>Toy Story</cite>, 1995</li> <li value="6"><cite>Monsters, Inc</cite>, 2001</li> <li value="5"><cite>Cars</cite>, 2006</li> <li value="4"><cite>Toy Story 2</cite>, 1999</li> <li value="3"><cite>Finding Nemo</cite>, 2003</li> <li value="2"><cite>The Incredibles</cite>, 2004</li> <li value="1"><cite>Ratatouille</cite>, 2007</li> </ol> </figure>
The markup could also be written as follows, using the reversed
attribute on the ol
element:
<figure> <figcaption>The top 10 movies of all time</figcaption> <ol reversed> <li><cite>Josie and the Pussycats</cite>, 2001</li> <li><cite lang="sr">Црна мачка, бели мачор</cite>, 1998</li> <li><cite>A Bug’s Life</cite>, 1998</li> <li><cite>Toy Story</cite>, 1995</li> <li><cite>Monsters, Inc</cite>, 2001</li> <li><cite>Cars</cite>, 2006</li> <li><cite>Toy Story 2</cite>, 1999</li> <li><cite>Finding Nemo</cite>, 2003</li> <li><cite>The Incredibles</cite>, 2004</li> <li><cite>Ratatouille</cite>, 2007</li> </ol> </figure>
While it is conforming to include heading elements (e.g., h2
) and Sectioning content inside li
elements, it likely does not convey the
semantics that the author intended. A heading starts a new section, so a heading in a list
implicitly splits the list into spanning multiple sections. Sectioning content explicitly creates a new section and so splits the list into spanning multiple sections.
4.4.9. The dl
element
- Categories:
- Flow content.
- If the element’s children include at least one name-value group: Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Either:Zero or more groups each consisting of one or more
dt
elements followed by one or moredd
elements, optionally intermixed with script-supporting elements.- Or: One or more
div
elements, optionally intermixed with script-supporting elements. - Or: One or more
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
list
role (default - do not set),group
,none
orpresentation
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLDListElement
: HTMLElement {}; - DPub Roles:
-
doc-glossary
The dl
element represents a description list of zero or more term-description groups.
Each term-description group consists of one or more terms (represented by dt
elements)
and one or more descriptions (represented by dd
elements.
The div
element may be used as a child of the dl
element (as a way to organize term-description groups consisting of one or more dt
elements, and one or more dd
elements).
Term-description groups may be names and definitions, questions and answers, categories and topics, or any other groups of term-description pairs.
In this example a dl
is used to represent a simple list of names and descriptions:
<dl> <dt>Blanco tequila</dt> <dd>The purest form of the blue agave spirit...</dd> <dt>Reposado tequila</dt> <dd>Typically aged in wooden barrels for between two and eleven months...</dd> </dl>
Each term within a term-description group must be represented by a single dt
element.
The descriptions within a term-description group are alternatives. Each description must
be represented by a single dd
element.
In this example a dl
element represents a set of terms, each of which has multiple
descriptions:
<p>Information about the rock band Queen:</p> <dl> <dt>Members</dt> <dd>Brian May</dd> <dd>Freddie Mercury</dd> <dd>John Deacon</dd> <dd>Roger Taylor</dd> <dt>Record labels</dt> <dd>EMI</dd> <dd>Parlophone</dd> <dd>Capitol</dd> <dd>Hollywood</dd> <dd>Island</dd> </dl>
The div
element may be used to contain a term-description group, consisting of at
least one dt
and at least one dd
element.
div
element is used as a styling container for a term-description group:
<dl> <div class="teas"> <dt>Black teas</dt> <dd>Assam</dd> <dd>Darjeeling</dd> </div> <div> <dt>Green teas</dt> <dd>Gunpowder</dd> </div> </dl>
A div
element that is a child of a dl
element, must contain at least one term-description group consisting of at least one dt
element and at least one dd
element.
div
element is ignored because it does not contain a term-description group:
<dl> <div> <p>Important questions:</p> </div> <dt>What is the answer to life, the universe, and everything?</dt> <dd>42</dd> </dl>
The order of term-description groups within a dl
element, and the order of terms and
descriptions within each group, may be significant.
dl
is used to show a set of instructions, where the order of the
instructions is important:
<p>Determine the victory points as follows (use the first matching case):</p> <dl> <dt> If you have exactly five gold coins </dt> <dd> You get five victory points </dd> <dt> If you have one or more gold coins, and you have one or more silver coins </dt> <dd> You get two victory points </dd> <dt> If you have one or more silver coins </dt> <dd> You get one victory point </dd> <dt> Otherwise </dt> <dd> You get no victory points </dd> </dl>
If a dl
element contains no dt
or dd
child elements, it contains no term-description groups.
When a dl
element does not match its content model, it is often because a dd
element
has been used instead of a dt
element, or vice versa.
4.4.10. The dt
element
- Categories:
- None.
- Contexts in which this element can be used:
- Before
dd
ordt
elements insidedl
elements. - Content model:
- Flow content, but with no
header
,footer
, sectioning content, or heading content descendants. - Tag omission in text/html:
- A
dt
element’s end tag may be omitted if thedt
element is immediately followed by anotherdt
element or add
element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
listitem
role (default - do not set) - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default role. - Any
- DOM interface:
- Uses
HTMLElement
.
The dt
element represents a term, part of a term-description group in a description list (dl
element).
In this example the dt
elements represent questions and the dd
elements the answers:
<dl> <dt>What is my favorite drink?</dt> <dd>Tea</dd> <dt>What is my favorite food?</dt> <dd>Sushi</dd> <dt>What is my favourite film?</dt> <dd>What a Wonderful Life</dd> </dl>
When used within a dl
element, the dt
element does not necessarily represent a term being defined. The dfn
element should be used to represent a term being defined.
In this example the dfn
element indicates that the dt
element contains a defined term, the definition for which is represented by the dd
element:
<dl> <dt lang="en-us"><dfn>Color</dfn></dt> <dt lang="en-gb"><dfn>Colour</dfn></dt> <dd>A sensation which (in humans) derives from the ability of the fine structure of the eye to distinguish three differently filtered analyses of a view.</dd> </dl>
4.4.11. The dd
element
- Categories:
- None.
- Contexts in which this element can be used:
- After
dt
ordd
elements insidedl
elements. - Content model:
- Flow content.
- Tag omission in text/html:
- A
dd
element’s end tag may be omitted if thedd
element is immediately followed by anotherdd
element or adt
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
definition
role (default - do not set) - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The dd
element represents a description, part of a term-description group in a description list (dl
element).
In this example the dd
elements represent the keys that invoke the keycodes indicated in the dt
elements:
<dl> <dt>37</dt> <dd>Left</dd> <dt>38</dt> <dd>Right</dd> <dt>39</dt> <dd>Up</dd> <dt>40</dt> <dd>Down</dd> </dl>
4.4.12. The figure
element
- Categories:
- Flow content.
- Sectioning root.
- Palpable content.
- Sectioning root.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content optionally including a
figcaption
child element. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
figure
role (default - do not set),group
,none
orpresentation
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The figure
element represents some flow content, optionally with a
caption, that is self-contained (like a complete sentence) and is typically referenced as a single
unit from the main flow of the document.
"Self-contained" in this context does not necessarily mean independent. For example, each sentence
in a paragraph is self-contained; an image that is part of a sentence would be inappropriate for figure
, but an entire sentence made of images would be fitting.
The element can thus be used to annotate illustrations, diagrams, photos, code listings, etc.
figure
is referred to from the main content of the document by identifying
it by its caption (e.g., by figure number), it enables such content to be easily moved away from
that primary content, e.g., to the side of the page, to dedicated pages, or to an appendix,
without affecting the flow of the document.
If a figure
element is referenced by its relative position, e.g., "in the photograph
above" or "as the next figure shows", then moving the figure would disrupt the page’s meaning.
Authors are encouraged to consider using labels to refer to figures, rather than using such
relative references, so that the page can easily be restyled without affecting the page’s
meaning.
The figcaption
descendant of figure
, if any, represents the caption of the figure
element’s contents. If there is no child figcaption
element, then there is no caption.
A figure
element’s contents are part of the surrounding flow. If the purpose of the
page is to display the figure, for example a photograph on an image sharing site, the figure
and figcaption
elements can be used to explicitly provide a
caption for that figure. For content that is only tangentially related, or that serves a separate
purpose than the surrounding flow, the aside
element should be used (and can itself
wrap a figure
). For example, a pull quote that repeats content from an article
would be more appropriate in an aside
than in a figure
, because it isn’t part of the content, it’s a repetition of the content for
the purposes of enticing readers or highlighting key topics.
figure
element to mark up a code listing.
<p>In <a href="#l4">listing 4</a> we see the primary core interface API declaration.</p> <figure id="l4"> <figcaption>Listing 4. The primary core interface API declaration.</figcaption> <pre><code>interface PrimaryCore { boolean verifyDataLine(); void sendData(in sequence<byte> data); void initSelfDestruct(); }</code></pre> </figure> <p>The API is designed to use UTF-8.</p>
figure
element to mark up a photo that is the main content of the
page (as in a gallery).
<!DOCTYPE html> <title>Bubbles at work — My Gallery™</title> <figure> <img src="bubbles-work.jpeg" alt="Bubbles, sitting in his office chair, works on his latest project intently."> <figcaption>Bubbles at work</figcaption> </figure> <nav><a href="19414.html">Prev</a> — <a href="19416.html">Next</a></nav>
figure
would be inappropriate.
<h2>Malinko’s comics</h2> <p>This case centered on some sort of "intellectual property" infringement related to a comic (see Exhibit A). The suit started after a trailer ending with these words:</p> <blockquote> <img src="promblem-packed-action.png" alt="ROUGH COPY! Promblem-Packed Action!"> </blockquote> <p>...was aired. A lawyer, armed with a Bigger Notebook, launched a preemptive strike using snowballs. A complete copy of the trailer is included with Exhibit B.</p> <figure> <img src="ex-a.png" alt="Two squiggles on a dirty piece of paper."> <figcaption>Exhibit A. The alleged <cite>rough copy</cite> comic.</figcaption> </figure> <figure> <video src="ex-b.mov"></video> <figcaption>Exhibit B. The <cite>Rough Copy</cite> trailer.</figcaption> </figure> <p>The case was resolved out of court.</p>
figure
.
<figure> <p>'Twas brillig, and the slithy toves<br> Did gyre and gimble in the wabe;<br> All mimsy were the borogoves,<br> And the mome raths outgrabe.</p> <figcaption><cite>Jabberwocky</cite> (first verse). Lewis Carroll, 1832-98</figcaption> </figure>
figure
elements are used to provide both a group caption and individual captions for
each figure in the group:
<figure> <figcaption>The castle through the ages: 1423, 1858, and 1999 respectively.</figcaption> <figure> <figcaption>Etching. Anonymous, ca. 1423.</figcaption> <img src="castle1423.jpeg" alt="The castle has one tower, and a tall wall around it."> </figure> <figure> <figcaption>Oil-based paint on canvas. Maria Towle, 1858.</figcaption> <img src="castle1858.jpeg" alt="The castle now has two towers and two walls."> </figure> <figure> <figcaption>Film photograph. Peter Jankle, 1999.</figcaption> <img src="castle1999.jpeg" alt="The castle lies in ruins, the original tower all that remains in one piece."> </figure> </figure>
<article> <h1>Fiscal negotiations stumble in Congress as deadline nears</h1> <figure> <img src="obama-reid.jpeg" alt="Obama and Reid sit together smiling in the Oval Office."> <figcaption>Barack Obama and Harry Reid. White House press photograph.</figcaption> </figure> <p>Negotiations in Congress to end the fiscal impasse sputtered on Tuesday, leaving both chambers grasping for a way to reopen the government and raise the country’s borrowing authority with a Thursday deadline drawing near.</p> ... </article>
4.4.13. The figcaption
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a descendant of a
figure
element. - Content model:
- Flow content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
group
,none
orpresentation
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The figcaption
element represents a caption or legend for the rest of the
contents of the figcaption
element’s parent figure
element, if any.
4.4.14. The main
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected, but only if it is a hierarchically correct main element.
- Content model:
- Flow content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
main
role (default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default role. - Any
- DOM interface:
- Uses
HTMLElement
The main
element represents the dominant contents of the document.
A document must not have more than one main
element that does not have the §5.1 The hidden attribute attribute specified.
A hierarchically correct main element is one whose ancestor elements are limited to html
, body
, div
, form
without an accessible name, and autonomous custom elements. Each main
element must be a hierarchically correct main element.
The main
element is not sectioning content and has no effect on the document outline.
The main
element is not suitable for identifying the main content areas of sub-sections of a document. The simplest solution is not to mark up the main content of a sub-section at all (leaving it as implicit), but an author could use §4.4 Grouping content or a sectioning content element as appropriate.
<!-- conforming example --> <main>...</main> <main hidden>...</main> <main hidden>...</main> <!-- non-conforming example --> <main>...</main> <main>...</main> <main>...</main>
In the following example, we see 2 articles about skateboards (the main topic of a Web page) the
main topic content is identified by the use of the main
element.
<!-- other content --> <main> <h1>Skateboards</h1> <p>The skateboard is the way cool kids get around</p> <article> <h2>Longboards</h2> <p>Longboards are a type of skateboard with a longer wheelbase and larger, softer wheels.</p> <p>... </p> <p>... </p> </article> <article> <h2>Electric Skateboards</h2> <p>These no longer require the propelling of the skateboard by means of the feet; rather an electric motor propels the board, fed by an electric battery.</p> <p>... </p> <p>... </p> </article> </main> <!-- other content -->
Here is a graduation programme, in which the main content section is defined by the use of the main
element. Note in this example the main
element contains a nav
element consisting of links to sub sections of the main content.
<html lang="en"> <head> <title>Graduation Ceremony Summer 2022</title> </head> <body> <header>The Lawson Academy: <nav> <ul> <li><a href="courses.html">Courses</a></li> <li><a href="fees.html">Fees</a></li> <li><a>Graduation</a></li> </ul> </nav> </header> <main> <h1>Graduation</h1> <nav> <ul> <li><a href="#ceremony">Ceremony</a></li> <li><a href="#graduates">Graduates</a></li> <li><a href="#awards">Awards</a></li> </ul> </nav> <h2 id="ceremony">Ceremony</h2> <p>Opening Procession</p> <p>Speech by Valedictorian</p> <p>Speech by Class President</p> <p>Presentation of Diplomas</p> <p>Closing Speech by Headteacher</p> <h2 id="graduates">Graduates</h2> <ul> <li>Eileen Williams</li> <li>Andy Maseyk</li> <li>Blanca Sainz Garcia</li> <li>Clara Faulkner</li> <li>Gez Lemon</li> <li>Eloisa Faulkner</li> </ul> <h2 id="awards">Awards</h2> <ul> <li>Clara Faulkner</li> <li>Eloisa Faulkner</li> <li>Blanca Sainz Garcia</li> </ul> </main> <footer> Copyright 2012 B.lawson</footer> </body> </html>
In the next example, both the header
and the footer
are outside the main
element
because they are generic to the website and not specific to main
's content.
<!DOCTYPE html> <html lang="en"> <head> <title>Great Dogs for Families</title> </head> <body> <header> <h1>The Border Terrier</h1> <nav> <ul> <li><a href="index.html">Home</a></li> <li><a href="about.html">About</a></li> <li><a href="health.html">Health</a></li> </ul> </nav> </header> <main> <h2>Welcome!</h2> <p>This site is all about the Border Terrier, the best breed of dog that there is!</p> </main> <footer> <small>Copyright © <time datetime="2013">2013</time> by I. Devlin</small> </footer> </body> </html>
Here, the same generic header
and footer
elements remain outside main
, but there
is an additional header
element within the main
element as its content is relevant to
the content within main
because it contains a relevant heading and in-page navigation.
The in-page navigation is repeated within a footer
which is again within the main
element.
<!DOCTYPE html> <html lang="en"> <head> <title>Great Dogs for Families</title> </head> <body> <header> <h1>The Border Terrier</h1> <nav> <ul> <li><a href="index.html">Home</a></li> <li><a href="about.html">About</a></li> <li><a href="health.html">Health</a></li> </ul> </nav> </header> <main> <section> <header> <h2>About</h2> <nav> <ul> <li><a href="#basic">Basic</a></li> <li><a href="#app">Appearance</a></li> <li><a href="#temp">Temperament</a></li> </ul> </nav> </header> <section id="basic"> <h3>Basic Information</h3> <p>The Border Terrier is a small, rough-coated breed of dog of the terrier group, originally bred as fox and vermin hunters. [...]</p> </section> <section id="app"> <h3>Appearance</h3> <p>Identifiable by their otter-shaped heads, Border Terriers have a broad skull and short (although many be fairly long), strong muzzle with a scissors bite. [...]</p> </section> <section id="temp"> <h3>Temperament</h3> <p>Though sometimes stubborn and strong willed, border terriers are, on the whole very even tempered, and are friendly and rarely aggressive. [...] </p> </section> <footer> <a href="#basic">Basic</a> - <a href="#app">Appearance</a> - <a href="#temp">Temperament</a> </footer> </section> </main> <footer> <small>Copyright © <time datetime="2013">2013</time> by I. Devlin</small> </footer> </body> </html>
This example is largely the same as the previous one except that it includes an aside
.
The content of the aside
is considered to be relevant to the content within the main
element, which is all about the Border Terrier, so the aside
is placed within the main
element.
<!DOCTYPE html> <html lang="en"> <head> <title>Great Dogs for Families</title> </head> <body> <header> <h1>The Border Terrier</h1> <nav> <ul> <li><a href="index.html">Home</a></li> <li><a href="about.html">About</a></li> <li><a href="health.html">Health</a></li> </ul> </nav> </header> <main> <section> <header> <h2>About</h2> <nav> <ul> <li><a href="#basic">Basic</a></li> <li><a href="#app">Appearance</a></li> <li><a href="#temp">Temperament</a></li> </ul> </nav> </header> <section id="basic"> <h3>Basic Information</h3> <p>The Border Terrier is a small, rough-coated breed of dog of the terrier group, originally bred as fox and vermin hunters. [...]</p> </section> <section id="app"> <h3>Appearance</h3> <p>Identifiable by their otter-shaped heads, Border Terriers have a broad skull and short (although many be fairly long), strong muzzle with a scissors bite. [...]</p> </section> <section id="temp"> <h3>Temperament</h3> <p>Though sometimes stubborn and strong willed, border terriers are, on the whole very even tempered, and are friendly and rarely aggressive. [...] </p> </section> <aside> <h3>History</h3> <p>The Border Terrier originates in, and takes its name from the Scottish borders. [...] </p> </aside> <footer> <a href="#basic">Basic</a> - <a href="#app">Appearance</a> - <a href="#temp">Temperament</a> </footer> </section> </main> <footer> <small>Copyright © <time datetime="2013">2013</time> by I. Devlin</small> </footer> </body> </html>
In the following example, two aside
elements containg adverts have been placed outside
the main
element as their content is not specific to the content within main
. These aside
s could be on any page, as they are as generic as the header
and footer
shown.
<!DOCTYPE html> <html lang="en"> <head> <title>Great Dogs for Families</title> </head> <body> <header> <h1>The Border Terrier</h1> <nav> <ul> <li><a href="index.html">Home</a></li> <li><a href="about.html">About</a></li> <li><a href="health.html">Health</a></li> </ul> </nav> </header> <main> <h2>Welcome!</h2> <p>This site is all about the Border Terrier, the best breed of dog that there is!</p> </main> <aside class="advert"> <h2>Border Farm Breeders</h2> <p>We are a certified breeder of Border Terriers, contact us at...</p> </aside> <aside class="advert"> <h2>Grumpy’s Pet Shop</h2> <p>Get all your pet’s needs at our shop!</p> </aside> <footer> <small>Copyright © <time datetime="2013">2013</time> by I. Devlin</small> </footer> </body> </html>
4.4.15. The div
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- As a child of a
dl
element. - As a child of a
- Content model:
- If the element is a child of a
dl
element: one or moredt
elements followed by one or moredd
elements, optionally intermixed with script-supporting elements.- If the element is not a child of a
dl
element: Flow content. - If the element is not a child of a
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLDivElement
: HTMLElement {};
The div
element has no special meaning at all. It represents its children. It
can be used with the class
, lang
, and title
attributes to
mark up semantics common to a group of consecutive elements.
Authors are strongly encouraged to view the div
element as an element of last
resort, for when no other element is suitable. Use of more appropriate elements instead of the div
element leads to better accessibility for readers and easier maintainability
for authors.
article
, a chapter using section
, a page’s navigation aids using nav
, and a group of form
controls using fieldset
.
On the other hand, div
elements can be useful for stylistic purposes or to wrap
multiple paragraphs within a section that are all to be annotated in a similar way. In the
following example, we see div
elements used as a way to set the language of two
paragraphs at once, instead of setting the language on the two paragraph elements separately:
<article lang="en-US"> <h2>My use of language and my cats</h2> <p>My cat’s behavior hasn’t changed much since her absence, except that she plays her new physique to the neighbors regularly, in an attempt to get pets.</p> <div lang="en-GB"> <p>My other cat, colored black and white, is a sweetie. He followed us to the pool today, walking down the pavement with us. Yesterday he apparently visited our neighbours. I wonder if he recognizes that their flat is a mirror image of ours.</p> <p>Hm, I just noticed that in the last paragraph I used British English. But I’m supposed to write in American English. So I shouldn’t say "pavement" or "flat" or "color"...</p> </div> <p>I should say "sidewalk" and "apartment" and "color"!</p> </article>
4.5. Text-level semantics
4.5.1. The a
element
- Categories:
- Flow content.
- Phrasing content.
- If the element has an
href
attribute: Interactive content.- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Transparent, but there must be no interactive content or
a
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
href
- Address of the hyperlinktarget
- Default browsing context for hyperlink navigation and §4.10.21 Form submissiondownload
- Indicates to download the linked resource instead of navigating to it. If the attribute has a set value, change the resource’s proposed filename to the set value.rel
— Relationship of this document (or subsection/topic) to the destination resourcerev
— Reverse link relationship of the destination resource to this document (or subsection/topic)hreflang
- Language of the linked resourcetype
- Hint for the type of the referenced resourcereferrerpolicy
- Referrer policy for fetches initiated by the element - Allowed ARIA role attribute values:
- If
href
is set:link
(default - do not set),button
,checkbox
,menuitem
,menuitemcheckbox
,menuitemradio
,option
,radio
,switch
,tab
ortreeitem
- If no
href
is set: Any role value. - If no
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLAnchorElement
: HTMLElement { attribute DOMString target; attribute DOMString download; attribute DOMString rel; attribute DOMString rev; [SameObject, PutForwards=value] readonly attribute DOMTokenList relList; attribute DOMString hreflang; attribute DOMString type; attribute DOMString text; attribute DOMStringreferrerPolicy
; }; HTMLAnchorElement implements HTMLHyperlinkElementUtils; - DPub Roles:
-
doc-backlink
,doc-biblioref
,doc-glossref
ordoc-noteref
If the a
element has an href
attribute, then it represents a hyperlink (a hypertext anchor) labeled by its contents.
If the a
element has no href
attribute, then the element represents a placeholder for where a link might otherwise have been placed, if it had been
relevant, consisting of just the element’s contents.
The target
, download
, rel
, rev
, hreflang
, type
, and referrerpolicy
attributes must be omitted if the href
attribute is not present.
If a site uses a consistent navigation toolbar on every page, then the link that would
normally link to the page itself could be marked up using an a
element:
<nav> <ul> <li> <a href="/">Home</a> </li> <li> <a href="/news">News</a> </li> <li> <a>Examples</a> </li> <li> <a href="/legal">Legal</a> </li> </ul> </nav>
The href
, target
, download
, and referrerpolicy
attributes affect what happens when users follow hyperlinks or download hyperlinks created using the a
element. The rel
, rev
, hreflang
, and type
attributes may be used to indicate to the user the likely nature of
the target resource before the user follows the link.
The activation behavior of a
elements that create hyperlinks is to
run the following steps:
-
If the
a
element’sDocument
is not fully active, then abort these steps. -
If either the
a
element has adownload
attribute and the algorithm is not allowed to show a popup, or the element’starget
attribute is present and applying the rules for choosing a browsing context given a browsing context name, using the value of thetarget
attribute as the browsing context name, would result in there not being a chosen browsing context, then run these substeps:-
If there is an entry settings object, throw an
InvalidAccessError
exception. -
Abort these steps without following the hyperlink.
-
-
If the target of the
click
event is animg
element with anismap
attribute specified, then server-side image map processing must be performed, as follows:-
If the
click
event was a real pointing-device-triggeredclick
event on theimg
element, then let x be the distance in CSS pixels from the left edge of the image to the location of the click, and let y be the distance in CSS pixels from the top edge of the image to the location of the click. Otherwise, let x and y be zero. -
Let hyperlink suffix be a U+003F QUESTION MARK character, the value of x expressed as a base-ten integer using ASCII digits, a U+002C COMMA character (,), and the value of y expressed as a base-ten integer using ASCII digits.
-
-
Finally, the user agent must follow the hyperlink or download the hyperlink created by the
a
element, as determined by thedownload
attribute and any expressed user preference, passing hyperlink suffix, if the steps above defined it.
- a .
text
- Same as
textContent
.
The IDL attributes download
, target
, rel
, rev
, hreflang
, and type
, must reflect the
respective content attributes of the same name.
The IDL attribute relList
must reflect the rel
content attribute.
The IDL attribute referrerPolicy
must reflect the referrerpolicy
content attribute, limited to only known values.
The text
IDL attribute, on getting,
must return the same value as the textContent
IDL attribute on the element, and on
setting, must act as if the textContent
IDL attribute on the element had been set to
the new value.
The a
element also supports the HTMLHyperlinkElementUtils
interface. [URL]
When the element is created, and whenever the element’s href
content attribute is
set, changed, or removed, the user agent must invoke the element’s HTMLHyperlinkElementUtils
interface’s set the input algorithm with the value of the href
content
attribute, if any, or the empty string otherwise, as the given value.
The element’s HTMLHyperlinkElementUtils
interface’s get the base algorithm must simply return
the document base URL.
The element’s HTMLHyperlinkElementUtils
interface’s query encoding is the document’s character encoding.
When the element’s HTMLHyperlinkElementUtils
interface invokes its update steps with a string value, the user agent must set the element’s href
content attribute to
the string value.
a
element may be wrapped around entire paragraphs, lists, tables, and so forth,
even entire sections, so long as there is no interactive content within (e.g., buttons or other
links). This example shows how this can be used to make an entire advertising block into a link:
<aside class="advertising"> <h2>Advertising</h2> <a href="https://ad.example.com/?adid=1929&pubid=1422"> <section> <h3>Mellblomatic 9000!</h3> <p>Turn all your widgets into mellbloms!</p> <p>Only $9.99 plus shipping and handling.</p> </section> </a> <a href="https://ad.example.com/?adid=375&pubid=1422"> <section> <h3>The Mellblom Browser</h3> <p>Web browsing at the speed of light.</p> <p>No other browser goes faster!</p> </section> </a> </aside>
4.5.2. The em
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The em
element represents stress emphasis of its contents.
The level of stress that a particular piece of content has is given by its number of ancestor em
elements.
The placement of stress emphasis changes the meaning of the sentence. The element thus forms an integral part of the content. The precise way in which stress is used in this way depends on the language.
<p>Cats are cute animals.</p>
By emphasizing the first word, the statement implies that the kind of animal under discussion is in question (maybe someone is asserting that dogs are cute):
<p><em>Cats</em> are cute animals.</p>
Moving the stress to the verb, one highlights that the truth of the entire sentence is in question (maybe someone is saying cats are not cute):
<p>Cats <em>are</em> cute animals.</p>
By moving it to the adjective, the exact nature of the cats is reasserted (maybe someone suggested cats were mean animals):
<p>Cats are <em>cute</em> animals.</p>
Similarly, if someone asserted that cats were vegetables, someone correcting this might emphasize the last word:
<p>Cats are cute <em>animals</em>.</p>
By emphasizing the entire sentence, it becomes clear that the speaker is fighting hard to get the point across. This kind of stress emphasis also typically affects the punctuation, hence the exclamation mark here.
<p><em>Cats are cute animals!</em></p>
Anger mixed with emphasizing the cuteness could lead to markup such as:
<p><em>Cats are <em>cute</em> animals!</em></p>
em
element isn’t a generic "italics" element. Sometimes, text is intended to
stand out from the rest of the paragraph, as if it was in a different mood or voice. For this,
the i
element is more appropriate.
The em
element also isn’t intended to convey importance; for that purpose, the strong
element is more appropriate.
4.5.3. The strong
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The strong
element represents strong importance, seriousness, or
urgency for its contents.
Importance: The strong
element can be used in a heading, caption,
or paragraph to distinguish the part that really matters from other parts that might be more
detailed, more jovial, or merely boilerplate.
For example, the first word of the previous paragraph is marked up with strong
to distinguish it from the more detailed text in the rest of the
paragraph.
Seriousness: The strong
element can be used to mark up a warning
or caution notice.
Urgency: The strong
element can be used to denote contents that
the user needs to see sooner than other parts of the document.
The relative level of importance of a piece of content is given by its number of ancestor strong
elements; each strong
element increases the importance of its
contents.
Changing the importance of a piece of text with the strong
element does not change
the meaning of the sentence.
strong
:
<h1>Chapter 1: <strong>The Praxis</strong></h1>
In the following example, the name of the diagram in the caption is marked up with strong
, to distinguish it from boilerplate text (before) and the description
(after):
<figcaption> Figure 1. <strong>Ant colony dynamics</strong>. The ants in this colony are affected by the heat source (upper left) and the food source (lower right). </figcaption>
In this example, the heading is really "Flowers, Bees, and Honey", but the author has added a
light-hearted addition to the heading. The strong
element is thus used to mark up
the first part to distinguish it from the latter part.
<h1><strong>Flowers, Bees, and Honey</strong> and other things I don’t understand</h1>
<p> <strong>Warning.</strong> This dungeon is dangerous. <strong>Avoid the ducks.</strong> Take any gold you find. <strong><strong>Do not take any of the diamonds</strong>, they are explosive and <strong>will destroy anything within ten meters.</strong></strong> You have been warned. </p>
strong
element is used to denote the part of the text that
the user is intended to read first.
<p>Welcome to Remy, the reminder system.</p> <p>Your tasks for today:</p> <ul> <li><strong>Turn off the oven.</strong></li> <li>Put out the trash.</li> <li>Do the laundry.</li> </ul>
4.5.4. The small
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The small
element represents side comments such as small print.
Small print typically features disclaimers, caveats, legal restrictions, or copyrights. Small print is also sometimes used for attribution, or for satisfying licensing requirements.
The small
element does not "de-emphasize" or lower the importance of text
emphasized by the em
element or marked as important with the strong
element. To mark text as not emphasized or important, simply do not mark it up with the em
or strong
elements respectively.
The small
element should not be used for extended spans of text, such as multiple
paragraphs, lists, or sections of text. It is only intended for short runs of text. The text of a
page listing terms of use, for instance, would not be a suitable candidate for the small
element: in such a case, the text is not a side comment, it is the main content
of the page.
small
element is used to indicate that value-added tax is
not included in a price of a hotel room:
<dl> <dt>Single room</dt> <dd>199 € <small>breakfast included, VAT not included</small></dd> <dt>Double room</dt> <dd>239 € <small>breakfast included, VAT not included</small></dd> </dl>
small
element is used for a side comment in an article.
<p>Example Corp today announced record profits for the second quarter <small>(Full Disclosure: Foo News is a subsidiary of Example Corp)</small>, leading to speculation about a third quarter merger with Demo Group.</p>
This is distinct from a sidebar, which might be multiple paragraphs long and is removed from the main flow of text. In the following example, we see a sidebar from the same article. This sidebar also has small print, indicating the source of the information in the sidebar.
<aside> <h1>Example Corp</h1> <p>This company mostly creates small software and Web sites.</p> <p>The Example Corp company mission is "To provide entertainment and news on a sample basis".</p> <p><small>Information obtained from <a href="https://example.com/about.html">example.com</a> home page.</small></p> </aside>
In this last example, the small
element is marked as being important small print.
<p><strong><small>Continued use of this service will result in a kiss.</small></strong></p>
4.5.5. The s
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The s
element represents contents that are no longer accurate or no longer
relevant.
The s
element is not appropriate when indicating document edits; to mark a span of
text as having been removed from a document, use the del
element.
<p>Buy our Iced Tea and Lemonade!</p> <p><s>Recommended retail price: $3.99 per bottle</s></p> <p><strong>Now selling for just $2.99 a bottle!</strong></p>
4.5.6. The cite
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The cite
element represents a reference to a creative work. It must include
the title of the work or the name of the author (person, people or organization) or an URL
reference, or a reference in abbreviated form as per the conventions used for the addition of
citation metadata.
Creative works include a book, a paper, an essay, a poem, a score, a song, a script, a film, a TV show, a game, a sculpture, a painting, a theatre production, a play, an opera, a musical, an exhibition, a legal case report, a computer program, a web site, a web page, a blog post or comment, a forum post or comment, a tweet, a written or oral statement, etc.
cite
element:
<p> In the words of <cite>Charles Bukowski</cite> - <q>An intellectual says a simple thing in a hard way. An artist says a hard thing in a simple way.</q> </p>
cite
element:
<blockquote class="twitter-tweet"> <p>This is for everyone #london2012 #oneweb #openingceremony @webfoundation @w3c</p> <cite>— Tim Berners-Lee (@timberners_lee) <a href="https://twitter.com/timberners_lee/status/228960085672599552">27 July 2012</a></cite> </blockquote>
cite
element is used to reference the title of a work in a
bibliography:
<p><cite>Universal Declaration of Human Rights</cite>, United Nations, December 1948. Adopted by General Assembly resolution 217 A (III).</p>
cite
element is used to reference the title of a television
show:
<p>Who is your favorite doctor (in <cite>Doctor Who</cite>)?</p>
cite
element is to identify the author of a comment in a
blog post or forum, as in this example:
<article id="comment-1"> Comment by <cite><a href="https://example.net">Elizabeth Bennet</a></cite> <time datetime="2013-08-19T16:01">August 19th, 2013 at 4:01 pm</time> <p>There is a stubbornness about me that never can bear to be frightened at the will of others. My courage always rises at every attempt to intimidate me</p> </article>
cite
element is to reference the URL
of a search result, as in this example:
<div id="resultStats">About 416,000,000 results 0.33 seconds) </div> <p><a href="https://www.w3.org/html/wg/">W3C <i>HTML Working Group</i></a></p> <p><cite>www.w3.org/<b>html</b>/wg/</cite></p> <p>15 Apr 2013 - The <i>HTML Working Group</i> is currently chartered to continue its work through 31 December 2014. A Plan 2014 document published by the...</p> ...
cite
element is used to identify an abbreviated reference such as Ibid. it is suggested that this reference be linked to the base reference:
<article> <h2>Book notes</h2> <blockquote>"Money is the real cause of poverty," <footer> <cite id="baseref">The Ragged-Trousered Philanthropists, page 89.</cite> </footer> </blockquote> <blockquote>"Money is the cause of poverty because it is the device by which those who are too lazy to work are enabled to rob the workers of the fruits of their labour." <a href="#baseref"><cite>Ibid.</cite></a> </blockquote> </article>
A citation is not a quote (for which the q
element is
appropriate).
cite
is not for quotes:
<p><cite>This is wrong!, said Hillary.</cite> is a quote from the popular daytime TV drama When Ian became Hillary.</p>
This is an example of the correct usage:
<p><q>This is correct, said Hillary.</q> is a quote from the popular daytime TV drama <cite>When Ian became Hillary</cite>.</p>
4.5.7. The q
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
cite
- Link to the source of the quotation. - Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes.
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLQuoteElement
.
The q
element represents some phrasing content quoted from another source.
Quotation punctuation (such as quotation marks) that is quoting the contents of the element must
not appear immediately before, after, or inside q
elements; they will be inserted
into the rendering by the user agent.
Content inside a q
element must be quoted from another source, whose address, if it
has one, may be cited in the cite
attribute. The source may be fictional,
as when quoting characters in a novel or screenplay.
If the cite
attribute is present, it must be a valid URL potentially surrounded by spaces. To obtain the corresponding citation link, the
value of the attribute must be parsed relative to the element’s node document.
User agents may allow users to follow such citation links, but they are primarily intended for
private use (e.g., by server-side scripts collecting statistics about a site’s use of quotations),
not for readers.
The q
element must not be used in place of quotation marks that do not represent
quotes; for example, it is inappropriate to use the q
element for marking up
sarcastic statements.
The use of q
elements to mark up quotations is entirely optional; using explicit
quotation punctuation without q
elements is just as correct.
q
element:
<p>The man said <q>Things that are impossible just take longer</q>. I disagreed with him.</p>
q
element, and an
explicit citation outside:
<p>The W3C page <cite>About W3C</cite> says the W3C’s mission is <q cite="https://www.w3.org/Consortium/">To lead the World Wide Web to its full potential by developing protocols and guidelines that ensure long-term growth for the Web</q>. I fully agree with this mission.</p>
<p>In <cite>Example One</cite>, he writes <q>The man said <q>Things that are impossible just take longer</q>. I disagreed with him</q>. Well, I disagree even more!</p>
q
element:
<p>His best argument was ❝I disagree❞, which I thought was laughable.</p>
q
element in this case would be inappropriate.
<p>The word "ineffable" could have been used to describe the disaster resulting from the campaign’s mismanagement.</p>
4.5.8. The dfn
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content, but there must be no
dfn
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Also, the
title
attribute has special semantics on this element. - Also, the
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The dfn
element represents the defining instance of a term. The term-description group, p
, li
or section
element that is the nearest
ancestor of the dfn
element must also contain the definition(s) for the term given by the dfn
element.
Defining term: If the dfn
element has a title
attribute, then the exact value of that attribute is the term being defined. Otherwise, if it
contains exactly one element child node and no child Text
nodes, and that child
element is an abbr
element with a title
attribute, then the exact value
of that attribute is the term being defined. Otherwise, it is the exact textContent
of the dfn
element that gives the term being defined.
If the title
attribute of the dfn
element is present, then it must
contain only the term being defined.
The title
attribute of ancestor elements does not affect dfn
elements.
An a
element that links to a dfn
element represents an instance of the
term defined by the dfn
element.
<p>The <dfn><abbr title="Garage Door Opener">GDO</abbr></dfn> is a device that allows off-world teams to open the iris.</p> <!-- ... later in the document: --> <p>Teal’c activated his <abbr title="Garage Door Opener">GDO</abbr> and so Hammond ordered the iris to be opened.</p>
With the addition of an a
element, the reference can be made explicit:
<p>The <dfn id="gdo"><abbr title="Garage Door Opener">GDO</abbr></dfn> is a device that allows off-world teams to open the iris.</p> <!-- ... later in the document: --> <p>Teal’c activated his <a href="#gdo"><abbr title="Garage Door Opener">GDO</abbr></a> and so Hammond ordered the iris to be opened.</p>
4.5.9. The abbr
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Also, the
title
attribute has special semantics on this element. - Also, the
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The abbr
element represents an abbreviation or acronym, optionally with its
expansion. The title
attribute may be used to provide an expansion of the
abbreviation. The attribute, if specified, must contain an expansion of the abbreviation, and
nothing else.
abbr
element.
This paragraph defines the term "Web Hypertext Application
Technology Working Group".
<p>The <dfn id="w3c"><abbr title="World Wide Web Consortium">W3C</abbr></dfn> is the main international standards organization for the World Wide Web.</p>
An alternative way to write this would be:
<p>The <dfn id="w3c">World Wide Web Consortium</dfn> (<abbr title="World Wide Web Consortium">W3C</abbr>) is the main international standards organization for the World Wide Web.</p>
abbr
element.
<p>The <abbr title="World Wide Web Consortium">W3C</abbr> started working on HTML in 1994.</p>
<p>The <a href="#w3c"><abbr title="World Wide Web Consortium">W3C</abbr></a> has members all over the world.</p>
<p>There are several <abbr>W3C</abbr> offices around the world.</p>
If an abbreviation is pluralized, the expansion’s grammatical number (plural vs singular) must match the grammatical number of the contents of the element.
<p>Two <abbr title="Working Group">WG</abbr>s worked on this specification: the <abbr>CSSWG</abbr> and the <abbr>ARIA</abbr>.</p>
Here the plural is inside the element, so the expansion is in the plural:
<p>Two <abbr title="Working Groups">WGs</abbr> worked on this specification: the <abbr>CSSWG</abbr> and the <abbr>ARIA</abbr>.</p>
Abbreviations do not have to be marked up using this element. It is expected to be useful in the following cases:
-
Abbreviations for which the author wants to give expansions, where using the
abbr
element with atitle
attribute is an alternative to including the expansion inline (e.g., in parentheses). -
Abbreviations that are likely to be unfamiliar to the document’s readers, for which authors are encouraged to either mark up the abbreviation using an
abbr
element with atitle
attribute or include the expansion inline in the text the first time the abbreviation is used. -
Abbreviations whose presence needs to be semantically annotated, e.g., so that they can be identified from a style sheet and given specific styles, for which the
abbr
element can be used without atitle
attribute.
Providing an expansion in a title
attribute once will not necessarily cause other abbr
elements in the same document with the same contents but without a title
attribute to behave as if they had the same expansion. Every abbr
element is independent.
4.5.10. The ruby
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- See prose.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The ruby
element allows one or more spans of phrasing content to be marked with ruby
annotations. Ruby annotations are short runs of text presented alongside base text, primarily
used in East Asian typography as a guide for pronunciation or to include other annotations. In
Japanese, this form of typography is also known as furigana. Ruby text can appear on either
side, and sometimes both sides, of the base text, and it is possible to control its position using
CSS. A more complete introduction to ruby can be found in the Use Cases & Exploratory
Approaches for Ruby Markup document as well as in CSS Ruby. [RUBY-UC] [CSS3-RUBY]
The content model of ruby
elements consists of one or more of the following sequences:
-
One or more phrasing content nodes or
rb
elements. -
One or more
rt
orrtc
elements, each of which either immediately preceded or followed by anrp
elements.
The ruby
, rb
, rtc
, and rt
elements can be used
for a variety of kinds of annotations, including in particular (though by no means limited to)
those described below. For more details on Japanese Ruby in particular, and how to render Ruby for
Japanese, see Requirements for Japanese Text Layout. [JLREQ] The rp
element can be used as fallback content when ruby rendering is not supported.
- Mono-ruby for individual base characters
-
Annotations (the ruby text) are associated individually with each ideographic character (the base text). In Japanese this is typically hiragana or katakana characters used to provide readings of kanji characters.
When no
rb
element is used, the base is implied, as above. But you can also make it explicit. This can be useful notably for styling, or when consecutive bases are to be treated as a group, as in the jukugo ruby example further down.In the following example, notice how each annotation corresponds to a single base character.
<ruby>日<rt>に</rt></ruby><ruby>本<rt>ほん</rt></ruby> <ruby>語<rt>ご</rt></ruby>で<ruby>書<rt>か</rt></ruby> いた <ruby>作<rt>さく</rt></ruby><ruby>文<rt>ぶん</rt></ruby>です。
Ruby text interspersed in regular text provides structure akin to the following image:
This example can also be written as follows, using one
ruby
element with two segments of base text and two annotations (one for each) rather than two back-to-backruby
elements each with one base text segment and annotation (as in the markup above):<ruby>日<rt>に</rt>本<rt>ほん</rt>語<rt>ご</rt></ruby> で<ruby>書<rt>か</rt></ruby> いた<ruby>作<rt>さく</rt>文<rt>ぶん</rt></ruby>です。
- Group ruby
-
Group ruby is often used where phonetic annotations don’t map to discreet base characters, or for semantic glosses that span the whole base text. For example, the word "today" is written with the characters 今日, literally "this day". But it’s pronounced きょう (kyou), which can’t be broken down into a "this" part and a "day" part. In typical rendering, you can’t split text that is annotated with group ruby; it has to wrap as a single unit onto the next line. When a ruby text annotation maps to a base that is comprised of more than one character, then that base is grouped.
The following group ruby:
Can be marked up as follows:
- Jukugo ruby
-
Jukugo refers to a Japanese compound noun, i.e., a word made up of more than one kanji character. Jukugo ruby is a term that is used not to describe ruby annotations over jukugo text, but rather to describe ruby with a behavior slightly different from mono or group ruby. Jukugo ruby is similar to mono ruby, in that there is a strong association between ruby text and individual base characters, but the ruby text is typically rendered as grouped together over multiple ideographs when they are on the same line.
The distinction is captured in this example:
Which can be marked up as follows:
In this example, each
rt
element is paired with its respectiverb
element, the difference with an interleavedrb
/rt
approach being that the sequences of both base text and ruby annotations are implicitly placed in common containers so that the grouping information is captured.For more details on Jukugo Ruby rendering, see Appendix F in the Requirements for Japanese Text Layout and Use Case C: Jukugo ruby in the Use Cases & Exploratory Approaches for Ruby Markup. [JLREQ] [RUBY-UC]
- Inline ruby
-
In some contexts, for instance when the font size or line height are too small for ruby to be readable, it is desirable to inline the ruby annotation such that it appears in parentheses after the text it annotates. This also provides a convenient fallback strategy for user agents that do not support rendering ruby annotations.
Inlining takes grouping into account. For example, Tokyo is written with two kanji characters, 東, which is pronounced とう, and 京, which is pronounced きょう. Each base character should be annotated individually, but the fallback should be 東京(とうきょう) not 東(とう)京(きょう). This can be marked up as follows:
Note that the above markup will enable the usage of parentheses when inlining for browsers that support ruby layout, but for those that don’t it will fail to provide parenthetical fallback. This is where the
rp
element is useful. It can be inserted into the above example to provide the appropriate fallback when ruby layout is not supported:
- Text with both phonetic and semantic annotations (double-sided ruby)
-
Sometimes, ruby can be used to annotate a base twice.
In the following example, the Chinese word for San Francisco (旧金山, i.e., "old gold mountain") is annotated both using pinyin to give the pronunciation, and with the original English.
Which is marked up as follows:
In this example, a single base run of three base characters is annotated with three pinyin ruby text segments in a first (implicit) container, and an
rtc
element is introduced in order to provide a second single ruby text annotation being the city’s English name.We can also revisit our jukugo example above with 上手 ("skill") to show how it can be annotation in both kana and romaji phonetics while at the same time maintaining the pairing to bases and annotation grouping information.
Which is marked up as follows:
Text that is a direct child of the
rtc
element implicitly produces a ruby text segment as if it were contained in anrt
element. In this contrived example, this is shown with some symbols that are given names in English and French with annotations intended to appear on either side of the base symbol.<ruby> ♥<rt>Heart<rtc lang="fr">Cœur</rtc> ☘<rt>Shamrock<rtc lang="fr">Trèfle</rtc> ✶<rt>Star<rtc lang="fr">Étoile </ruby>
Similarly, text directly inside a
ruby
element implicitly produces a ruby base as if it were contained in anrb
element, andrt
children ofruby
are implicitly contained in anrtc
container. In effect, the above example is equivalent (in meaning, though not in the DOM it produces) to the following:
Within a ruby element, content is parcelled into a series of ruby segments. Each ruby segment is described by:
-
Zero or more ruby bases, each of which is a DOM range that may contain phrasing content or an
rb
element. -
A base range, that is a DOM range including all the bases. This is the ruby base container.
-
Zero or more ruby text containers which may correspond to explicit
rtc
elements, or to sequences ofrt
elements implicitly recognized as contained in an anonymous ruby text container.
Each ruby text container is described by zero or more ruby text annotations each of which is a DOM range that may contain phrasing content
or an rt
element, and an annotations range that is a range including all the
annotations for that container. A ruby text container is also known (primarily in a CSS
context) as a ruby annotation container.
Furthermore, a ruby element contains ignored ruby content. Ignored ruby content does
not form part of the document’s semantics. It consists of some inter-element white space and rp
elements, the latter of which are used for legacy user agents that do not
support ruby at all.
The process of annotation pairing associates ruby annotations with ruby bases. Within each ruby segment, each ruby base in the ruby base container is paired with one ruby text annotation from the ruby text container, in order. If there are not enough ruby text annotations in a ruby annotation container, the last one is associated with any excess ruby bases. (If there are not any in the ruby annotation container, an anonymous empty one is assumed to exist.) If there are not enough ruby bases, any remaining ruby text annotations are assumed to be associated with empty, anonymous bases inserted at the end of the ruby base container.
Note that the terms ruby segment, ruby base, ruby text annotation, ruby text container, ruby base container, and ruby annotation container have their equivalents in CSS Ruby Module Level 3. [CSS3-RUBY]
Informally, the segmentation and categorization algorithm below performs a simple set of
tasks. First it processes adjacent rb
elements, text nodes, and non-ruby
elements into a list of bases. Then it processes any number of rtc
elements or
sequences of rt
elements that are considered to automatically map to an
anonymous ruby text container. Put together these data items form a ruby
segment as detailed in the data model above. It will continue to produce such segments
until it reaches the end of the content of a given ruby
element. The complexity
of the algorithm below compared to this informal description stems from the need to support
an author-friendly syntax and being mindful of inter-element white space.
At any particular time, the segmentation and categorization of content of a ruby
element is the result that would be obtained from running the following
algorithm:
- Let root be the
ruby
element for which the algorithm is being run. - Let index be 0.
- Let ruby segments be an empty list.
- Let current bases be an empty list of DOM ranges.
- Let current bases range be null.
- Let current bases range start be null.
- Let current annotations be an empty list of DOM ranges.
- Let current annotations range be null.
- Let current annotations range start be null.
- Let current annotation containers be an empty list.
- Let current automatic base nodes be an empty list of DOM Nodes.
- Let current automatic base range start be null.
- Process a ruby child: If index is equal to or greater than the number of child nodes in root, then run the steps to commit a ruby segment, return ruby segments, and abort these steps.
- Let current child be the indexth node in root.
- If current child is not a Text node and is not an
Element
node, then increment index by one and jump to the step labelled process a ruby child. - If current child is an
rp
element, then increment index by one and jump to the step labelled process a ruby child. (Note that this has the effect of including this element in any range that we are currently processing. This is done intentionally so that misplacedrp
can be processed correctly; semantically they are ignored all the same.) -
If current child is an
rt
element, then run these substeps:- Run the steps to commit an automatic base.
- Run the steps to commit the base range.
- If current annotations is empty, set current annotations range start to the value of index.
- Create a new DOM range whose start is the boundary point (root, index) and whose end is the boundary point (root, index plus one), and append it at the end of current annotations.
- Increment index by one and jump to the step labelled process a ruby child.
-
If current child is an
rtc
element, then run these substeps:- Run the steps to commit an automatic base.
- Run the steps to commit the base range.
- Run the steps to commit current annotations.
- Create a new ruby annotation container. It is described by the list of
annotations returned by running the steps to process an
rtc
element and a DOM range whose start is the boundary point (root, index) and whose end is the boundary point (root, index plus one). Append this new ruby annotation container at the end of current annotation containers. - Increment index by one and jump to the step labelled process a ruby child.
-
If current child is a
Text
node and is inter-element white space, then run these substeps:- If current annotations is not empty, increment index by one and jump to the step labelled process a ruby child.
-
Run the following substeps:
- Let lookahead index be set to the value of index.
- Peek ahead: Increment lookahead index by one.
- If lookahead index is equal to or greater than the number of child nodes in root, then abort these substeps.
- Let peek child be the lookahead indexth node in root.
- If peek child is a
Text
node and is inter-element white space, then jump to the step labelled peek ahead. - If peek child is an
rt
element, anrtc
element, or anrp
element, then set index to the value of lookahead index and jump to the step labelled process a ruby child.
- If current annotations is not empty or if current annotation containers is not empty, then run the steps to commit a ruby segment.
-
If current child is an
rb
element, then run these substeps:- Run the steps to commit an automatic base.
- If current bases is empty, then set current bases range start to the value of index.
- Create a new DOM range whose start is the boundary point (root, index) and whose end is the boundary point (root, index plus one), and append it at the end of current bases.
- Increment index by one and jump to the step labelled process a ruby child.
- If current automatic base nodes is empty, set current automatic base range start to the value of index.
- Append current child at the end of current automatic base nodes.
- Increment index by one and jump to the step labelled process a ruby child.
When the steps above say to commit a ruby segment, it means to run the following steps at that point in the algorithm:
- Run the steps to commit an automatic base.
- If current bases, current annotations, and current annotation containers are all empty, abort these steps.
- Run the steps to commit the base range.
- Run the steps to commit current annotations.
- Create a new ruby segment. It is described by a list of bases set to current bases, a base DOM range set to current bases range, and a list of ruby annotation containers that are the current annotation containers list. Append this new ruby segment at the end of ruby segments.
- Let current bases be an empty list.
- Let current bases range be null.
- Let current bases range start be null.
- Let current annotation containers be an empty list.
When the steps above say to commit the base range, it means to run the following steps at that point in the algorithm:
- If current bases is empty, abort these steps.
- If current bases range is not null, abort these steps.
- Let current bases range be a DOM range whose start is the boundary point (root, current bases range start) and whose end is the boundary point (root, index).
When the steps above say to commit current annotations, it means to run the following steps at that point in the algorithm:
- If current annotations is not empty and current annotations range is null let current annotations range be a DOM range whose start is the boundary point (root, current annotations range start) and whose end is the boundary point (root, index).
- If current annotations is not empty, create a new ruby annotation container. It is described by an annotations list set to current annotations and a range set to current annotations range. Append this new ruby annotation container at the end of current annotation containers.
- Let current annotations be an empty list of DOM ranges.
- Let current annotations range be null.
- Let current annotations range start be null.
When the steps above say to commit an automatic base, it means to run the following steps at that point in the algorithm:
- If current automatic base nodes is empty, abort these steps.
-
If current automatic base nodes contains nodes that are not
Text
nodes, orText
nodes that are not inter-element white space, then run these substeps:- It current bases is empty, set current bases range start to the value of current automatic base range start.
- Create a new DOM range whose start is the boundary point (root, current automatic base range start) and whose end is the boundary point (root, index), and append it at the end of current bases.
- Let current automatic base nodes be an empty list of DOM Nodes.
- Let current automatic base range start be null.
4.5.11. The rb
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
ruby
element. - Content model:
- Phrasing content.
- Tag omission in text/html:
- An
rb
element’s end tag may be omitted if therb
element is immediately followed by anrb
,rt
,rtc
orrp
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The rb
element marks the base text component of a ruby annotation. When it is
the child of a ruby
element, it doesn’t represent anything itself, but its parent ruby
element uses it as part of determining what it represents.
An rb
element that is not a child of a ruby
element represents the same thing as its children.
4.5.12. The rt
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
ruby
or of anrtc
element. - Content model:
- Phrasing content.
- Tag omission in text/html:
- An
rt
element’s end tag may be omitted if thert
element is immediately followed by anrb
,rt
,rtc
orrp
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The rt
element marks the ruby text component of a ruby annotation. When it is
the child of a ruby
element or of an rtc
element that is itself
the child of a ruby
element, it doesn’t represent anything itself, but its ancestor ruby
element uses it as part of determining what it represents.
An rt
element that is not a child of a ruby
element or of an rtc
element that is itself the child of a ruby
element represents the same thing as its children.
4.5.13. The rtc
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
ruby
element. - Content model:
- Phrasing content,
rt
, orrp
elements. - Tag omission in text/html:
- An
rtc
element’s end tag may be omitted if thertc
element is immediately followed by anrb
orrtc
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The rtc
element marks a ruby text container for ruby text components
in a ruby annotation. When it is the child of a ruby
element it doesn’t represent anything itself, but its parent ruby
element
uses it as part of determining what it represents.
An rtc
element that is not a child of a ruby
element represents the same thing as its children.
When an rtc
element is processed as part of the segmentation and
categorization of content for a ruby
element, the following algorithm
defines how to process an rtc
element:
- Let root be the
rtc
element for which the algorithm is being run. - Let index be 0.
- Let annotations be an empty list of DOM ranges.
- Let current automatic annotation nodes be an empty list of DOM nodes.
- Let current automatic annotation range start be null.
- Process an rtc child: If index is equal to or greater than the number of child nodes in root, then run the steps to commit an automatic annotation, return annotations, and abort these steps.
- Let current child be the indexth node in root.
-
If current child is an
rt
element, then run these substeps:- Run the steps to commit an automatic annotation.
- Create a new DOM range whose start is the boundary point (root, index) and whose end is the boundary point (root, index plus one), and append it at the end of annotations.
- Increment index by one and jump to the step labelled process an rtc child.
- If current automatic annotation nodes is empty, set current automatic annotation range start to the value of index.
- Append current child at the end of current automatic annotation nodes.
- Increment index by one and jump to the step labelled process an rtc child.
When the steps above say to commit an automatic annotation, it means to run the following steps at that point in the algorithm:
- If current automatic annotation nodes is empty, abort these steps.
- If current automatic annotation nodes contains nodes that are not
Text
nodes, orText
nodes that are not inter-element white space, then create a new DOM range whose start is the boundary point (root, current automatic annotation range start) and whose end is the boundary point (root, index), and append it at the end of annotations. - Let current automatic annotation nodes be an empty list of DOM nodes.
- Let current automatic annotation range start be null.
4.5.14. The rp
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
ruby
orrtc
element, either immediately before or immediately after anrt
orrtc
element, but not betweenrt
elements. - Content model:
- Phrasing content.
- Tag omission in text/html:
- An
rp
element’s end tag may be omitted if therp
element is immediately followed by anrb
,rt
,rtc
orrp
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The rp
element is used to provide fallback text to be shown by user agents that
don’t support ruby annotations. One widespread convention is to provide parentheses around
the ruby text component of a ruby annotation.
The contents of the rp
elements are typically not displayed by user agents
which do support ruby annotations
An rp
element that is a child of a ruby
element represents nothing. An rp
element whose parent element is not a ruby
element represents its
children.
The example shown previously, in which each ideograph in the text 漢字 is annotated with its phonetic reading, could be expanded
to use rp
so that in legacy user agents the readings are in parentheses (please
note that white space has been introduced into this example in order to make it more
readable):
In conforming user agents the rendering would be as above, but in user agents that do not support ruby, the rendering would be:
When there are multiple annotations for a segment, rp
elements can also be
placed between the annotations. Here is another copy of an earlier contrived example showing
some symbols with names given in English and French using double-sided annotations, but this
time with rp
elements as well:
<ruby> ♥<rp>: </rp><rt>Heart</rt><rp>, </rp><rtc><rt lang="fr">Cœur</rt></rtc><rp>.</rp> ☘<rp>: </rp><rt>Shamrock</rt><rp>, </rp><rtc><rt lang="fr">Trèfle</rt></rtc><rp>.</rp> ✶<rp>: </rp><rt>Star</rt><rp>, </rp><rtc><rt lang="fr">Étoile</rt></rtc><rp>.</rp> </ruby>
This would make the example render as follows in non-ruby-capable user agents:
4.5.15. The data
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
value
- Machine-readable value - Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLDataElement
: HTMLElement { attribute DOMString value; };
The data
element represents its contents, along with a
machine-readable form of those contents in the value
attribute.
The value
attribute must be present. Its value
must be a representation of the element’s contents in a machine-readable format.
When the value is a date or time, the more specific time
element should be used instead.
The element can be used to provide a machine-readable value for data processors, including scripts running in the page, alongside a more human-readable value that is rendered in a Web browser. Typical uses include microdata and microformats. [microdata][microformats]
<h1 itemscope> <data itemprop="product-id" value="9678AOU879">The Instigator 2000</data> </h1>
The value
IDL attribute must reflect the content attribute of the same name.
4.5.16. The time
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- If the element has a
datetime
attribute: Phrasing content.- Otherwise: Text , but must match requirements described in prose below.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
datetime
- Machine-readable value - Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLTimeElement
: HTMLElement { attribute DOMString dateTime; };
The time
element represents its contents, along with a
machine-readable form of those contents in the datetime
attribute. The kind of content is limited to various kinds of dates, times, time-zone offsets, and
durations, as described below.
The datetime
attribute may be present. If
present, its value must be a representation of the element’s contents in a machine-readable
format.
A time
element that does not have a datetime
content attribute must not have any element
descendants.
The datetime value of a time
element is the value of the element’s datetime
content attribute, if it has one, otherwise the child text content of
the time
element.
The datetime value of a time
element must match one of the following
syntaxes.
- A valid month string
-
<time>2011-11</time>
- A valid date string
-
<time>2011-11-18</time>
- A valid yearless date string
-
<time>11-18</time>
- A valid time string
-
<time>09:54</time>
<time>09:54:39</time>
<time>09:54:39.929</time>
- A valid floating date and time string
-
<time>2011-11-18T14:54</time>
<time>2011-11-18T14:54:39</time>
<time>2011-11-18T14:54:39.929</time>
<time>2011-11-18 14:54</time>
<time>2011-11-18 14:54:39</time>
<time>2011-11-18 14:54:39.929</time>
Times with dates but without a time zone offset are useful for specifying events that are observed at the same specific time in each time zone, throughout a day. For example, the 2020 new year is celebrated at 2020-01-01 00:00 in each time zone, not at the same precise moment across all time zones. For events that occur at the same time across all time zones, for example a videoconference meeting, a valid global date and time string is likely more useful.
- A valid time-zone offset string
-
<time>Z</time>
<time>+0000</time>
<time>+00:00</time>
<time>-0800</time>
<time>-08:00</time>
For times without dates (or times referring to events that recur on multiple dates), specifying the geographic location that controls the time is usually more useful than specifying a time zone offset, because geographic locations change time zone offsets with daylight savings time. In some cases, geographic locations even change time zone, e.g., when the boundaries of those time zones are redrawn, as happened with Samoa at the end of 2011. There exists a time zone database that describes the boundaries of time zones and what rules apply within each such zone, known as the time zone database. [TZDATABASE]
- A valid global date and time string
-
<time>2011-11-18T14:54Z</time>
<time>2011-11-18T14:54:39Z</time>
<time>2011-11-18T14:54:39.929Z</time>
<time>2011-11-18T14:54+0000</time>
<time>2011-11-18T14:54:39+0000</time>
<time>2011-11-18T14:54:39.929+0000</time>
<time>2011-11-18T14:54+00:00</time>
<time>2011-11-18T14:54:39+00:00</time>
<time>2011-11-18T14:54:39.929+00:00</time>
<time>2011-11-18T06:54-0800</time>
<time>2011-11-18T06:54:39-0800</time>
<time>2011-11-18T06:54:39.929-0800</time>
<time>2011-11-18T06:54-08:00</time>
<time>2011-11-18T06:54:39-08:00</time>
<time>2011-11-18T06:54:39.929-08:00</time>
<time>2011-11-18 14:54Z</time>
<time>2011-11-18 14:54:39Z</time>
<time>2011-11-18 14:54:39.929Z</time>
<time>2011-11-18 14:54+0000</time>
<time>2011-11-18 14:54:39+0000</time>
<time>2011-11-18 14:54:39.929+0000</time>
<time>2011-11-18 14:54+00:00</time>
<time>2011-11-18 14:54:39+00:00</time>
<time>2011-11-18 14:54:39.929+00:00</time>
<time>2011-11-18 06:54-0800</time>
<time>2011-11-18 06:54:39-0800</time>
<time>2011-11-18 06:54:39.929-0800</time>
<time>2011-11-18 06:54-08:00</time>
<time>2011-11-18 06:54:39-08:00</time>
<time>2011-11-18 06:54:39.929-08:00</time>
Times with dates and a time zone offset are useful for specifying specific events, or recurring virtual events where the time is not anchored to a specific geographic location. For example, the precise time of an asteroid impact, or a particular meeting in a series of meetings held at 1400 UTC every day, regardless of whether any particular part of the world is observing daylight savings time or not. For events where the precise time varies by the local time zone offset of a specific geographic location, a valid floating date and time string combined with that geographic location is likely more useful.
- A valid week string
-
<time>2011-W47</time>
- Four ASCII digits , at least one of which is not U+0030 DIGIT ZERO (0)
-
<time>2011</time>
<time>0001</time>
- A valid duration string
-
<time>PT4H18M3S</time>
<time>4h 18m 3s</time>
Many of the preceding valid syntaxes describe "floating" date and/or time values (they do not include a time-zone offset). Care is needed when converting floating time values to or from global ("incremental") time values (e.g., JavaScript’s Date object). In many cases, an implicit time-of-day and time zone are used in the conversion and may result in unexpected changes to the value of the date itself. [TIMEZONE]
The machine-readable equivalent of the element’s contents must be obtained from the element’s datetime value by using the following algorithm:
- If parsing a month string from the element’s datetime value returns a month, that is the machine-readable equivalent; abort these steps.
- If parsing a date string from the element’s datetime value returns a date, that is the machine-readable equivalent; abort these steps.
- If parsing a yearless date string from the element’s datetime value returns a yearless date, that is the machine-readable equivalent; abort these steps.
- If parsing a time string from the element’s datetime value returns a time, that is the machine-readable equivalent; abort these steps.
- If parsing a floating date and time string from the element’s datetime value returns a floating date and time, that is the machine-readable equivalent; abort these steps.
- If parsing a time-zone offset string from the element’s datetime value returns a time-zone offset, that is the machine-readable equivalent; abort these steps.
- If parsing a floating date and time string from the element’s datetime value returns a global date and time, that is the machine-readable equivalent; abort these steps.
- If parsing a week string from the element’s datetime value returns a week, that is the machine-readable equivalent; abort these steps.
- If the element’s datetime value consists of only ASCII digits, at least one of which is not U+0030 DIGIT ZERO (0), then the machine-readable equivalent is the base-ten interpretation of those digits, representing a year; abort these steps.
- If parsing a duration string from the element’s datetime value returns a duration, that is the machine-readable equivalent; abort these steps.
- There is no machine-readable equivalent.
The algorithms referenced above are intended to be designed such that for any arbitrary string s, only one of the algorithms returns a value. A more efficient approach might be to create a single algorithm that parses all these data types in one pass; developing such an algorithm is left as an exercise to the reader.
The dateTime
IDL attribute must reflect the element’s datetime
content
attribute.
time
element can be used to encode dates, for example in microformats. The
following shows a hypothetical way of encoding an event using a variant on hCalendar that uses
the time
element:
<div class="vevent"> <a class="url" href="https://conference.example.com/">https://conference.example.com/</a> <span class="summary">Web 3.0 Conference</span>: <time class="dtstart" datetime="2025-10-05">October 5</time> - <time class="dtend" datetime="2025-10-07">7</time>, at the <span class="location">Argent Hotel, San Francisco, CA</span> </div>
time
element to mark up a blog post’s publication date [html-rdfa].
<article vocab="https://n.example.org/" typeof="rfc4287"> <h1 property="title">Big tasks</h1> <footer>Published <time property="published" datetime="2009-08-29">two days ago</time>.</footer> <p property="content">Today, I went out and bought a bike for my kid.</p> </article>
time
, this
time using the schema.org vocabulary:
<article typeof="schema:BlogPosting"> <h1 property="schema:headline">Small tasks</h1> <footer>Published <time property="schema:datePublished" datetime="2009-08-30">yesterday</time>.</footer> <p property="schema:articleBody">I put a bike bell on his bike.</p> </article>
time
element is used to encode a date in the
ISO8601 format, for later processing by a script:
<p>Our first date was <time datetime="2006-09-23">a Saturday</time>.</p>
In this second snippet, the value includes a time:
<p>We stopped talking at <time datetime="2006-09-24T05:00-07:00">5am the next morning</time>.</p>
A script loaded by the page (and thus privy to the page’s internal convention of marking up
dates and times using the time
element) could scan through the page and look at all
the time
elements therein to create an index of dates and times.
Today is <time datetime="2011-11-18">Friday</time>.
Your next meeting is at <time datetime="2011-11-18T15:00-08:00">3pm</time>.
4.5.17. The code
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The code
element represents a fragment of computer code. This could
be an XML element name, a file name, a computer program, or any other string that a computer would
recognize.
There is no formal way to indicate the language of computer code being marked up. Authors who
wish to mark code
elements with the language used, e.g., so that syntax highlighting
scripts can use the right rules, can use the class
attribute, e.g.,
by adding a class prefixed with "language-
" to the element.
<p>The <code>code</code> element represents a fragment of computer code.</p> <p>When you call the <code>activate()</code> method on the <code>robotSnowman</code> object, the eyes glow.</p> <p>The example below uses the <code>begin</code> keyword to indicate the start of a statement block. It is paired with an <code>end</code> keyword, which is followed by the <code>.</code> punctuation character (full stop) to indicate the end of the program.</p>
pre
and code
elements.
<pre><code class="language-pascal">var i: Integer; begin i := 1; end.</code></pre>
A class is used in that example to indicate the language used.
See the pre
element for more details.
4.5.18. The var
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The var
element represents a variable. This could be an actual
variable in a mathematical expression or programming context, an identifier representing a
constant, a symbol identifying a physical quantity, a function parameter, or just be a term used
as a placeholder in prose.
<p>If there are <var>n</var> pipes leading to the ice cream factory then I expect at <em>least</em> <var>n</var> flavors of ice cream to be available for purchase!</p>
For mathematics, in particular for anything beyond the simplest of expressions, MathML is more
appropriate. However, the var
element can still be used to refer to specific
variables that are then mentioned in MathML expressions.
var
.
<figure> <math> <mi>a</mi> <mo>=</mo> <msqrt> <msup><mi>b</mi><mn>2</mn></msup> <mi>+</mi> <msup><mi>c</mi><mn>2</mn></msup> </msqrt> </math> <figcaption> Using Pythagoras' theorem to solve for the hypotenuse <var>a</var> of a triangle with sides <var>b</var> and <var>c</var> </figcaption> </figure>
var
element is used to mark the variables and constants in that equation:
<p>Then he turned to the blackboard and picked up the chalk. After a few moment’s thought, he wrote <var>E</var> = <var>m</var> <var>c</var><sup>2</sup>. The teacher looked pleased.</p>
4.5.19. The samp
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The samp
element represents sample or quoted output from another
program or computing system.
See the pre
and kbd
elements for more details.
This element can be contrasted with the output
element, which can be
used to provide immediate output in a Web application.
samp
element being used
inline:
<p>The computer said <samp>Too much cheese in tray two</samp> but I didn’t know what that meant.</p>
samp
and kbd
elements allow for the styling of specific elements of the sample output using a
style sheet. There’s also a few parts of the samp
that are annotated with even more
detailed markup, to enable very precise styling. To achieve this, span
elements are
used.
<pre><samp><span class="prompt">jdoe@mowmow:~$</span> <kbd>ssh demo.example.com</kbd> Last login: Tue Apr 12 09:10:17 2005 from mowmow.example.com on pts/1 Linux demo 2.6.10-grsec+gg3+e+fhs6b+nfs+gr0501+++p3+c4a+gr2b-reslog-v6.189 #1 SMP Tue Feb 1 11:22:36 PST 2005 i686 unknown <span class="prompt">jdoe@demo:~$</span> <span class="cursor">_</span></samp></pre>
4.5.20. The kbd
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The kbd
element represents user input (typically keyboard input,
although it may also be used to represent other input, such as voice commands).
When the kbd
element is nested inside a samp
element, it represents
the input as it was echoed by the system.
When the kbd
element contains a samp
element, it represents
input based on system output.
When the kbd
element is nested inside another kbd
element, it
represents an actual key or other single unit of input as appropriate for the input mechanism.
kbd
element is used to indicate keys to press:
<p>To make George eat an apple, press <kbd><kbd>Shift</kbd>+<kbd>F3</kbd></kbd></p>
In this second example, the user is told to pick a particular menu item. The outer kbd
element marks up a block of input, with the inner kbd
elements
representing each individual step of the input, and the samp
elements inside them
indicating that the steps are input based on something being displayed by the system, in this
case menu labels:
<p>To make George eat an apple, select <kbd><kbd><samp>File</samp></kbd>|<kbd><samp>Eat Apple...</samp></kbd></kbd> </p>
Such precision isn’t necessary; the following is equally fine:
<p>To make George eat an apple, select <kbd>File | Eat Apple...</kbd></p>
4.5.21. The sub
and sup
elements
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Use
HTMLElement
.
The sub
element represents a subscript, and the sup
element represents a superscript.
These elements must be used only to mark up typographical conventions with specific meanings,
not for typographical presentation for presentation’s sake. For example, it would be inappropriate
for the sub
and sup
elements to be used in the name of the LaTeX
document preparation system. In general, authors should use these elements only if the absence of those elements would change the meaning of the content.
In certain languages, superscripts are part of the typographical conventions for some abbreviations.
<p>The most intelligent women are <span lang="fr"><abbr>M<sup>lle</sup></abbr> de Beauvoir</span> and <span lang="fr"><abbr>M<sup>me</sup></abbr> Colette</span>.</p>
The sub
element can be used inside a var
element, for variables that
have subscripts.
sub
element is used to represent the subscript that identifies the
variable in a family of variables:
<p>The coordinate of the <var>i</var>th point is (<var>x<sub><var>i</var></sub></var>, <var>y<sub><var>i</var></sub></var>). For example, the 10th point has coordinate (<var>x<sub>10</sub></var>, <var>y<sub>10</sub></var>).</p>
Mathematical expressions often use subscripts and superscripts. Authors are encouraged to use
MathML for marking up mathematics, but authors may opt to use sub
and sup
if detailed mathematical markup is not desired. [MATHML]
<var>E</var>=<var>m</var><var>c</var><sup>2</sup> f(<var>x</var>, <var>n</var>) = log<sub>4</sub><var>x</var><sup><var>n</var></sup>
4.5.22. The i
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The i
element represents a span of text in an alternate voice or
mood, or otherwise offset from the normal prose in a manner indicating a different quality of
text, such as a taxonomic designation, a technical term, an idiomatic phrase from another
language, transliteration, a thought, or a ship name in Western texts.
Terms in languages different from the main text should be annotated with lang
attributes (or, in XML, lang
attributes in the XML namespace).
i
element:
<p>The <i class="taxonomy">Felis silvestris catus</i> is cute.</p> <p>The term <i>prose content</i> is defined above.</p> <p>There is a certain <i lang="fr">je ne sais quoi</i> in the air.</p>
In the following example, a dream sequence is marked up using i
elements.
<p>Raymond tried to sleep.</p> <p><i>The ship sailed away on Thursday</i>, he dreamt. <i>The ship had many people aboard, including a beautiful princess called Carey. He watched her, day-in, day-out, hoping she would notice him, but she never did.</i></p> <p><i>Finally one night he picked up the courage to speak with her—</i></p> <p>Raymond woke with a start as the fire alarm rang out.</p>
Authors are encouraged to consider whether other elements might be more applicable than the i
element, for instance the em
element for marking up stress emphasis,
or the dfn
element to mark up the defining instance of a term.
Style sheets can be used to format i
elements, just like any other
element can be restyled. Thus, it is not the case that content in i
elements will
necessarily be italicized.
4.5.23. The b
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The b
element represents a span of text to which attention is being
drawn for utilitarian purposes without conveying any extra importance and with no implication of
an alternate voice or mood, such as key words in a document abstract, product names in a review,
actionable words in interactive text-driven software, or an article lede.
b
element to highlight key words without
marking them up as important:
<p>The <b>frobonitor</b> and <b>barbinator</b> components are fried.</p>
b
element.
<p>You enter a small room. Your <b>sword</b> glows brighter. A <b>rat</b> scurries past the corner wall.</p>
b
element is appropriate is in marking up the lede (or
lead) sentence or paragraph. The following example shows how a BBC article about
kittens adopting a rabbit as their own could be marked up:
<article> <h2>Kittens 'adopted' by pet rabbit</h2> <p><b class="lede">Six abandoned kittens have found an unexpected new mother figure — a pet rabbit.</b></p> <p>Veterinary nurse Melanie Humble took the three-week-old kittens to her Aberdeen home.</p> ... </article>
As with the i
element, authors can use the class
attribute on the b
element to identify why the element is being used, so that if the
style of a particular use is to be changed at a later date, the author doesn’t have to go through
annotating each use.
The b
element should be used as a last resort when no other element is more
appropriate. In particular, headings should use the h1
to h6
elements,
stress emphasis should use the em
element, importance should be denoted with the strong
element, and text marked or highlighted should use the mark
element.
<p><b>WARNING!</b> Do not frob the barbinator!</p>
In the previous example, the correct element to use would have been strong
, not b
.
Style sheets can be used to format b
elements, just like any other
element can be restyled. Thus, it is not the case that content in b
elements will
necessarily be boldened.
4.5.24. The u
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The u
element represents a span of text with a non-textual annotation,
such as labeling a proper name in Chinese text, a surname, or text as being misspelt.
<p>Among others, Japanese, Hungarian and Chinese names are generally written with the family name first: <u>Wu</u> Xiaoqian.</p>
and when the sun rises over the trees of fire, there are no other <u class="spelling">incediaris</u> as powerful in this collection of dwelling
<p>The <u>see</u> is full of fish</p>
In most cases, another element is likely to be more appropriate: for marking stress emphasis,
the em
element should be used; for marking key words or phrases either the b
element or
the mark
element should be used, depending on the context; for marking book titles, the cite
element should be used; for labeling text with explicit textual annotations, the ruby
element should be used; for technical terms, taxonomic designation, transliteration,
a thought, or for labeling ship names in Western texts, the i
element should be used.
The default rendering of the u
element in visual presentations clashes with the
conventional rendering of hyperlinks (underlining). Authors are encouraged to avoid using
the u
element where it could be confused for a hyperlink.
4.5.25. The mark
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The mark
element represents a run of text in one document marked or highlighted for
reference purposes, due to its relevance in another context. When used in a quotation or other
block of text referred to from the prose, it indicates a highlight that was not originally
present but which has been added to bring the reader’s attention to a part of the text that
might not have been considered important by the original author when the block was originally
written, but which is now under previously unexpected scrutiny. When used in the main prose of a
document, it indicates a part of the document that has been highlighted due to its likely
relevance to the user’s current activity.
mark
element can be used to bring attention to a
particular part of a quotation:
<p lang="en-US">Consider the following quote:</p> <blockquote lang="en-GB"> <p>Look around and you will find, no-one’s really <mark>colour</mark> blind.</p> </blockquote> <p lang="en-US">As we can tell from the <em>spelling</em> of the word, the person writing this quote is clearly not American.</p>
(If the goal was to mark the element as misspelt, however, the u
element,
possibly with a class, would be more appropriate.)
mark
element is highlighting parts of a document that are matching
some search string. If someone looked at a document, and the server knew that the user was
searching for the word "kitten", then the server might return the document with one paragraph
modified as follows:
<p>I also have some <mark>kitten</mark>s who are visiting me these days. They’re really cute. I think they like my garden! Maybe I should adopt a <mark>kitten</mark>.</p>
<p>The highlighted part below is where the error lies:</p> <pre><code>var i: Integer; begin i := <mark>1.1</mark>; end.</code></pre>
This is separate from syntax highlighting, for which span
is more
appropriate. Combining both, one would get:
<p>The highlighted part below is where the error lies:</p> <pre><code><span class="keyword">var</span> <span class="ident">i</span>: <span class="type">Integer</span>; <span class="keyword">begin</span> <span class="ident">i</span> := <span class="literal"><mark>1.1</mark></span>; <span class="keyword">end</span>.</code></pre>
mark
to highlight a part of quoted
text that was originally not emphasized. In this example, common typographic conventions have led
the author to explicitly style mark
elements in quotes to render in italics.
<head> <style> blockquote mark, q mark { font: inherit; font-style: italic; text-decoration: none; background: transparent; color: inherit; } .bubble em { font: inherit; font-size: larger; text-decoration: underline; } </style> </head> <body> <article> <h1>She knew</h1> <p>Did you notice the subtle joke in the joke on panel 4?</p> <blockquote> <p class="bubble">I didn’t <em>want</em> to believe. <mark>Of course on some level I realized it was a known-plaintext attack.</mark> But I couldn’t admit it until I saw for myself.</p> </blockquote> <p>(Emphasis mine.) I thought that was great. It’s so pedantic, yet it explains everything neatly.</p> </article> </body>
Note, incidentally, the distinction between the em
element in this example, which
is part of the original text being quoted, and the mark
element, which is
highlighting a part for comment.
strong
) as opposed to denoting the relevance of a span of text
(mark
). It is an extract from a textbook, where the extract has had the parts
relevant to the exam highlighted. The safety warnings, important though they may be, are
apparently not relevant to the exam.
<h3>Wormhole Physics Introduction</h3> <p><mark>A wormhole in normal conditions can be held open for a maximum of just under 39 minutes.</mark> Conditions that can increase the time include a powerful energy source coupled to one or both of the gates connecting the wormhole, and a large gravity well (such as a black hole).</p> <p><mark>Momentum is preserved across the wormhole. Electromagnetic radiation can travel in both directions through a wormhole, but matter cannot.</mark></p> <p>When a wormhole is created, a vortex normally forms. <strong>Warning: The vortex caused by the wormhole opening will annihilate anything in its path.</strong> Vortexes can be avoided when using sufficiently advanced dialing technology.</p> <p><mark>An obstruction in a gate will prevent it from accepting a wormhole connection.</mark></p>
4.5.26. The bdi
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Also, the
dir
global attribute has special semantics on this element. - Also, the
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The bdi
element represents a span of text that is to be isolated from
its surroundings for the purposes of bidirectional text formatting. [BIDI]
The dir
global attribute defaults to auto
on this element
(it never inherits from the parent element like with other elements).
This element has rendering requirements involving the bidirectional algorithm.
In this example, usernames are shown along with the number of posts that the user has
submitted. If the bdi
element were not used, the username of the Arabic user would end
up confusing the text (the bidirectional algorithm would put the colon and the number "3"
next to the word "User" rather than next to the word "posts").
<ul> <li>User <bdi>jcranmer</bdi>: 12 posts.</li> <li>User <bdi>hober</bdi>: 5 posts.</li> <li>User <bdi><bdo dir="rtl">إيان</bdo></bdi>: 3 posts.</li> </ul>

bdi
element, the username acts as expected.bdi
element is a shorthand for dir
with a value of auto
, so the dir
attribute can be applied to another element to achieve the same result.
For example, the b
element may be used to draw attention to part of the content:

bdi
element were to be replaced by a b
element, the username would confuse the bidirectional algorithm and the third bullet would end up saying "User 3 :", followed by the Arabic name (right-to-left), followed by "posts" and a period.In this case the bdi
and b
elements could both be used, but where there is an
existing element available, the shortest way to achieve the same result is to apply the dir
attribute directly to the b
element:
<ul> <li>User <b dir="auto">jcranmer</b>: 12 posts.</li> <li>User <b dir="auto">hober</b>: 5 posts.</li> <li>User <b dir="auto">إيان</b>: 3 posts.</li> </ul>
When there is no existing element available, the bdi
element can be used to achieve the same effect.
<ul> <li>User <bdi>jcranmer</bdi>: 12 posts.</li> <li>User <bdi>hober</bdi>: 5 posts.</li> <li>User <bdi>إيان</bdi>: 3 posts.</li> </ul>
4.5.27. The bdo
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Also, the
dir
global attribute has special semantics on this element. - Also, the
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The bdo
element represents explicit text directionality formatting
control for its children. It allows authors to override the Unicode bidirectional algorithm while
explicitly specifying a direction override. [BIDI]
Authors must specify the dir
attribute on this element, with the value ltr
to specify a left-to-right override and with
the value rtl
to specify a right-to-left
override. The auto
value must not be specified.
This element has rendering requirements involving the bidirectional algorithm.
The effect of using the bdo
element is to completely disable the bidirectional
algorithm. This means that characters within the bdo
element will be displayed exactly
as stored in memory and in the direction specified.
This is different than the bdi
element, where the characters will be re-ordered and
re-arranged according to the directional algorithm. Use the bdo
element only if you
specifically want to disable the bidirectional algorithm completely for that text.
bdi
and bdo
element.
<bdi dir="rtl">שלום Majima! מה שלומך היום?</bdi> <bdo dir="rtl">שלום Majima! מה שלומך היום?</bdo> <bdo dir="ltr">שלום Majima! מה שלומך היום?</bdo>
שלום Majima! מה שלומך היום?
שלום Majima! מה שלומך היום?
שלום Majima! מה שלומך היום?
In this example, you can see the latin characters in the bdi
element being rendered from left-to-right, whereas the rest of the text being rendered right-to-left. This is because the bidirectional algorithm recognizes latin characters and automatically applies a left-to-right rendering for just those characters.
In the bdo
text, the bidirectional algorithm is disabled. So the text will be rendered character by character in the direction specified, in a sequential order corresponding to that of the characters in memory.
4.5.28. The span
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLSpanElement
: HTMLElement {};
The span
element doesn’t mean anything on its own, but can be useful when used
together with the Global attributes, e.g., class
, lang
, or dir
. It represents its children.
span
elements and class
attributes so that its keywords and
identifiers can be color-coded from CSS:
<pre> <code class="lang-c"> <span class="keyword">for</span> (<span class="ident">j</span> = 0; <span class="ident">j</span> < 256; <span class="ident">j</span>++) { <span class="ident">i_t3</span> = (<span class="ident">i_t3</span> & 0x1ffff) | (<span class="ident">j</span> << 17); <span class="ident">i_t6</span> = (((((((<span class="ident">i_t3</span> >> 3) ^ <span class="ident">i_t3</span>) >> 1) ^ <span class="ident">i_t3</span>) >> 8) ^ <span class="ident">i_t3</span>) >> 5) & 0xff; <span class="keyword">if</span> (<span class="ident">i_t6</span> == <span class="ident">i_t1</span>) <span class="keyword">break</span>; } </code>
4.5.29. The br
element
- Categories:
- Flow content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLBRElement
: HTMLElement {};
The br
element represents a line break.
While line breaks are usually represented in visual media by physically moving subsequent text to a new line, a style sheet or user agent would be equally justified in causing line breaks to be rendered in a different manner, for instance as green dots, or as extra spacing.
br
elements must be used only for line breaks that are actually part of the
content, as in poems or addresses.
br
element:
<p>P. Sherman<br> 42 Wallaby Way<br> Sydney</p>
br
elements must not be used for separating thematic groups in a paragraph.
br
element:
<p><a ...>34 comments.</a><br> <a ...>Add a comment.</a></p>
<p><label>Name: <input name="name"></label><br> <label>Address: <input name="address"></label></p>
Here are alternatives to the above, which are correct:
<p><a ...>34 comments.</a></p> <p><a ...>Add a comment.</a></p>
<p><label>Name: <input name="name"></label></p> <p><label>Address: <input name="address"></label></p>
If a paragraph consists of nothing but a single br
element, it
represents a placeholder blank line (e.g., as in a template). Such blank lines must not be used for
presentation purposes.
Any content inside br
elements must not be considered part of the surrounding
text.
This element has rendering requirements involving the bidirectional algorithm.
4.5.30. The wbr
element
- Categories:
- Flow content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
- Uses
HTMLElement
.
The wbr
element represents a line break opportunity.
wbr
element.
<p>So then he pointed at the tiger and screamed "there<wbr>is<wbr>no<wbr>way<wbr>you<wbr>are<wbr>ever<wbr>going<wbr>to<wbr>catch<wbr>me"!</p>
wbr
elements.
<pre> Heading heading = Helm.HeadingFactory(HeadingCoordinates[1], <wbr>HeadingCoordinates[2], <wbr>HeadingCoordinates[3], <wbr>HeadingCoordinates[4]); Course course = Helm.CourseFactory(Heading, <wbr>Maps.MapFactoryFromHeading(heading), <wbr>Speeds.GetMaximumSpeed().ConvertToWarp()); </pre>
Any content inside wbr
elements must not be considered part of the surrounding
text.
var wbr = document.createElement("wbr"); wbr.textContent = "This is wrong"; document.body.appendChild(wbr);
This element has rendering requirements involving the bidirectional algorithm.
4.5.31. Usage summary
This section is non-normative.
Element | Purpose | Example |
---|---|---|
a
| Hyperlinks |
Visit my <a href="drinks.html">drinks</a> page. |
em
| Stress emphasis |
I must say I <em>adore</em> lemonade. |
strong
| Importance |
This tea is <strong>very hot</strong>. |
small
| Side comments |
These grapes are made into wine. <small>Alcohol is addictive.</small> |
s
| Inaccurate text |
Price: <s>£4.50</s> £2.00! |
cite
| Titles of works |
The case <cite>Hugo v. Danielle</cite> is relevant here. |
q
| Quotations |
The judge said <q>You can drink water from the fish tank</q> but advised against it. |
dfn
| Defining instance |
The term <dfn>organic food</dfn> refers to food produced without synthetic chemicals. |
abbr
| Abbreviations |
Organic food in Ireland is certified by the <abbr title="Irish Organic Farmers and Growers Association">IOFGA</abbr>. |
ruby , rb , rp , rt , rtc
| Ruby annotations |
<ruby> <rb>OJ <rp>(<rtc><rt>Orange Juice</rtc><rp>)</ruby> |
data
| Machine-readable equivalent |
Available starting today! <data value="UPC:022014640201">North Coast Organic Apple Cider</data> |
time
| Machine-readable equivalent of date- or time-related data |
Available starting on <time datetime="2011-11-18">November 18th</time>! |
code
| Computer code |
The <code>fruitdb</code> program can be used for tracking fruit production. |
var
| Variables |
If there are <var>n</var> fruit in the bowl, at least <var>n</var>÷2 will be ripe. |
samp
| Computer output |
The computer said <samp>Unknown error -3</samp>. |
kbd
| User input |
Hit <kbd>F1</kbd> to continue. |
sub
| Subscripts |
Water is H<sub>2</sub>O. |
sup
| Superscripts |
The Hydrogen in heavy water is usually <sup>2</sup>H. |
i
| Alternative voice |
Lemonade consists primarily of <i>Citrus limon</i>. |
b
| Keywords |
Take a <b>lemon</b> and squeeze it with a <b>juicer</b>. |
u
| Annotations |
The mixture of apple juice and <u class="spelling">eldeflower</u> juice is very pleasant. |
mark
| Highlight |
Elderflower cordial, with one <mark>part</mark> cordial to ten <mark>part</mark>s water, stands a<mark>part</mark> from the rest. |
bdi
| Text directionality isolation |
The recommended restaurant is <bdi lang="">My Juice Café (At The Beach)</bdi>. |
bdo
| Text directionality formatting |
The proposal is to write English, but in reverse order. "Juice" would become "<bdo dir="rtl">Juice</bdo>" |
span
| Other |
In French we call it <span lang="fr">sirop de sureau</span>. |
br
| Line break |
Simply Orange Juice Company<br>Apopka, FL 32703<br>U.S.A. |
wbr
| Line breaking opportunity |
www.simply<wbr>orange<wbr>juice.com |
4.6. Edits
The ins
and del
elements represent edits to the document.
4.6.1. The ins
element
- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Transparent.
- Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes.
cite
- Link to the source of the edit to provide additional information.datetime
- Date and (optionally) time of the change. - Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes.
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
- Uses the
HTMLModElement
interface.
The ins
element represents an addition to the document.
<aside> <ins> <p> I like fruit. </p> </ins> </aside>
As does the following, because everything in the aside
element here counts as phrasing content and therefore there is just one paragraph:
<aside> <ins> Apples are <em>tasty</em>. </ins> <ins> So are pears. </ins> </aside>
ins
elements should not cross implied paragraph boundaries.
ins
element in this example thus crosses a
paragraph boundary, which is considered poor form.
<aside> <!-- don’t do this --> <ins datetime="2005-03-16 00:00Z"> <p> I like fruit. </p> Apples are <em>tasty</em>. </ins> <ins datetime="2007-12-19 00:00Z"> So are pears. </ins> </aside>
Here is a better way of marking this up. It uses more elements, but none of the elements cross implied paragraph boundaries.
<aside> <ins datetime="2005-03-16 00:00Z"> <p> I like fruit. </p> </ins> <ins datetime="2005-03-16 00:00Z"> Apples are <em>tasty</em>. </ins> <ins datetime="2007-12-19 00:00Z"> So are pears. </ins> </aside>
4.6.2. The del
element
- Categories:
- Flow content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Transparent.
- Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes.
cite
- Link to the source of the edit to provide additional information.datetime
- Date and (optionally) time of the edit. - Allowed ARIA role attribute values:
- Any role value.
- Allowed ARIA state and property attributes:
- Global aria-* attributes.
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
- Uses the
HTMLModElement
interface.
The del
element represents a removal from the document.
del
elements should not cross implied paragraph boundaries.
<h1>To Do</h1> <ul> <li>Empty the dishwasher</li> <li><del datetime="2009-10-11T01:25-07:00">Watch Walter Lewin’s lectures</del></li> <li><del datetime="2009-10-10T23:38-07:00">Download more tracks</del></li> <li>Buy a printer</li> </ul>
4.6.3. Attributes common to ins
and del
elements
The cite
attribute may be used to specify the
address of a document that explains the change. When that document is long, for instance the
minutes of a meeting, authors are encouraged to include a fragment pointing to the
specific part of that document that discusses the change.
If the cite
attribute is present, it must be a valid URL potentially surrounded by spaces that explains the change. To obtain the
corresponding citation link, the value of the attribute must be parsed relative to the
element’s node document. User agents may allow users to follow such citation links, but
they are primarily intended for private use (e.g., by server-side scripts collecting statistics
about a site’s use of quotations), not for readers.
The datetime
attribute may be used to specify
the time and date of the change.
If present, the datetime
attribute’s value must be a valid date string with optional time.
User agents must parse the datetime
attribute according
to the parse a date or time string algorithm. If that doesn’t return a date or a global date and time,
then the modification has no associated timestamp (the value is non-conforming; it is not a valid date string with optional time). Otherwise, the modification is marked as
having been made at the given date or global date and time. If the given value is a global date and time then user agents should use the associated
time-zone offset information to determine which time zone to present the given datetime in.
This value may be shown to the user, but it is primarily intended for private use.
The ins
and del
elements must implement the HTMLModElement
interface:
interface HTMLModElement
: HTMLElement {
attribute DOMString cite;
attribute DOMString dateTime;
};
The cite
IDL attribute must reflect the element’s cite
content attribute. The dateTime
IDL attribute must reflect the
element’s datetime
content attribute.
4.6.4. Edits and paragraphs
This section is non-normative.
Since the ins
and del
elements do not affect paragraphing, it is possible, in some cases where paragraphs are implied (without explicit p
elements), for an ins
or del
element to span both an entire paragraph or other
non-phrasing content elements and part of another paragraph. For example:
<section> <ins> <p> This is a paragraph that was inserted. </p> This is another paragraph whose first sentence was inserted at the same time as the paragraph above. </ins> This is a second sentence, which was there all along. </section>
By only wrapping some paragraphs in p
elements, one can even get the end of one
paragraph, a whole second paragraph, and the start of a third paragraph to be covered by the same ins
or del
element (though this is very confusing, and not considered
good practice):
<section> This is the first paragraph. <ins> This sentence was inserted. <p>This second paragraph was inserted.</p> This sentence was inserted too. </ins> This is the third paragraph in this example. <!-- (don’t do this) --> </section>
However, due to the way implied paragraphs are defined, it is
not possible to mark up the end of one paragraph and the start of the very next one using the same ins
or del
element. You instead have to use one (or two) p
element(s) and two ins
or del
elements, as for example:
<section> <p>This is the first paragraph. <del>This sentence was deleted.</del></p> <p><del>This sentence was deleted too.</del> That sentence needed a separate <del> element.</p> </section>
Partly because of the confusion described above, authors are strongly encouraged to always mark
up all paragraphs with the p
element, instead of having ins
or del
elements that cross implied paragraphs boundaries.
4.6.5. Edits and lists
This section is non-normative.
The content models of the ol
and ul
elements do not allow ins
and del
elements as children. Lists always represent all their
items, including items that would otherwise have been marked as deleted.
To indicate that an item is inserted or deleted, an ins
or del
element can be wrapped around the contents of the li
element. To indicate that an
item has been replaced by another, a single li
element can have one or more del
elements followed by one or more ins
elements.
<h1>Stop-ship bugs</h1> <ol> <li><ins datetime="2008-02-12T15:20Z">Bug 225: Rain detector doesn’t work in snow</ins></li> <li><del datetime="2008-03-01T20:22Z"><ins datetime="2008-02-14T12:02Z">Bug 228: Water buffer overflows in April</ins></del></li> <li><ins datetime="2008-02-16T13:50Z">Bug 230: Water heater doesn’t use renewable fuels</ins></li> <li><del datetime="2008-02-20T21:15Z"><ins datetime="2008-02-16T14:25Z">Bug 232: Carbon dioxide emissions detected after startup</ins></del></li> </ol>
<h1>List of <del>fruits</del><ins>colors</ins></h1> <ul> <li><del>Lime</del><ins>Green</ins></li> <li><del>Apple</del></li> <li>Orange</li> <li><del>Pear</del></li> <li><ins>Teal</ins></li> <li><del>Lemon</del><ins>Yellow</ins></li> <li>Olive</li> <li><ins>Purple</ins></li> </ul>
4.6.6. Edits and tables
This section is non-normative.
The elements that form part of the table model have complicated content model requirements that
do not allow for the ins
and del
elements, so indicating edits to a
table can be difficult.
To indicate that an entire row or an entire column has been added or removed, the entire
contents of each cell in that row or column can be wrapped in ins
or del
elements (respectively).
<table> <thead> <tr><th>Game name</th> <th>Game publisher</th> <th>Verdict</th></tr> </thead> <tbody> <tr><td>Diablo 2</td> <td>Blizzard</td> <td>8/10</td></tr> <tr><td>Portal</td> <td>Valve</td> <td>9/10</td></tr> <tr><td><ins>Portal 2</ins></td> <td><ins>Valve</ins></td> <td><ins>10/10</ins></tr> </tbody> </table>
Here, a column has been removed (the time at which it was removed is given also, as is a link to the page explaining why):
<table> <thead> <tr><th>Game name</th> <th>Game publisher</th> <th><del cite="/edits/r192" datetime="2011-05-02 14:23Z">Verdict</del></th></tr> </thead> <tbody> <tr><td>Diablo 2</td> <td>Blizzard</td> <td><del cite="/edits/r192" datetime="2011-05-02 14:23Z">8/10</del></td></tr> <tr><td>Portal</td> <td>Valve</td> <td><del cite="/edits/r192" datetime="2011-05-02 14:23Z">9/10</del></td></tr> <tr><td>Portal 2</td> <td>Valve</td> <td><del cite="/edits/r192" datetime="2011-05-02 14:23Z">10/10</del></td></tr> </tbody> </table>
Generally speaking, there is no good way to indicate more complicated edits (e.g., that a cell was removed, moving all subsequent cells up or to the left).
4.7. Embedded content
4.7.1. Introduction
This section is non-normative.
To embed an image in HTML, when there is only a single image resource,
use the img
element and with its src
and alt
attributes.
<h2>From today’s featured article</h2> <img src="/uploads/100-marie-lloyd.jpg" alt="A singer on the stage" width="100" height="150"> <p><a href="/wiki/Marie_Lloyd">Marie Lloyd</a> (1870–1922) was an English <a href="/wiki/Music_hall">music hall</a> singer, ...
However, there are a number of situations for which the author might wish to use multiple image resources that the user agent can choose from:
-
Different users might have different environmental characteristics:
-
The users' physical screen size might be different from one another.
A mobile phone’s screen might be 4 inches diagonally, while a laptop’s screen might be 14 inches diagonally.This is only relevant when an image’s rendered size depends on the viewport size.
-
The users' screen pixel density might be different from one another.
-
The users' zoom level might be different from one another, or might change for a single user over time.
A user might zoom in to a particular image to be able to get a more detailed look.
The zoom level and the screen pixel density (the previous point) can both affect the number of physical screen pixels per CSS pixel. This ratio is usually referred to as device-pixel-ratio.
-
The users' screen orientation might be different from one another, or might change for a single user over time.
-
The users' network speed, network latency and bandwidth cost might be different from one another, or might change for a single user over time.
A user might be on a fast, low-latency and constant-cost connection while at work, on a slow, low-latency and constant-cost connection while at home, and on a variable-speed, high-latency and variable-cost connection anywhere else.
-
-
Authors might want to show the same image content but with different rendered size depending on, usually, the width of the viewport. This is usually referred to as viewport-based selection.
A Web page might have a banner at the top that always spans the entire viewport width. In this case, the rendered size of the image depends on the physical size of the screen (assuming a maximised browser window).Another Web page might have images in columns, with a single column for screens with a small physical size, two columns for screens with medium physical size, and three columns for screens with big physical size, with the images varying in rendered size in each case to fill up the viewport. In this case, the rendered size of an image might be bigger in the one-column layout compared to the two-column layout, despite the screen being smaller. -
Authors might want to show different image content depending on the rendered size of the image. This is usually referred to as art direction.
When a Web page is viewed on a screen with a large physical size (assuming a maximised browser window), the author might wish to include some less relevant parts surrounding the critical part of the image. When the same Web page is viewed on a screen with a small physical size, the author might wish to show only the critical part of the image. -
Authors might want to show the same image content but using different image formats, depending on which image formats the user agent supports. This is usually referred to as image format-based selection.
A Web page might have some images in the JPEG, WebP and JPEG XR image formats, as the latter two have better compression abilities compared to JPEG. Since different user agents can support different image formats, with some formats offering better compression ratios, the author would like to serve the better formats to user agents that support them, while providing a JPEG fallback for user agents that don’t.
The above situations are not mutually exclusive. For example, it is reasonable to combine different resources for different device-pixel-ratio with different resources for art direction.
While it is possible to solve these problems using scripting, doing so introduces some other problems:
- Some user agents aggressively download images specified in the HTML markup, before scripts have had a chance to run, so that Web pages complete loading sooner. If a script changes which image to download, the user agent will potentially start two separate downloads, which can instead cause worse page loading performance.
- If the author avoids specifying any image in the HTML markup and instead instantiates a single download from script, that avoids the double download problem above but instead it makes no image be downloaded at all for users with scripting disabled and it disables the aggressive image downloading optimization.
With this in mind, this specification introduces a number of features to address the above problems in a declarative manner.
- Device-pixel-ratio-based selection when the rendered size of the image is fixed
-
The
src
andsrcset
attributes on theimg
element can be used, using thex
descriptor, to provide multiple images that only vary in their size (the smaller image is a scaled-down version of the bigger image).The
x
descriptor is not appropriate when the rendered size of the image depends on the viewport width (viewport-based selection), but can be used together with art direction.<h2>From today’s featured article</h2> <img src="/uploads/100-marie-lloyd.jpg" srcset="/uploads/150-marie-lloyd.jpg 1.5x, /uploads/200-marie-lloyd.jpg 2x" alt="A singer on the stage" width="100" height="150"> <p> <a href="/wiki/Marie_Lloyd">Marie Lloyd</a> (1870–1922) was an English <a href="/wiki/Music_hall">music hall</a> singer, ...
The user agent can choose any of the given resources depending on the user’s screen’s pixel density, zoom level, and possibly other factors such as the user’s network conditions.
To provide backwards compatibility with older user agents that don’t understand the
srcset
attribute, one of the URLs is specified in theimg
element’ssrc
attribute. This will result in something useful (though perhaps at a lower-resolution than the user might expect) being displayed even in older user agents. For user agents that understandsrcset
, thesrc
attribute participates in the resource selection, as if it had been specified bysrcset
with a1x
descriptor.The image’s rendered size is given in the
width
andheight
attributes, which allows the user agent to allocate space for the image before it is downloaded. - Viewport-based selection
-
The
srcset
andsizes
attributes can be used, using thew
descriptor, to provide multiple images that only vary in their size (the smaller image is a scaled-down version of the bigger image).In this example, a banner image takes up the entire viewport width (using appropriate CSS).<h1> <img srcset="wolf-400.jpg 400w, wolf-800.jpg 800w, wolf-1600.jpg 1600w" src="wolf-400.jpg" sizes="100vw" alt="The rad wolf"> </h1>
The user agent will calculate the effective pixel density of each image from the specified
w
descriptors and the specified rendered size in thesizes
attribute. It can then choose any of the given resources depending on the user’s screen’s pixel density, zoom level, and possibly other factors such as the user’s network conditions.If the user’s screen is 320 CSS pixels wide, this is equivalent to specifying
wolf-400.jpg 1.25x, wolf-800.jpg 2.5x, wolf-1600.jpg 5x
. On the other hand, if the user’s screen is 1200 CSS pixels wide, this is equivalent to specifyingwolf-400.jpg 0.33x, wolf-800.jpg 0.67x, wolf-1600.jpg 1.33x
. By using thew
descriptors and thesizes
attribute, the user agent can choose the correct image source to download regardless of how large the user’s device is.For backwards compatibility, one of the URLs is specified in the
img
element’ssrc
attribute. In new user agents, thesrc
attribute is ignored when thesrcset
attribute usesw
descriptors.In this example, the
sizes
attribute could be omitted because the default value is100vw
.In this example, the Web page has three layouts depending on the width of the viewport. The narrow layout has one column of images (the width of each image is about 100%), the middle layout has two columns of images (the width of each image is about 50%), and the widest layout has three columns of images, and some page margin (the width of each image is about 33%). It breaks between these layouts when the viewport is30em
wide and50em
wide, respectively.<img sizes="(max-width: 30em) 100vw, (max-width: 50em) 50vw, calc(33vw - 100px)" srcset="swing-200.jpg 200w, swing-400.jpg 400w, swing-800.jpg 800w, swing-1600.jpg 1600w" src="swing-400.jpg" alt="Kettlebell Swing">
The
sizes
attribute sets up the layout breakpoints at30em
and50em
, and declares the image sizes between these breakpoints to be100vw
,50vw
, orcalc(33vw - 100px)
. These sizes do not necessarily have to match up exactly with the actual image width as specified in the CSS.The user agent will pick a width from the
sizes
attribute, using the first item with a <media-condition> (the part in parentheses) that evaluates to true, or using the last item (calc(33vw - 100px)
) if they all evaluate to false.For example, if the viewport width is
29em
, then(max-width: 30em)
evaluates to true and100vw
is used, so the image size, for the purpose of resource selection, is29em
. If the viewport width is instead32em
, then(max-width: 30em)
evaluates to false, but(max-width: 50em)
evaluates to true and50vw
is used, so the image size, for the purpose of resource selection, is16em
(half the viewport width). Notice that the slightly wider viewport results in a smaller image because of the different layout.The user agent can then calculate the effective pixel density and choose an appropriate resource similarly to the previous example.
- Art direction-based selection
-
The
picture
element and thesource
element, together with themedia
attribute, can be used, to provide multiple images that vary the image content (for instance the smaller image might be a cropped version of the bigger image).<picture> <source media="(min-width: 45em)" srcset="large.jpg"> <source media="(min-width: 32em)" srcset="med.jpg"> <img src="small.jpg" alt="The wolf runs through the snow."> </picture>
The user agent will choose the first
source
element for which the media query in themedia
attribute matches, and then choose an appropriate URL from itssrcset
attribute.The rendered size of the image varies depending on which resource is chosen. To specify dimensions that the user agent can use before having downloaded the image, CSS can be used.
img { width: 300px; height: 300px } @media (min-width: 32em) { img { width: 500px; height:300px } } @media (min-width: 45em) { img { width: 700px; height:400px } }
This example combines art direction- and device-pixel-ratio-based selection. A banner that takes half the viewport is provided in two versions, one for wide screens and one for narrow screens.<h1> <picture> <source media="(max-width: 500px)" srcset="banner-phone.jpeg, banner-phone-HD.jpeg 2x"> <img src="banner.jpeg" srcset="banner-HD.jpeg 2x" alt="The Breakfast Combo"> </picture> </h1>
- Image format-based selection
-
The
type
attribute on thesource
element can be used, to provide multiple images in different formats.<h2>From today’s featured article</h2> <picture> <source srcset="/uploads/100-marie-lloyd.webp" type="image/webp"> <source srcset="/uploads/100-marie-lloyd.jxr" type="image/vnd.ms-photo"> <img src="/uploads/100-marie-lloyd.jpg" alt="A singer on the stage" width="100" height="150"> </picture> <p> <a href="/wiki/Marie_Lloyd">Marie Lloyd</a> (1870–1922) was an English <a href="/wiki/Music_hall">music hall</a> singer, ...
In this example, the user agent will choose the first
source
that has atype
attribute with a supported MIME type. If the user agent supports WebP images, the firstsource
element will be chosen. If not, but the user agent does support JPEG XR images, the secondsource
element will be chosen. If neither of those formats are supported, theimg
element will be chosen.
4.7.2. Dependencies
- Media Queries [MEDIAQ]
- CSS Values and Units [CSS-VALUES]
- CSS Syntax [CSS-SYNTAX-3]
-
Parse a comma-separated list of component values
4.7.3. The picture
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- Zero or more
source
elements, followed by oneimg
element, optionally intermixed with script-supporting elements. - Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes.
- Allowed ARIA role attribute values:
- None.
- Allowed ARIA state and property attributes:
- None.
- DOM interface:
-
interface
HTMLPictureElement
: HTMLElement {};
The picture
element is a container which provides multiples sources to its contained img
element to allow authors to declaratively control or give hints to the user agent about
which image resource to use, based on the screen pixel density, viewport size, image
format, and other factors. It represents its children.
The user agent first tries to match an image source contained within the source
attribute and use that,
but if none is found, it falls back to what is contained within the img
element, which must be present.
<h3> <picture> <source media="(max-width: 500px)" srcset="photo-small-screen.jpg"> <img src="photo-large-screen.jpg"" alt> </picture> Dogs & Cats, Living Together </h3>
For other picture
element examples, see the examples in Embedded content introduction, or the An image in a picture
element example.
The picture
element is somewhat different from the similar-looking video
and audio
elements. While all of them contain source
elements,
the source
element’s src
attribute has no meaning when the element is
nested within a picture
element, and the resource selection algorithm is different.
By itself the picture
element itself does not display anything; it merely provides
a context for its contained img
element that enables it to choose from multiple URLs.
4.7.4. The source
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
picture
element, before theimg
element.- As a child of a media element, before any flow content or
track
elements. - As a child of a media element, before any flow content or
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
src
- Address of the resourcetype
- Type of embedded resourcesrcset
- Images to use in different situations (e.g., high-resolution displays, small monitors, etc)sizes
- Image sizes between breakpointsmedia
- Applicable media - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLSourceElement
: HTMLElement { attribute DOMString src; attribute DOMString type; attribute DOMString srcset; attribute DOMString sizes; attribute DOMString media; };
The source
element allows authors to specify multiple alternative source sets for img
elements or multiple alternative media resources for media elements. It does
not represent anything on its own.
The type
attribute may be present. If present,
the value must be a valid MIME type.
The remainder of the requirements depend on whether the parent is a picture
element or a media element:
source
element’s parent is apicture
element-
The
srcset
content attribute must be present, and must consist of one or more image candidate strings, each separated from the next by a U+002C COMMA character (,). If an image candidate string contains no descriptors and no space characters after the URL, the following image candidate string, if there is one, must begin with one or more space characters.If the
srcset
attribute has any image candidate strings using a width descriptor, thesizes
content attribute must also be present, and the value must be a valid source size list.The
media
content attribute may also be present. If present, the value must contain a valid media query list.The
type
gives the type of the images in the source set, to allow the user agent to skip to the nextsource
element if it does not support the given type.If the
type
attribute is not specified, the user agent will not select a differentsource
element if it finds that it does not support the image format after fetching it.When a
source
element has a following siblingsource
element orimg
element with asrcset
attribute specified, it must have at least one of the following:-
A
media
attribute specified with a value that, after stripping leading and trailing white space, is not the empty string and is not an ASCII case-insensitive match for the string "all
". -
A
type
attribute specified.
The
src
attribute must not be present. -
source
element’s parent is a media element-
The
src
attribute gives the address of the media resource. The value must be a valid non-empty URL potentially surrounded by spaces. This attribute must be present.Dynamically modifying a
source
element and its attribute when the element is already inserted in avideo
oraudio
element will have no effect. To change what is playing, just use thesrc
attribute on the media element directly, possibly making use of thecanPlayType()
method to pick from amongst available resources. Generally, manipulatingsource
elements manually after the document has been parsed is an unnecessarily complicated approach.The
type
content attribute gives the type of the media resource, to help the user agent determine if it can play this media resource before fetching it. If specified, its value must be a valid MIME type. Thecodecs
parameter, which certain MIME types define, might be necessary to specify exactly how the resource is encoded. [RFC6381]The following list shows some examples of how to use thecodecs=
MIME parameter in thetype
attribute.- H.264 Constrained baseline profile video (main and extended video compatible) level 3 and Low-Complexity AAC audio in MP4 container
-
<source src='video.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'>
- H.264 Extended profile video (baseline-compatible) level 3 and Low-Complexity AAC audio in MP4 container
-
<source src='video.mp4' type='video/mp4; codecs="avc1.58A01E, mp4a.40.2"'>
- H.264 Main profile video level 3 and Low-Complexity AAC audio in MP4 container
-
<source src='video.mp4' type='video/mp4; codecs="avc1.4D401E, mp4a.40.2"'>
- H.264 "High" profile video (incompatible with main, baseline, or extended profiles) level 3 and Low-Complexity AAC audio in MP4 container
-
<source src='video.mp4' type='video/mp4; codecs="avc1.64001E, mp4a.40.2"'>
- MPEG-4 Visual Simple Profile Level 0 video and Low-Complexity AAC audio in MP4 container
-
<source src='video.mp4' type='video/mp4; codecs="mp4v.20.8, mp4a.40.2"'>
- MPEG-4 Advanced Simple Profile Level 0 video and Low-Complexity AAC audio in MP4 container
-
<source src='video.mp4' type='video/mp4; codecs="mp4v.20.240, mp4a.40.2"'>
- MPEG-4 Visual Simple Profile Level 0 video and AMR audio in 3GPP container
-
<source src='video.3gp' type='video/3gpp; codecs="mp4v.20.8, samr"'>
- Theora video and Vorbis audio in Ogg container
-
<source src='video.ogv' type='video/ogg; codecs="theora, vorbis"'>
- Theora video and Speex audio in Ogg container
-
<source src='video.ogv' type='video/ogg; codecs="theora, speex"'>
- Vorbis audio alone in Ogg container
-
<source src='audio.ogg' type='audio/ogg; codecs=vorbis'>
- Speex audio alone in Ogg container
-
<source src='audio.spx' type='audio/ogg; codecs=speex'>
- FLAC audio alone in Ogg container
-
<source src='audio.oga' type='audio/ogg; codecs=flac'>
- Dirac video and Vorbis audio in Ogg container
-
<source src='video.ogv' type='video/ogg; codecs="dirac, vorbis"'>
The
srcset
,sizes
, andmedia
attributes must not be present.
If a source
element is inserted as a child of a media element that has no src
attribute and whose networkState
has the value NETWORK_EMPTY
, the user agent must invoke the media element’s resource selection algorithm.
The IDL attributes src
, type
, srcset
, sizes
and media
must reflect the
respective content attributes of the same name.
error
event on the last source
element and trigger fallback behavior:
<script> function fallback(video) { // replace <video> with its contents while (video.hasChildNodes()) { if (video.firstChild instanceof HTMLSourceElement) video.removeChild(video.firstChild); else video.parentNode.insertBefore(video.firstChild, video); } video.parentNode.removeChild(video); } </script> <video controls autoplay> <source src='video.mp4' type='video/mp4; codecs="avc1.42E01E, mp4a.40.2"'> <source src='video.ogv' type='video/ogg; codecs="theora, vorbis"' onerror="fallback(parentNode)"> ... </video>
4.7.5. The img
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- Form-associated element.
- If the element has a
usemap
attribute: interactive content.- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- Nothing
- Tag omission in text/html:
- No end tag.
- Content attributes:
- Global attributes
alt
- Replacement text for use when images are not availablesrc
- Address of the resourcesrcset
- Images to use in different situations (e.g., high-resolution displays, small monitors, etc)sizes
- Image sizes between breakpointscrossorigin
- How the element handles crossorigin requestsdecoding
- Hint for requesting synchronous or asynchronous loadingusemap
- Name of image map to useismap
- Whether the image is a server-side image mapwidth
- Horizontal dimensionheight
- Vertical dimensionreferrerpolicy
- Referrer policy for fetches initiated by the elementlongdesc
- A url that provides a link to an expanded description of the image, defined in [html-longdesc] - Allowed ARIA role attribute values:
- If
img
has an emptyalt
attribute value:presentation
ornone
role only.- If
img
has a non-emptyalt
attribute value:img
(default - do not set) or any other role value exceptpresentation
ornone
roles. - If
- Allowed ARIA state and property attributes:
- If
img
has an emptyalt
attribute value: Noaria-*
attributes exceptaria-hidden
.- If
img
has a non-emptyalt
attribute value: Global aria-* attributes and anyaria-*
attributes applicable to the allowed roles. - If
- DOM interface:
-
[NamedConstructor=Image(optional unsigned long
width
, optional unsigned longheight
)] interfaceHTMLImageElement
: HTMLElement { [CEReactions] attribute DOMString alt; [CEReactions] attribute DOMString src; [CEReactions] attribute DOMString srcset; [CEReactions] attribute DOMString sizes; [CEReactions] attribute DOMString? crossOrigin; [CEReactions] attribute DOMStringdecoding
; [CEReactions] attribute DOMString useMap; attribute DOMString longDesc; [CEReactions] attribute boolean isMap; [CEReactions] attribute unsigned long width; [CEReactions] attribute unsigned long height; readonly attribute unsigned long naturalWidth; readonly attribute unsigned long naturalHeight; readonly attribute boolean complete; readonly attribute DOMString currentSrc; [CEReactions] attribute DOMString referrerPolicy; };
An img
element represents an image and its fallback content.
The image given by the src
and srcset
attributes,
and any previous sibling source
elements' srcset
attributes if the parent is a picture
element,
is the embedded content; the value of
the alt
attribute and the content referred to by
the longdesc
attribute are the img
element’s fallback content, and provide equivalent content for
users and user agents who cannot process images or have image loading disabled.
Requirements for alternative representations of the image are described in the next section.
The src
attribute must be present, and must contain a valid non-empty URL potentially surrounded by spaces referencing a non-interactive,
optionally animated, image resource that is neither paged nor scripted.
The srcset
attribute may also be present.
If present, its value must consist of one or more image candidate strings,
each separated from the next by a U+002C COMMA character (,).
If an image candidate string contains no descriptors
and no space characters after the URL,
the following image candidate string, if there is one,
must begin with one or more space characters.
An image candidate string consists of the following components, in order, with the further restrictions described below this list:
- Zero or more space characters.
- A valid non-empty URL that does not start or end with a U+002C COMMA character (,), referencing a non-interactive, optionally animated, image resource that is neither paged nor scripted.
- Zero or more space characters.
-
Zero or one of the following:
- A width descriptor, consisting of: a space character, a valid non-negative integer giving a number greater than zero representing the width descriptor value, and a U+0077 LATIN SMALL LETTER W character.
- A pixel density descriptor, consisting of: a space character, a valid floating-point number giving a number greater than zero representing the pixel density descriptor value, and a U+0078 LATIN SMALL LETTER X character.
- Zero or more space characters.
There must not be an image candidate string for an element that has the same width descriptor value as another image candidate string’s width descriptor value for the same element.
There must not be an image candidate string for an element that has the same pixel density descriptor value as another image candidate string’s pixel density descriptor value for the same element.
For the purpose of this requirement, an image candidate string with no descriptors
is equivalent to an image candidate string with a 1x
descriptor.
If a source
element has a sizes
attribute present
or an img
element has a sizes
attribute present,
all image candidate strings for that
element must have the width descriptor specified.
If an image candidate string for a source
or img
element has the width descriptor specified, all other image candidate strings for that element must also
have the width descriptor specified.
The specified width in an image candidate string’s width descriptor must match the intrinsic width in the resource given by the image candidate string’s URL, if it has an intrinsic width.
The requirements above imply that images can be static bitmaps (e.g., PNGs, GIFs, JPEGs), single-page vector documents (single-page PDFs, XML files with an SVG document element), animated bitmaps (APNGs, animated GIFs), animated vector graphics (XML files with an SVG document element that use declarative SMIL animation), and so forth. However, these definitions preclude SVG files with script, multipage PDF files, interactive MNG files, HTML documents, plain text documents, and so forth. [PNG] [GIF] [JPEG] [PDF] [XML] [APNG] [SVG11] [MNG]
If the srcset
attribute is present,
the sizes
attribute may also be present.
If present, its value must be a valid source size list.
A valid source size list is a string that matches the following grammar: [CSS-VALUES] [MEDIAQ]
<source-size-list> = <source-size># [ , <source-size-value> ]? | <source-size-value> <source-size> = <media-condition> <source-size-value> <source-size-value> = <length>
A <source-size-value>
must not be negative.
Percentages are not allowed in a <source-size-value>
,
to avoid confusion about what it would be relative to.
The vw
unit can be used for sizes relative to the viewport width.
The img
element must not be used as a layout tool. In particular, img
elements should not be used to display transparent images, as such images rarely convey meaning and
rarely add anything useful to the document.
The crossorigin
attribute is a CORS
settings attribute. Its purpose is to allow images from third-party sites that allow
cross-origin access to be used with canvas
.
The decoding
attribute is an enumerated attribute.
It is an image decoding hint to request synchronous or asynchronous image loading.
Valid values are "sync
", "async
", and "auto
".
The missing value default and invalid value default are both "auto
".
The referrerpolicy
attribute is a referrer policy attribute.
Its purpose is to set the referrer policy used when fetching the image. [REFERRERPOLICY]
An img
element has a current request and a pending request.
The current request is initially set to a new image request.
The pending request is initially set to null.
The current request is usually referred to as the img
element itself.
An image request has a state, current URL and image data.
An image request’s state is one of the following:
- Unavailable
- The user agent hasn’t obtained any image data, or has obtained some or all of the image data but hasn’t yet decoded enough of the image to get the image dimensions.
- Partially available
- The user agent has obtained some of the image data and at least the image dimensions are available.
- Completely available
- The user agent has obtained all of the image data and at least the image dimensions are available.
- Broken
- The user agent has obtained all of the image data that it can, but it cannot even decode the image enough to get the image dimensions (e.g., the image is corrupted, or the format is not supported, or no data could be obtained).
An image request’s current URL is initially the empty string.
An image request’s image data is the decoded image data.
When an image request is either in the partially available state or in the completely available state, it is said to be available.
An image request is initially unavailable.
When an img
element is available,
it provides a paint source whose width is the image’s density-corrected intrinsic width (if any),
whose height is the image’s density-corrected intrinsic height (if any),
and whose appearance is the intrinsic appearance of the image.
In a browsing context where scripting is disabled, user agents may obtain images immediately or on demand. In a browsing context where scripting is enabled, user agents must obtain images immediately.
A user agent that obtains images immediately must immediately update the image data of an img
element,
with the restart animation flag set if so stated,
whenever that element is created or has experienced relevant mutations.
A user agent that obtains images on demand must update the image data of an img
element whenever it needs the image data (i.e., on demand),
but only if the img
element is in the unavailable state. When an img
element
has experienced relevant mutations, if the user
agent only obtains images on demand, the img
element must return to the unavailable state.
The relevant mutations for an img
element are as follows:
- The element’s
src
,srcset
,width
, orsizes
attributes are set, changed, or removed. - The element’s
src
attribute is set to the same value as the previous value. This must set the restart animation flag for the update the image data algorithm. - The element’s
crossorigin
attribute’s state is changed. - The element is inserted into or removed from a
picture
parent element. - The element’s parent is a
picture
element and asource
element is inserted as a previous sibling. - The element’s parent is a
picture
element and asource
element that was a previous sibling is removed. - The element’s parent is a
picture
element and asource
element that is a previous sibling has itssrcset
,sizes
,media
ortype
attributes set, changed, or removed. - The element’s adopting steps are run.
Each img
element has a last selected source, which must initially be
null.
Each image request has a current pixel density, which must initially be undefined.
When an img
element has a current pixel density that is not 1.0, the
element’s image data must be treated as if its resolution, in device pixels per CSS pixels, was
the current pixel density.
The image’s density-corrected intrinsic width and height are the intrinsic width and height after taking into account the current pixel density.
For example, given a screen with 96 CSS pixels per CSS inch, if the current pixel density is 3.125, that means that there are 96 × 3.125 = 300 device pixels per CSS inch, and thus if the image data is 300x600, it has intrinsic dimensions of 300 ÷ 3.125 = 96 CSS pixels by 600 ÷ 3.125 = 192 CSS pixels. With a current pixel density of 2.0 (192 device pixels per CSS inch) and the same image data (300x600), the intrinsic dimensions would be 150x300.
Each Document
object must have a list of available images. Each image
in this list is identified by a tuple consisting of an absolute URL, a CORS
settings attribute mode, and, if the mode is not No CORS, an origin.
Each image furthermore has an ignore higher-layer caching flag.
User agents may copy entries from one Document
object’s list of available images to another at any time (e.g., when the Document
is created, user agents can add to it all the images that are loaded in
other Document
s), but must not change the keys of entries copied in this way when
doing so, and must unset the ignore higher-layer caching flag for the copied entry.
User agents may also remove images from such lists at any time (e.g., to save
memory).
User agents must remove entries in the list of available images as appropriate
given higher-layer caching semantics for the resource (e.g., the HTTP Cache-Control
response header) when the ignore higher-layer caching flag is unset.
The list of available images is intended to enable synchronous
switching when changing the src
attribute to a URL that has
previously been loaded, and to avoid re-downloading images in the same document even when they
don’t allow caching per HTTP. It is not used to avoid re-downloading the same image while the
previous image is still loading.
For example, if a resource has the HTTP response header Cache-Control: must-revalidate
,
the user agent would remove it from the list of available images but could keep the image data separately,
and use that if the server responds with a 204 No Content
status.
Image decoding is the process which converts an encoded image’s data into a bitmap form for presentation. Implementations may choose when and what to decode for the best user experience.
Image decoding is said to be synchronous if it prevents presentation of other content until it is finished. Typically, this has an effect of atomically presenting the image and any other content at the same time. However, this presentation is delayed by the amount of time it takes to perform the decode.
Image decoding is said to be asynchronous if it does not prevent presentation of other content. This has an effect of presenting non-image content faster. However, the image content is missing on screen until the decode finishes. Once the decode is finished, the screen is updated with the image.
In both synchronous and asynchronous decoding modes, the final content is presented to screen after the same amount of time has elapsed. The main difference is whether the user agent presents non-image content ahead of presenting the final content.
In order to aid the user agent in deciding whether to perform synchronous or
asynchronous decode, the decoding attribute can
be set on img
elements. The possible values of the decoding attribute are the following image decoding hint keywords:
Keyword | State | Brief description |
---|---|---|
sync
| Sync | Indicates a preference to decode this image synchronously for atomic presentation with other content. |
async
| Async | Indicates a preference to decode this image asynchronously to avoid delaying presentation of other content. |
auto
| Auto | Indicates no preference in decoding mode (the default). |
When decoding an image, the user agent should respect the preference indicated by the decoding attribute’s state. If the state indicated is auto, then the user agent is free to choose any decoding behavior.
When the user agent is to update the image data of an img
element,
optionally with the restart animations flag set,
it must run the following steps:
-
If the element’s node document is not the active document, then run these substeps:
- Continue running this algorithm in parallel.
- Wait until the element’s node document is the active document.
- If another instance of this algorithm for this
img
element was started after this instance (even if it aborted and is no longer running), then abort these steps. - Queue a microtask to continue this algorithm.
- If the user agent cannot support images, or its support for images has been disabled, then abort the image request for the current request and the pending request, set current request to the unavailable state, let pending request be null, and abort these steps.
-
If the element does not use
srcset
orpicture
and it does not have a parent or it has a parent but it is not apicture
element, and it has asrc
attribute specified and its value is not the empty string, let selected source be the value of the element’ssrc
attribute, and selected pixel density be 1.0. Otherwise, let selected source be null and selected pixel density be undefined. - Let the
img
element’s last selected source be selected source. -
If selected source is not null, run these substeps:
- Parse selected source, relative to the element’s node document. If that is not successful, then abort these inner set of steps. Otherwise, let urlString be the resulting URL string.
- Let key be a tuple consisting of urlString, the
img
element’scrossorigin
attribute’s mode, and, if that mode is not No CORS, the node document’s origin. -
If the list of available images contains an entry for key, run these subsubsteps:
- Set the ignore higher-layer caching flag for that entry.
- Abort the image request for the current request and the pending request.
- Let pending request be null.
- Let current request be a new image request whose image data is that of the entry and whose state is set to the completely available state.
- Update the presentation of the image appropriately.
- Let the current request’s current pixel density be selected pixel density.
- Queue a task to restart the animation if restart
animation is set, change current request’s current URL to urlString, and then fire a simple event named
load
at theimg
element. - Abort the update the image data algorithm.
- in parallel await a stable state, allowing the task that invoked this algorithm to continue. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended. (Steps in synchronous sections are marked with ⌛.)
-
⌛ If another instance of this algorithm for this
img
element was started after this instance (even if it aborted and is no longer running), then abort these steps.Only the last instance takes effect, to avoid multiple requests when, for example, the
src
,srcset
, andcrossorigin
attributes are all set in succession. -
⌛ Let selected source and selected pixel density be the URL and pixel density that results from selecting an image source, respectively.
-
⌛ If selected source is null, run these substeps:
- ⌛ Set the current request to the broken state, abort the image request for the current request and the pending request, and let pending request be null.
- ⌛ Queue a task to change the current request’s current URL to
the empty string, and then, if the element has a
src
attribute or it usessrcset
orpicture
, fire a simple event namederror
at theimg
element. - ⌛ Abort this algorithm.
-
⌛ Queue a task to fire a progress event named
loadstart
at theimg
element.⌛ Parse selected source, relative to the element’s node document, and let urlString be the resulting URL string. If that is not successful, run these substeps:
- ⌛ Abort the image request for the current request and the pending request.
- ⌛ Set the current request to the broken state.
- ⌛ Let pending request be null.
- ⌛ Queue a task to change the current request’s current URL to selected source, fire a simple event named
error
at theimg
element and then fire a simple event namedloadend
at theimg
element. - ⌛ Abort the update the image data algorithm.
-
⌛ If the pending request is not null, and urlString is the same as the pending request’s current URL, then abort these steps.
⌛ If urlString is the same as the current request’s current URL, and current request is in the partially available state, then abort the image request for the pending request, queue a task to restart the animation if restart animation is set, and abort these steps.
⌛ If the pending request is not null, abort the image request for the pending request.
⌛ Let image request be a new image request whose current URL is urlString.
⌛ If current request is in the unavailable state or the broken state, let the current request be image request. Otherwise, let the pending request be image request.
⌛ Let request be the result of creating a potential-CORS request given urlString and the current state of the element’s
crossorigin
content attribute.⌛ Set request’s client to the element’s node document’s
Window
object’s environment settings object and type to "image
".⌛ If the element uses
srcset
orpicture
, set request’s initiator to "imageset
".⌛ Set request’s referrer policy to the current state of the element’s
referrerpolicy
attribute.⌛ Fetch request. Let this instance of the fetching algorithm be associated with image request.
The resource obtained in this fashion, if any, is image request’s image data. It can be either CORS-same-origin or CORS-cross-origin; this affects the origin of the image itself (e.g., when used on a
canvas
).Fetching the image must delay the load event of the element’s node document until the task that is queued by the networking task source once the resource has been fetched (defined below) has been run.
This, unfortunately, can be used to perform a rudimentary port scan of the user’s local network (especially in conjunction with scripting, though scripting isn’t actually necessary to carry out such an attack). User agents may implement cross-origin access control policies that are stricter than those described above to mitigate this attack, but unfortunately such policies are typically not compatible with existing Web content.
If the resource is CORS-same-origin, each task that is queued by the networking task source while the image is being fetched, if image request is the current request, must fire a progress event named
progress
at theimg
element. - End the synchronous section, continuing the remaining steps in parallel, but without missing any data from fetching.
-
As soon as possible, jump to the first applicable entry from the following list:
- If the resource type is
multipart/x-mixed-replace
-
The next task that is queued by the networking task source while the image is being fetched must run the following steps:
-
If image request is the pending request and at least one body part has been completely decoded, abort the image request for the current request, upgrade the pending request to the current request.
-
Otherwise, if image request is the pending request and the user agent is able to determine that image request’s image is corrupted in some fatal way such that the image dimensions cannot be obtained, abort the image request for the current request, upgrade the pending request to the current request and set the current request’s state to broken.
-
Otherwise, if image request is the current request, it is in the unavailable state, and the user agent is able to determine image request’s image’s width and height, set the current request’s state to partially available.
-
Otherwise, if image request is the current request, it is in the unavailable state, and the user agent is able to determine that image request’s image is corrupted in some fatal way such that the image dimensions cannot be obtained, set the current request’s state to broken.
Each task that is queued by the networking task source while the image is being fetched must update the presentation of the image, but as each new body part comes in, it must replace the previous image. Once one body part has been completely decoded, the user agent must set the
img
element to the completely available state and queue a task to fire a simple event namedload
at theimg
element.The
progress
andloadend
events are not fired formultipart/x-mixed-replace
image streams. -
- If the resource type and data corresponds to a supported image format, as described below
-
The next task that is queued by the networking task source while the image is being fetched must run the following steps:
-
If the user agent is able to determine image request’s image’s width and height, and image request is pending request, set image request’s state to partially available.
-
Otherwise, if the user agent is able to determine image request’s image’s width and height, and image request is current request, update the
img
element’s presentation appropriately and set image request’s state to partially available. -
Otherwise, if the user agent is able to determine that image request’s image is corrupted in some fatal way such that the image dimensions cannot be obtained, and image request is pending request, abort the image request for the current request and the pending request, upgrade the pending request to the current request, set current request to the broken state, fire a simple event named
error
at theimg
element, fire a simple event namedloadend
at theimg
element, and abort these steps. -
Otherwise, if the user agent is able to determine that image request’s image is corrupted in some fatal way such that the image dimensions cannot be obtained, and image request is current request, abort the image request for image request, fire a simple event named
error
at theimg
element, fire a simple event namedloadend
at theimg
element, and abort these steps.
That task, and each subsequent task, that is queued by the networking task source while the image is being fetched, if image request is the current request, must update the presentation of the image appropriately (e.g., if the image is a progressive JPEG, each packet can improve the resolution of the image).
Furthermore, the last task that is queued by the networking task source once the resource has been fetched must additionally run these steps:
- If image request is the pending request, abort the image request for the current request, upgrade the pending request to the current request and
update the
img
element’s presentation appropriately. - Set image request to the completely available state.
- Add the image to the list of available images using the key key, with the ignore higher-layer caching flag set.
- Fire a progress event or simple event named
load
at theimg
element, depending on the resource in image request. - Fire a progress event or simple event named
loadend
at theimg
element, depending on the resource in image request.
-
- Otherwise
-
The image data is not in a supported file format; the user agent must set image request to the broken state, abort the image request for the current request and the pending request, upgrade the pending request to the current request if image request is the pending request, and then queue a task to first fire a simple event named
error
at theimg
element and then fire a simple event namedloadend
at theimg
element.
- If the resource type is
To abort the image request for an image request image request means to run the following steps:
- Forget image request’s image data, if any.
- Abort any instance of the fetching algorithm for image request, discarding any pending tasks generated by that algorithm.
To upgrade the pending request to the current request for an img
element means to run the following steps:
- Let the
img
element’s current request be the pending request. - Let the
img
element’s pending request be null.
To fire a progress event or simple event named type at an element e, depending on resource r, means to fire a progress event named type at e if r is CORS-same-origin, and otherwise fire a simple event named type at e.
While a user agent is running the above algorithm for an element x, there
must be a strong reference from the element’s node document to the element x,
even if that element is not in its Document
.
An img
element is said to use srcset
or picture
if it has a srcset
attribute specified or if it has a parent that is a picture
element.
When an img
element is in the completely available state and the user agent can decode the media data without errors, then the img
element is said to be fully decodable.
Whether the image is fetched successfully or not (e.g., whether the response status was an ok status) must be ignored when determining the image’s type and whether it is a valid image.
This allows servers to return images with error responses, and have them displayed.
The user agent should apply the image sniffing rules to determine the type of the image, with the image’s associated Content-Type headers giving the official type. If these rules are not applied, then the type of the image must be the type given by the image’s associated Content-Type headers.
User agents must not support non-image resources with the img
element (e.g., XML files whose document element is an HTML element). User agents must not run executable code (e.g.,
scripts) embedded in the image resource. User agents must only display the first page of a
multipage resource (e.g., a PDF file). User agents must not allow the resource to act in an
interactive fashion, but should honor any animation in the resource.
This specification does not specify which image types are to be supported.
An img
element is associated with a source set.
A source set is an ordered set of zero or more image sources and a source size.
An image source is a URL, and optionally either a density descriptor, or a width descriptor.
A source size is a <source-size-value>
.
When a source size has a unit relative to the viewport,
it must be interpreted relative to the img
element’s document’s viewport.
Other units must be interpreted the same as in Media Queries. [MEDIAQ]
When asked to select an image source for a given img
element el, user agents must do the following:
- Update the source set for el.
- If el’s source set is empty, return null as the URL and undefined as the pixel density and abort these steps.
- Otherwise, take el’s source set and let it be source set.
- If an entry b in source set has the same associated density descriptor as an earlier entry a in source set, then remove entry b. Repeat this step until none of the entries in source set have the same associated density descriptor as an earlier entry.
- In a user agent-specific manner, choose one image source from source set. Let this be selected source.
- Return selected source and its associated pixel density.
When asked to update the source set for a given img
element el,
user agents must do the following:
- Set el’s source set to an empty source set.
- If el has a parent node and that is a
picture
element, let elements be an array containing el’s parent node’s child elements, retaining relative order. Otherwise, let elements be array containing only el. - If el has a
width
attribute, and parsing that attribute’s value using the rules for parsing dimension values doesn’t generate an error or a percentage value, then let width be the returned integer value. Otherwise, let width be null. -
Iterate through elements, doing the following for each item child:
-
If child is el:
- If child has a
srcset
attribute, parse child’s srcset attribute and let the returned source set be source set. Otherwise, let source set be an empty source set. - Parse child’s sizes attribute with the fallback width width, and let source set’s source size be the returned value.
- If child has a
src
attribute whose value is not the empty string and source set does not contain an image source with a density descriptor value of 1, and no image source with a width descriptor, append child’ssrc
attribute value to source set. - Normalize the source densities of source set.
- Let el’s source set be source set.
- Abort this algorithm.
- If child has a
- If child is not a
source
element, continue to the next child. Otherwise, child is asource
element. - If child does not have a
srcset
attribute, continue to the next child. - Parse child’s
srcset
attribute and let the returned source set be source set. - If source set has zero image sources, continue to the next child.
- If child has a
media
attribute, and its value does not match the environment, continue to the next child. - Parse child’s
sizes
attribute with the fallback width width, and let source set’s source size be the returned value. - If child has a
type
attribute, and its value is an unknown or unsupported MIME type, continue to the next child. - Normalize the source densities of source set.
- Let el’s source set be source set.
- Abort this algorithm.
-
Each img
element independently considers
its previous sibling source
elements
plus the img
element itself
for selecting an image source, ignoring any other (invalid) elements,
including other img
elements in the same picture
element,
or source
elements that are following siblings
of the relevant img
element.
When asked to parse a srcset attribute from an element,
parse the value of the element’s srcset
attribute as follows:
- Let input be the value passed to this algorithm.
- Let position be a pointer into input, initially pointing at the start of the string.
- Let candidates be an initially empty source set.
- Splitting loop: Collect a sequence of characters that are space characters or U+002C COMMA characters. If any U+002C COMMA characters were collected, that is a parse error.
- If position is past the end of input, return candidates and abort these steps.
- Collect a sequence of characters that are not space characters, and let that be url.
- Let descriptors be a new empty list.
-
If url ends with a U+002C COMMA character (,), follow these substeps:
- Remove all trailing U+002C COMMA characters from url. If this removed more than one character, that is a parse error.
Otherwise, follow these substeps:
- Descriptor tokenizer: Skip white space
- Let current descriptor be the empty string.
- Let state be in descriptor.
-
Let c be the character at position. Do the following depending on the value of state. For the purpose of this step, "EOF" is a special character representing that position is past the end of input.
- In descriptor
-
Do the following, depending on the value of c:
- Space character
- If current descriptor is not empty, append current descriptor to descriptors and let current descriptor be the empty string. Set state to after descriptor.
- U+002C COMMA (,)
- Advance position to the next character in input. If current descriptor is not empty, append current descriptor to descriptors. Jump to the step labeled descriptor parser.
- U+0028 LEFT PARENTHESIS (()
- Append c to current descriptor. Set state to in parens.
- EOF
- If current descriptor is not empty, append current descriptor to descriptors. Jump to the step labeled descriptor parser.
- Anything else
- Append c to current descriptor.
- In parens
-
Do the following, depending on the value of c:
- U+0029 RIGHT PARENTHESIS ())
- Append c to current descriptor. Set state to in descriptor.
- EOF
- Append current descriptor to descriptors. Jump to the step labeled descriptor parser.
- Anything else
- Append c to current descriptor.
- After descriptor
-
Do the following, depending on the value of c:
- Space character
- Stay in this state.
- EOF
- Jump to the step labeled descriptor parser.
- Anything else
- Set state to in descriptor. Set position to the previous character in input.
Advance position to the next character in input. Repeat this substep.
In order to be compatible with future additions, this algorithm supports multiple descriptors and descriptors with parens.
- Descriptor parser: Let error be no.
- Let width be absent.
- Let density be absent.
- Let future-compat-h be absent.
-
For each descriptor in descriptors, run the appropriate set of steps from the following list:
- If the descriptor consists of a valid non-negative integer followed by a U+0077 LATIN SMALL LETTER W character
-
-
If the user agent does not support the
sizes
attribute, let error be yes.A conforming user agent will support the
sizes
attribute. However, user agents typically implement and ship features in an incremental manner in practice. - If width and density are not both absent, then let error be yes.
- Apply the rules for parsing non-negative integers to the descriptor. If the result is zero, let error be yes. Otherwise, let width be the result.
-
- If the descriptor consists of a valid floating-point number followed by a U+0078 LATIN SMALL LETTER X character
-
- If width, density and future-compat-h are not all absent, then let error be yes.
-
Apply the rules for parsing floating-point number values to the descriptor. If the result is less than zero, let error be yes. Otherwise, let density be the result.
If density is zero, the intrinsic dimensions will be infinite. User agents are expected to have limits in how big images can be rendered, which is allowed by the hardware limitations clause.
- If the descriptor consists of a valid non-negative integer followed by a U+0068 LATIN SMALL LETTER H character
-
This is a parse error.
- If future-compat-h and density are not both absent, then let error be yes.
- Apply the rules for parsing non-negative integers to the descriptor. If the result is zero, let error be yes. Otherwise, let future-compat-h be the result.
- Anything else
- Let error be yes.
- If future-compat-h is not absent and width is absent, let error be yes.
- If error is still no, then append a new image source to candidates whose URL is url, associated with a width width if not absent and a pixel density density if not absent. Otherwise, there is a parse error.
- Return to the step labeled splitting loop.
When asked to parse a sizes attribute from an element, parse a comma-separated list of component values from the value of the element’s sizes
attribute
(or the empty string, if the attribute is absent),
and let unparsed sizes list be the result. [CSS-SYNTAX-3]
For each unparsed size in unparsed sizes list:
- Remove all consecutive <whitespace-token>s from the end of unparsed size. If unparsed size is now empty, that is a parse error; continue to the next iteration of this algorithm.
- If the last component value in unparsed size is a valid non-negative
<source-size-value>
, let size be its value and remove the component value from unparsed size. Any CSS function other than thecalc()
function is invalid. Otherwise, there is a parse error; continue to the next iteration of this algorithm. - Remove all consecutive <whitespace-token>s from the end of unparsed size. If unparsed size is now empty, return size and exit this algorithm. If this was not the last item in unparsed sizes list, that is a parse error.
- Parse the remaining component values in unparsed size as a <media-condition>. If it does not parse correctly, or it does parse correctly but the <media-condition> evaluates to false, continue to the next iteration of this algorithm. [MEDIAQ]
- Return size and exit this algorithm.
If the above algorithm exhausts unparsed sizes list without returning a size value, follow these steps:
- If width is not null, return a
<length>
with the value width and the unitpx
. - Return
100vw
.
A parse error for the algorithms above indicates a non-fatal mismatch between input and requirements. User agents are encouraged to expose parse errors somehow.
While a valid source size list only contains a bare <source-size-value>
(without an accompanying <media-condition>)
as the last entry in the <source-size-list>
,
the parsing algorithm technically allows such at any point in the list,
and will accept it immediately as the size
if the preceding entries in the list weren’t used.
This is to enable future extensions,
and protect against simple author errors such as a final trailing comma.
An image source can have a density descriptor, a width descriptor, or no descriptor at all accompanying its URL. Normalizing a source set gives every image source a density descriptor.
When asked to normalize the source densities of a source set source set, the user agent must do the following:
- Let source size be source set’s source size.
-
For each image source in source set:
- If the image source has a density descriptor, continue to the next image source.
-
Otherwise, if the image source has a width descriptor, replace the width descriptor with a density descriptor with a value of the width descriptor divided by the source size and a unit of
x
.If the source size is zero, the density would be infinity, which results in the intrinsic dimensions being zero by zero.
- Otherwise, give the image source a density descriptor of
1x
.
The user agent may at any time run the following algorithm to update an img
element’s image in order to react to changes in the environment. (User agents are not
required to ever run this algorithm; for example, if the user is not looking at the page any
more, the user agent might want to wait until the user has returned to the page before determining
which image to use, in case the environment changes again in the meantime.)
User agents are encouraged to run this algorithm in particular when the user changes the viewport’s size (e.g., by resizing the window or changing the page zoom),
and when an img
element is inserted into a document,
so that the density-corrected intrinsic width and height match the new viewport,
and so that the correct image is chosen when art direction is involved.
- in parallel await a stable state. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended. (Steps in synchronous sections are marked with ⌛.)
- ⌛ If the
img
element does not usesrcset
orpicture
, its node document is not the active document, has image data whose resource type ismultipart/x-mixed-replace
, or the pending request is not null, then abort this algorithm. - ⌛ Let selected source and selected pixel density be the URL and pixel density that results from selecting an image source, respectively.
- ⌛ If selected source is null, then abort these steps.
- ⌛ If selected source and selected pixel density are the same as the element’s last selected source and current pixel density, then abort these steps.
- ⌛ Parse selected source, relative to the element’s node document, and let urlString be the resulting URL string. If that is not successful, abort these steps.
- ⌛ Let corsAttributeState be the state of the element’s
crossorigin
content attribute. - ⌛ Let origin be the origin of the
img
element’s node document. - ⌛ Let client be the
img
element’s node document’sWindow
object’s environment settings object. - ⌛ Let key be a tuple consisting of urlString, corsAttributeState, and, if corsAttributeState is not No CORS, origin.
- ⌛ Let image request be a new image request whose current URL is urlString
- ⌛ Let the element’s pending request be image request.
- End the synchronous section, continuing the remaining steps in parallel.
-
If the list of available images contains an entry for key, then set image request’s image data to that of the entry. Continue to the next step.
Otherwise, run these substeps:
- Let request be the result of creating a potential-CORS request given urlString and corsAttributeState.
- Set request’s client to client, type to "
image
", and set request’s synchronous flag. - Set request’s referrer policy to the current state of the
element’s
referrerpolicy
attribute. - Let response be the result of fetching request.
- If response’s unsafe response is a network error or
if the image format is unsupported (as determined by applying the image sniffing rules, again as mentioned earlier),
or if the user agent is able to determine that image request’s image is corrupted in
some fatal way such that the image dimensions cannot be obtained, or if the resource type is
multipart/x-mixed-replace
, then let pending request be null and abort these steps. - Otherwise, response’s unsafe response is image
request’s image data. It can be either CORS-same-origin or CORS-cross-origin; this affects the origin of the image itself (e.g., when used on a
canvas
).
-
Queue a task to run the following substeps:
- If the
img
element has experienced relevant mutations since this algorithm started, then let pending request be null and abort these steps. - Let the
img
element’s last selected source be selected source and theimg
element’s current pixel density be selected pixel density. - Set image request to the completely available state.
- Add the image to the list of available images using the key key, with the ignore higher-layer caching flag set.
- Upgrade the pending request to the current request.
- Update the
img
element’s presentation appropriately. - Fire a simple event named
load
at theimg
element.
- If the
The task source for the tasks queued by algorithms in this section is the DOM manipulation task source.
What an img
element represents depends on the src
attribute and the alt
attribute.
- If the
src
attribute is set and thealt
attribute is set to the empty string (e.g.alt=""
oralt
without a set value) -
The image is either decorative or supplemental to the rest of the content, redundant with some other information in the document.
If the image is available and the user agent is configured to display that image, then the element represents the element’s image data.
Otherwise, the element represents nothing, and may be omitted completely from the rendering. User agents may provide the user with a notification that an image is present but has been omitted from the rendering.
- If the
src
attribute is set and thealt
attribute is set to a value that isn’t empty -
The image is a key part of the content; the
alt
attribute gives a textual equivalent or replacement for the image.If the image is available and the user agent is configured to display that image, then the element represents the element’s image data.
Otherwise, the element represents the text given by the
alt
attribute. User agents may provide the user with a notification that an image is present but has been omitted from the rendering. - If the
src
attribute is set and thealt
attribute is not -
There is no textual equivalent of the image available.
If the image is available and the user agent is configured to display that image, then the element represents the element’s image data.
Otherwise, the user agent should display some sort of indicator that there is an image that is not being rendered, and may, if requested by the user, or if so configured, or when required to provide contextual information in response to navigation, provide caption information for the image, derived as follows:
- If the image is a descendant of a
figure
element that has a childfigcaption
element, and, ignoring thefigcaption
element and its descendants, thefigure
element has noText
node descendants other than inter-element white space, and no embedded content descendant other than theimg
element, then the contents of the first suchfigcaption
element are the caption information; abort these steps. - There is no caption information.
- If the image is a descendant of a
- If the
src
attribute is not set and either thealt
attribute is set to the empty string or thealt
attribute is not set at all -
The element represents nothing.
- Otherwise
-
The element represents the text given by the
alt
attribute.
The alt
attribute does not represent advisory information.
User agents must not present the contents of the alt
attribute
in the same way as content of the title
attribute.
User agents may always provide the user with the option to display any image, or to prevent any image from being displayed. User agents may also apply heuristics to help the user make use of the image when the user is unable to see it, e.g., due to a visual disability or because they are using a text terminal with no graphics capabilities. Such heuristics could include, for instance, optical character recognition (OCR) of text found within the image.
In the case where an img
without an alt
attribute is the child of a figure
element with a non-empty figcaption
element, the image’s presence should be minimally conveyed
to a user by Assistive Technology, typically by identifying the image role
.
While user agents are encouraged to repair cases of missing alt
attributes, authors must not rely on such behavior. Requirements for providing
text to act as an alternative for images are described in detail below.
The contents of img
elements, if any, are ignored for the purposes of
rendering.
The usemap
attribute,
if present, can indicate that the image has an associated image map.
The ismap
attribute, when used on an element that is a descendant of an a
element with an href
attribute, indicates by its
presence that the element provides access to a server-side image
map. This affects how events are handled on the corresponding a
element.
Users who do not have a pointing device, or who cannot see
the image referred to will generally not be able to use a server-side image map successfully.
Authors should use another mechanism, such as a "client-side" image map made using the usemap
attribute, wherever possible.
The ismap
attribute is a boolean attribute. The attribute must not be specified
on an element that does not have an ancestor a
element
with an href
attribute.
<figure> <a href="solve.html"> <img src="zoo.jpg" ismap alt="Animals and people at the zoo, among them Wally with striped clothes"> </a> <figcaption>Where’s Wally? Click on him!</figcaption> </figure>
The coordinates where the user clicks are sent to the server with the
request for the resource referenced by the a
element’s href
attribute.
The definition of the a
element explains how the coordinates of the click
event on an img
element with ismap
attribute inside an a
element are communicated to the server.
The usemap
and ismap
attributes can result in confusing behavior
when used together with source
elements with the media
attribute specified
in a picture
element.
The img
element supports dimension attributes.
The alt
, src
, srcset
and sizes
IDL attributes must reflect the
respective content attributes of the same name.
The crossOrigin
IDL attribute must reflect the crossorigin
content attribute, limited to only known values.
The useMap
IDL attribute must reflect the usemap
content attribute.
The isMap
IDL attribute must reflect the ismap
content attribute.
The referrerPolicy
IDL attribute must reflect the referrerpolicy
content attribute, limited to only known values.
The longDesc
IDL attribute is defined in [html-longdesc]. The IDL attribute must reflect the longdesc
content attribute.
- image .
width
[ = value ]- image .
height
[ = value ] - image .
-
These attributes return the actual rendered dimensions of the image, or zero if the dimensions are not known.
They can be set, to change the corresponding content attributes.
- image .
naturalWidth
- image .
naturalHeight
- image .
-
These attributes return the intrinsic dimensions of the image, or zero if the dimensions are not known.
- image .
complete
-
Returns true if the image has been completely downloaded or if no image is specified; otherwise, returns false.
- image .
currentSrc
-
Returns the image’s absolute URL.
- image .
decoding
-
Returns the image decoding hint set for this image.
- image .
decode()
-
This method causes the user agent to decode the image in parallel, returning a promise that fulfills when decoding is complete.
The promise will be rejected with an "
EncodingError
"DOMException
if the image cannot be decoded. - image = new
Image
( [ width [, height ] ] ) -
Returns a new
img
element, with thewidth
andheight
attributes set to the values passed in the relevant arguments, if applicable.
The IDL attributes width
and height
must return the rendered width and height of the
image, in CSS pixels, if the image is being rendered, and is being rendered to a
visual medium; or else the density-corrected intrinsic width and height of the image, in CSS pixels, if the image has intrinsic dimensions and is available but not being rendered to a visual medium; or else 0, if
the image is not available or does not have intrinsic dimensions. [CSS-2015]
On setting, they must act as if they reflected the respective content attributes of the same name.
The IDL attributes naturalWidth
and naturalHeight
must return
the density-corrected intrinsic width and height of the image, in CSS pixels, if the image has intrinsic dimensions and is available, or else 0. [CSS-2015]
The IDL attribute complete
must return true if
any of the following conditions is true:
- Both the
src
attribute and thesrcset
attribute are omitted. - The
srcset
attribute is omitted and thesrc
attribute’s value is the empty string. - The final task that is queued by the networking task source once the resource has been fetched has been queued.
- The
img
element is completely available. - The
img
element is broken.
Otherwise, the attribute must return false.
The value of complete
can thus change while
a script is executing.
The currentSrc
IDL attribute
must return the img
element’s current request’s current URL.
The decode()
method, when invoked,
must perform the following steps:
-
If any of the following conditions are true about this
img
element:- its node document is not an active document;
- its current request's state is broken,
then reject promise with an "
EncodingError
"DOMException
. -
Otherwise, in parallel, wait for one of the following cases to occur,
and perform the corresponding actions:
- This img element’s node document stops being an active document
- This img element’s current request changes or is mutated
- This img element’s current request's state becomes broken
- This img element’s current request changes or is mutated
- Reject promise with an "
EncodingError
"DOMException
. - This
img
element’s current request's state becomes completely available -
Decode the image.
If decoding does not need to be performed for this image, resolve promise with undefined. An example of this case would be for vector graphics.
If decoding fails, reject promise with an "
EncodingError
"DOMException
. An example of this would be corrupt image data or attempting to decode an image encoded by an unsupported codec.If the decoding process completes successfully, resolve promise with undefined.
User agents should ensure that the decoded media image is readily available until at least the end of the next successful update the rendering step in the event loop.
Implementations may choose to discard the decoded image data in the event it is difficult to keep the decoded copy ready. Low memory situations or large images would be cases where implementations may choose to do this.
Implementations are expected to treat animated images that have all frames loaded as completely available.
- This img element’s node document stops being an active document
- Return promise.
A constructor is provided for creating HTMLImageElement
objects (in addition to
the factory methods from DOM such as createElement()
): Image(width, height)
.
When invoked as a constructor, this must return a new HTMLImageElement
object (a new img
element). If the width argument is present, the new object’s width
content attribute must be set to width. If the height argument is also present, the new object’s height
content attribute must be set to height.
The element’s node document must be the active document of the browsing context of the Window
object on which the interface object of
the invoked constructor is found.
4.7.5.1. Requirements for providing text to act as an alternative for images
Text alternatives, [WCAG20] are a primary way of making visual information accessible, because they can be rendered through many sensory modalities (for example, visual, auditory or tactile) to match the needs of the user. Providing text alternatives allows the information to be rendered in a variety of ways by a variety of user agents. For example, a person who cannot see a picture can hear the text alternative read aloud using synthesized speech.
The alt
attribute on images is a very important accessibility attribute.
Authoring useful alt
attribute content requires the author to
carefully consider the context in which the image appears and the function that
image may have in that context.
The longdesc
attribute on images is likely to be read far less often by users
and is necessary for far fewer images. Nevertheless it provides an important way for
users who cannot see an image or cannot see it clearly, and user agents that cannot automatically process images,
to understand what it shows. The longdesc
attribute’s use cases are more fully described in [html-longdesc]
The guidance included here addresses the most common ways authors use images. Additional guidance and techniques are available in Resources on Alternative Text for Images.
4.7.5.1.1. Examples of scenarios where users benefit from text alternatives for images
- They have a very slow connection and are browsing with images disabled.
- They have a vision impairment and use text to speech software.
- They have a cognitive impairment and use text to speech software.
- They are using a text-only browser.
- They are listening to the page being read out by a voice Web browser.
- They have images disabled to save on download costs.
- They have problems loading images or the source of an image is wrong.
4.7.5.1.2. General guidelines
Except where otherwise specified, the alt
attribute must be specified and its value must not be empty;
the value must be an appropriate functional replacement for the image. The specific requirements for the alt
attribute content depend on the image’s function in the page, as described in the following sections.
To determine an appropriate text alternative it is important to think about why an image is being included in a page. What is its purpose? Thinking like this will help you to understand what is important about the image for the intended audience. Every image has a reason for being on a page, because it provides useful information, performs a function, labels an interactive element, enhances aesthetics or is purely decorative. Therefore, knowing what the image is for, makes writing an appropriate text alternative easier.
4.7.5.1.3. A link or button containing nothing but an image
When an a
element that is a hyperlink, or a button
element, has no text content
but contains one or more images, include text in the alt
attribute(s) that together convey the purpose of the link or button.
alt
attributes of the images:
<ul> <li><button><img src="b.png" alt="Bold"></button></li> <li><button><img src="i.png" alt="Italics"></button></li> <li><button><img src="strike.png" alt="Strike through"></button></li> <li><button><img src="blist.png" alt="Bulleted list"></button></li> <li><button><img src="nlist.png" alt="Numbered list"></button></li> </ul>
<a href="https://w3.org"> <img src="images/w3c_home.png" width="72" height="48" alt="W3C web site"> </a>
<a href="https://w3.org"> <img src="images/w3c_home.png" width="72" height="48" alt="W3C home"> </a>
Depending on the context in which an image of a logo is used it could be appropriate to provide an indication, as part of the text alternative, that the image is a logo. Refer to section §4.7.5.1.19 Logos, insignia, flags, or emblems.
<a href="preview.html"> <img src="images/preview.png" width="32" height="30" alt="Print preview."> </a>
<button> <img src="images/search.png" width="74" height="29" alt="Search"> </button>
alt
attribute of the first image.
<a href="pipco-home.html"> <img src="pip.gif" alt="PIP CO home"><img src="co.gif" alt=""> </a>
4.7.5.1.4. Graphical Representations: Charts, diagrams, graphs, maps, illustrations
Users can benefit when content is presented in graphical form, for example as a flowchart, a diagram, a graph, or a map showing directions. Users who are unable to view the image also benefit when content presented in a graphical form is provided in a text-based format. Software agents that process text content, but cannot automatically process images (e.g. translation services, many search engines), also benefit from a text-based description.
alt
attribute representing the data shown in the pie chart:
<img src="piechart.gif" alt="Pie chart: Browser Share - Internet Explorer 25%, Firefox 40%, Chrome 25%, Safari 6% and Opera 4%.">
alt
attribute content labels the image and the longdesc
attribute identifies it as a description.
<p id="graph7">According to a recent study Firefox has a 40% browser share, Internet Explorer has 25%, Chrome has 25%, Safari has 6% and Opera has 4%.</p> <p><img src="piechart.gif" alt="The browser shares as a pie chart." longdesc="#graph7"></p>
It can be seen that when the image is not available, for example because the src
attribute value is incorrect, the text alternative provides the user with a brief description of
the image content:
In cases where the text alternative is lengthy, more than a sentence or two, or would benefit
from the use of structured markup, provide a brief description or label using the alt
attribute, and an associated text alternative.
alt
attribute, in this case the text alternative is a description of the link target
as the image is the sole content of a link. The link points to a description, within the same document, of the
process represented in the flowchart.
<a href="#desc"><img src="flowchart.gif" alt="Flowchart: Dealing with a broken lamp." longdesc="#desc"></a> ... ... <div id="desc"> <h2>Dealing with a broken lamp</h2> <ol> <li>Check if it’s plugged in, if not, plug it in.</li> <li>If it still doesn’t work; check if the bulb is burned out. If it is, replace the bulb.</li> <li>If it still doesn’t work; buy a new lamp.</li> </ol> </div>
alt
attribute as the information is a data set. Instead a
structured text alternative is provided below the image in the form of a data table using the data that is represented
in the chart image.
Indications of the highest and lowest rainfall for each season have been included in the table, so trends easily identified in the chart are also available in the data table.
United Kingdom | Japan | Australia | |
---|---|---|---|
Spring | 5.3 (highest) | 2.4 | 2 (lowest) |
Summer | 4.5 (highest) | 3.4 | 2 (lowest) |
Autumn | 3.5 (highest) | 1.8 | 1.5 (lowest) |
Winter | 1.5 (highest) | 1.2 | 1 (lowest) |
<figure> <figcaption>Rainfall Data</figcaption> <img src="rainchart.gif" alt="Bar chart: average rainfall by Country and Season. Full description in Table below." longdesc="#table-4"> <table id="table-4"> <caption>Rainfall in millimetres by Country and Season.</caption> <tr> <td> <th scope="col">UK <th scope="col">Japan <th scope="col">Australia </tr> <tr> <th scope="row">Spring <td>5.5 (highest) <td>2.4 <td>2 (lowest) </tr> <tr> <th scope="row">Summer <td>4.5 (highest) <td>3.4 <td>2 (lowest) </tr> <tr> <th scope="row">Autumn <td>3.5 (highest) <td>1.8 <td>1.5 (lowest) </tr> <tr> <th scope="row">Winter <td>1.5 (highest) <td>1.2 <td>1 lowest </tr> </table> </figure>
The figure
element is used to group the Bar Chart image and data table.
The figcaption
element provides a caption for the grouped content.
For any of the examples in this section the details
and summary
elements could be used so that the text descriptions for the images are only displayed on demand:
<figure> <img src="flowchart.gif" alt="Flowchart: Dealing with a broken lamp."> <details> <summary>Dealing with a broken lamp</summary> <ol> <li>Check if it’s plugged in, if not, plug it in.</li> <li>If it still doesn’t work; check if the bulb is burned out. If it is, replace the bulb.</li> <li>If it still doesn’t work; buy a new lamp.</li> </ol> </details> </figure>
The details
and summary
elements are not currently well supported by
browsers, until such times they are supported, if used, you will need to use scripting to
provide the functionality. There are a number of scripted Polyfills and scripted custom
controls available, in popular JavaScript UI widget libraries, which provide similar
functionality.
4.7.5.1.5. Images of text
Sometimes, an image only contains text, and the purpose of the image
is to display text using visual effects and /or fonts. It is strongly recommended that text styled using CSS be used, but if this is not possible, provide
the same text in the alt
attribute as is in the image.
<h1><img src="gethappy.gif" alt="Get Happy!"></h1>
<p><img src="sale.gif" alt="The BIG sale ...ends Friday."></p>
In situations where there is also a photo or other graphic along with the image of text, ensure that the words in the image text are included in the text alternative, along with any other description of the image that conveys meaning to users who can view the image, so the information is also available to users who cannot view the image.
Only 5.99!
<p>Only <img src="euro.png" alt="euro ">5.99!
An image should not be used if Unicode characters would serve an identical purpose. Only when the text cannot be directly represented using Unicode, e.g., because of decorations or because the character is not in the Unicode character set (as in the case of gaiji), would an image be appropriate.
If an author is tempted to use an image because their default system font does not support a given character, then Web Fonts are a better solution than images.

<p><img src="initials/fancyO.png" alt="O">nce upon a time and a long long time ago...
longdesc
can provide a link to a more detailed description: 
<p><img src="initials/story-o.jpg" alt="O" longdesc="letters/story-0.html">nce upon a time and a long long time ago...
4.7.5.1.6. Images that include text
Sometimes, an image consists of a graphics such as a chart and associated text. In this case it is recommended that the text in the image is included in the text alternative.
<p><img src="figure1.gif" alt="Figure 1. Distribution of Articles by Journal Category. Pie chart: Language=68%, Education=14% and Science=18%."></p>
alt
attribute
and a longer text alternative in text. The figure
and figcaption
elements are used to associate the longer text alternative with the image. The alt
attribute is used
to label the image.
<figure> <img src="figure1.gif" alt="Figure 1"> <figcaption> <strong>Figure 1.</strong> Distribution of Articles by Journal Category. Pie chart: Language=68%, Education=14% and Science=18%. </figcaption> </figure>
The advantage of this method over the previous example is that the text alternative
is available to all users at all times. It also allows structured mark up to be used in the text
alternative, where as a text alternative provided using the alt
attribute does not.
4.7.5.1.7. Images that enhance the themes or subject matter of the page content
An image that isn’t discussed directly by the surrounding text but still has some relevance can
be included in a page using the img
element. Such images are more than mere decoration, they
may augment the themes or subject matter of the page content and so still form part of the
content. In these cases, it is recommended that a text alternative be provided.
alt
attribute and
a link below the image to a longer description located at the bottom of the document. At the end
of the longer description there is also a link to further information about the painting.
<header> <h1>The Lady of Shalott</h1> <p>A poem by Alfred Lord Tennyson</p> </header> <img src="shalott.jpg" alt="Painting - a young woman with long hair, sitting in a wooden boat. Full description below." longdesc="#des"> <p><a href="#des">Description of the painting</a>.</p> <!-- Full Recitation of Alfred, Lord Tennyson’s Poem. --> ... ... ... <p id="des">The woman in the painting is wearing a flowing white dress. A large piece of intricately patterned fabric is draped over the side. In her right hand she holds the chain mooring the boat. Her expression is mournful. She stares at a crucifix lying in front of her. Beside it are three candles. Two have blown out. <a href="https://www.tate.org.uk/art/artworks/waterhouse-the-lady-of-shalott-n01543">Further information about the painting</a>.</p>
This example illustrates the provision of a text alternative identifying an image as a photo of the main subject of a page.
<img src="orateur_robin_berjon.png" alt="Portrait photo (black and white) of Robin."> <h1>Robin Berjon</h1> <p>What more needs to be said?</p>
alt
attribute, and
there is a link after the image. The link points to a page containing information about the painting.
The Lady of Shalott
A poem by Alfred Lord Tennyson.
Full recitation of Alfred, Lord Tennyson’s poem.
<header> <h1>The Lady of Shalott</h1> <p>A poem by Alfred Lord Tennyson</p> </header> <figure> <img src="shalott.jpeg" alt="Painting: a woman in a white flowing dress, sitting in a small boat."> <p><a href="http://www.tate.org.uk/art/artworks/waterhouse-the-lady-of-shalott-n01543">About this painting: The Lady of Shalott.</a></p> </figure> <!-- Full Recitation of Alfred, Lord Tennyson’s Poem. -->
4.7.5.1.8. A graphical representation of some of the surrounding text
In many cases, the image is actually just supplementary, and its presence merely reinforces the
surrounding text. In these cases, the alt
attribute must be
present but its value must be unset or the empty string.
In general, an image falls into this category if removing the image doesn’t make the page any less useful, but including the image makes it a lot easier for users of visual browsers to understand the concept.
In the text file, add SleepMode=1
under [options]
, then save and close.
<p> In the text file, add <code>SleepMode=1</code> under <code>[options]</code>, then save and close. </p> <img src="images/text.png" alt="">
4.7.5.1.9. A purely decorative image that doesn’t add any information
Purely decorative images are visual enhancements, decorations or embellishments that provide no function or information beyond aesthetics to users who can view the images.
Mark up purely decorative images so they can be ignored by assistive technology by using an alt
attribute with no value (e.g. alt=""
or alt
with
no set value). While it is not unacceptable to include decorative images inline,
it is recommended if they are purely decorative to include the image using CSS.
alt
attribute with no set value
is used.
<header> <div><img src="border.gif" alt width="400" height="30"></div> <h1>Clara’s Blog</h1> </header> <p>Welcome to my blog...</p>
4.7.5.1.10. Inline images
When images are used inline as part of the flow of text in a sentence, provide a word or phrase as a text alternative which makes sense in the context of the sentence it is a part of.

I <img src="heart.png" alt="love"> you.
My breaks.
My <img src="heart.png" alt="heart"> breaks.
4.7.5.1.11. A group of images that form a single larger picture with no links
When a picture has been sliced into smaller image files that are then displayed
together to form the complete picture again, include a text alternative for one
of the images using the alt
attribute as per the relevant
guidance for the picture as a whole, and then include an empty alt
attribute on the other images.
alt
attribute of the first image.
<img src="pip.gif" alt="PIP CO"><img src="co.gif" alt="">
alt
attributes. 
<p>Rating: <img src="1" alt="3 out of 5"> <img src="1" alt=""><img src="1" alt=""> <img src="0" alt=""><img src="0" alt=""> </p>
4.7.5.1.12. Image maps
If animg
element has a usemap
attribute which references a map
element containing area
elements that have href
attributes, the img
is considered to be interactive content.
In such cases, always provide a text alternative for the image using the alt
attribute.
alt
attribute on each
of the area
elements provides text describing the content of the target page of each linked region:
<p>View houses for sale in North Katoomba or South Katoomba:</p> <p><img src="imagemap.png" width="209" alt="Map of Katoomba" height="249" usemap="#Map"> <map name="Map"> <area shape="poly" coords="78,124,124,10,189,29,173,93,168,132,136,151,110,130" href="north.html" alt="Houses in North Katoomba"> <area shape="poly" coords="66,63,80,135,106,138,137,154,167,137,175,133,144,240,49,223,17,137,17,61" alt="Houses in South Katoomba" href="south.html"> </map>
4.7.5.1.13. A group of images that form a single larger picture with links
Sometimes, when you create a composite picture from multiple images, you may wish to
link one or more of the images. Provide an alt
attribute
for each linked image to describe the purpose of the link.
<h1>The crocoduck</h1> <p>You encounter a strange creature called a "crocoduck". The creature seems angry! Perhaps some friendly stroking will help to calm it, but be careful not to stroke any crocodile parts. This would just enrage the beast further.</p> <a href="?stroke=head"><img src="crocoduck1.png" alt="Stroke crocodile’s angry, chomping head"></a> <a href="?stroke=body"><img src="crocoduck2.png" alt="Stroke duck’s soft, feathery body"></a>
4.7.5.1.14. Images of Pictures
Images of pictures or graphics include visual representations of objects, people, scenes, abstractions, etc. This non-text content, [WCAG20] can convey a significant amount of information visually or provide a specific sensory experience, [WCAG20] to a sighted person. Examples include photographs, paintings, drawings and artwork.
An appropriate text alternative for a picture is a brief description, or name [WCAG20]. As in all text alternative authoring decisions, writing suitable text alternatives for pictures requires
human judgment. The text value is subjective to the context where the image is used and the page author’s writing style. Therefore,
there is no single "right" or "correct" piece of alt
text for any particular image. In addition to providing a short text
alternative that gives a brief description of the non-text content, also providing supplemental content through another means when
appropriate may be useful.
img
element’s alt
attribute. It also has a caption provided by including
the img
element in a figure
element and using a figcaption
element to identify the caption text.
Lola prefers a bath to a shower.
<figure> <img src="664aef.jpg" alt="Lola the cat sitting under an umbrella in the bath tub."> <figcaption>Lola prefers a bath to a shower.</figcaption> </figure>
alt
attribute which gives users who cannot view the image a sense
of what the image is. It also has a caption provided by including the img
element in a figure
element and using a figcaption
element to identify the caption text.
The first of the ten cards in the Rorschach test.
<figure> <img src="Rorschach1.jpg" alt="An abstract, freeform, vertically symmetrical, black inkblot on a light background."> <figcaption>The first of the ten cards in the Rorschach test.</figcaption> </figure>
4.7.5.1.15. Webcam images
Webcam images are static images that are automatically updated periodically. Typically the images are from a fixed viewpoint, the images may update on the page automatically as each new image is uploaded from the camera or the user may be required to refresh the page to view an updated image. Examples include traffic and weather cameras.
figure
and figcaption
elements. As the image is provided to give a visual indication of the current weather near a building,
a link to a local weather forecast is provided, as with automatically generated and uploaded webcam images it may be impractical to
provide such information as a text alternative.
The text of the alt
attribute includes a prose version of the timestamp, designed to make the text more
understandable when announced by text to speech software. The text alternative also includes a description of some aspects
of what can be seen in the image which are unchanging, although weather conditions and time of day change.
View from the top of Sopwith house, looking towards North Kingston. This image is updated every hour.
View the latest weather details for Kingston upon Thames.
<figure> <img src="webcam1.jpg" alt="Sopwith house weather cam. Taken on the 21/04/10 at 11:51 and 34 seconds. In the foreground are the safety rails on the flat part of the roof. Nearby there are low rize industrial buildings, beyond are blocks of flats. In the distance there’s a church steeple."> <figcaption>View from Sopwith house, looking towards north Kingston. This image is updated every hour.</figcaption> </figure> <p>View the <a href="https://www.bbc.co.uk/weather/0/6690829">latest weather details</a> for Kingston upon Thames.</p>
4.7.5.1.16. When a text alternative is not available at the time of publication
In some cases an image is included in a published document, but the author is unable to provide an appropriate text alternative.
In such cases the minimum requirement is to provide a caption for the image using the figure
and figcaption
elements under the following conditions:
- The
img
element is in afigure
element - The
figure
element contains afigcaption
element - The
figcaption
element contains content other than inter-element white space - Ignoring the
figcaption
element and its descendants, thefigure
element has noText
node descendants other than inter-element white space, and no embedded content descendant other than theimg
element.
In other words, the only content of the figure
is an img
element and a figcaption
element, and the figcaption
element must include (caption) content.
Such cases are to be kept to an absolute
minimum. If there is even the slightest possibility of the author
having the ability to provide real alternative text, then it would
not be acceptable to omit the alt
attribute.
The caption text in the example below is not a suitable text alternative and is not conforming to the Web Accessibility Guidelines 2.0. [WCAG20]

<figure> <img src="clara.jpg"> <figcaption>clara.jpg, taken on 12/11/2010.</figcaption> </figure>
Notice that even in this example, as much useful information as possible is
still included in the figcaption
element.
alt
attribute.

<figure> <img src="elo.jpg"> <figcaption>Eloisa with Princess Belle</figcaption> </figure>
<table> <tr> <th>Image</th> <th>Description</th> </tr> <tr> <td> <figure> <img src="2421.png"> <figcaption>Image 640 by 100, filename 'banner.gif'</figcaption> </figure> </td> <td> <input name="alt2421"> </td> </tr> <tr> <td> <figure> <img src="2422.png"> <figcaption>Image 200 by 480, filename 'ad3.gif'</figcaption> </figure> </td> <td> <input name="alt2422"> </td> </tr> </table>
Since some users cannot use images at all (e.g., because they are blind) the alt
attribute is only allowed to be omitted when no text
alternative is available and none can be made available, as in the above examples.
4.7.5.1.17. An image not intended for the user
Generally authors should avoid using img
elements
for purposes other than showing images.
If an img
element is being used for purposes other
than showing an image, e.g., as part of a service to count page
views, use an empty alt
attribute.
img
element used to collect web page statistics.
The alt
attribute is empty as the image has no meaning.
<img src="https://stats.example.com/count?site=w3.org" width="0" height="0" alt="">
It is recommended for the example use above the width
and height
attributes be set to zero.
alt
attribute is empty as the image has no meaning.
<img src="spacer.gif" width="10" height="10" alt="">
It is recommended that CSS be used to position content instead of img
elements.
4.7.5.1.18. Icon Images
An icon is usually a simple picture representing a program, action, data file or a concept. Icons are intended to help users of visual browsers to recognize features at a glance.
Use an empty alt
attribute when an icon is supplemental to
text conveying the same meaning.
alt
text.
<a href="home.html"><img src="home.gif" width="15" height="15" alt="">Home</a>
Where images are used in this way, it would also be appropriate to add the image using CSS.
#home:before { content: url(home.png); }
<a href="home.html" id="home">Home</a>
img
element is given an empty alt
attribute.
Warning! Your session is about to expire.
<p> <img src="warning.png" width="38" height="34" alt=""> <strong>Warning!</strong> Your session is about to expire. </p>
When an icon conveys additional information not available in text, provide a text alternative.
Your session is about to expire.
<p> <img src="warning.png" width="38" height="34" alt="Warning!"> <strong>Your session is about to expire.</strong> </p>
4.7.5.1.19. Logos, insignia, flags, or emblems
Many pages include logos, insignia, flags, or emblems, which stand for a company, organization, project, band, software package, country, or other entity. What can be considered as an appropriate text alternative depends upon, like all images, the context in which the image is being used and what function it serves in the given context.
If a logo is the sole content of a link, provide a brief description of the link target in the alt
attribute.
<a href="https://w3c.github.io/html/"><img src="HTML5_Logo.png" alt="HTML 5.1 specification"></a>
If a logo is being used to represent the entity, e.g., as a page heading, provide the name of the entity being represented by the logo as the text alternative.
and other developer resources
<h2> <img src="images/webplatform.png" alt="WebPlatform.org"> and other developer resources </h2>
The text alternative in the example above could also include the word "logo" to describe the
type of image content. If so, it is suggested that square brackets be used to delineate this
information: alt="[logo] WebPlatform.org"
.
If a logo is being used next to the name of the what that it represents, then the logo is
supplemental. Include an empty alt
attribute as the text alternative is already
provided.
WebPlatform.org
<img src="images/webplatform1.png" alt=""> WebPlatform.org
If the logo is used alongside text discussing the subject or entity the logo represents, then provide a text alternative which describes the logo.
HTML is a language for structuring and presenting content for the World Wide Web, a core technology of the Internet. HTML5 is the latest revision of the HTML specification which was originally created in 1990. Its core aims are to improve the language with support for the latest multimedia while keeping it easily readable by humans and consistently understood by computers and devices.
<p> <img src="HTML5_Logo.png" alt="HTML5 logo: Shaped like a shield with the text 'HTML' above and the numeral '5' prominent on the face of the shield."> </p> <p> <strong>HTML</strong> is a language for structuring and presenting content... </p>
4.7.5.1.20. CAPTCHA Images
CAPTCHA stands for "Completely Automated Public Turing test to tell Computers and Humans Apart". CAPTCHA images are used for security purposes to confirm that content is being accessed by a person rather than a computer. This authentication is done through visual verification of an image. CAPTCHA typically presents an image with characters or words in it that the user is to re-type. The image is usually distorted and has some noise applied to it to make the characters difficult to read.
To improve the accessibility of CAPTCHA provide text alternatives that identify and describe the purpose of the image, and provide alternative forms of the CAPTCHA using output modes for different types of sensory perception. For instance provide an audio alternative along with the visual image. Place the audio option right next to the visual one. This helps but is still problematic for people without sound cards, the deaf-blind, and some people with limited hearing. Another method is to include a form that asks a question along with the visual image. This helps but can be problematic for people with cognitive impairments.
It is strongly recommended that alternatives to CAPTCHA be used, as all forms of CAPTCHA introduce unacceptable barriers to entry for users with disabilities. Further information is available in Inaccessibility of CAPTCHA.
alt
attribute provides instructions for a user in the case where she cannot
access the image content.
Example code:
<img src="captcha.png" alt="If you cannot view this image an audio challenge is provided."> <!-- audio CAPTCHA option that allows the user to listen and type the word --> <!-- form that asks a question -->
4.7.5.1.21. An image in a picture
element
The picture
element and any source
elements it contains have no semantics for users,
only the img
element or its text alternative is displayed to users. Provide a text alternative for an img
element without regard to it being within a picture
element. Refer to Requirements for providing text to act as an alternative for images for more information on how to provide
useful alt
text for images.
Art directed images that rely on picture
need to depict
the same content (irrespective of size, pixel density, or any other discriminating
factor). Therefore the appropriate text alternative for an image will always be the
same irrespective of which source file ends up being chosen by the browser.
<h2>Is it a ghost?</h2> <picture> <source media="(min-width: 32em)" srcset="large.jpg"> <img src="small.jpg" alt="Reflection of a girl’s face in a train window."> </picture>
The large and small versions (both versions are displayed for demonstration purposes) of
the image portray the same scene: Reflection of a girls face in a train window,
while the small version (displayed on smaller screens) is cropped, this does not effect the subject matter
or the appropriateness of the alt
text.
4.7.5.1.22. Guidance for markup generators
Wherever possible, markup generators (such as WYSIWYG authoring tools) should obtain alternative text from their users. However, it is recognized that in many cases obtaining alternative text from users may not be possible.
For images that are the sole contents of links, markup generators should examine the link target to determine the title of the target, or the URL of the target, and use information obtained in this manner as the alternative text.
For images that have captions, markup generators should use the figure
and figcaption
elements to provide the image’s caption.
As a last resort, implementors must omit the alt attribute altogether. [ATAG20]
image
element’s alt
attribute to the empty string means the image in
question provides no essential information. Assistive technology, such as screen readers,
will typically ignore the presence of such an image, as ignoring it will not stop the user
from understanding the document, and saves the user time.
In the following example, the alt
is set to the empty string, so it will be silently
ignored by screen readers.
<img src="bar-graph.png" alt="">
Unless the image is truly decorative, implementors setting an image’s alt
attribute to the empty string is not recommended. An empty string will indicate to content
management software and accessibility checking software that the image does not need
alternative text, and therefore they will not flag the image in question as a potential
problem, meaning it is less likely to be repaired.
In contrast, if an image is vital to understanding the contents of a document, implementors
should be aware that an image without an alt
attribute is preferable to an alt
attribute set to the empty string.
Taking the previous example and omitting the alt
attribute, as follows:
<img src="bar-graph.png">
will allow screen readers to announce the filename of the image (bar-graph.png). Doing so may allow the user to try to learn what the image conveys, e.g. from its announced filename, asking a friend to describe it, running Optical Character Recognition to see if the image contains text, or submitting it to an image search to get more information, etc.
(None of these approaches are as good as giving the image correct alternative text).
Markup generators may specify a generator-unable-to-provide-required-alt
attribute on img
elements for which they have been unable to obtain a text alternative and
for which they have therefore omitted the alt
attribute. The value of this
attribute must be the empty string. Documents containing such attributes are not conforming,
but conformance checkers will silently ignore this error.
This is intended to avoid markup generators from being pressured into replacing the error of
omitting the alt
attribute with the even more egregious error of providing phony
text alternatives, because state-of-the-art automated conformance checkers cannot distinguish
phony text alternatives from correct text alternatives.
Markup generators should generally avoid using the image’s own file name as the text alternative. Similarly, markup generators should avoid generating text alternatives from any content that will be equally available to presentation user agents (e.g., Web browsers).
This is because once a page is generated, it will typically not be updated, whereas the browsers that later read the page can be updated by the user, therefore the browser is likely to have more up-to-date and finely-tuned heuristics than the markup generator did when generating the page.
4.7.5.1.23. Guidance for conformance checkers
A conformance checker must report the lack of an alt
attribute as an error unless one
of the conditions listed below applies:
-
The
img
element is in afigure
element that satisfies the conditions described above. -
The
img
element has a (non-conforming)generator-unable-to-provide-required-alt
attribute whose value is the empty string. A conformance checker that is not reporting the lack of analt
attribute as an error must also not report the presence of the emptygenerator-unable-to-provide-required-alt
attribute as an error. (This case does not represent a case where the document is conforming, only that the generator could not determine appropriate alternative text — validators are not required to show an error in this case, because such an error might encourage markup generators to include bogus alternative text purely in an attempt to silence validators. Naturally, conformance checkers may report the lack of analt
attribute as an error even in the presence of thegenerator-unable-to-provide-required-alt
attribute; for example, there could be a user option to report all conformance errors even those that might be the more or less inevitable result of using a markup generator.)
4.7.6. The iframe
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- Interactive content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- Text that conforms to the requirements given in the prose.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
src
- Address of the resourcesrcdoc
- A document to render in theiframe
name
- Name of nested browsing contextsandbox
- Security rules for nested contentallowfullscreen
- Whether to allow theiframe
’s contents to userequestFullscreen()
allowpaymentrequest
- Whether theiframe
’s contents are allowed to use thePaymentRequest
interface to make payment requestsallowusermedia
- Whether to allow theiframe
's browsing context to usegetUserMedia()
width
- Horizontal dimensionheight
- Vertical dimensionreferrerpolicy
- Referrer policy for fetches initiated by the element - Allowed ARIA role attribute values:
-
application
,document
orimg
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLIFrameElement
: HTMLElement { attribute DOMString src; attribute DOMString srcdoc; attribute DOMString name; [SameObject, PutForwards=value] readonly attribute DOMTokenList sandbox; attribute boolean allowFullscreen; attribute boolean allowPaymentRequest; attribute boolean allowUserMedia; attribute DOMString width; attribute DOMString height; attribute DOMString referrerPolicy; readonly attribute Document? contentDocument; readonly attribute WindowProxy? contentWindow; };
The iframe
element represents a nested browsing context.
The src
attribute gives the address of a page
that the nested browsing context is to contain. The attribute, if present, must be a valid non-empty URL potentially surrounded by spaces.
The srcdoc
attribute gives the content of
the page that the nested browsing context is to contain. The value of the attribute
is the source of an iframe
srcdoc
document.
The srcdoc
attribute, if present, must have a value
using the HTML syntax that consists of the following syntactic components, in the
given order:
- Any number of comments and space characters.
-
Optionally, a DOCTYPE. Any DOCTYPE will be ignored, and it will be parsed as if it had
<!DOCTYPE html>
- Any number of comments and space characters.
- The document element, in the form of an
html
element. - Any number of comments and space characters.
srcdoc
attribute in conjunction
with the sandbox
attributes described below to provide users of user
agents that support this feature with an extra layer of protection from script injection in the
blog post comments:
<article> <h1>I got my own magazine!</h1> <p>After much effort, I’ve finally found a publisher, and so now I have my own magazine! Isn’t that awesome?! The first issue will come out in September, and we have articles about getting food, and about getting in boxes, it’s going to be great!</p> <footer> <p>Written by <a href="/users/cap">cap</a>, 1 hour ago. </footer> <article> <footer>Thirteen minutes ago, <a href="/users/ch">ch</a> wrote:</footer> <iframe sandbox srcdoc="<p>did you get a cover picture yet?"></iframe> </article> <article> <footer>Nine minutes ago, <a href="/users/cap">cap</a> wrote:</footer> <iframe sandbox srcdoc="<p>Yeah, you can see it <a href="/gallery?mode=cover&amp;page=1">in my gallery</a>."></iframe> </article> <article> <footer>Five minutes ago, <a href="/users/ch">ch</a> wrote:</footer> <iframe sandbox srcdoc="<p>hey that’s earl’s table. <p>you should get earl&amp;me on the next cover."></iframe> </article>
Notice the way that quotes have to be escaped (otherwise the srcdoc
attribute would end prematurely), and the way raw
ampersands (e.g., in URLs or in prose) mentioned in the sandboxed content have to be doubly escaped — once so that the ampersand is preserved when originally parsing
the srcdoc
attribute, and once more to prevent the
ampersand from being misinterpreted when parsing the sandboxed content.
Furthermore, notice that since the DOCTYPE is optional in iframe
srcdoc
documents, and the html
, head
, and body
elements have optional
start and end tags, and the title
element is also optional in iframe
srcdoc
documents, the markup in a srcdoc
attribute can be
relatively succinct despite representing an entire document, since only the contents of the body
element need appear literally in the syntax. The other elements are still
present, but only by implication.
In the HTML syntax, authors need only remember to use U+0022
QUOTATION MARK characters (") to wrap the attribute contents and then to escape all U+0026
AMPERSAND (&) and U+0022 QUOTATION MARK (") characters, and to specify the sandbox
attribute, to ensure safe embedding of content.
Due to restrictions of the XHTML syntax, in XML the U+003C LESS-THAN SIGN character (<) needs to be escaped as well. In order to prevent attribute-value normalization, some of XML’s white space characters — specifically U+0009 CHARACTER TABULATION (tab), U+000A LINE FEED (LF), and U+000D CARRIAGE RETURN (CR) — also need to be escaped. [XML]
If the src
attribute and the srcdoc
attribute are both specified together, the srcdoc
attribute takes priority. This allows authors to provide
a fallback URL for legacy user agents that do not support the srcdoc
attribute.
When an iframe
element is inserted into a document that has a browsing context, the user agent must create a nested browsing context, and
then process the iframe
attributes for the "first time".
When an iframe
element is removed from a document, the user agent must discard the nested browsing context, if any.
This happens without any unload
events firing
(the nested browsing context and its Document
are discarded, not unloaded).
Whenever an iframe
element with a nested browsing context has its srcdoc
attribute set, changed, or removed, the user agent
must process the iframe
attributes.
Similarly, whenever an iframe
element with a nested browsing context but with no srcdoc
attribute specified has its src
attribute set, changed, or removed, the user agent must process the iframe
attributes.
When the user agent is to process the iframe
attributes, it must run
the first appropriate steps from the following list:
- If the
srcdoc
attribute is specified -
Navigate the element’s child browsing context to a new response whose url list consists of about:srcdoc, header list consists of
Content-Type
/text/html
, body is the value of the attribute, CSP list is the CSP list of theiframe
element’s node document, and HTTPS state is the HTTPS state of theiframe
element’s node document.The resulting
Document
must be considered aniframe
srcdoc
document. - Otherwise, if the element has no
src
attribute specified, and the user agent is processing theiframe
’s attributes for the "first time" -
Queue a task to run the iframe load event steps.
The task source for this task is the DOM manipulation task source.
- Otherwise
- Run the otherwise steps for iframe or frame elements.
The otherwise steps for iframe or frame elements are as follows:
1: If the element has no src
attribute specified, or its
value is the empty string, let url be the URL "about:blank
".
Otherwise, parse the value of the src
attribute, relative to the element’s node document.
If that is not successful, then let url be the URL "about:blank
". Otherwise, let url be the resulting URL record.
-
If there exists an ancestor browsing context whose active document’s URL, ignoring fragments, is equal to url, then abort these steps.
-
Let resource be a new request whose url is URL and whose referrer policy is the current state of the element’s
referrerpolicy
content attribute. -
Navigate the element’s child browsing context to resource.
Furthermore, if the active document of the element’s child browsing context before such a navigation was not completely loaded at the time of the new navigation, then the navigation must be completed with replacement enabled.
Similarly, if the child browsing context’s session history contained only one Document
when the process the iframe
attributes algorithm was invoked, and
that was the about:blank
Document
created when the child browsing context was created, then any navigation required of the user agent in that algorithm must be
completed with replacement enabled.
When a Document
in an iframe
is marked as completely loaded, the user
agent must run the iframe load event steps.
A load
event is also fired at the iframe
element when it is created if no other
data is loaded in it.
Each Document
has an iframe load in progress flag and a mute iframe load flag. When a Document
is created, these flags must be unset for that Document
.
The iframe load event steps are as follows:
- Let child document be the active document of the
iframe
element’s nested browsing context. - If child document has its mute iframe load flag set, abort these steps.
- Set child document’s iframe load in progress flag.
- Fire a simple event named
load
at theiframe
element. - Unset child document’s iframe load in progress flag.
This, in conjunction with scripting, can be used to probe the URL space of the local network’s HTTP servers. User agents may implement cross-origin access control policies that are stricter than those described above to mitigate this attack, but unfortunately such policies are typically not compatible with existing Web content.
When the iframe
’s browsing context’s active document is
not ready for post-load tasks, and when anything in the iframe
is delaying the load event of the iframe
’s browsing context’s active document, and when the iframe
’s browsing context is in the delaying load
events
mode, the iframe
must delay the load event of its document.
If, during the handling of the load
event, the browsing context in the iframe
is again navigated, that will further delay the load event.
If, when the element is created, the srcdoc
attribute is not set, and the src
attribute is either also not set or set but its value cannot be parsed, the browsing context will remain at the initial about:blank
page.
If the user navigates away from this page, the iframe
’s corresponding WindowProxy
object will proxy new Window
objects for new Document
objects, but the src
attribute will not change.
The name
attribute, if present, must be a valid browsing context name. The given value is used to name the nested browsing context.
When the browsing context is created, if the attribute is present, the browsing context name must be set to the value of this attribute;
otherwise, the browsing context name must be set to the empty string.
Whenever the name
attribute is set, the nested browsing context’s name must be changed to
the new value. If the attribute is removed, the browsing context name must be set to
the empty string.
The sandbox
attribute, when specified,
enables a set of extra restrictions on any content hosted by the iframe
. Its value
must be an unordered set of unique space-separated tokens that are ASCII
case-insensitive. The allowed values are allow-forms
, allow-pointer-lock
, allow-popups
, allow-presentation
, allow-same-origin
, allow-scripts
, and allow-top-navigation
.
When the attribute is set, the content is treated as being from a unique origin,
forms, scripts, and various potentially annoying APIs are disabled, links are prevented from
targeting other browsing contexts, and plugins are secured.
The allow-same-origin
keyword causes
the content to be treated as being from its real origin instead of forcing it into a unique
origin; the allow-top-navigation
keyword allows the content to navigate its top-level browsing context;
and the allow-forms
, allow-pointer-lock
, allow-popups
, allow-presentation
and allow-scripts
keywords re-enable forms, the
pointer lock API, popups, the presentation API, and scripts respectively. [POINTERLOCK] [PRESENTATION-API]
Setting both the allow-scripts
and allow-same-origin
keywords together when the
embedded page has the same origin as the page containing the iframe
allows the embedded page to simply remove the sandbox
attribute and then reload itself, effectively breaking out of the sandbox altogether.
These flags only take effect when the nested browsing context of
the iframe
is navigated. Removing them, or removing the
entire sandbox
attribute, has no effect on an
already-loaded page.
Potentially hostile files should not be served from the same server as the file
containing the iframe
element. Sandboxing hostile content is of minimal help if an
attacker can convince the user to just visit the hostile content directly, rather than in the iframe
. To limit the damage that can be caused by hostile HTML content, it should be
served from a separate dedicated domain. Using a different domain ensures that scripts in the
files are unable to attack the site, even if the user is tricked into visiting those pages
directly, without the protection of the sandbox
attribute.
When an iframe
element with a sandbox
attribute has its nested browsing context created (before the initial about:blank
Document
is created), and when an iframe
element’s sandbox
attribute is set or changed while it
has a nested browsing context, the user agent must parse the sandboxing directive using the attribute’s value as the input, the iframe
element’s nested browsing context’s iframe
sandboxing flag set as the output, and, if the iframe
has an allowfullscreen
attribute, the allow fullscreen flag.
When an iframe
element’s sandbox
attribute is removed while it has a nested browsing context, the user agent must
empty the iframe
element’s nested browsing context’s iframe
sandboxing flag set as the output.
<p>We’re not scared of you! Here is your content, unedited:</p> <iframe title="Example iframe" sandbox src="https://usercontent.example.net/getusercontent.cgi?id=12345"></iframe>
It is important to use a separate domain so that if the attacker convinces the user to visit that page directly, the page doesn’t run in the context of the site’s origin, which would make the user vulnerable to any attack found in the page.
<iframe title="Maps" sandbox="allow-same-origin allow-forms allow-scripts" src="https://maps.example.com/embedded.html"></iframe>;
<iframe title="Example iframe" sandbox="allow-same-origin allow-forms" src="B"></iframe>
Suppose that file B contained an iframe also:
<iframe title="Example iframe" sandbox="allow-scripts" src="C"></iframe>
Further, suppose that file C contained a link:
<a href="D">Link</a>
For this example, suppose all the files were served as text/html
.
Page C in this scenario has all the sandboxing flags set. Scripts are disabled, because the iframe
in A has scripts disabled, and this overrides the allow-scripts
keyword set on the iframe
in B. Forms are also disabled, because the inner iframe
(in B)
does not have the allow-forms
keyword
set.
Suppose now that a script in A removes all the sandbox
attributes in A and B.
This would change nothing immediately. If the user clicked the link in C, loading page D into the iframe
in B, page D would now act as if the iframe
in B had the allow-same-origin
and allow-forms
keywords set, because that was the
state of the nested browsing context in the iframe
in A when page B was
loaded.
Generally speaking, dynamically removing or changing the sandbox
attribute is ill-advised, because it can make it quite
hard to reason about what will be allowed and what will not.
The allowfullscreen
attribute is a boolean attribute. When specified, it indicates that Document
objects in
the iframe
element’s browsing context are to be allowed to use requestFullscreen()
(if it’s not blocked for other
reasons, e.g., there is another ancestor iframe
without this attribute set).
iframe
is used to embed a player from a video site. The allowfullscreen
attribute is needed to enable the
player to show its video fullscreen.
<p>Check out my new video!</p> <iframe title="Video" src="https://video.example.com/embed?id=123456" allowfullscreen></iframe>
The allowpaymentrequest
attribute is a boolean attribute. When specified, it indicates that Document
objects in the iframe
element’s browsing context are to be allowed to use the PaymentRequest
interface
to make payment requests.
The allowusermedia
attribute
is a boolean attribute. When specified, it indicates that Document
objects
in the iframe
element’s browsing context are to be allowed to
use getUserMedia()
(if it’s not blocked for other reasons, e.g. there
is another ancestor iframe
without this attribute set).
To determine whether a Document
object document is allowed to use the feature indicated by attribute name allowattribute, run these steps:
-
If document has no browsing context, then return false.
-
If document’s browsing context is a top-level browsing context, then return true.
-
If document’s browsing context has a browsing context container that is an
iframe
element with an allowattribute attribute specified, and whose node document is allowed to use the feature indicated by allowattribute, then return true. -
Return false.
The iframe
element supports dimension attributes for cases where the
embedded content has specific dimensions (e.g., ad units have well-defined dimensions).
An iframe
element never has fallback content, as it will always
create a nested browsing context, regardless of whether the specified initial
contents are successfully used.
The referrerpolicy
attribute is a referrer policy attribute.
Its purpose is to set the referrer policy used when processing the iframe
attributes. [REFERRERPOLICY]
Descendants of iframe
elements represent nothing. (In legacy user agents that do
not support iframe
elements, the contents would be parsed as markup that could act as
fallback content.)
When used in HTML documents, the allowed content model
of iframe
elements is text, except that invoking the HTML fragment parsing
algorithm with the iframe
element as the context element and the text contents as
the input must result in a list of nodes that are all phrasing content,
with no parse errors having occurred, with no script
elements being anywhere in the list or as descendants of elements in the list, and with all the
elements in the list (including their descendants) being themselves conforming.
The iframe
element must be empty in XML documents.
The HTML parser treats markup inside iframe
elements as
text.
The IDL attributes src
, srcdoc
, name
, and sandbox
must reflect the respective
content attributes of the same name.
The supported tokens for sandbox
's DOMTokenList
are the
allowed values defined in the sandbox
attribute and supported by the user agent.
The allowFullscreen
IDL attribute
must reflect the allowfullscreen
content attribute.
The allowPaymentRequest
IDL
attribute must reflect the allowpaymentrequest
content attribute.
The allowUserMedia
IDL
attribute must reflect the allowusermedia
content attribute.
The referrerPolicy
IDL attribute must reflect the referrerpolicy
content attribute, limited to only known values.
The contentDocument
IDL attribute must
return the Document
object of the active document of the iframe
element’s nested browsing context, if any and if its origin is the same origin-domain as the origin specified by the incumbent settings object, or null otherwise.
The contentWindow
IDL attribute must
return the WindowProxy
object of the iframe
element’s nested browsing context, if any, or null otherwise.
iframe
to include advertising from an
advertising broker:
<iframe title="Advert" src="https://ads.example.com/?customerid=123456&format=banner" width="468" height="60"></iframe>
4.7.7. The embed
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- Interactive content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
src
- Address of the resourcetype
- Type of embedded resourcewidth
- Horizontal dimensionheight
- Vertical dimension- Any other attribute that has no namespace (see prose).
- Allowed ARIA role attribute values:
-
application
,document
,img
,none
orpresentation
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLEmbedElement
: HTMLElement { attribute DOMString src; attribute DOMString type; attribute DOMString width; attribute DOMString height; legacycaller any (any...arguments
); };Depending on the type of content instantiated by the
embed
element, the node may also support other interfaces.
The embed
element provides an integration point for an external (typically
non-HTML) application or interactive content.
The src
attribute gives the address of the
resource being embedded. The attribute, if present, must contain a valid non-empty URL
potentially surrounded by spaces.
The type
attribute, if present, gives the MIME type by which the plugin to instantiate is selected. The value must be a valid mime type. If both the type
attribute and
the src
attribute are present, then the type
attribute must specify the same type as the explicit Content-Type metadata of the resource given by the src
attribute.
While any of the following conditions are occurring, any plugin instantiated for
the element must be removed, and the embed
element represents nothing:
- The element has neither a
src
attribute nor atype
attribute. - The element has a media element ancestor.
- The element has an ancestor
object
element that is not showing its fallback content.
An embed
element is said to be potentially
active when the following conditions are all met simultaneously:
- The element is in a
Document
or was in aDocument
the last time the event loop reached step 1. - The element’s node document is fully active.
- The element has either a
src
attribute set or atype
attribute set (or both). - The element’s
src
attribute is either absent or its value is not the empty string. - The element is not a descendant of a media element.
- The element is not a descendant of an
object
element that is not showing its fallback content. - The element is being rendered, or was being rendered the last time the event loop reached step 1.
Whenever an embed
element that was not potentially active becomes potentially active, and whenever a potentially active embed
element that is
remaining potentially active and has its src
attribute set, changed, or removed or its type
attribute set, changed, or removed, the user agent must queue a task using the embed task source to run the embed
element setup steps.
The embed
element setup steps are as follows:
- If another task has since been queued to run the
embed
element setup steps for this element, then abort these steps. -
- If the element has a
src
attribute set -
The user agent must parse the value of the element’s
src
attribute, relative to the element. If that is successful, the user agent should run these steps:- Let request be a new request whose URL is the resulting URL string, client is the element’s node
document’s
Window
object’s environment settings object, destination is "unknown
", omit-Origin
-header flag is set if the element doesn’t have a browsing context scope origin, credentials mode is "include
", and whose use-URL-credentials flag is set. - Fetch request.
The task that is queued by the networking task source once the resource has been fetched must run the following steps:
- If another task has since been queued to run the
embed
element setup steps for this element, then abort these steps. -
Determine the type of the content being embedded, as follows (stopping at the first substep that determines the type):
- If the element has a
type
attribute, and that attribute’s value is a type that a plugin supports, then the value of thetype
attribute is the content’s type. -
Otherwise, if applying the URL parser algorithm to the URL of the specified resource (after any redirects) results in a URL record whose path component matches a pattern that a plugin supports, then the content’s type is the type that the plugin can handle.
For example, a plugin might say that it can handle resources with path components that end with the four character string "
.swf
". - Otherwise, if the specified resource has explicit Content-Type metadata, then that is the content’s type.
- Otherwise, the content has no type and there can be no appropriate plugin for it.
- If the element has a
-
If the previous step determined that the content’s type is
image/svg+xml
, then run the following substeps:- If the
embed
element is not associated with a nested browsing context, associate the element with a newly created nested browsing context, and, if the element has aname
attribute, set the browsing context name of the element’s nested browsing context to the value of this attribute. - Navigate the nested browsing context to
the fetched resource, with replacement enabled, and with the
embed
element’s node document’s browsing context as the source browsing context. (Thesrc
attribute of theembed
element doesn’t get updated if the browsing context gets further navigated to other locations.) - The
embed
element now represents its associated nested browsing context.
- If the
-
Otherwise, find and instantiate an appropriate plugin based on the content’s type, and hand that plugin the content of the resource, replacing any previously instantiated plugin for the element. The
embed
element now represents this plugin instance. - Once the resource or plugin has completely loaded, queue a task to fire a simple event named
load
at the element.
Whether the resource is fetched successfully or not (e.g., whether the response status was an ok status) must be ignored when determining the content’s type and when handing the resource to the plugin.
This allows servers to return data for plugins even with error responses (e.g., HTTP 500 Internal Server Error codes can still contain plugin data).
Fetching the resource must delay the load event of the element’s node document.
- Let request be a new request whose URL is the resulting URL string, client is the element’s node
document’s
- If the element has no
src
attribute set -
The user agent should find and instantiate an appropriate plugin based on the value of the
type
attribute. Theembed
element now represents this plugin instance.Once the plugin is completely loaded, queue a task to fire a simple event named
load
at the element.
- If the element has a
The embed
element has no fallback content. If the user agent can’t
find a suitable plugin when attempting to find and instantiate one for the algorithm above, then
the user agent must use a default plugin. This default could be as simple as saying "Unsupported
Format".
Whenever an embed
element that was potentially
active stops being potentially active, any plugin that had been instantiated for that element must be unloaded.
When a plugin is to be instantiated but it cannot be secured and the sandboxed plugins browsing context
flag is set on the embed
element’s node document’s active
sandboxing flag set, then the user agent must not instantiate the plugin, and
must instead render the embed
element in a manner that conveys that the plugin was disabled. The user agent may offer the user the option to override the
sandbox and instantiate the plugin anyway; if the user invokes such an option, the
user agent must act as if the conditions above did not apply for the purposes of this element.
Plugins that cannot be secured are disabled in sandboxed browsing contexts because they might not honor the restrictions imposed by the sandbox (e.g., they might allow scripting even when scripting in the sandbox is disabled). User agents should convey the danger of overriding the sandbox to the user if an option to do so is provided.
When an embed
element represents a nested browsing context: if the embed
element’s nested browsing context’s active document is not ready for post-load tasks, and when anything is delaying the load event of the embed
element’s browsing context’s active document, and when the embed
element’s browsing context is in the delaying load
events mode, the embed
must delay the load event of its
document.
The task source for the tasks mentioned in this section is the DOM manipulation task source.
Any namespace-less attribute other than name
, align
, hspace
, and vspace
may be
specified on the embed
element, so long as its name is XML-compatible and contains no uppercase ASCII letters. These attributes are then passed as
parameters to the plugin.
All attributes in HTML documents get lowercased automatically, so the restriction on uppercase letters doesn’t affect such documents.
The four exceptions are to exclude legacy attributes that have side-effects beyond just sending parameters to the plugin.
The user agent should pass the names and values of all the attributes of the embed
element that have no namespace to the plugin used, when one is instantiated.
The HTMLEmbedElement
object representing the element must expose the scriptable
interface of the plugin instantiated for the embed
element, if any. At a
minimum, this interface must implement the legacy caller
operation. (It is suggested that the default behavior of this legacy caller operation, e.g.,
the behavior of the default plugin’s legacy caller operation, be to throw a NotSupportedError
exception.)
The embed
element supports dimension attributes.
The IDL attributes src
and type
each must reflect the
respective content attributes of the same name.
<embed src="catgame.swf">
If the user does not have the plugin (for example if the plugin vendor doesn’t support the user’s platform), then the user will be unable to use the resource.
To pass the plugin a parameter "quality" with the value "high", an attribute can be specified:
<embed src="catgame.swf" quality="high">
This would be equivalent to the following, when using an object
element
instead:
<object data="catgame.swf"> <param name="quality" value="high"> </object>
4.7.8. The object
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- listed, submittable, and reassociateable form-associated element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- Zero or more
param
elements, then, transparent. - Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes
data
- Address of the resourcetype
- Type of embedded resourcetypemustmatch
- Whether thetype
attribute and the Content-Type value need to match for the resource to be usedname
- Name of nested browsing contextform
- Associates the control with aform
elementwidth
- Horizontal dimensionheight
- Vertical dimension - Allowed ARIA role attribute values:
-
application
,document
orimg
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLObjectElement
: HTMLElement { attribute DOMString data; attribute DOMString type; attribute boolean typeMustMatch; attribute DOMString name; readonly attribute HTMLFormElement? form; attribute DOMString width; attribute DOMString height; readonly attribute Document? contentDocument; readonly attribute WindowProxy? contentWindow; readonly attribute booleanwillValidate
; readonly attribute ValidityStatevalidity
; readonly attribute DOMStringvalidationMessage
; booleancheckValidity
(); booleanreportValidity
(); voidsetCustomValidity
(DOMStringerror
); legacycaller any (any...arguments
); };Depending on the type of content instantiated by the
object
element, the node also supports other interfaces.
The object
element can represent an external resource, which, depending on the
type of the resource, will either be treated as an image, as a nested browsing context, or as an external resource to be processed by a plugin.
The data
attribute, if present, specifies the
address of the resource. If present, the attribute must be a valid non-empty URL potentially
surrounded by spaces.
Authors who reference resources from other origins that they do not trust are urged to use the typemustmatch
attribute defined below. Without that
attribute, it is possible in certain cases for an attacker on the remote host to use the plugin
mechanism to run arbitrary scripts, even if the author has used features such as the Flash
"allowScriptAccess" parameter.
The type
attribute, if present, specifies the
type of the resource. If present, the attribute must be a valid mime type.
At least one of either the data
attribute or the type
attribute must be present.
The typemustmatch
attribute is a boolean attribute whose presence indicates that the resource specified by the data
attribute is only to be used if the value of the type
attribute and the Content-Type of the
aforementioned resource match.
The typemustmatch
attribute must not be
specified unless both the data
attribute and the type
attribute are present.
The name
attribute, if present, must be a valid browsing context name. The value is used to name the nested browsing context created for the object, if applicable.
Clicking the link "Check out the new icon" in the example below would cause the new.svg to be loaded in place of the original old.svg.
<p> <object data="old.svg" name="svgobject">A boring icon</object> </p> <p> <a href="new.svg" target="svgobject">Check out the new icon</a>! </p>
If a nested browsing context is not created, e.g. for security reasons or due to
incorrect implementation of the name3
attribute, the target
attribute
in this example will instead create a new browsing context - typically a new tab -
whose browsing context name is the attribute’s value, and the resource that the link
references will be loaded there.
Whenever one of the following conditions occur:
- the element is created,
- the element is popped off the stack of open elements of an HTML parser or XML parser,
- the element is not on the stack of open elements of an HTML parser or XML parser, and it is either inserted into a document or removed from a document,
- the element’s node document changes whether it is fully active,
- one of the element’s ancestor
object
elements changes to or from showing its fallback content, - the element’s
classid
attribute is set, changed, or removed, - the element’s
classid
attribute is not present, and itsdata
attribute is set, changed, or removed, - neither the element’s
classid
attribute nor itsdata
attribute are present, and itstype
attribute is set, changed, or removed, - the element changes from being rendered to not being rendered, or vice versa,
...the user agent must queue a task to run the following steps to (re)determine
what the object
element represents. This task being queued or actively running must delay the load
event of the element’s node document.
-
If the user has indicated a preference that this
object
element’s fallback content be shown instead of the element’s usual behavior, then jump to the step below labeled fallback.For example, a user could ask for the element’s fallback content to be shown because that content uses a format that the user finds more accessible.
-
If the element has an ancestor media element, or has an ancestor
object
element that is not showing its fallback content, or if the element is not in aDocument
with a browsing context, or if the element’s node document is not fully active, or if the element is still in the stack of open elements of an HTML parser or XML parser, or if the element is not being rendered, or if the Should element be blocked a priori by Content Security Policy? algorithm returns "Blocked" when executed on the element, then jump to the step below labeled fallback. [CSP3]. -
If the
classid
attribute is present, and has a value that isn’t the empty string, then: if the user agent can find a plugin suitable according to the value of theclassid
attribute, and either plugins aren’t being sandboxed or that plugin can be secured, then that plugin should be used, and the value of thedata
attribute, if any, should be passed to the plugin. If no suitable plugin can be found, or if the plugin reports an error, jump to the step below labeled fallback. -
If the
data
attribute is present and its value is not the empty string, then:- If the
type
attribute is present and its value is not a type that the user agent supports, and is not a type that the user agent can find a plugin for, then the user agent may jump to the step below labeled fallback without fetching the content to examine its real type. - Parse the URL specified by the
data
attribute, relative to the element. - If that failed, fire a simple event named
error
at the element, then jump to the step below labeled fallback. - Let request be a new request whose URL is the resulting URL string, client is the element’s node
document’s
Window
object’s environment settings object, destination is "unknown
", omit-Origin
-header flag is set if the element doesn’t have a browsing context scope origin, credentials mode is "include
", and whose use-URL-credentials flag is set. -
Fetch request.
Fetching the resource must delay the load event of the element’s node document until the task that is queued by the networking task source once the resource has been fetched (defined next) has been run.
- If the resource is not yet available (e.g., because the resource was not available in the cache, so that loading the resource required making a request over the network), then jump to the step below labeled fallback. The task that is queued by the networking task source once the resource is available must restart this algorithm from this step. Resources can load incrementally; user agents may opt to consider a resource "available" whenever enough data has been obtained to begin processing the resource.
- If the load failed (e.g., there was an HTTP 404 error, there was a DNS error), fire
a simple event named
error
at the element, then jump to the step below labeled fallback. -
Determine the resource type, as follows:
-
Let the resource type be unknown.
-
If the
object
element has atype
attribute and atypemustmatch
attribute, and the resource has associated Content-Type metadata, and the type specified in the resource’s Content-Type metadata is an ASCII case-insensitive match for the value of the element’stype
attribute, then let resource type be that type and jump to the step below labeled handler. -
If the
object
element has atypemustmatch
attribute, jump to the step below labeled handler. -
If the user agent is configured to strictly obey Content-Type headers for this resource, and the resource has associated Content-Type metadata, then let the resource type be the type specified in the resource’s Content-Type metadata, and jump to the step below labeled handler.
This can introduce a vulnerability, wherein a site is trying to embed a resource that uses a particular plugin, but the remote site overrides that and instead furnishes the user agent with a resource that triggers a different plugin with different security characteristics.
-
If there is a
type
attribute present on theobject
element, and that attribute’s value is not a type that the user agent supports, but it is a type that a plugin supports, then let the resource type be the type specified in thattype
attribute, and jump to the step below labeled handler. -
Run the appropriate set of steps from the following list:
- If the resource has associated Content-Type metadata
-
-
Let binary be false.
-
If the type specified in the resource’s Content-Type metadata is "
text/plain
", and the result of applying the rules for distinguishing if a resource is text or binary to the resource is that the resource is nottext/plain
, then set binary to true. -
If the type specified in the resource’s Content-Type metadata is "
application/octet-stream
", then set binary to true. -
If binary is false, then let the resource type be the type specified in the resource’s Content-Type metadata, and jump to the step below labeled handler.
-
If there is a
type
attribute present on theobject
element, and its value is notapplication/octet-stream
, then run the following steps:-
If the attribute’s value is a type that a plugin supports, or the attribute’s value is a type that starts with "
image/
" that is not also an XML MIME type, then let the resource type be the type specified in thattype
attribute. -
Jump to the step below labeled handler.
-
-
- Otherwise, if the resource does not have associated Content-Type metadata
-
-
If there is a
type
attribute present on theobject
element, then let the tentative type be the type specified in thattype
attribute.Otherwise, let tentative type be the computed type of the resource.
-
If tentative type is not
application/octet-stream
, then let resource type be tentative type and jump to the step below labeled handler.
-
-
If applying the URL parser algorithm to the URL of the specified resource (after any redirects) results in a URL record whose path component matches a pattern that a plugin supports, then let resource type be the type that the plugin can handle.
For example, a plugin might say that it can handle resources with path components that end with the four character string "
.swf
".
It is possible for this step to finish, or for one of the substeps above to jump straight to the next step, with resource type still being unknown. In both cases, the next step will trigger fallback.
-
-
Handler: Handle the content as given by the first of the following cases that
matches:
- If the resource type is not a type that the user agent supports, but it is a type that a plugin supports
-
If plugins are being sandboxed and the plugin that supports resource type cannot be secured, jump to the step below labeled fallback.
Otherwise, the user agent should use the plugin that supports resource type and pass the content of the resource to that plugin. If the plugin reports an error, then jump to the step below labeled fallback.
- If the resource type is an XML MIME type, or if the resource type does not start with "
image/
" -
The
object
element must be associated with a newly created nested browsing context, if it does not already have one.If the URL of the given resource is not
about:blank
, the element’s nested browsing context must then be navigated to that resource, with replacement enabled, and with theobject
element’s node document’s browsing context as the source browsing context. (Thedata
attribute of theobject
element doesn’t get updated if the browsing context gets further navigated to other locations.)If the URL of the given resource is
about:blank
, then, instead, the user agent must queue a task to fire a simple event namedload
at theobject
element. Noload
event is fired at theabout:blank
document itself.The
object
element represents the nested browsing context.If the
name
attribute is present, the browsing context name must be set to the value of this attribute; otherwise, the browsing context name must be set to the empty string. - If the resource type starts with "
image/
", and support for images has not been disabled -
Apply the image sniffing rules to determine the type of the image.
The
object
element represents the specified image. The image is not a nested browsing context.If the image cannot be rendered, e.g., because it is malformed or in an unsupported format, jump to the step below labeled fallback.
- Otherwise
-
The given resource type is not supported. Jump to the step below labeled fallback.
If the previous step ended with the resource type being unknown, this is the case that is triggered.
- The element’s contents are not part of what the
object
element represents. -
Abort these steps. Once the resource is completely loaded, queue a task to fire a simple event named
load
at the element.
- If the
- If the
data
attribute is absent but thetype
attribute is present, and the user agent can find a plugin suitable according to the value of thetype
attribute, and either plugins aren’t being sandboxed or the plugin can be secured, then that plugin should be used. If these conditions cannot be met, or if the plugin reports an error, jump to the step below labeled fallback. Otherwise abort these steps; once the plugin is completely loaded, queue a task to fire a simple event namedload
at the element. - Fallback: The
object
element represents the element’s children, ignoring any leadingparam
element children. This is the element’s fallback content. If the element has an instantiated plugin, then unload it.
When the algorithm above instantiates a plugin, the user agent
should pass to the plugin used the names and values of all the attributes on the
element, in the order they were added to the element, with the attributes added by the parser
being ordered in source order, followed by a parameter named "PARAM" whose value is null, followed
by all the names and values of parameters given by param
elements that are children of the object
element, in tree
order. If the plugin supports a scriptable interface, the HTMLObjectElement
object representing the element should expose that interface. The object
element represents the plugin. The plugin is not a nested browsing context.
Plugins are considered sandboxed for the purpose of an object
element if the sandboxed plugins browsing context flag is set on
the object
element’s node document’s active sandboxing flag
set.
Due to the algorithm above, the contents of object
elements act as fallback content, used only when referenced resources can’t be shown (e.g., because it
returned a 404 error). This allows multiple object
elements to be nested inside each other,
targeting multiple user agents with different capabilities, with the user agent picking the first
one it supports.
When an object
element represents a nested browsing context: if the object
element’s nested browsing context’s active document is not ready for post-load tasks, and when anything is delaying the load event of
the object
element’s browsing context’s active document, and when the object
element’s browsing context is in the delaying load
events mode, the object
must delay the load event of its document.
The task source for the tasks mentioned in this section is the DOM manipulation task source.
Whenever the name
attribute is set, if the object
element has a nested browsing context, its name must be changed to the new value. If the attribute is
removed, if the object
element has a browsing context, the browsing context name must be set to the empty string.
The form
attribute is used to explicitly associate the object
element with its form owner.
Constraint validation: object
elements are always barred
from constraint validation.
The object
element supports dimension attributes.
The IDL attributes data
, type
and name
each must reflect the
respective content attributes of the same name. The typeMustMatch
IDL attribute must reflect the typemustmatch
content attribute.
The contentDocument
IDL attribute must
return the Document
object of the active document of the object
element’s nested browsing context, if any and if its origin is the same origin-domain as the origin specified by the incumbent settings object, or null otherwise.
The contentWindow
IDL attribute must
return the WindowProxy
object of the object
element’s nested browsing context, if
it has one; otherwise, it must return null.
The willValidate
, validity
, and validationMessage
attributes, and the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of the constraint validation API. The form
IDL attribute is part
of the element’s forms API.
All object
elements have a legacy caller operation. If the object
element has an instantiated plugin that supports a scriptable interface that
defines a legacy caller operation, then that must be the behavior of the object’s legacy caller
operation. Otherwise, the object’s legacy caller operation must be to throw a NotSupportedError
exception.
object
element. To account for a user not having Java installed, a paragraph of fallback content has been added after the param
. The fallback p
should not be
displayed if the Java applet loads.
<figure> <object type="application/x-java-applet"> <param name="code" value="MyJavaClass"> <p>You do not have Java available, or it is disabled.</p> </object> <figcaption>My Java Clock</figcaption> </figure>
Applets have been removed from the web platform, and the example in this section is only provided as a reference for providing fallback content when dealing with removed features such as applets. All current implementations are expected to only show the fallback content in the example above.
object
element.
<figure> <object data="clock.html"></object> <figcaption>My HTML Clock</figcaption> </figure>
video
element to show the video for those using user agents that support video
, and finally providing a link to the video for those who have neither Flash
nor a video
-capable browser.
<p>Look at my video: <object type="application/x-shockwave-flash"> <param name="movie" value="https://video.example.com/library/watch.swf"> <param name="allowfullscreen" value="true"> <param name="flashvars" value="https://video.example.com/vids/123456"> <video controls src="https://video.example.com/vids/123456"> <a href="https://video.example.com/vids/123456">View video</a>. </video> </object> </p>
4.7.9. The param
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of an
object
element, before any flow content. - Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
name
- Name of parametervalue
- Value of parameter - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLParamElement
: HTMLElement { attribute DOMString name; attribute DOMString value; };
The param
element defines parameters for plugins invoked by object
elements. It does not represent anything on its own.
The name
attribute gives the name of the
parameter.
The value
attribute gives the value of the
parameter.
Both attributes must be present. They may have any value.
If both attributes are present, and if the parent element of the param
is an object
element, then the element defines a parameter with the given name-value pair.
If either the name or value of a parameter defined
by a param
element that is the child of an object
element that represents an instantiated plugin changes, and if that plugin is communicating with the user agent using an API that features the ability to
update the plugin when the name or value of a parameter so changes, then the user agent must
appropriately exercise that ability to notify the plugin of the change.
The IDL attributes name
and value
must both reflect the respective
content attributes of the same name.
param
element can be used to pass a parameter
to a plugin, in this case the O3D plugin.
<object type="application/vnd.o3d.auto"> <param name="o3d_features" value="FloatingPointTextures"> <img src="o3d-teapot.png" title="3D Utah Teapot illustration rendered using O3D." alt="When O3D renders the Utah Teapot, it appears as a squat teapot with a shiny metallic finish on which the surroundings are reflected, with a faint shadow caused by the lighting."> <p>To see the teapot actually rendered by O3D on your computer, please download and install the <a href="https://example.com/o3d/install">O3D plugin</a>.</p> </object> <script src="o3d-teapot.js"></script>
4.7.10. The video
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- If the element has a
controls
attribute: interactive content.- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- If the element has a
src
attribute: zero or moretrack
elements, then transparent, but with no media element descendants.- If the element does not have a
src
attribute: zero or moresource
elements, then zero or moretrack
elements, then transparent, but with no media element descendants. - If the element does not have a
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
src
- Address of the resourcecrossorigin
- How the element handles crossorigin requestsposter
- Poster frame to show prior to video playbackpreload
- Hints how much buffering the media resource will likely needautoplay
- Hint that the media resource can be started automatically when the page is loadedloop
- Whether to loop the media resourcemuted
- Whether to mute the media resource by defaultcontrols
- Show user agent controlsdisableRemotePlayback
- Whether the remote playback of a media resource is disabledwidth
- Horizontal dimensionheight
- Vertical dimension - Allowed ARIA role attribute values:
-
application
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to theapplication
role. - Any
- DOM interface:
-
interface
HTMLVideoElement
: HTMLMediaElement { attribute unsigned long width; attribute unsigned long height; readonly attribute unsigned long videoWidth; readonly attribute unsigned long videoHeight; attribute DOMString poster; };
A video
element is used for playing videos or movies, and audio files with captions.
Content may be provided inside the video
element. User agents
should not show this content to the user; it is intended for older Web browsers which do
not support video
, so that legacy video plugins can be tried, or to show text to the
users of these older browsers informing them of how to access the video contents.
In particular, this content is not intended to address accessibility concerns. To make video
content accessible to people with disabilities, a variety of features are available.
Captions and sign language tracks can be embedded in the video stream, or as external files
using the track
element. Audio descriptions can be provided, either as a separate track
embedded in the video stream, or by referencing a WebVTT file with the track
element that the user agent can present as synthesized speech. WebVTT can also be used to
provide chapter titles. For users who would rather not use a media element at all, transcripts
or other textual alternatives can be provided by simply linking to them in the prose near the video
element. [WEBVTT]
The video
element is a media element whose media data is ostensibly video
data, possibly with associated audio data.
The src
, preload
, autoplay
, loop
, muted
, and controls
attributes are the attributes common to all
media elements.
The poster
content attribute gives the address of an
image file that the user agent can show while no video data is available. The attribute, if
present, must contain a valid non-empty URL potentially surrounded by spaces.
If the specified resource is to be used, then, when the element is created or when the poster
attribute is set, changed, or removed, the user agent must
run the following steps to determine the element’s poster frame (regardless of the
value of the element’s show poster flag):
- If there is an existing instance of this algorithm running for this
video
element, abort that instance of this algorithm without changing the poster frame. - If the
poster
attribute’s value is the empty string or if the attribute is absent, then there is no poster frame; abort these steps. - Parse the
poster
attribute’s value relative to the element. If this fails, then there is no poster frame; abort these steps. - Let request be a new request whose URL is the resulting URL string, client is the element’s node document’s
Window
object’s environment settings object, type is "image
", destination is "subresource
", credentials mode is "include
", and whose use-URL-credentials flag is set. - Fetch request. This must delay the load event of the element’s node document.
- If an image is thus obtained, the poster frame is that image. Otherwise, there is no poster frame.
The image given by the poster
attribute, the poster frame, is intended to
be a representative frame of the video (typically one of the first non-blank frames) that
gives the user an idea of what the video is like.
A video
element represents what is given for the first matching condition in the list below:
- When no video data is available (the element’s
readyState
attribute is eitherHAVE_NOTHING
, orHAVE_METADATA
but no video data has yet been obtained at all, or the element’sreadyState
attribute is any subsequent value but the media resource does not have a video channel) - The
video
element represents its poster frame, if any, or else transparent black with no intrinsic dimensions. - When the
video
element ispaused
, the current playback position is the first frame of video, and the element’s show poster flag is set - The
video
element represents its poster frame, if any, or else the first frame of the video. - When the
video
element ispaused
, and the frame of video corresponding to the current playback position is not available (e.g., because the video is seeking or buffering)- When the
video
element is neither potentially playing norpaused
(e.g., when seeking or stalled) - When the
- The
video
element represents the last frame of the video to have been rendered. - When the
video
element ispaused
- The
video
element represents the frame of video corresponding to the current playback position. - Otherwise (the
video
element has a video channel and is potentially playing) - The
video
element represents the frame of video at the continuously increasing "current" position. When the current playback position changes such that the last frame rendered is no longer the frame corresponding to the current playback position in the video, the new frame must be rendered.
Frames of video must be obtained from the video track that was selected when the event loop last reached step 1.
Which frame in a video stream corresponds to a particular playback position is defined by the video stream’s format.
The video
element also represents any text track cues whose text track cue active flag is set and whose text track is in the showing mode, and any
audio from the media resource, at the current playback position.
Any audio associated with the media resource must, if played, be played synchronized with the current playback position, at the element’s effective media volume. The user agent must play the audio from audio tracks that were enabled when the event loop last reached step 1.
In addition to the above, the user agent may provide messages to the user (such as "buffering", "no video loaded", "error", or more detailed information) by overlaying text or icons on the video or other areas of the element’s playback area, or in another appropriate manner.
User agents that cannot render the video may instead make the element represent a link to an external video playback utility or to the video data itself.
When a video
element’s media resource has a video channel, the
element provides a paint source whose width is the media resource’s intrinsic width, whose height is the media resource’s intrinsic height, and whose appearance is
the frame of video corresponding to the current playback position, if that is available, or else
(e.g., when the video is seeking or buffering) its previous appearance, if any, or else (e.g.,
because the video is still loading the first frame) blackness.
- video .
videoWidth
- video .
videoHeight
- video .
-
These attributes return the intrinsic dimensions of the video, or zero if the dimensions are not known.
The intrinsic width and intrinsic height of the media resource are the dimensions of the resource in CSS pixels after taking into account the resource’s dimensions, aspect ratio, clean aperture, resolution, and so forth, as defined for the format used by the resource. If an anamorphic format does not define how to apply the aspect ratio to the video data’s dimensions to obtain the "correct" dimensions, then the user agent must apply the ratio by increasing one dimension and leaving the other unchanged.
The videoWidth
IDL attribute must return
the intrinsic width of the video in CSS pixels.
The videoHeight
IDL attribute must
return the intrinsic height of the video in CSS
pixels. If the element’s readyState
attribute is HAVE_NOTHING
,
then the attributes must return 0.
Whenever the intrinsic width or intrinsic height of the video changes
(including, for example, because the selected video
track was changed), if the element’s readyState
attribute is not HAVE_NOTHING
, the user agent must queue a task to fire a simple event named resize
at the media element.
The video
element supports dimension attributes.
In the absence of style rules to the contrary, video content should be rendered inside the element’s playback area such that the video content is shown centered in the playback area at the largest possible size that fits completely within it, with the video content’s aspect ratio being preserved. Thus, if the aspect ratio of the playback area does not match the aspect ratio of the video, the video will be shown letterboxed or pillarboxed. Areas of the element’s playback area that do not contain the video represent nothing.
In user agents that implement CSS, the above requirement can be implemented by using the style rule suggested in §10 Rendering.
The intrinsic width of a video
element’s playback area is the intrinsic width of the poster frame, if that is available and the
element currently represents its poster frame; otherwise, it is the intrinsic width of the video resource, if that is
available; otherwise the intrinsic width is missing.
The intrinsic height of a video
element’s playback area is the intrinsic height of the poster frame, if that is available and the
element currently represents its poster frame; otherwise it is the intrinsic height of the video resource, if that is
available; otherwise the intrinsic height is missing.
The default object size is a width of 300 CSS pixels and a height of 150 CSS pixels. [CSS3-IMAGES]
User agents should provide controls to enable or disable the display of closed captions, audio description tracks, and other additional data associated with the video stream, though such features should, again, not interfere with the page’s normal rendering.
User agents may allow users to view the video content in manners more suitable to the user
(e.g., fullscreen or in an independent resizable window). Captions, subtitles or other additional
visual tracks should remain available and visible when enabled. As for the other user interface
features, controls to enable this should not interfere with the page’s normal rendering unless
the user agent is exposing a user interface. As for the other user interface features, controls to
enable this should not interfere with the page’s normal rendering unless the user agent is exposing a user interface. In such an independent context, however, user agents may make
full user interfaces visible e.g., play, pause, seeking, and volume controls even if the controls
attribute is absent.
User agents may allow video playback to affect system features that could interfere with the user’s experience; for example, user agents could disable screensavers while video playback is in progress.
The poster
IDL attribute must reflect the poster
content attribute.
This example also shows the controls
, and preload
attributes.
<video controls preload="metadata"> <source type="video/webm" src="example.webm"> <source type="video/mp4" src="example.mp4"> <a href="example.webm">Download the video file.</a> </video>
<script> function failed(e) { // video playback failed - show a message saying why switch (e.target.error.code) { case e.target.error.MEDIA_ERR_ABORTED: alert('You aborted the video playback.'); break; case e.target.error.MEDIA_ERR_NETWORK: alert('A network error caused the video download to fail part-way.'); break; case e.target.error.MEDIA_ERR_DECODE: alert('The video playback was aborted due to a corruption problem or because the video used features your browser did not support.'); break; case e.target.error.MEDIA_ERR_SRC_NOT_SUPPORTED: alert('The video could not be loaded, either because the server or network failed or because the format is not supported.'); break; default: alert('An unknown error occurred.'); break; } } </script> <p><video src="example.webm" autoplay controls onerror="failed(event)"></video></p> <p><a href="example.webm">Download the video file</a>.</p>
4.7.11. The audio
element
- Categories:
- Flow content.
- Phrasing content.
- Embedded content.
- If the element has a
controls
attribute: Interactive content.- If the element has a
controls
attribute: Palpable content. - Phrasing content.
- Contexts in which this element can be used:
- Where embedded content is expected.
- Content model:
- If the element has a
src
attribute: zero or moretrack
elements, then transparent, but with no media element descendants.- If the element does not have a
src
attribute: zero or moresource
elements, then zero or moretrack
elements, then transparent, but with no media element descendants. - If the element does not have a
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
src
- Address of the resourcecrossorigin
- How the element handles crossorigin requestspreload
- Hints how much buffering the media resource will likely needautoplay
- Hint that the media resource can be started automatically when the page is loadedloop
- Whether to loop the media resourcemuted
- Whether to mute the media resource by defaultcontrols
- Show user agent controlsdisableRemotePlayback
- Whether the remote playback of a media resource is disabled - Allowed ARIA role attribute values:
-
application
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to theapplication
role. - Any
- DOM interface:
-
[NamedConstructor=Audio(optional DOMString
src
)] interfaceHTMLAudioElement
: HTMLMediaElement {};
An audio
element represents a sound or audio stream.
Content may be provided inside the audio
element. User agents
should not show this content to the user; it is intended for older Web browsers which do
not support audio
, so that legacy audio plugins can be tried, or to show text to the
users of these older browsers informing them of how to access the audio contents.
<audio src="music.ogg" controls> Your browser does not support the audio element. <a href="music.ogg">Download the music file instead</a>. </audio>
In particular, this content is not intended to address accessibility concerns. To
make audio content accessible to the deaf or to those with other physical or cognitive
disabilities, a variety of features are available. If captions or a sign language video are
available, the video
element can be used instead of the audio
element to
play the audio, allowing users to enable the visual alternatives. Chapter titles can be
provided to aid navigation, using the track
element and a WebVTT file. And,
naturally, transcripts or other textual alternatives can be provided by simply linking to
them in the prose near the audio
element. [WEBVTT]
The audio
element is a media element whose media data is ostensibly audio data.
The src
, preload
, autoplay
, loop
, muted
, and controls
attributes are the attributes common to all media elements.
When an audio
element is potentially playing, it must have its audio
data played synchronized with the current playback position, at the element’s effective media volume. The user agent must play the audio from audio tracks that
were enabled when the event loop last reached step 1.
When an audio
element is not potentially playing, audio must not play for the element.
- audio = new
Audio
( [ url ] ) -
Returns a new
audio
element, with thesrc
attribute set to the value passed in the argument, if applicable.
A constructor is provided for creating HTMLAudioElement
objects (in addition to
the factory methods from DOM such as createElement()
): Audio(src)
.
When invoked as a constructor, it must return a new HTMLAudioElement
object
(a new audio
element). The element must be created with its preload
attribute set to the literal value "auto
". If the src argument is
present, the object created must be created with its src
content attribute set
to the provided value (this will cause the user agent to invoke the object’s resource selection algorithm before returning).
The element’s node document must be the active document of the browsing context of the Window
object on which the interface object
of the invoked constructor is found.
This example also shows the boolean controls
, autoplay
, and loop
attributes.
<audio controls autoplay loop> <source src="music.ogg" type="audio/ogg; codecs=vorbis"/> <source src="music.mp3" type="audio/mpeg"/> </audio>
4.7.12. The track
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a media element, before any flow content.
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
kind
- The type of text tracksrc
- Address of the resourcesrclang
- Language of the text tracklabel
- User-visible labeldefault
- Enable the track if no other text track is more suitable - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLTrackElement
: HTMLElement { attribute DOMString kind; attribute DOMString src; attribute DOMString srclang; attribute DOMString label; attribute boolean default; const unsigned short NONE = 0; const unsigned short LOADING = 1; const unsigned short LOADED = 2; const unsigned short ERROR = 3; readonly attribute unsigned short readyState; readonly attribute TextTrack track; };
The track
element allows authors to specify explicit external text resources for media elements. It does not represent anything on its own.
The kind
attribute is an enumerated attribute. The following table lists the keywords defined for this attribute.
The keyword given in the first cell of each row maps to the state given in the second cell.
Keyword | State | Brief description |
---|---|---|
subtitles
| Subtitles | Transcription or translation of the dialog, suitable for when the sound is available but not understood (e.g., because the user does not understand the language of the media resource’s audio track). Overlaid on the video. |
captions
| Captions | Transcription or translation of the dialog, sound effects, relevant musical cues, and other relevant audio information, suitable for when sound is unavailable or not clearly audible (e.g., because it is muted, drowned-out by ambient noise, or because the user is deaf). Overlaid on the video; labeled as appropriate for the hard-of-hearing. |
descriptions
| Descriptions | Textual descriptions of the video component of the media resource, intended for audio synthesis when the visual component is obscured, unavailable, or not usable (e.g., because the user is interacting with the application without a screen while driving, or because the user is blind). Synthesized as audio. |
chapters
| Chapters | Chapter titles, intended to be used for navigating the media resource. Displayed as an interactive (potentially nested) list in the user agent’s interface. |
metadata
| Metadata | Tracks intended for use from script. Not displayed by the user agent. |
The attribute may be omitted. The missing value default is the subtitles state. The invalid value default is the metadata state.
The src
attribute gives the address of the text
track data. The value must be a valid non-empty URL potentially surrounded by spaces.
This attribute must be present.
If the element has a src
attribute whose value is not the empty string and whose
value, when the attribute was set, could be successfully parsed relative to the element’s node document, then the element’s track URL is the resulting URL string. Otherwise, the element’s track URL is the empty string.
kind
attribute is not in the Metadata state, then the WebVTT file must be a WebVTT file using cue text. [WEBVTT]
Furthermore, if the element’s track URL identifies a WebVTT resource, and the
element’s kind
attribute is in the chapters state, then the WebVTT file must be both a WebVTT file using chapter title text and a WebVTT file using only nested cues. [WEBVTT]
The srclang
attribute gives the language of
the text track data. The value must be a valid BCP 47 language tag. This attribute must be
present if the element’s kind
attribute is in the subtitles state. [BCP47]
If the element has a srclang
attribute whose value is not the empty string,
then the element’s track language is the value of the attribute.
Otherwise, the element has no track language.
The label
attribute gives a user-readable
title for the track. This title is used by user agents when listing subtitle, caption, and audio description tracks in
their user interface.
The value of the label
attribute, if the attribute is present, must not be the
empty string. Furthermore, there must not be two track
element children of the
same media element whose kind
attributes are in the same state, whose srclang
attributes are both missing or have values that represent the same
language, and whose label
attributes are again both missing or both have the
same value.
If the element has a label
attribute whose value is not the empty string, then
the element’s track label is the value of the attribute. Otherwise, the element’s track label is an empty string.
The default
attribute is a boolean attribute, which, if specified, indicates that the track is to be enabled
if the user’s preferences do not indicate that another track would be more appropriate.
Each media element must have no more than one track
element child
whose kind
attribute is in the Subtitles or Captions state and whose default
attribute is specified.
Each media element must have no more than one track
element child
whose kind
attribute is in the Descriptions state
and whose default
attribute is specified.
Each media element must have no more than one track
element child whose kind
attribute is in the Chapters state and
whose default
attribute is specified.
There is no limit on the number of track
elements whose kind
attribute is in the Metadata state and whose default
attribute is specified.
- track .
readyState
-
Returns the text track readiness state, represented by a number from the following list:
- track .
NONE
(0) - The text track not loaded state.
- track .
LOADING
(1) - The text track loading state.
- track .
LOADED
(2) - The text track loaded state.
- track .
ERROR
(3) - The text track failed to load state.
- track .
- track .
track
-
Returns the
TextTrack
object corresponding to the text track of thetrack
element.
The readyState
attribute must return the
numeric value corresponding to the text track readiness state of the track
element’s text track, as defined by the following list:
NONE
(numeric value 0)- The text track not loaded state.
LOADING
(numeric value 1)- The text track loading state.
LOADED
(numeric value 2)- The text track loaded state.
ERROR
(numeric value 3)- The text track failed to load state.
The track
IDL attribute must, on
getting, return the track
element’s text track’s corresponding TextTrack
object.
The src
, srclang
, label
, and default
IDL attributes must reflect the respective content attributes of the same name.
The kind
IDL attribute must reflect the content attribute of the same name, limited to only known values.
<video src="brave.webm"> <track kind="subtitles" src="brave.en.vtt" srclang="en" label="English"> <track kind="captions" src="brave.en.hoh.vtt" srclang="en" label="English for the Hard of Hearing"> <track kind="subtitles" src="brave.fr.vtt" srclang="fr" lang="fr" label="Français"> <track kind="subtitles" src="brave.de.vtt" srclang="de" lang="de" label="Deutsch"> </video>
(The lang
attributes on the last two describe the language of the label
attribute, not the language of the subtitles themselves. The language of
the subtitles is given by the srclang
attribute.)
4.7.13. Media elements
HTMLMediaElement
objects (audio
and video
, in this specification) are simply known as media elements.
enumCanPlayTypeResult
{""
/* empty string */,"maybe"
,"probably"
};
typedef (MediaStream or MediaSource or Blob) MediaProvider
;
interfaceHTMLMediaElement
: HTMLElement { // error state readonly attribute MediaError? error; // network state attribute DOMString src; attribute MediaProvider? srcObject; readonly attribute DOMString currentSrc; attribute DOMString? crossOrigin; const unsigned short NETWORK_EMPTY = 0; const unsigned short NETWORK_IDLE = 1; const unsigned short NETWORK_LOADING = 2; const unsigned short NETWORK_NO_SOURCE = 3; readonly attribute unsigned short networkState; attribute DOMString preload; readonly attribute TimeRanges buffered; void load(); CanPlayTypeResult canPlayType(DOMStringtype
); // ready state const unsigned short HAVE_NOTHING = 0; const unsigned short HAVE_METADATA = 1; const unsigned short HAVE_CURRENT_DATA = 2; const unsigned short HAVE_FUTURE_DATA = 3; const unsigned short HAVE_ENOUGH_DATA = 4; readonly attribute unsigned short readyState; readonly attribute boolean seeking; // playback state attribute double currentTime; void fastSeek(doubletime
); readonly attribute unrestricted double duration; object getStartDate(); readonly attribute boolean paused; attribute double defaultPlaybackRate; attribute double playbackRate; readonly attribute TimeRanges played; readonly attribute TimeRanges seekable; readonly attribute boolean ended; [SameObject] readonly attribute RemotePlaybackremote
; [CEReactions] attribute boolean autoplay; [CEReactions] attribute boolean disableRemotePlayback; [CEReactions] attribute boolean loop; Promise<void> play(); void pause(); // controls attribute boolean controls; attribute double volume; attribute boolean muted; attribute boolean defaultMuted; // tracks [SameObject] readonly attribute AudioTrackList audioTracks; [SameObject] readonly attribute VideoTrackList videoTracks; [SameObject] readonly attribute TextTrackList textTracks; TextTrack addTextTrack(TextTrackKindkind
, optional DOMStringlabel
= "", optional DOMStringlanguage
= ""); };
The media element attributes, src
, crossorigin
, preload
, autoplay
, disableRemotePlayback
, loop
, muted
, and controls
, apply to all media elements. They are
defined in this section.
Media elements are used to present audio data, or video and audio data, to the user. This is referred to as media data in this section, since this section applies equally to media elements for audio or for video.
The term media resource is used to refer to the complete set of media data, e.g., the complete video file, or complete audio file.
A media resource can have multiple audio and video tracks. For the purposes of a media element, the video data of the media resource is only that of the
currently selected track (if any) as given by the element’s videoTracks
attribute
when the event loop last reached step 1, and the audio data of the media resource is the result of mixing all the currently enabled tracks (if any) given by the element’s audioTracks
attribute when the event loop last reached step 1.
Both audio
and video
elements can be used for both audio and video. The main
difference between the two is simply that the audio
element has no playback area for
visual content (such as video or captions), whereas the video
element does.
Except where otherwise explicitly specified, the task source for all the tasks queued in this section and its subsections is the media element event task source of the media element in question.
4.7.13.1. Error codes
- media .
error
-
Returns a
MediaError
object representing the current error state of the element.Returns null if there is no error.
All media elements have an associated error status, which records the last error the
element encountered since its resource selection algorithm was last invoked. The error
attribute, on getting, must
return the MediaError
object created for this last error, or null if there has
not been an error.
interface MediaError
{
const unsigned short MEDIA_ERR_ABORTED = 1;
const unsigned short MEDIA_ERR_NETWORK = 2;
const unsigned short MEDIA_ERR_DECODE = 3;
const unsigned short MEDIA_ERR_SRC_NOT_SUPPORTED = 4;
readonly attribute unsigned short code;
};
- media .
error
.code
-
Returns the current error’s error code, from the list below.
The code
attribute of a MediaError
object must return the code for the error, which must be one of the
following:
MEDIA_ERR_ABORTED
(numeric value 1)- The fetching process for the media resource was aborted by the user agent at the user’s request.
MEDIA_ERR_NETWORK
(numeric value 2)- A network error of some description caused the user agent to stop fetching the media resource, after the resource was established to be usable.
MEDIA_ERR_DECODE
(numeric value 3)- An error of some description occurred while decoding the media resource, after the resource was established to be usable.
MEDIA_ERR_SRC_NOT_SUPPORTED
(numeric value 4)- The media resource indicated by the
src
attribute or assigned media provider object was not suitable.
4.7.13.2. Location of the media resource
The src
content attribute on media elements gives the address of the media resource (video, audio) to show. The
attribute, if present, must contain a valid non-empty URL potentially surrounded by spaces.
The crossorigin
content attribute on media elements is a CORS settings attribute.
If a media element is created with a src
attribute, the user agent must immediately invoke the media element’s resource selection algorithm.
If a src
attribute of a media element is set or changed, the user agent must
invoke the media element’s media element load algorithm. (Removing the src
attribute does not do this, even if there are source
elements present.)
The src
IDL attribute on media elements must reflect the content attribute of the same name.
The crossOrigin
IDL attribute must reflect the crossorigin
content attribute, limited to only known values.
A media provider object is an object that can represent a media resource,
separate from a URL. MediaStream
objects, MediaSource
objects, Blob
objects, and File
objects are all media provider objects.
Each media element can have an assigned media provider object, which is a media provider object. When a media element is created, it has no assigned media provider object.
- media .
srcObject
[ = source ] - Allows the media element to be assigned a media provider object.
- media .
currentSrc
-
Returns the URL of the current media resource, if any.
Returns the empty string when there is no media resource, or it doesn’t have a URL.
The currentSrc
IDL attribute is
initially the empty string. Its value is changed by the resource selection algorithm defined below.
The srcObject
IDL attribute, on getting,
must return the element’s assigned media provider object, if any, or null otherwise. On
setting, it must set the element’s assigned media provider object to the new value, and
then invoke the element’s media element load algorithm.
There are three ways to specify a media resource, the srcObject
IDL attribute, the src
content attribute, and source
elements. The IDL attribute
takes priority, followed by the content attribute, followed by the elements.
4.7.13.3. MIME types
A media resource can be described in terms of its type, specifically a MIME type, in some cases with a codecs
parameter. (Whether the codecs
parameter is allowed or not depends on the MIME type.) [RFC6381]
Types are usually somewhat incomplete descriptions; for example "video/mpeg
"
doesn’t say anything except what the container type is, and even a type like
"video/mp4; codecs="avc1.42E01E, mp4a.40.2"
" doesn’t include information like the
actual bitrate (only the maximum bitrate). Thus, given a type, a user agent can often only know
whether it might be able to play media of that type (with varying levels of
confidence), or whether it definitely cannot play media of that type.
A type that the user agent knows it cannot render is one that describes a resource that the user agent definitely does not support, for example because it doesn’t recognize the container type, or it doesn’t support the listed codecs.
The MIME type "application/octet-stream
" with no parameters is never a type that the user agent knows it cannot render. User agents must treat that type
as equivalent to the lack of any explicit Content-Type metadata when it is used to label a potential media resource.
Only the MIME type "application/octet-stream
" with no parameters is
special-cased here; if any parameter appears with it, it will be treated just like any other MIME type. This is a deviation from the rule that unknown MIME type parameters
should be ignored.
- media .
canPlayType
(type) -
Returns the empty string (a negative response), "maybe", or "probably" based on how confident the user agent is that it can play media resources of the given type.
The canPlayType(type)
method
must return the empty string if type is a type that the user agent
knows it cannot render or is the type "application/octet-stream
"; it must
return "probably
" if the user agent is confident that the type
represents a media resource that it can render if used in with this audio
or video
element; and it must return "maybe
" otherwise.
Implementors are encouraged to return "maybe
" unless the type can be
confidently established as being supported or not. Generally, a user agent should never return
"probably
" for a type that allows the codecs
parameter if that
parameter is not present.
video
element or a plugin:
<p id="video"> <p><a href="playing-cats.nfv" download>Download video</a></p> </p> <script> var videoSection = document.getElementById('video'); var videoElement = document.createElement('video'); var support = videoElement.canPlayType('video/x-new-fictional-format;codecs="kittens,bunnies"'); if (support == "") { // not confident of browser support // but we might have a plugin // so try plugin instead videoElement = document.createElement("embed"); } if (videoElement) { while (videoSection.hasChildNodes()) { videoSection.removeChild(videoSection.firstChild); } videoElement.setAttribute("src", "playing-cats.nfv"); videoSection.appendChild(videoElement); } </script>
The type
attribute of the source
element allows the user agent to avoid
downloading resources that use formats it cannot render.
4.7.13.4. Network states
- media .
networkState
- Returns the current state of network activity for the element, from the codes in the list below.
As media elements interact with the network, their current network activity is represented
by the networkState
attribute. On
getting, it must return the current network state of the element, which must be one of the
following values:
NETWORK_EMPTY
(numeric value 0)-
The element has not yet been initialized. All attributes are in their initial states.
NETWORK_IDLE
(numeric value 1)-
The element’s resource selection algorithm is active and has selected a resource, but it is not actually using the network at this time.
NETWORK_LOADING
(numeric value 2)-
The user agent is actively trying to download data.
NETWORK_NO_SOURCE
(numeric value 3)-
The element’s resource selection algorithm is active, but it has not yet found a resource to use.
The resource selection algorithm defined below describes exactly when the networkState
attribute changes value and what events fire to indicate
changes in this state.
4.7.13.5. Loading the media resource
- media .
load
() -
Causes the element to reset and start selecting and loading a new media resource from scratch.
All media elements have an autoplaying flag, which must begin in the true state, and a delaying-the-load-event flag, which must begin in the false state. While the delaying-the-load-event flag is true, the element must delay the load event of its document.
When the load()
method on a media element is invoked, the user agent must run the media element load algorithm.
The media element load algorithm consists of the following steps.
- Abort any already-running instance of the resource selection algorithm for this element.
-
If there are any tasks from the media element’s media element event task source that would resolve pending play promises or reject pending play promises in one of the task queues, then remove those tasks.
Basically, pending events and callbacks for the media element are discarded and pending promises are rejected when the media element starts loading a new resource.
- If the media element’s
networkState
is set toNETWORK_LOADING
orNETWORK_IDLE
, queue a task to fire a simple event namedabort
at the media element. -
If the media element’s
networkState
is not set toNETWORK_EMPTY
, then run these substeps:- Queue a task to fire a simple event named emptied at the media element.
- If a fetching process is in progress for the media element, the user agent should stop it.
- If the media element’s assigned media provider object is a
MediaSource
object, then detach it. - Forget the media element’s media-resource-specific tracks.
- If
readyState
is not set toHAVE_NOTHING
, then set it to that state. - If the
paused
attribute is false, then set it to true. - If
seeking
is true, set it to false. -
Set the current playback position to 0.
Set the official playback position to 0.
If this changed the official playback position, then queue a task to fire a simple event named
timeupdate
at the media element. - Set the initial playback position to 0.
- Set the timeline offset to Not-a-Number (NaN).
-
Update the
duration
attribute to Not-a-Number (NaN).The user agent will not fire a
durationchange
event for this particular change of the duration.
- Set the
playbackRate
attribute to the value of thedefaultPlaybackRate
attribute. - Set the
error
attribute to null and the autoplaying flag to true. - Invoke the media element’s resource selection algorithm.
-
Playback of any previously playing media resource for this element stops.
The resource selection algorithm for a media element is as follows. This algorithm is always invoked as part of a task, but one of the first steps in the algorithm is to return and continue running the remaining steps in parallel. In addition, this algorithm interacts closely with the event loop mechanism; in particular, it has synchronous sections (which are triggered as part of the event loop algorithm). Steps in such sections are marked with ⌛.
- Set the element’s
networkState
attribute to theNETWORK_NO_SOURCE
value. - Set the element’s show poster flag to true.
- Set the media element’s delaying-the-load-event flag to true (this delays the load event).
- in parallel await a stable state, allowing the task that invoked this algorithm to continue. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended. (Steps in synchronous sections are marked with ⌛.)
-
⌛ If the media element’s blocked-on-parser flag is false, then populate the list of pending text tracks.
-
⌛ If the media element has an assigned media provider object, then let mode be object.
⌛ Otherwise, if the media element has no assigned media provider object but has a
src
attribute, then let mode be attribute.⌛ Otherwise, if the media element does not have an assigned media provider object and does not have a
src
attribute, but does have asource
element child, then let mode be children and let candidate be the first suchsource
element child in tree order.⌛ Otherwise the media element has no assigned media provider object and has neither a
src
attribute nor asource
element child: set thenetworkState
toNETWORK_EMPTY
, and abort these steps; the synchronous section ends. - ⌛ Set the media element’s
networkState
toNETWORK_LOADING
. - ⌛ Queue a task to fire a simple event named
loadstart
at the media element. -
Run the appropriate steps from the following list:
- If mode is object
-
- ⌛ Set the
currentSrc
attribute to the empty string. - End the synchronous section, continuing the remaining steps in parallel.
- Run the resource fetch algorithm with the assigned media provider object. If that algorithm returns without aborting this one, then the load failed.
- Failed with media provider: Reaching this step indicates that the media resource failed to load. Queue a task to run the dedicated media source failure steps.
- Wait for the task queued by the previous step to have executed.
- Abort these steps. The element won’t attempt to load another resource until this algorithm is triggered again.
- ⌛ Set the
- If mode is attribute
-
- ⌛ If the
src
attribute’s value is the empty string, then end the synchronous section, and jump down to the failed with attribute step below. - ⌛ Let urlString and urlRecord be the resulting URL string and the resulting URL record, respectively, that would have resulted from parsing the URL specified by the
src
attribute’s value relative to the media element's node document when thesrc
attribute was last changed. - ⌛ If urlString was obtained successfully, set the
currentSrc
attribute to urlString. - End the synchronous section, continuing the remaining steps in parallel.
- If urlRecord was obtained successfully, run the resource fetch algorithm with urlRecord. If that algorithm returns without aborting this one, then the load failed.
- Failed with attribute: Reaching this step indicates that the media resource failed to load or that the given URL could not be parsed. Queue a task to run the dedicated media source failure steps.
- Wait for the task queued by the previous step to have executed.
- Abort these steps. The element won’t attempt to load another resource until this algorithm is triggered again.
- ⌛ If the
- Otherwise (mode is children)
-
-
⌛ Let pointer be a position defined by two adjacent nodes in the media element’s child list, treating the start of the list (before the first child in the list, if any) and end of the list (after the last child in the list, if any) as nodes in their own right. One node is the node before pointer, and the other node is the node after pointer. Initially, let pointer be the position between the candidate node and the next node, if there are any, or the end of the list, if it is the last node.
As nodes are inserted and removed into the media element, pointer must be updated as follows:
- If a new node is inserted between the two nodes that define pointer
- Let pointer be the point between the node before pointer and the new node. In other words, insertions at pointer go after pointer.
- If the node before pointer is removed
- Let pointer be the point between the node after pointer and the node before the node after pointer. In other words, pointer doesn’t move relative to the remaining nodes.
- If the node after pointer is removed
- Let pointer be the point between the node before pointer and the node after the node before pointer. Just as with the previous case, pointer doesn’t move relative to the remaining nodes.
Other changes don’t affect pointer.
- ⌛ Process candidate: If candidate does not have a
src
attribute, or if itssrc
attribute’s value is the empty string, then end the synchronous section, and jump down to the failed with elements step below. - ⌛ Let urlString and urlRecord be the resulting URL string and the resulting URL record, respectively, that would have resulted from parsing the URL specified by candidate’s
src
attribute’s value relative to the candidate’s node document when thesrc
attribute was last changed. - ⌛ If urlString was not obtained successfully, then end the synchronous section, and jump down to the Failed with elements step below.
- ⌛ If candidate has a
type
attribute whose value, when parsed as a MIME type (including any codecs described by thecodecs
parameter, for types that define that parameter), represents a type that the user agent knows it cannot render, then end the synchronous section, and jump down to the failed with elements step below. - ⌛ Set the
currentSrc
attribute to urlString. - End the synchronous section, continuing the remaining steps in parallel.
- Run the resource fetch algorithm with urlRecord. If that algorithm returns without aborting this one, then the load failed.
- Failed with elements: Queue a task to fire a simple
event named
error
at the candidate element. - Await a stable state. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended. (Steps in synchronous sections are marked with ⌛.)
- ⌛ Forget the media element’s media-resource-specific tracks.
- ⌛ Find next candidate: Let candidate be null.
- ⌛ Search loop: If the node after pointer is the end of the list, then jump to the waiting step below.
- ⌛ If the node after pointer is a
source
element, let candidate be that element. - ⌛ Advance pointer so that the node before pointer is now the node that was after pointer, and the node after pointer is the node after the node that used to be after pointer, if any.
- ⌛ If candidate is null, jump back to the search loop step. Otherwise, jump back to the process candidate step.
- ⌛ Waiting: Set the element’s
networkState
attribute to theNETWORK_NO_SOURCE
value. - ⌛ Set the element’s show poster flag to true.
- ⌛ Queue a task to set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
- End the synchronous section, continuing the remaining steps in parallel.
- Wait until the node after pointer is a node other than the end of the list. (This step might wait forever.)
- Await a stable state. The synchronous section consists of all the remaining steps of this algorithm until the algorithm says the synchronous section has ended. (Steps in synchronous sections are marked with ⌛.)
- ⌛ Set the element’s delaying-the-load-event flag back to true (this delays the load event again, in case it hasn’t been fired yet).
- ⌛ Set the
networkState
back toNETWORK_LOADING
. - ⌛ Jump back to the find next candidate step above.
-
The dedicated media source failure steps are the following steps:
- Set the
error
attribute to a newMediaError
object whosecode
attribute is set toMEDIA_ERR_SRC_NOT_SUPPORTED
. - Forget the media element’s media-resource-specific tracks.
- Set the element’s
networkState
attribute to theNETWORK_NO_SOURCE
value. - Set the element’s show poster flag to true.
- Fire a simple event named
error
at the media element. - Reject pending play promises with promises and a
"
NotSupportedError
"DOMException
. - Set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
The resource fetch algorithm for a media element and a given URL record or media provider object is as follows:
- If the algorithm was invoked with media provider object or a URL record whose object is a media provider object, then let mode be local. Otherwise let mode be remote.
- If mode is remote, then let the current media resource be the resource given by the URL record passed to this algorithm; otherwise, let the current media resource be the resource given by the media provider object. Either way, the current media resource is now the element’s media resource.
- Remove all media-resource-specific text tracks from the media element’s list of pending text tracks, if any.
-
Run the appropriate steps from the following list:
- If mode is remote
-
-
Optionally, run the following substeps. This is the expected behavior if the user agent
intends to not attempt to fetch the resource until the user requests it explicitly
(e.g., as a way to implement the
preload
attribute’snone
keyword).- Set the
networkState
toNETWORK_IDLE
. - Queue a task to fire a simple event named
suspend
at the element. - Queue a task to set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
- Wait for the task to be run.
- Wait for an implementation-defined event (e.g., the user requesting that the media element begin playback).
- Set the element’s delaying-the-load-event flag back to true (this delays the load event again, in case it hasn’t been fired yet).
- Set the
networkState
toNETWORK_LOADING
.
- Set the
-
Let request be the result of creating a potential-CORS request given current media resource’s URL record and the media element’s
crossorigin
content attribute value.Set request’s client to the media element’s node document’s
Window
object’s environment settings object and type to "audio
" if the media element is anaudio
element and to "video
" otherwise.Fetch request.
The response’s unsafe response obtained in this fashion, if any, contains the media data. It can be CORS-same-origin or CORS-cross-origin; this affects whether subtitles referenced in the media data are exposed in the API and, for
video
elements, whether acanvas
gets tainted when the video is drawn on it.The stall timeout is a user-agent defined length of time, which should be about three seconds. When a media element that is actively attempting to obtain media data has failed to receive any data for a duration equal to the stall timeout, the user agent must queue a task to fire a simple event named
stalled
at the element.User agents may allow users to selectively block or slow media data downloads. When a media element’s download has been blocked altogether, the user agent must act as if it was stalled (as opposed to acting as if the connection was closed). The rate of the download may also be throttled automatically by the user agent, e.g., to balance the download with other connections sharing the same bandwidth.
User agents may decide to not download more content at any time, e.g., after buffering five minutes of a one hour media resource, while waiting for the user to decide whether to play the resource or not, while waiting for user input in an interactive resource, or when the user navigates away from the page. When a media element’s download has been suspended, the user agent must queue a task, to set the
networkState
toNETWORK_IDLE
and fire a simple event namedsuspend
at the element. If and when downloading of the resource resumes, the user agent must queue a task to set thenetworkState
toNETWORK_LOADING
. Between the queuing of these tasks, the load is suspended (soprogress
events don’t fire, as described above).The
preload
attribute provides a hint regarding how much buffering the author thinks is advisable, even in the absence of theautoplay
attribute.When a user agent decides to completely suspend a download, e.g., if it is waiting until the user starts playback before downloading any further content, the user agent must queue a task to set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
The user agent may use whatever means necessary to fetch the resource (within the constraints put forward by this and other specifications); for example, reconnecting to the server in the face of network errors, using HTTP range retrieval requests, or switching to a streaming protocol. The user agent must consider a resource erroneous only if it has given up trying to fetch it.
To determine the format of the media resource, the user agent must use the rules for sniffing audio and video specifically.
While the load is not suspended (see below), every 350ms (±200ms) or for every byte received, whichever is least frequent, queue a task to fire a simple event named
progress
at the element.The networking task source tasks to process the data as it is being fetched must each immediately queue a task to run the first appropriate steps from the media data processing steps list below. (A new task is used for this so that the work described below occurs relative to the media element event task source rather than the networking task source.)
When the networking task source has queued the last task as part of fetching the media resource (i.e., once the download has completed), if the fetching process completes without errors, including decoding the media data, and if all of the data is available to the user agent without network access, then, the user agent must move on to the final step below. This might never happen, e.g., when streaming an infinite resource such as Web radio, or if the resource is longer than the user agent’s ability to cache data.
While the user agent might still need network access to obtain parts of the media resource, the user agent must remain on this step.
For example, if the user agent has discarded the first half of a video, the user agent will remain at this step even once the playback has ended, because there is always the chance the user will seek back to the start. In fact, in this situation, once playback has ended, the user agent will end up firing a
suspend
event, as described earlier.
-
Optionally, run the following substeps. This is the expected behavior if the user agent
intends to not attempt to fetch the resource until the user requests it explicitly
(e.g., as a way to implement the
- Otherwise (mode is local)
-
The resource described by the current media resource, if any, contains the media data. It is CORS-same-origin.
If the current media resource is a raw data stream (e.g., from a
File
object), then to determine the format of the media resource, the user agent must use the rules for sniffing audio and video specifically. Otherwise, if the data stream is pre-decoded, then the format is the format given by the relevant specification.Set the element’s delaying-the-load-event flag to false. This stops delaying the load event when the resource is local.
Whenever new data for the current media resource becomes available, queue a task to run the first appropriate steps from the media data processing steps list below.
When the current media resource is permanently exhausted (e.g., all the bytes of a
Blob
have been processed), if there were no decoding errors, then the user agent must move on to the final step below. This might never happen, e.g., if the current media resource is aMediaStream
.
The media data processing steps list is as follows:
- If the media data cannot be fetched at all, due to network errors, causing the
user agent to give up trying to fetch the resource
- If the media data can be fetched but is found by inspection to be in an unsupported format, or can otherwise not be rendered at all
-
DNS errors, HTTP 4xx and 5xx errors (and equivalents in other protocols), and other fatal network errors that occur before the user agent has established whether the current media resource is usable, as well as the file using an unsupported container format, or using unsupported codecs for all the data, must cause the user agent to execute the following steps:
- The user agent should cancel the fetching process.
- Abort this subalgorithm, returning to the resource selection algorithm.
- If the media resource is found to have an audio track
-
- Create an
AudioTrack
object to represent the audio track. - Update the media element’s
audioTracks
attribute’sAudioTrackList
object with the newAudioTrack
object. - Let enable be unknown.
-
If either the media resource or the address of the current media resource indicate a particular set of audio tracks to enable, or if the user agent has information that would facilitate the selection of specific audio tracks to improve the user’s experience, then: if this audio track is one of the ones to enable, then set enable to true, otherwise, set enable to false.
This could be triggered by Media Fragments URI fragment identifier syntax, but it could also be triggered e.g., by the user agent selecting a 5.1 surround sound audio track over a stereo audio track. [MEDIA-FRAGS]
- If enable is still unknown, then, if the media element does not yet have an enabled audio track, then set enable to true, otherwise, set enable to false.
- If enable is true, then enable this audio track, otherwise, do not enable this audio track.
- Fire a trusted event with the name
addtrack
, that does not bubble and is not cancelable, and that uses theTrackEvent
interface, with thetrack
attribute initialized to the newAudioTrack
object, at thisAudioTrackList
object.
- Create an
- If the media resource is found to have a video track
-
- Create a
VideoTrack
object to represent the video track. - Update the media element’s
videoTracks
attribute’sVideoTrackList
object with the newVideoTrack
object. - Let enable be unknown.
-
If either the media resource or the address of the current media resource indicate a particular set of video tracks to enable, or if the user agent has information that would facilitate the selection of specific video tracks to improve the user’s experience, then: if this video track is the first such video track, then set enable to true, otherwise, set enable to false.
- If enable is still unknown, then, if the media element does not yet have a selected video track, then set enable to true, otherwise, set enable to false.
- If enable is true, then select this track and unselect any
previously selected video tracks, otherwise, do not select this video track. If other
tracks are unselected, then a
change
event will be fired. - Fire a trusted event with the name
addtrack
, that does not bubble and is not cancelable, and that uses theTrackEvent
interface, with thetrack
attribute initialized to the newVideoTrack
object, at thisVideoTrackList
object.
- Create a
- Once enough of the media data has been fetched to determine the duration of the media resource, its dimensions, and other metadata
-
This indicates that the resource is usable. The user agent must follow these substeps:
-
Establish the media timeline for the purposes of the current playback position and the earliest possible position, based on the media data.
-
Update the timeline offset to the date and time that corresponds to the zero time in the media timeline established in the previous step, if any. If no explicit time and date is given by the media resource, the timeline offset must be set to Not-a-Number (NaN).
- Set the current playback position and the official playback position to the earliest possible position.
-
Update the
duration
attribute with the time of the last frame of the resource, if known, on the media timeline established above. If it is not known (e.g., a stream that is in principle infinite), update theduration
attribute to the value positive Infinity.The user agent will queue a task to fire a simple event named
durationchange
at the element at this point. -
For
video
elements, set thevideoWidth
andvideoHeight
attributes, and queue a task to fire a simple event namedresize
at the media element.Further
resize
events will be fired if the dimensions subsequently change. -
Set the
readyState
attribute toHAVE_METADATA
.A
loadedmetadata
DOM event will be fired as part of setting thereadyState
attribute to a new value. - Let jumped be false.
- If the media element’s default playback start position is greater than zero, then seek to that time, and let jumped be true.
- Let the media element’s default playback start position be zero.
- Let the initial playback position be zero.
-
If either the media resource or the address of the current media resource indicate a particular start time, then set the initial playback position to that time and, if jumped is still false, seek to that time and let jumped be true.
For example, with media formats that support the media fragment syntax the fragment, can be used to indicate a start position. [MEDIA-FRAGS]
- If there is no enabled audio track, then enable an audio track. This will cause a
change
event to be fired. - If there is no selected video track, then select a video track. This will
cause a
change
event to be fired.
Once the
readyState
attribute reachesHAVE_CURRENT_DATA
, after theloadeddata
event has been fired, set the element’s delaying-the-load-event flag to false. This stops delaying the load event.A user agent that is attempting to reduce network usage while still fetching the metadata for each media resource would also stop buffering at this point, following the rules described previously, which involve the
networkState
attribute switching to theNETWORK_IDLE
value and asuspend
event firing.The user agent is required to determine the duration of the media resource and go through this step before playing.
-
- Once the entire media resource has been fetched (but potentially before any of it has been decoded)
-
Fire a simple event named
progress
at the media element.Set the
networkState
toNETWORK_IDLE
and fire a simple event namedsuspend
at the media element.If the user agent ever discards any media data and then needs to resume the network activity to obtain it again, then it must queue a task to set the
networkState
toNETWORK_LOADING
.If the user agent can keep the media resource loaded, then the algorithm will continue to its final step below, which aborts the algorithm.
- If the connection is interrupted after some media data has been received, causing the user agent to give up trying to fetch the resource
-
Fatal network errors that occur after the user agent has established whether the current media resource is usable (i.e., once the media element’s
readyState
attribute is no longerHAVE_NOTHING
) must cause the user agent to execute the following steps:- The user agent should cancel the fetching process.
- Set the
error
attribute to a newMediaError
object whosecode
attribute is set toMEDIA_ERR_NETWORK
. - Set the element’s
networkState
attribute to theNETWORK_IDLE
value. - Set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
- Fire a simple event named
error
at the media element. - Abort the overall resource selection algorithm.
- If the media data is corrupted
-
Fatal errors in decoding the media data that occur after the user agent has established whether the current media resource is usable (i.e., once the media element’s
readyState
attribute is no longerHAVE_NOTHING
) must cause the user agent to execute the following steps:- The user agent should cancel the fetching process.
- Set the
error
attribute to a newMediaError
object whosecode
attribute is set toMEDIA_ERR_DECODE
. - Set the element’s
networkState
attribute to theNETWORK_IDLE
value. - Set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
- Fire a simple event named
error
at the media element. - Abort the overall resource selection algorithm.
- If the media data fetching process is aborted by the user
-
The fetching process is aborted by the user, e.g., because the user pressed a "stop" button, the user agent must execute the following steps. These steps are not followed if the
load()
method itself is invoked while these steps are running, as the steps above handle that particular kind of abort.- The user agent should cancel the fetching process.
- Set the
error
attribute to a newMediaError
object whosecode
attribute is set toMEDIA_ERR_ABORTED
. - Fire a simple event named
abort
at the media element. -
If the media element’s
readyState
attribute has a value equal toHAVE_NOTHING
, set the element’snetworkState
attribute to theNETWORK_EMPTY
value, set the element’s show poster flag to true, and fire a simple event named emptied at the element.Otherwise, set the element’s
networkState
attribute to theNETWORK_IDLE
value. - Set the element’s delaying-the-load-event flag to false. This stops delaying the load event.
- Abort the overall resource selection algorithm.
- If the media data can be fetched but has non-fatal errors or uses, in part, codecs that are unsupported, preventing the user agent from rendering the content completely correctly but not preventing playback altogether
-
The server returning data that is partially usable but cannot be optimally rendered must cause the user agent to render just the bits it can handle, and ignore the rest.
- If the media resource is found to declare a media-resource-specific text track that the user agent supports
-
If the media data is CORS-same-origin, run the steps to expose a media-resource-specific text track with the relevant data.
Cross-origin videos do not expose their subtitles, since that would allow attacks such as hostile sites reading subtitles from confidential videos on a user’s intranet.
- Final step: If the user agent ever reaches this step (which can only happen if the entire resource gets loaded and kept available): abort the overall resource selection algorithm.
When a media element is to forget the media element’s media-resource-specific
tracks, the user agent must remove from the media element’s list of text tracks all the media-resource-specific text tracks, then empty the media element’s audioTracks
attribute’s AudioTrackList
object,
then empty the media element’s videoTracks
attribute’s VideoTrackList
object. No events (in particular, no removetrack
events) are fired as part of this;
the error
and emptied events, fired by the algorithms that
invoke this one, can be used instead.
The preload
attribute is an enumerated
attribute. The following table lists the keywords and states for the attribute — the
keywords in the left column map to the states in the cell in the second column on the same row as
the keyword. The attribute can be changed even once the media resource is being
buffered or played; the descriptions in the table below are to be interpreted with that in mind.
Keyword | State | Brief description |
---|---|---|
none
| None | Hints to the user agent that either the author does not expect the user to need the media resource, or that the server wants to minimize unnecessary traffic. This state does not provide a hint regarding how aggressively to actually download the media resource if buffering starts anyway (e.g., once the user hits "play"). |
metadata
| Metadata | Hints to the user agent that the author does not expect the user to need the media resource, but that fetching the resource metadata (dimensions, track list, duration, etc), and maybe even the first few frames, is reasonable. If the user agent precisely fetches no more than the metadata, then the media element will end up with its readyState attribute set to HAVE_METADATA ; typically though, some frames will be obtained as well and it will probably be HAVE_CURRENT_DATA or HAVE_FUTURE_DATA .
When the media resource is playing, hints to the user agent that bandwidth is to be considered scarce, e.g., suggesting throttling the download so that the media data is obtained at the slowest possible rate that still maintains consistent playback.
|
auto
| Automatic | Hints to the user agent that the user agent can put the user’s needs first without risk to the server, up to and including optimistically downloading the entire resource. |
The empty string is also a valid keyword, and maps to the Automatic state. The attribute’s missing value default is user-agent defined, though the Metadata state is suggested as a compromise between reducing server load and providing an optimal user experience.
Authors might switch the attribute from "none
" or "metadata
" to
"auto
" dynamically once the user begins playback. For example, on a page with
many videos this might be used to indicate that the many videos are not to be downloaded
unless requested, but that once one is requested it is to be downloaded aggressively.
The preload
attribute is intended to provide a hint to the user agent about what
the author thinks will lead to the best user experience. The attribute may be ignored
altogether, for example based on explicit user preferences or based on the available
connectivity.
The preload
IDL attribute must reflect the content attribute of the same name, limited to only known values.
The autoplay
attribute can override the preload
attribute
(since if the media plays, it naturally has to buffer first, regardless of the hint given
by the preload
attribute). Including both is not an error.
- media .
buffered
-
Returns a
TimeRanges
object that represents the ranges of the media resource that the user agent has buffered.
The buffered
attribute must return a new
static normalized TimeRanges
object that represents the ranges of the media resource, if any, that the user agent has buffered, at the time the attribute
is evaluated. Users agents must accurately determine the ranges available, even for media streams
where this can only be determined by tedious inspection.
Typically this will be a single range anchored at the zero point. However, if the user agent uses HTTP range requests in response to seeking, then there could be multiple ranges.
User agents may discard previously buffered data.
Thus, a time position included within a range of the objects return by the buffered
attribute at one time can end up being not included in the range(s) of
objects returned by the same attribute at later times.
4.7.13.6. Offsets into the media resource
- media .
duration
-
Returns the length of the media resource, in seconds, assuming that the start of the media resource is at time zero.
Returns NaN if the duration isn’t available.
Returns Infinity for unbounded streams.
- media .
currentTime
[ = value ] -
Returns the official playback position, in seconds.
Can be set, to seek to the given time.
A media resource has a media timeline that maps times (in seconds) to positions in the media resource. The origin of a timeline is its earliest defined position. The duration of a timeline is its last defined position.
Establishing the media timeline:
If the media resource somehow specifies an explicit timeline whose origin is not negative
(i.e., gives each frame a specific time offset and gives the first frame a zero or positive
offset), then the media timeline should be that timeline. (Whether the media resource can specify a timeline or not depends on the media resource’s format.) If the media resource specifies an explicit start time and date,
then that time and date should be considered the zero point in the media timeline; the timeline offset will be the time and date, exposed using the getStartDate()
method.
If the media resource has a discontinuous timeline, the user agent must extend the timeline used at the start of the resource across the entire resource, so that the media timeline of the media resource increases linearly starting from the earliest possible position (as defined below), even if the underlying media data has out-of-order or even overlapping time codes.
For example, if two clips have been concatenated into one video file, but the video format exposes the original times for the two clips, the video data might expose a timeline that goes, say, 00:15..00:29 and then 00:05..00:38. However, the user agent would not expose those times; it would instead expose the times as 00:15..00:29 and 00:29..01:02, as a single video.
In the rare case of a media resource that does not have an explicit timeline, the
zero time on the media timeline should correspond to the first frame of the media resource. In the even rarer case of a media resource with no
explicit timings of any kind, not even frame durations, the user agent must itself determine the
time for each frame in a user-agent-defined manner.
An example of a file format with no explicit timeline but with explicit frame durations is
the Animated GIF format. An example of a file format with no explicit timings at all is the
JPEG-push format (multipart/x-mixed-replace
with JPEG frames, often used as the
format for MJPEG streams).
If, in the case of a resource with no timing information, the user agent will nonetheless be able to seek to an earlier point than the first frame originally provided by the server, then the zero time should correspond to the earliest seekable time of the media resource; otherwise, it should correspond to the first frame received from the server (the point in the media resource at which the user agent began receiving the stream).
At the time of writing, there is no known format that lacks explicit frame time offsets yet still supports seeking to a frame before the first frame sent by the server.
getStartDate()
method would always return the date that the
broadcast started; this would allow controllers to display real times in their scrubber (e.g.,
"2:30pm") rather than a time relative to when the broadcast began ("8 months, 4 hours, 12
minutes, and 23 seconds").
Consider a stream that carries a video with several concatenated fragments, broadcast by a
server that does not allow user agents to request specific times but instead just streams the
video data in a predetermined order, with the first frame delivered always being identified as
the frame with time zero. If a user agent connects to this stream and receives fragments
defined as covering timestamps 2010-03-20 23:15:00 UTC to 2010-03-21 00:05:00 UTC and
2010-02-12 14:25:00 UTC to 2010-02-12 14:35:00 UTC, it would expose this with a media timeline starting at 0s and extending to 3,600s (one hour). Assuming the
streaming server disconnected at the end of the second clip, the duration
attribute would then return 3,600. The getStartDate()
method would return a Date
object with a time corresponding to 2010-03-20 23:15:00 UTC. However, if a
different user agent connected five minutes later, it would (presumably) receive
fragments covering timestamps 2010-03-20 23:20:00 UTC to 2010-03-21 00:05:00 UTC and 2010-02-12
14:25:00 UTC to 2010-02-12 14:35:00 UTC, and would expose this with a media timeline starting at 0s and extending to 3,300s (fifty five minutes). In this case, the getStartDate()
method would return a Date
object
with a time corresponding to 2010-03-20 23:20:00 UTC.
In both of these examples, the seekable
attribute would give the ranges that
the controller would want to actually display in its UI; typically, if
the servers don’t support seeking to arbitrary times, this would be the range of time from the
moment the user agent connected to the stream up to the latest frame that the user agent has
obtained; however, if the user agent starts discarding earlier information, the actual range
might be shorter.
In any case, the user agent must ensure that the earliest possible position (as defined below) using the established media timeline, is greater than or equal to zero.
The media timeline also has an associated clock. Which clock is used is user-agent defined, and may be media resource-dependent, but it should approximate the user’s wall clock.
Media elements have a current playback position, which must initially (i.e., in the absence of media data) be zero seconds. The current playback position is a time on the media timeline.
Media elements also have an official playback position, which must initially be set to zero seconds. The official playback position is an approximation of the current playback position that is kept stable while scripts are running.
Media elements also have a default playback start position, which must initially be set to zero seconds. This time is used to allow the element to be seeked even before the media is loaded.
Each media element has a show poster flag. When a media element is created, this flag must be set to true. This flag is used to control when the user agent
is to show a poster frame for a video
element instead of showing the video contents.
The currentTime
attribute must, on
getting, return the media element’s default playback start position,
unless that is zero, in which case it must return the element’s official playback
position. The returned value must be expressed in seconds. On setting, if the media element’s readyState
is HAVE_NOTHING
,
then it must set the media element’s default playback start position to the
new value; otherwise, it must set the official playback position to the new value and
then seek to the new value. The new value must be interpreted as being in seconds.
Media elements have an initial playback position, which must initially (i.e., in the absence of media data) be zero seconds. The initial playback position is updated when a media resource is loaded. The initial playback position is a time on the media timeline.
If the media resource is a streaming resource, then the user agent might be unable to obtain certain parts of the resource after it has expired from its buffer. Similarly, some media resources might have a media timeline that doesn’t start at zero. The earliest possible position is the earliest position in the stream or resource that the user agent can ever obtain again. It is also a time on the media timeline.
The earliest possible position is not explicitly exposed in the API; it corresponds to
the start time of the first range in the seekable
attribute’s TimeRanges
object, if any, or the current playback position otherwise.
When the earliest possible position changes, then: if the current playback
position is before the earliest possible position, the user agent must seek to the earliest possible position; otherwise, if the user agent has not
fired a timeupdate
event at the element in the past 15 to 250ms and is not still
running event handlers for such an event, then the user agent must queue a task to fire a simple event named timeupdate
at the element.
Because of the above requirement and the requirement in the resource fetch algorithm that kicks in when the metadata of the clip becomes known, the current playback position can never be less than the earliest possible position.
If at any time the user agent learns that an audio or video track has ended and all media
data relating to that track corresponds to parts of the media timeline that
are before the earliest possible position, the user agent may queue a
task to first remove the track from the audioTracks
attribute’s AudioTrackList
object or the videoTracks
attribute’s VideoTrackList
object as appropriate and then fire a trusted event with the
name removetrack
, that does not bubble and is not cancelable, and that
uses the TrackEvent
interface, with the track
attribute initialized to the AudioTrack
or VideoTrack
object representing the track, at the media element’s aforementioned AudioTrackList
or VideoTrackList
object.
The duration
attribute must return
the time of the end of the media resource, in seconds, on the media timeline.
If no media data is available, then the attributes must return the Not-a-Number (NaN)
value. If the media resource is not known to be bounded (e.g., streaming radio, or a
live event with no announced end time), then the attribute must return the positive Infinity
value.
The user agent must determine the duration of the media resource before playing
any part of the media data and before setting readyState
to a value equal
to or greater than HAVE_METADATA
, even if doing so requires fetching multiple
parts of the resource.
When the length of the media resource changes to a known value (e.g., from being unknown to known, or from a previously established length to a new length) the user agent must queue a task to fire a simple event named durationchange at the media element. (The event is not fired when the duration is reset as part of loading a new media resource.) If the duration is changed such that the current playback position ends up being greater than the time of the end of the media resource, then the user agent must also seek to the time of the end of the media resource.
If an "infinite" stream ends for some reason, then the duration would change from positive
Infinity to the time of the last frame or sample in the stream, and the durationchange
event would be fired. Similarly, if the user agent initially
estimated the media resource’s duration instead of determining it precisely, and later
revises the estimate based on new information, then the duration would change and the durationchange
event would be fired.
Some video files also have an explicit date and time corresponding to the zero time in the media timeline, known as the timeline offset. Initially, the timeline offset must be set to Not-a-Number (NaN).
The getStartDate()
method must return a new Date
object representing the current timeline offset.
The loop
attribute is a boolean
attribute that, if specified, indicates that the media element is to seek back
to the start of the media resource upon reaching the end.
The loop
IDL attribute must reflect the content attribute of the same name.
4.7.13.7. Ready states
- media .
readyState
-
Returns a value that expresses the current state of the element with respect to rendering the current playback position, from the codes in the list below.
Media elements have a ready state, which describes to what degree they are ready to be rendered at the current playback position. The possible values are as follows; the ready state of a media element at any particular time is the greatest value describing the state of the element:
HAVE_NOTHING
(numeric value 0)- No information regarding the media resource is available. No data for the current playback position is available. Media elements whose
networkState
attribute are set toNETWORK_EMPTY
are always in theHAVE_NOTHING
state. HAVE_METADATA
(numeric value 1)- Enough of the resource has been obtained that the duration of the resource is available.
In the case of a
video
element, the dimensions of the video are also available. No media data is available for the immediate current playback position. HAVE_CURRENT_DATA
(numeric value 2)- Data for the immediate current playback position is available, but either not
enough data is available that the user agent could successfully advance the current
playback position in the direction of playback at all without immediately
reverting to the
HAVE_METADATA
state, or there is no more data to obtain in the direction of playback. For example, in video this corresponds to the user agent having data from the current frame, but not the next frame, when the current playback position is at the end of the current frame; and to when playback has ended. HAVE_FUTURE_DATA
(numeric value 3)- Data for the immediate current playback position is available, as well as
enough data for the user agent to advance the current playback position in the direction of playback at least a little without immediately reverting to the
HAVE_METADATA
state, and the text tracks are ready. For example, in video this corresponds to the user agent having data for at least the current frame and the next frame when the current playback position is at the instant in time between the two frames, or to the user agent having the video data for the current frame and audio data to keep playing at least a little when the current playback position is in the middle of a frame. The user agent cannot be in this state if playback has ended, as the current playback position can never advance in this case. HAVE_ENOUGH_DATA
(numeric value 4)-
All the conditions described for the
HAVE_FUTURE_DATA
state are met, and, in addition, either of the following conditions is also true:- The user agent estimates that data is being fetched at a rate where the current playback position, if it were to advance at the effective playback rate, would not overtake the available data before playback reaches the end of the media resource.
- The user agent has entered a state where waiting longer will not result in further data being obtained, and therefore nothing would be gained by delaying playback any further. (For example, the buffer might be full.)
In practice, the difference between HAVE_METADATA
and HAVE_CURRENT_DATA
is negligible. Really the only time the difference is
relevant is when painting a video
element onto a canvas
, where it distinguishes the
case where something will be drawn (HAVE_CURRENT_DATA
or greater) from the case
where nothing is drawn (HAVE_METADATA
or less). Similarly, the difference between HAVE_CURRENT_DATA
(only the current frame) and HAVE_FUTURE_DATA
(at least this frame and the next) can be negligible (in the extreme, only one frame). The
only time that distinction really matters is when a page provides an interface for
"frame-by-frame" navigation.
When the ready state of a media element whose networkState
is not NETWORK_EMPTY
changes, the user agent must follow the steps given below:
-
Apply the first applicable set of substeps from the following list:
- If the previous ready state was
HAVE_NOTHING
, and the new ready state isHAVE_METADATA
-
Queue a task to fire a simple event named
loadedmetadata
at the element.Before this task is run, as part of the event loop mechanism, the rendering will have been updated to resize the
video
element if appropriate. - If the previous ready state was
HAVE_METADATA
and the new ready state isHAVE_CURRENT_DATA
or greater -
If this is the first time this occurs for this media element since the
load()
algorithm was last invoked, the user agent must queue a task to fire a simple event namedloadeddata
at the element.If the new ready state is
HAVE_FUTURE_DATA
orHAVE_ENOUGH_DATA
, then the relevant steps below must then be run also. - If the previous ready state was
HAVE_FUTURE_DATA
or more, and the new ready state isHAVE_CURRENT_DATA
or less -
If the media element was potentially playing before its
readyState
attribute changed to a value lower thanHAVE_FUTURE_DATA
, and the element has not ended playback, and playback has not stopped due to errors, paused for user interaction, or paused for in-band content, the user agent must queue a task to fire a simple event namedtimeupdate
at the element, and queue a task to fire a simple event namedwaiting
at the element. - If the previous ready state was
HAVE_CURRENT_DATA
or less, and the new ready state isHAVE_FUTURE_DATA
-
The user agent must queue a task to fire a simple event named
canplay
at the element.If the element’s
paused
attribute is false, the user agent must queue a task to fire a simple event namedplaying
at the element. - If the new ready state is
HAVE_ENOUGH_DATA
-
If the previous ready state was
HAVE_CURRENT_DATA
or less, the user agent must queue a task to fire a simple event namedcanplay
at the element, and, if the element’spaused
attribute is false, queue a task to fire a simple event namedplaying
at the element.If the autoplaying flag is true, and the
paused
attribute is true, and the media element has anautoplay
attribute specified, and the media element’s node document’s active sandboxing flag set does not have the sandboxed automatic features browsing context flag set, then the user agent may also run the following substeps:- Set the
paused
attribute to false. - If the element’s show poster flag is true, set it to false and run the time marches on steps.
- Queue a task to fire a simple event named
play
at the element. - Queue a task to fire a simple event named
playing
at the element. - Set the autoplaying flag to false.
User agents do not need to support autoplay, and it is suggested that user agents honor user preferences on the matter. Authors are urged to use the
autoplay
attribute rather than using script to force the video to play, so as to allow the user to override the behavior if so desired.In any case, the user agent must finally queue a task to fire a simple event named
canplaythrough
at the element. - Set the
- If the previous ready state was
It is possible for the ready state of a media element to jump between these states
discontinuously. For example, the state of a media element can jump straight from HAVE_METADATA
to HAVE_ENOUGH_DATA
without passing through the HAVE_CURRENT_DATA
and HAVE_FUTURE_DATA
states.
The readyState
IDL attribute must, on
getting, return the value described above that describes the current ready state of the media element.
The autoplay
attribute is a boolean
attribute. When present, the user agent (as described in the algorithm
described herein) will automatically begin playback of the media resource as
soon as it can do so without stopping.
Authors are urged to use the autoplay
attribute rather than using script to
trigger automatic playback, as this allows the user to override the automatic playback when
it is not desired, e.g., when using a screen reader. Authors are also encouraged to consider
not using the automatic playback behavior at all, and instead to let the user agent wait for
the user to start playback explicitly.
The autoplay
IDL attribute must reflect the content attribute of the same name.
4.7.13.8. Playing the media resource
- media .
paused
-
Returns true if playback is paused; false otherwise.
- media .
ended
-
Returns true if playback has reached the end of the media resource.
- media .
disableRemotePlayback
-
Whether the remote playback of a media element is disabled.
- media .
defaultPlaybackRate
[ = value ] -
Returns the default rate of playback, for when the user is not fast-forwarding or reversing through the media resource.
Can be set, to change the default rate of playback.
The default rate has no direct effect on playback, but if the user switches to a fast-forward mode, when they return to the normal playback mode, it is expected that the rate of playback will be returned to the default rate of playback.
- media .
playbackRate
[ = value ] -
Returns the current rate playback, where 1.0 is normal speed.
Can be set, to change the rate of playback.
- media .
played
-
Returns a
TimeRanges
object that represents the ranges of the media resource that the user agent has played. - media .
play()
-
Sets the
paused
attribute to false, loading the media resource and beginning playback if necessary. If the playback had ended, will restart it from the start. - media .
pause
() -
Sets the
paused
attribute to true, loading the media resource if necessary.
The paused
attribute represents whether
the media element is paused or not. The attribute must initially be true.
A media element is a blocked media element if its readyState
attribute is in the HAVE_NOTHING
state, the HAVE_METADATA
state, or the HAVE_CURRENT_DATA
state, or if the element has paused for user interaction or paused for in-band content.
A media element is said to be potentially playing when its paused
attribute is false, the element has not ended playback,
playback has not stopped due to errors, and the element is not a blocked media element.
A waiting
DOM event can be fired as a result of an element that is potentially playing stopping playback due to its readyState
attribute changing to a value lower than HAVE_FUTURE_DATA
.
A media element is said to have ended playback when:
- The element’s
readyState
attribute isHAVE_METADATA
or greater, and -
Either:
- The current playback position is the end of the media resource, and
- The direction of playback is forwards, and
- The media element does not have a
loop
attribute specified.
Or:
- The current playback position is the earliest possible position, and
- The direction of playback is backwards.
The ended
attribute must return true if,
the last time the event loop reached step 1, the media element had ended playback and the direction of playback was forwards, and false otherwise.
A media element is said to have stopped due to errors when the
element’s readyState
attribute is HAVE_METADATA
or greater, and the user agent encounters a non-fatal error during the processing of the media data, and due to that error, is not able to play the content at the current playback position.
A media element is said to have paused for user interaction when its paused
attribute is false, the readyState
attribute is
either HAVE_FUTURE_DATA
or HAVE_ENOUGH_DATA
and the user agent has
reached a point in the media resource where the user has to make a selection for the
resource to continue.
It is possible for a media element to have both ended playback and paused for user interaction at the same time.
When a media element that is potentially playing stops playing
because it has paused for user interaction, the user agent must queue a
task to fire a simple event named timeupdate
at the element.
A media element is said to have paused for in-band content when its paused
attribute is false, the readyState
attribute is
either HAVE_FUTURE_DATA
or HAVE_ENOUGH_DATA
and the user agent has
suspended playback of the media resource in order to play content that is temporally
anchored to the media resource and has a non-zero length, or to play content that is
temporally anchored to a segment of the media resource but has a length longer than
that segment.
One example of when a media element would be paused for in-band content is when the user agent is playing audio descriptions from an external WebVTT file, and the synthesized speech generated for a cue is longer than the time between the text track cue start time and the text track cue end time.
When the current playback position reaches the end of the media resource when the direction of playback is forwards, then the user agent must follow these steps:
- If the media element has a
loop
attribute specified, then seek to the earliest possible position of the media resource and abort these steps. - As defined above, the
ended
IDL attribute starts returning true once the event loop returns to step 1. - Queue a task to fire a simple event named
timeupdate
at the media element. - Queue a task that, if the media element has still ended playback, and
the direction of playback is still forwards, and
paused
is false, changespaused
to true and fires a simple event namedpause
at the media element, take pending play promises and reject pending play promises with the result and anAbortError
DOMException
. - Queue a task to fire a simple event named
ended
at the media element.
When the current playback position reaches the earliest possible
position of the media resource when the direction of playback is
backwards, then the user agent must only queue a task to fire a simple
event named timeupdate
at the element.
The word "reaches" here does not imply that the current playback position needs to have changed during normal playback; it could be via seeking, for instance.
The remote
attribute
MUST return the RemotePlayback object associated with the media element.
The disableRemotePlayback
attribute is a boolean
attribute. When present, the user agent MUST NOT play the media element remotely or present any UI to do so.
When the disableRemotePlayback
attribute is added to the media element, the user agent MUST run the steps to disable remote playback.
A corresponding disableRemotePlayback
IDL attribute which reflects the
value of each element’s disableRemotePlayback
content
attribute is added to the HTMLMediaElement
interface. The disableRemotePlayback
IDL attribute MUST reflect the content attribute of the same name.
The defaultPlaybackRate
attribute
gives the desired speed at which the media resource is to play, as a multiple of its
intrinsic speed. The attribute is mutable: on getting it must return the last value it was set to,
or 1.0 if it hasn’t yet been set; on setting the attribute must be set to the new value.
The defaultPlaybackRate
is used by the user agent when it exposes a user interface to the user.
The playbackRate
attribute gives the effective playback rate which is the speed at which the media resource plays, as a
multiple of its intrinsic speed. If it is not equal to the defaultPlaybackRate
, then the implication is that the user is using a feature
such as fast forward or slow motion playback. The attribute is mutable: on getting it must return
the last value it was set to, or 1.0 if it hasn’t yet been set; on setting the attribute must be
set to the new value, and the playback will change speed (if the element is potentially playing).
When the defaultPlaybackRate
or playbackRate
attributes
change value (either by being set by script or by being changed directly by the user agent, e.g.,
in response to user control) the user agent must queue a task to fire a simple event named ratechange
at the media element.
The played
attribute must return a new
static normalized TimeRanges
object that represents the ranges of points on
the media timeline of the media resource reached through the usual monotonic
increase of the current playback position during normal playback, if any, at the time
the attribute is evaluated.
Each media element has a list of pending play promises, which must be initially empty.
To take pending play promises for a media element, the user agent must run the following steps:
- Let promises be an empty list of promises.
- Copy the media element's list of pending play promises to promises.
- Clear the media element's list of pending play promises.
- Return promises.
To resolve pending play promises for a media element with a list of promises promises, the user agent must resolve each promise in promises with undefined.
To reject pending play promises for a media element with a list of promise promises and an exception name error, the user agent must reject each promise in promises with error.
To notify about playing for a media element, the user agent must run the following steps:
- Take pending play promises and let promises be the result.
- Queue a task to run these steps:
- Fire an event named playing at the element.
- Resolve pending play promises with promises.
When the
play()
method on a media element is invoked, the user agent must run the following steps.-
If the media element is not allowed to play, return a promise rejected
with a "
NotAllowedError
"DOMException
.For example, a user agent could require user interaction in order to start playback. This specification does not require any particular behavior.
-
If the media element's
error
attribute is not null and itscode
isMEDIA_ERR_SRC_NOT_SUPPORTED
, return a promise rejected with a "NotSupportedError
" DOMException.This means that the dedicated media source failure steps have run. Playback is not possible until the media element load algorithm clears the error attribute.
- Let promise be a new promise and append promise to the list of pending play promises.
- If the media element’s
networkState
attribute has the valueNETWORK_EMPTY
, invoke the media element’s resource selection algorithm. -
If the playback has ended and the direction of playback is forwards, seek to the earliest possible position of the media resource.
This will cause the user agent to queue a task to fire a simple event named
timeupdate
at the media element. -
If the media element’s
paused
attribute is true, run the following substeps:- Change the value of
paused
to false. - If the show poster flag is true, set the element’s show poster flag to false and run the time marches on steps.
- Queue a task to notify about playing for the element.
-
If the media element’s
readyState
attribute has the valueHAVE_NOTHING
,HAVE_METADATA
, orHAVE_CURRENT_DATA
, queue a task to fire a simple event namedwaiting
at the element.Otherwise, the media element’s
readyState
attribute has the valueHAVE_FUTURE_DATA
orHAVE_ENOUGH_DATA
: queue a task to notify about playing at the element.
- Change the value of
-
Otherwise, if the media element's
readyState
attribute has the valueHAVE_FUTURE_DATA
orHAVE_ENOUGH_DATA
, take pending play promises and queue a task to resolve pending play promises with the result.The media element is already playing. However, it’s possible that promise will be rejected before the queued task is run.
- Set the media element’s autoplaying flag to false.
- Return promise.
When the
pause()
method is invoked, and when the user agent is required to pause the media element, the user agent must run the following steps:- If the media element’s
networkState
attribute has the valueNETWORK_EMPTY
, invoke the media element’s resource selection algorithm. - Run the internal pause steps for the media element.
The internal pause steps for a media element are as follows:
- Set the media element’s autoplaying flag to false.
-
If the media element’s
paused
attribute is false, run the following steps:- Change the value of
paused
to true. - Queue a task to fire a simple
event named
timeupdate
at the element. - Queue a task to fire a simple
event named
pause
at the element. - Set the official playback position to the current playback position.
- Change the value of
The effective playback rate is just the element’s
playbackRate
.If the effective playback rate is positive or zero, then the direction of playback is forwards. Otherwise, it is backwards.
When a media element is potentially playing and its
Document
is a fully activeDocument
, its current playback position must increase monotonically at effective playback rate units of media time per unit time of the media timeline’s clock. (This specification always refers to this as an increase, but that increase could actually be a decrease if the effective playback rate is negative.)The effective playback rate can be 0.0, in which case the current playback position doesn’t move, despite playback not being paused (
paused
doesn’t become true, and thepause
event doesn’t fire).This specification doesn’t define how the user agent achieves the appropriate playback rate — depending on the protocol and media available, it is plausible that the user agent could negotiate with the server to have the server provide the media data at the appropriate rate, so that (except for the period between when the rate is changed and when the server updates the stream’s playback rate) the client doesn’t actually have to drop or interpolate any frames.
Any time the user agent provides a stable state, the official playback position must be set to the current playback position.
While the direction of playback is backwards, any corresponding audio must be muted. While the effective playback rate is so low or so high that the user agent cannot play audio usefully, the corresponding audio must also be muted. If the effective playback rate is not 1.0, the user agent may apply pitch adjustments to the audio as necessary to render it faithfully.
Media elements that are potentially playing while not in a
Document
must not play any video, but should play any audio component. Media elements must not stop playing just because all references to them have been removed; only once a media element is in a state where no further audio could ever be played by that element may the element be garbage collected.It is possible for an element to which no explicit references exist to play audio, even if such an element is not still actively playing: for instance, a media element whose media resource has no audio tracks could eventually play audio again if it had an event listener that changes the media resource.
Each media element has a list of newly introduced cues, which must be initially empty. Whenever a text track cue is added to the list of cues of a text track that is in the list of text tracks for a media element, that cue must be added to the media element’s list of newly introduced cues. Whenever a text track is added to the list of text tracks for a media element, all of the cues in that text track’s list of cues must be added to the media element’s list of newly introduced cues. When a media element’s list of newly introduced cues has new cues added while the media element’s show poster flag is not set, then the user agent must run the time marches on steps.
When a text track cue is removed from the list of cues of a text track that is in the list of text tracks for a media element, and whenever a text track is removed from the list of text tracks of a media element, if the media element’s show poster flag is not set, then the user agent must run the time marches on steps.
When the current playback position of a media element changes (e.g., due to playback or seeking), the user agent must run the time marches on steps. If the current playback position changes while the steps are running, then the user agent must wait for the steps to complete, and then must immediately rerun the steps. (These steps are thus run as often as possible or needed — if one iteration takes a long time, this can cause certain cues to be skipped over as the user agent rushes ahead to "catch up".)
The time marches on steps are as follows:
- Let current cues be a list of cues, initialized to contain all the cues of all the or showing text tracks of the media element (not the disabled ones) whose start times are less than or equal to the current playback position and whose end times are greater than the current playback position.
- Let other cues be a list of cues, initialized to contain all the cues of and showing text tracks of the media element that are not present in current cues.
- Let last time be the current playback position at the time this algorithm was last run for this media element, if this is not the first time it has run.
- If the current playback position has, since the last time this algorithm was run, only changed through its usual monotonic increase during normal playback, then let missed cues be the list of cues in other cues whose start times are greater than or equal to last time and whose end times are less than or equal to the current playback position. Otherwise, let missed cues be an empty list.
- Remove all the cues in missed cues that are also in the media element’s list of newly introduced cues, and then empty the element’s list of newly introduced cues.
-
If the time was reached through the usual monotonic increase of the current playback
position during normal playback, and if the user agent has not fired a
timeupdate
event at the element in the past 15 to 250ms and is not still running event handlers for such an event, then the user agent must queue a task to fire a simple event namedtimeupdate
at the element. (In the other cases, such as explicit seeks, relevant events get fired as part of the overall process of changing the current playback position.)The event thus is not to be fired faster than about 66Hz or slower than 4Hz (assuming the event handlers don’t take longer than 250ms to run). User agents are encouraged to vary the frequency of the event based on the system load and the average cost of processing the event each time, so that the UI updates are not any more frequent than the user agent can comfortably handle while decoding the video.
- If all of the cues in current cues have their text track cue active flag set, none of the cues in other cues have their text track cue active flag set, and missed cues is empty, then abort these steps.
-
If the time was reached through the usual monotonic increase of the current playback position during normal playback, and there are cues in other cues that have their text track cue pause-on-exit flag set and that either have their text track cue active flag set or are also in missed cues, then immediately pause the media element.
In the other cases, such as explicit seeks, playback is not paused by going past the end time of a cue, even if that cue has its text track cue pause-on-exit flag set.
-
Let events be a list of tasks, initially empty. Each task in this list will be associated with a text track, a text track cue, and a time, which are used to sort the list before the tasks are queued.
Let affected tracks be a list of text tracks, initially empty.
When the steps below say to prepare an event named event for a text track cue target with a time time, the user agent must run these substeps:
- Let track be the text track with which the text track cue target is associated.
- Create a task to fire a simple event named event at target.
- Add the newly created task to events, associated with the time time, the text track track, and the text track cue target.
- Add track to affected tracks.
- For each text track cue in missed
cues, prepare an event named
enter
for theTextTrackCue
object with the text track cue start time. - For each text track cue in other
cues that either has its text track cue active flag set or is in missed cues, prepare an event named
exit
for theTextTrackCue
object with the later of the text track cue end time and the text track cue start time. - For each text track cue in current
cues that does not have its text track cue active flag set, prepare an
event named
enter
for theTextTrackCue
object with the text track cue start time. -
Sort the tasks in events in ascending time order (tasks with earlier times first).
Further sort tasks in events that have the same time by the relative text track cue order of the text track cues associated with these tasks.
Finally, sort tasks in events that have the same time and same text track cue order by placing tasks that fire
enter
events before those that fireexit
events. - Queue each task in events, in list order.
- Sort affected tracks in the same order as the text tracks appear in the media element’s list of text tracks, and remove duplicates.
- For each text track in affected tracks, in the list
order, queue a task to fire a simple event named
cuechange
at theTextTrack
object, and, if the text track has a correspondingtrack
element, to then fire a simple event namedcuechange
at thetrack
element as well. - Set the text track cue active flag of all the cues in the current cues, and unset the text track cue active flag of all the cues in the other cues.
- Run the rules for updating the text track rendering of each of the text tracks in affected tracks that are showing, providing the text track’s text track language as the fallback language if it is not the empty string. For example, for text tracks based on WebVTT, the rules for updating the display of WebVTT text tracks. [WEBVTT]
For the purposes of the algorithm above, a text track cue is considered to be part of a text track only if it is listed in the text track list of cues, not merely if it is associated with the text track.
If the media element’s node document stops being a fully active document, then the playback will stop until the document is active again.
When a media element is removed from a
Document
, the user agent must run the following steps:- Await a stable state, allowing the task that removed the media element from the
Document
to continue. The synchronous section consists of all the remaining steps of this algorithm. (Steps in the synchronous section are marked with ⌛.) - ⌛ If the media element is in a
Document
, abort these steps. - ⌛ Run the internal pause steps for the media element.
4.7.13.9. Seeking
- media .
seeking
-
Returns true if the user agent is currently seeking.
- media .
seekable
-
Returns a
TimeRanges
object that represents the ranges of the media resource to which it is possible for the user agent to seek. - media .
fastSeek
( time ) -
Seeks to near the given time as fast as possible, trading precision for speed. (To seek to a precise time, use the
currentTime
attribute.)This does nothing if the media resource has not been loaded.
The
seeking
attribute must initially have the value false.The
fastSeek(double time)
method must seek to the time given by the method’s argument, with the approximate-for-speed flag set.When the user agent is required to seek to a particular new playback position in the media resource, optionally with the approximate-for-speed flag set, it means that the user agent must run the following steps. This algorithm interacts closely with the event loop mechanism; in particular, it has a synchronous section (which is triggered as part of the event loop algorithm). Steps in that section are marked with ⌛.
- Set the media element’s show poster flag to false.
- If the media element’s
readyState
isHAVE_NOTHING
, abort these steps. - If the element’s
seeking
IDL attribute is true, then another instance of this algorithm is already running. Abort that other instance of the algorithm without waiting for the step that it is running to complete. - Set the
seeking
IDL attribute to true. - If the seek was in response to a DOM method call or setting of an IDL attribute, then continue the script. The remainder of these steps must be run in parallel. With the exception of the steps marked with ⌛, they could be aborted at any time by another instance of this algorithm being invoked.
- If the new playback position is later than the end of the media resource, then let it be the end of the media resource instead.
- If the new playback position is less than the earliest possible position, let it be that position instead.
- If the (possibly now changed) new playback position is not in one of
the ranges given in the
seekable
attribute, then let it be the position in one of the ranges given in theseekable
attribute that is the nearest to the new playback position. If two positions both satisfy that constraint (i.e., the new playback position is exactly in the middle between two ranges in theseekable
attribute) then use the position that is closest to the current playback position. If there are no ranges given in theseekable
attribute then set theseeking
IDL attribute to false and abort these steps. -
If the approximate-for-speed flag is set, adjust the new playback position to a value that will allow for playback to resume promptly. If new playback position before this step is before current playback position, then the adjusted new playback position must also be before the current playback position. Similarly, if the new playback position before this step is after current playback position, then the adjusted new playback position must also be after the current playback position.
For example, the user agent could snap to a nearby key frame, so that it doesn’t have to spend time decoding then discarding intermediate frames before resuming playback.
- Queue a task to fire a simple event named
seeking
at the element. -
Set the current playback position to the new playback position.
If the media element was potentially playing immediately before it started seeking, but seeking caused its
readyState
attribute to change to a value lower thanHAVE_FUTURE_DATA
, then awaiting
event will be fired at the element.This step sets the current playback position, and thus can immediately trigger other conditions, such as the rules regarding when playback "reaches the end of the media resource" (part of the logic that handles looping), even before the user agent is actually able to render the media data for that position (as determined in the next step).
The
currentTime
attribute returns the official playback position, not the current playback position, and therefore gets updated before script execution, separate from this algorithm. - Wait until the user agent has established whether or not the media data for the new playback position is available, and, if it is, until it has decoded enough data to play back that position.
- Await a stable state. The synchronous section consists of all the remaining steps of this algorithm. (Steps in the synchronous section are marked with ⌛.)
- ⌛ Set the
seeking
IDL attribute to false. - ⌛ Run the time marches on steps.
- ⌛ Queue a task to fire a simple event named
timeupdate
at the element. - ⌛ Queue a task to fire a simple event named
seeked
at the element.
The
seekable
attribute must return a new static normalizedTimeRanges
object that represents the ranges of the media resource, if any, that the user agent is able to seek to, at the time the attribute is evaluated.If the user agent can seek to anywhere in the media resource, e.g., because it is a simple movie file and the user agent and the server support HTTP Range requests, then the attribute would return an object with one range, whose start is the time of the first frame (the earliest possible position, typically zero), and whose end is the time of the last frame.
The range might be continuously changing, e.g., if the user agent is buffering a sliding window on an infinite stream. This is the behavior seen with DVRs viewing live TV, for instance.
User agents should adopt a very liberal and optimistic view of what is seekable. User agents should also buffer recent content where possible to enable seeking to be fast.
For instance, consider a large video file served on an HTTP server without support for HTTP Range requests. A browser could implement this by only buffering the current frame and data obtained for subsequent frames, never allow seeking, except for seeking to the very start by restarting the playback. However, this would be a poor implementation. A high quality implementation would buffer the last few minutes of content (or more, if sufficient storage space is available), allowing the user to jump back and rewatch something surprising without any latency, and would in addition allow arbitrary seeking by reloading the file from the start if necessary, which would be slower but still more convenient than having to literally restart the video and watch it all the way through just to get to an earlier unbuffered spot.
Media resources might be internally scripted or interactive. Thus, a media element could play in a non-linear fashion. If this happens, the user agent must act as if the algorithm for seeking was used whenever the current playback position changes in a discontinuous fashion (so that the relevant events fire).
4.7.13.10. Media resources with multiple media tracks
A media resource can have multiple embedded audio and video tracks. For example, in addition to the primary video and audio tracks, a media resource could have foreign-language dubbed dialogs, director’s commentaries, audio descriptions, alternative angles, or sign-language overlays.
- media .
audioTracks
-
Returns an
AudioTrackList
object representing the audio tracks available in the media resource. - media .
videoTracks
-
Returns a
VideoTrackList
object representing the video tracks available in the media resource.
The
audioTracks
attribute of a media element must return a liveAudioTrackList
object representing the audio tracks available in the media element’s media resource.The
videoTracks
attribute of a media element must return a liveVideoTrackList
object representing the video tracks available in the media element’s media resource.There are only ever one
AudioTrackList
object and oneVideoTrackList
object per media element, even if another media resource is loaded into the element: the objects are reused. (TheAudioTrack
andVideoTrack
objects are not, though.)In this example, a script defines a function that takes a URL to a video and a reference to an element where the video is to be placed. That function then tries to load the video, and, once it is loaded, checks to see if there is a sign-language track available. If there is, it also displays that track. Both tracks are just placed in the given container; it’s assumed that styles have been applied to make this work in a pretty way!<script> function loadVideo(url, container) { var video = document.createElement('video'); video.src = url; video.autoplay = true; video.controls = true; container.appendChild(video); video.videoTracks.onaddtrack = function(event) { if (event.track.kind == 'sign') { var sign = document.createElement('video'); sign.src = url + '#track=' + event.track.id; sign.autoplay = true; container.appendChild(sign); return; } }; } </script>
4.7.13.10.1.
AudioTrackList
andVideoTrackList
objectsThe
AudioTrackList
andVideoTrackList
interfaces are used by attributes defined in the previous section.interface
AudioTrackList
: EventTarget { readonly attribute unsigned long length; getter AudioTrack (unsigned longindex
); AudioTrack? getTrackById(DOMStringid
); attribute EventHandler onchange; attribute EventHandler onaddtrack; attribute EventHandler onremovetrack; };interface
AudioTrack
{ readonly attribute DOMString id; readonly attribute DOMString kind; readonly attribute DOMString label; readonly attribute DOMString language; attribute boolean enabled; };interface
VideoTrackList
: EventTarget { readonly attribute unsigned long length; getter VideoTrack (unsigned longindex
); VideoTrack? getTrackById(DOMStringid
); readonly attribute long selectedIndex; attribute EventHandler onchange; attribute EventHandler onaddtrack; attribute EventHandler onremovetrack; };interface
VideoTrack
{ readonly attribute DOMString id; readonly attribute DOMString kind; readonly attribute DOMString label; readonly attribute DOMString language; attribute boolean selected; };- media .
audioTracks
.length
- media .
videoTracks
.length
- media .
-
Returns the number of tracks in the list.
- audioTrack = media .
audioTracks
[index]- videoTrack = media .
videoTracks
[index] - videoTrack = media .
-
Returns the specified
AudioTrack
orVideoTrack
object. - audioTrack = media .
audioTracks
.getTrackById
( id )- videoTrack = media .
videoTracks
.getTrackById
( id ) - videoTrack = media .
-
Returns the
AudioTrack
orVideoTrack
object with the given identifier, or null if no track has that identifier. - audioTrack .
id
- videoTrack .
id
- videoTrack .
-
Returns the ID of the given track. This is the ID that can be used with a fragment if the format supports the media fragments syntax, and that can be used with the
getTrackById()
method. [MEDIA-FRAGS] - audioTrack .
kind
- videoTrack .
kind
- videoTrack .
-
Returns the category the given track falls into. The possible track categories are given below.
- audioTrack .
label
- videoTrack .
label
- videoTrack .
-
Returns the label of the given track, if known, or the empty string otherwise.
- audioTrack .
language
- videoTrack .
language
- videoTrack .
-
Returns the language of the given track, if known, or the empty string otherwise.
- audioTrack .
enabled
[ = value ] -
Returns true if the given track is active, and false otherwise.
Can be set, to change whether the track is enabled or not. If multiple audio tracks are enabled simultaneously, they are mixed.
- media .
videoTracks
.selectedIndex
-
Returns the index of the currently selected track, if any, or -1 otherwise.
- videoTrack .
selected
[ = value ] -
Returns true if the given track is active, and false otherwise.
Can be set, to change whether the track is selected or not. Either zero or one video track is selected; selecting a new track while a previous one is selected will unselect the previous one.
An
AudioTrackList
object represents a dynamic list of zero or more audio tracks, of which zero or more can be enabled at a time. Each audio track is represented by anAudioTrack
object.A
VideoTrackList
object represents a dynamic list of zero or more video tracks, of which zero or one can be selected at a time. Each video track is represented by aVideoTrack
object.Tracks in
AudioTrackList
andVideoTrackList
objects must be consistently ordered. If the media resource is in a format that defines an order, then that order must be used; otherwise, the order must be the relative order in which the tracks are declared in the media resource. The order used is called the natural order of the list.Each track in one of these objects thus has an index; the first has the index 0, and each subsequent track is numbered one higher than the previous one. If a media resource dynamically adds or removes audio or video tracks, then the indices of the tracks will change dynamically. If the media resource changes entirely, then all the previous tracks will be removed and replaced with new tracks.
The
AudioTrackList.length
andVideoTrackList.length
attributes must return the number of tracks represented by their objects at the time of getting.The supported property indices of
AudioTrackList
andVideoTrackList
objects at any instant are the numbers from zero to the number of tracks represented by the respective object minus one, if any tracks are represented. If anAudioTrackList
orVideoTrackList
object represents no tracks, it has no supported property indices.To determine the value of an indexed property for a given index index in an
AudioTrackList
orVideoTrackList
object list, the user agent must return theAudioTrack
orVideoTrack
object that represents the indexth track in list.The
AudioTrackList.getTrackById(id)
andVideoTrackList.getTrackById(id)
methods must return the firstAudioTrack
orVideoTrack
object (respectively) in theAudioTrackList
orVideoTrackList
object (respectively) whose identifier is equal to the value of the id argument (in the natural order of the list, as defined above). When no tracks match the given argument, the methods must return null.The
AudioTrack
andVideoTrack
objects represent specific tracks of a media resource. Each track can have an identifier, category, label, and language. These aspects of a track are permanent for the lifetime of the track; even if a track is removed from a media resource’sAudioTrackList
orVideoTrackList
objects, those aspects do not change.In addition,
AudioTrack
objects can each be enabled or disabled; this is the audio track’s enabled state. When anAudioTrack
is created, its enabled state must be set to false (disabled). The resource fetch algorithm can override this.Similarly, a single
VideoTrack
object perVideoTrackList
object can be selected, this is the video track’s selection state. When aVideoTrack
is created, its selection state must be set to false (not selected). The resource fetch algorithm can override this.The
AudioTrack.id
andVideoTrack.id
attributes must return the identifier of the track, if it has one, or the empty string otherwise. If the media resource is in a format that supports the Media Fragments URI fragment identifier syntax, the identifier returned for a particular track must be the same identifier that would enable the track if used as the name of a track in the track dimension of such a fragment identifier. [MEDIA-FRAGS] [INBANDTRACKS]For example, in Ogg files, this would be the Name header field of the track. [OGGSKELETON]
The
AudioTrack.kind
andVideoTrack.kind
attributes must return the category of the track, if it has one, or the empty string otherwise.The category of a track is the string given in the first column of the table below that is the most appropriate for the track based on the definitions in the table’s second and third columns, as determined by the metadata included in the track in the media resource. The cell in the third column of a row says what the category given in the cell in the first column of that row applies to; a category is only appropriate for an audio track if it applies to audio tracks, and a category is only appropriate for video tracks if it applies to video tracks. Categories must only be returned for
AudioTrack
objects if they are appropriate for audio, and must only be returned forVideoTrack
objects if they are appropriate for video.The
AudioTrack.label
andVideoTrack.label
attributes must return the label of the track, if it has one, or the empty string otherwise. [INBANDTRACKS]The
AudioTrack.language
andVideoTrack.language
attributes must return the BCP 47 language tag of the language of the track, if it has one, or the empty string otherwise. If the user agent is not able to express that language as a BCP 47 language tag (for example because the language information in the media resource’s format is a free-form string without a defined interpretation), then the method must return the empty string, as if the track had no language.Source attribute values for id, kind, label and language of multitrack audio and video tracks as described for the relevant media resource format. [INBANDTRACKS]
The
AudioTrack.enabled
attribute, on getting, must return true if the track is currently enabled, and false otherwise. On setting, it must enable the track if the new value is true, and disable it otherwise. (If the track is no longer in anAudioTrackList
object, then the track being enabled or disabled has no effect beyond changing the value of the attribute on theAudioTrack
object.)Whenever an audio track in an
AudioTrackList
that was disabled is enabled, and whenever one that was enabled is disabled, the user agent must queue a task to fire a simple event namedchange
at theAudioTrackList
object.An audio track that has no data for a particular position on the media timeline, or that does not exist at that position, must be interpreted as being silent at that point on the timeline.
The
VideoTrackList.selectedIndex
attribute must return the index of the currently selected track, if any. If theVideoTrackList
object does not currently represent any tracks, or if none of the tracks are selected, it must instead return -1.The
VideoTrack.selected
attribute, on getting, must return true if the track is currently selected, and false otherwise. On setting, it must select the track if the new value is true, and unselect it otherwise. If the track is in aVideoTrackList
, then all the otherVideoTrack
objects in that list must be unselected. (If the track is no longer in aVideoTrackList
object, then the track being selected or unselected has no effect beyond changing the value of the attribute on theVideoTrack
object.)Whenever a track in a
VideoTrackList
that was previously not selected is selected, and whenever the selected track in aVideoTrackList
is unselected without a new track being selected in its stead, the user agent must queue a task to fire a simple event namedchange
at theVideoTrackList
object. This task must be queued before the task that fires theresize
event, if any.A video track that has no data for a particular position on the media timeline must be interpreted as being fully transparent black at that point on the timeline, with the same dimensions as the last frame before that position, or, if the position is before all the data for that track, the same dimensions as the first frame for that track. A track that does not exist at all at the current position must be treated as if it existed but had no data.
For instance, if a video has a track that is only introduced after one hour of playback, and the user selects that track then goes back to the start, then the user agent will act as if that track started at the start of the media resource but was simply transparent until one hour in.
The following are the event handlers (and their corresponding event handler event types) that must be supported, as event handler IDL attributes, by all objects implementing the
AudioTrackList
andVideoTrackList
interfaces:Event handler Event handler event type onchange
change
onaddtrack
addtrack
onremovetrack
removetrack
4.7.13.10.2. Selecting specific audio and video tracks declaratively
The
audioTracks
andvideoTracks
attributes allow scripts to select which track should play, but it is also possible to select specific tracks declaratively, by specifying particular tracks in the fragment of the URL of the media resource. The format of the fragment depends on the MIME type of the media resource. [RFC2046] [URL]In this example, a video that uses a format that supports the media fragments syntax is embedded in such a way that the alternative angles labeled "Alternative" are enabled instead of the default video track. [MEDIA-FRAGS]<video src="myvideo#track=Alternative"></video>
4.7.13.11. Timed text tracks
4.7.13.11.1. Text track model
A media element can have a group of associated text tracks, known as the media element’s list of text tracks. The text tracks are sorted as follows:
- The text tracks corresponding to
track
element children of the media element, in tree order. - Any text tracks added using the
addTextTrack()
method, in the order they were added, oldest first. - Any media-resource-specific text tracks (text tracks corresponding to data in the media resource), in the order defined by the media resource’s format specification.
A text track consists of:
- The kind of text track
-
This decides how the track is handled by the user agent. The kind is represented by a string. The possible strings are:
subtitles
captions
descriptions
chapters
metadata
The kind of track can change dynamically, in the case of a text track corresponding to a
track
element. - A label
-
This is a human-readable string intended to identify the track for the user.
The label of a track can change dynamically, in the case of a text track corresponding to a
track
element.When a text track label is the empty string, the user agent should automatically generate an appropriate label from the text track’s other properties (e.g., the kind of text track and the text track’s language) for use in its user interface. This automatically-generated label is not exposed in the API.
- An in-band metadata track dispatch type
-
This is a string extracted from the media resource specifically for in-band metadata tracks to enable such tracks to be dispatched to different scripts in the document.
For example, a traditional TV station broadcast streamed on the Web and augmented with Web-specific interactive features could include text tracks with metadata for ad targeting, trivia game data during game shows, player states during sports games, recipe information during food programs, and so forth. As each program starts and ends, new tracks might be added or removed from the stream, and as each one is added, the user agent could bind them to dedicated script modules using the value of this attribute.
Other than for in-band metadata text tracks, the in-band metadata track dispatch type is the empty string. How this value is populated for different media formats is described in steps to expose a media-resource-specific text track.
- A language
-
This is a string (a BCP 47 language tag) representing the language of the text track’s cues. [BCP47]
The language of a text track can change dynamically, in the case of a text track corresponding to a
track
element. - A readiness state
-
One of the following:
- Not loaded
-
Indicates that the text track’s cues have not been obtained.
- Loading
-
Indicates that the text track is loading and there have been no fatal errors encountered so far. Further cues might still be added to the track by the parser.
- Loaded
-
Indicates that the text track has been loaded with no fatal errors.
- Failed to load
-
Indicates that the text track was enabled, but when the user agent attempted to obtain it, this failed in some way (e.g., URL could not be parsed, network error, unknown text track format). Some or all of the cues are likely missing and will not be obtained.
The readiness state of a text track changes dynamically as the track is obtained.
- A mode
-
One of the following:
- Disabled
-
Indicates that the text track is not active. Other than for the purposes of exposing the track in the DOM, the user agent is ignoring the text track. No cues are active, no events are fired, and the user agent will not attempt to obtain the track’s cues.
- Hidden
-
Indicates that the text track is active, but that the user agent is not actively displaying the cues. If no attempt has yet been made to obtain the track’s cues, the user agent will perform such an attempt momentarily. The user agent is maintaining a list of which cues are active, and events are being fired accordingly.
- Showing
-
Indicates that the text track is active. If no attempt has yet been made to obtain the track’s cues, the user agent will perform such an attempt momentarily. The user agent is maintaining a list of which cues are active, and events are being fired accordingly. In addition, for text tracks whose kind is
subtitles
orcaptions
, the cues are being overlaid on the video as appropriate; for text tracks whose kind isdescriptions
, the user agent is making the cues available to the user in a non-visual fashion; and for text tracks whose kind ischapters
, the user agent is making available to the user a mechanism by which the user can navigate to any point in the media resource by selecting a cue.
- A list of zero or more cues
-
A list of text track cues, along with rules for updating the text track rendering. For example, for WebVTT, the rules for updating the display of WebVTT text tracks. [WEBVTT]
The list of cues of a text track can change dynamically, either because the text track has not yet been loaded or is still loading, or due to DOM manipulation.
Each text track has a corresponding
TextTrack
object.
Each media element has a list of pending text tracks, which must initially be empty, a blocked-on-parser flag, which must initially be false, and a did-perform-automatic-track-selection flag, which must also initially be false.
When the user agent is required to populate the list of pending text tracks of a media element, the user agent must add to the element’s list of pending text tracks each text track in the element’s list of text tracks whose text track mode is not disabled and whose text track readiness state is loading.
Whenever a
track
element’s parent node changes, the user agent must remove the corresponding text track from any list of pending text tracks that it is in.Whenever a text track’s text track readiness state changes to either loaded or failed to load, the user agent must remove it from any list of pending text tracks that it is in.
When a media element is created by an HTML parser or XML parser, the user agent must set the element’s blocked-on-parser flag to true. When a media element is popped off the stack of open elements of an HTML parser or XML parser, the user agent must honor user preferences for automatic text track selection, populate the list of pending text tracks, and set the element’s blocked-on-parser flag to false.
The text tracks of a media element are ready when both the element’s list of pending text tracks is empty and the element’s blocked-on-parser flag is false.
Each media element has a pending text track change notification flag, which must initially be unset.
Whenever a text track that is in a media element’s list of text tracks has its text track mode change value, the user agent must run the following steps for the media element:
- If the media element’s pending text track change notification flag is set, abort these steps.
- Set the media element’s pending text track change notification flag.
-
Queue a task that runs the following substeps:
- Unset the media element’s pending text track change notification flag.
- Fire a simple event named
change
at the media element’stextTracks
attribute’sTextTrackList
object.
- If the media element’s show poster flag is not set, run the time marches on steps.
The task source for the tasks listed in this section is the DOM manipulation task source.
A text track cue is the unit of time-sensitive data in a text track, corresponding for instance for subtitles and captions to the text that appears at a particular time and disappears at another time.
Each text track cue consists of:
- An identifier
- An arbitrary string.
- A start time
- The time, in seconds and fractions of a second, that describes the beginning of the range of the media data to which the cue applies.
- An end time
- The time, in seconds and fractions of a second, that describes the end of the range of the media data to which the cue applies.
- A pause-on-exit flag
- A boolean indicating whether playback of the media resource is to pause when the end of the range to which the cue applies is reached.
- Some additional format-specific data
- Additional fields, as needed for the format. For example, WebVTT has a text track cue writing direction and so forth. [WEBVTT]
- Rules for extracting the chapter title
- An algorithm which, when applied to the cue, returns a string that can be used in user interfaces that use the cue as a chapter title.
The text track cue start time and text track cue end time can be negative. (The current playback position can never be negative, though, so cues entirely before time zero cannot be active.)
Each text track cue has a corresponding
TextTrackCue
object (or more specifically, an object that inherits fromTextTrackCue
— for example, WebVTT cues use theVTTCue
interface). A text track cue’s in-memory representation can be dynamically changed through thisTextTrackCue
API. [WEBVTT]A text track cue is associated with rules for updating the text track rendering, as defined by the specification for the specific kind of text track cue. These rules are used specifically when the object representing the cue is added to a
TextTrack
object using theaddCue()
method.In addition, each text track cue has two pieces of dynamic information:
- The active flag
-
This flag must be initially unset. The flag is used to ensure events are fired appropriately when the cue becomes active or inactive, and to make sure the right cues are rendered.
The user agent must immediately unset this flag whenever the text track cue is removed from its text track’s text track list of cues; whenever the text track itself is removed from its media element’s list of text tracks or has its text track mode changed to disabled; and whenever the media element’s
readyState
is changed back toHAVE_NOTHING
. When the flag is unset in this way for one or more cues in text tracks that were showing prior to the relevant incident, the user agent must, after having unset the flag for all the affected cues, apply the rules for updating the text track rendering of those text tracks. For example, for text tracks based on WebVTT, the rules for updating the display of WebVTT text tracks. [WEBVTT] - The display state
-
This is used as part of the rendering model, to keep cues in a consistent position. It must initially be empty. Whenever the text track cue active flag is unset, the user agent must empty the text track cue display state.
The text track cues of a media element’s text tracks are ordered relative to each other in the text track cue order, which is determined as follows: first group the cues by their text track, with the groups being sorted in the same order as their text tracks appear in the media element’s list of text tracks; then, within each group, cues must be sorted by their start time, earliest first; then, any cues with the same start time must be sorted by their end time, latest first; and finally, any cues with identical end times must be sorted in the order they were last added to their respective text track list of cues, oldest first (so e.g., for cues from a WebVTT file, that would initially be the order in which the cues were listed in the file). [WEBVTT]
4.7.13.11.2. Sourcing in-band text tracks
A media-resource-specific text track is a text track that corresponds to data found in the media resource.
Rules for processing and rendering such data are defined by the relevant specifications, e.g., the specification of the video format if the media resource is a video. Details for some legacy formats can be found in the Sourcing In-band Media Resource Tracks from Media Containers into HTML specification. [INBANDTRACKS]
When a media resource contains data that the user agent recognizes and supports as being equivalent to a text track, the user agent runs the steps to expose a media-resource-specific text track with the relevant data, as follows.
- Associate the relevant data with a new text track and its corresponding new
TextTrack
object. The text track is a media-resource-specific text track. - Set the new text track’s kind, label, and language based on the semantics of the relevant data, as defined for the relevant format [INBANDTRACKS]. If there is no label in that data, then the label must be set to the empty string.
- Associate the text track list of cues with the rules for updating the text track rendering appropriate for the format in question.
-
If the new text track’s kind is
metadata
, then set the text track in-band metadata track dispatch type as follows, based on the type of the media resource:- If the media resource is an Ogg file
- The text track in-band metadata track dispatch type must be set to the value of the Role header field. [OGGSKELETON]
- If the media resource is a WebM file
- The text track in-band metadata track dispatch type must be set to the value
of the
CodecID
element. [WEBM] - If the media resource is an MPEG-2 file
- Let stream type be the value of the "stream_type" field describing the text track’s type in the file’s program map section, interpreted as an 8-bit unsigned integer. Let length be the value of the "ES_info_length" field for the track in the same part of the program map section, interpreted as an integer as defined by the MPEG-2 specification. Let descriptor bytes be the length bytes following the "ES_info_length" field. The text track in-band metadata track dispatch type must be set to the concatenation of the stream type byte and the zero or more descriptor bytes bytes, expressed in hexadecimal using uppercase ASCII hex digits. [MPEG2TS]
- If the media resource is an MPEG-4 file
-
Let the
first
stsd
box of the firststbl
box of the firstminf
box of the firstmdia
box of the text track’strak
box in the firstmoov
box of the file be the stsd box, if any.If the file has no stsd box, or if the stsd box has neither a
mett
box nor ametx
box, then the text track in-band metadata track dispatch type must be set to the empty string.Otherwise, if the stsd box has a
mett
box then the text track in-band metadata track dispatch type must be set to the concatenation of the string "mett
", a U+0020 SPACE character, and the value of the firstmime_format
field of the firstmett
box of the stsd box, or the empty string if that field is absent in that box.Otherwise, if the stsd box has no
mett
box but has ametx
box then the text track in-band metadata track dispatch type must be set to the concatenation of the string "metx
", a U+0020 SPACE character, and the value of the firstnamespace
field of the firstmetx
box of the stsd box, or the empty string if that field is absent in that box. - If the media resource is a DASH media resource
- The text track in-band metadata track dispatch type must be set to the concatenation of the "AdaptationSet" element attributes and all child Role descriptors. [MPEGDASH]
- Populate the new text track’s list of cues with the cues parsed so far, following the guidelines for exposing cues, and begin updating it dynamically as necessary.
- Set the new text track’s readiness state to loaded.
-
Set the new text track’s mode to the
mode consistent with the user’s preferences and the requirements of the relevant specification
for the data.
For instance, if there are no other active subtitles, and this is a forced subtitle track (a subtitle track giving subtitles in the audio track’s primary language, but only for audio that is actually in another language), then those subtitles might be activated here.
- Add the new text track to the media element’s list of text tracks.
- Fire a trusted event with the name
addtrack
, that does not bubble and is not cancelable, and that uses theTrackEvent
interface, with thetrack
attribute initialized to the text track’sTextTrack
object, at the media element’stextTracks
attribute’sTextTrackList
object.
4.7.13.11.3. Sourcing out-of-band text tracks
When a
track
element is created, it must be associated with a new text track (with its value set as defined below) and its corresponding newTextTrack
object.The text track kind is determined from the state of the element’s
kind
attribute according to the following table; for a state given in a cell of the first column, the kind is the string given in the second column:State String Subtitles subtitles
Captions captions
Descriptions descriptions
Chapters chapters
Metadata metadata
The text track label is the element’s track label.
The text track language is the element’s track language, if any, or the empty string otherwise.
As the
kind
,label
, andsrclang
attributes are set, changed, or removed, the text track must update accordingly, as per the definitions above.Changes to the track URL are handled in the algorithm below.
The text track readiness state is initially not loaded, and the text track mode is initially disabled.
The text track list of cues is initially empty. It is dynamically modified when the referenced file is parsed. Associated with the list are the rules for updating the text track rendering appropriate for the format in question; for WebVTT, this is the rules for updating the display of WebVTT text tracks. [WEBVTT]
When a
track
element’s parent element changes and the new parent is a media element, then the user agent must add thetrack
element’s corresponding text track to the media element’s list of text tracks, and then queue a task to fire a trusted event with the nameaddtrack
, that does not bubble and is not cancelable, and that uses theTrackEvent
interface, with thetrack
attribute initialized to the text track’sTextTrack
object, at the media element’stextTracks
attribute’sTextTrackList
object.When a
track
element’s parent element changes and the old parent was a media element, then the user agent must remove thetrack
element’s corresponding text track from the media element’s list of text tracks, and then queue a task to fire a trusted event with the nameremovetrack
, that does not bubble and is not cancelable, and that uses theTrackEvent
interface, with thetrack
attribute initialized to the text track’sTextTrack
object, at the media element’stextTracks
attribute’sTextTrackList
object.
When a text track corresponding to a
track
element is added to a media element’s list of text tracks, the user agent must queue a task to run the following steps for the media element:- If the element’s blocked-on-parser flag is true, abort these steps.
- If the element’s did-perform-automatic-track-selection flag is true, abort these steps.
- Honor user preferences for automatic text track selection for this element.
When the user agent is required to honor user preferences for automatic text track selection for a media element, the user agent must run the following steps:
- Perform automatic text track selection for
subtitles
andcaptions
. - Perform automatic text track selection for
descriptions
. - Perform automatic text track selection for
chapters
. - If there are any text tracks in the media element’s list of text tracks whose text track kind is
metadata
that correspond totrack
elements with adefault
attribute set whose text track mode is set to disabled, then set the text track mode of all such tracks to - Set the element’s did-perform-automatic-track-selection flag to true.
When the steps above say to perform automatic text track selection for one or more text track kinds, it means to run the following steps:
- Let candidates be a list consisting of the text tracks in the media element’s list of text tracks whose text track kind is one of the kinds that were passed to the algorithm, if any, in the order given in the list of text tracks.
- If candidates is empty, then abort these steps.
- If any of the text tracks in candidates have a text track mode set to showing, abort these steps.
-
If the user has expressed an interest in having a track from candidates enabled based on its text track kind, text track language, and text track label, then set its text track mode to showing.
For example, the user could have set a browser preference to the effect of "I want French captions whenever possible", or "If there is a subtitle track with "Commentary" in the title, enable it", or "If there are audio description tracks available, enable one, ideally in Swiss German, but failing that in Standard Swiss German or Standard German".
Otherwise, if there are any text tracks in candidates that correspond to
track
elements with adefault
attribute set whose text track mode is set to disabled, then set the text track mode of the first such track to showing.
When a text track corresponding to a
track
element experiences any of the following circumstances, the user agent must start thetrack
processing model for that text track and itstrack
element:- The
track
element is created. - The text track has its text track mode changed.
- The
track
element’s parent element changes and the new parent is a media element.
When a user agent is to start the
track
processing model for a text track and itstrack
element, it must run the following algorithm. This algorithm interacts closely with the event loop mechanism; in particular, it has a synchronous section (which is triggered as part of the event loop algorithm). The steps in that section are marked with ⌛.- If another occurrence of this algorithm is already running for this text
track and its
track
element, abort these steps, letting that other algorithm take care of this element. - If the text track’s text track mode is not set to one of or showing, abort these steps.
- If the text track’s
track
element does not have a media element as a parent, abort these steps. - Run the remainder of these steps in parallel, allowing whatever caused these steps to run to continue.
- Top: Await a stable state. The synchronous section consists of the following steps. (The steps in the synchronous section are marked with ⌛.)
- ⌛ Set the text track readiness state to loading.
- ⌛ Let URL be the track URL of the
track
element. - ⌛ If the
track
element’s parent is a media element then let corsAttributeState be the state of the parent media element’scrossorigin
content attribute. Otherwise, let corsAttributeState be No CORS. - End the synchronous section, continuing the remaining steps in parallel.
-
If URL is not the empty string, run these substeps:
- Let request be the result of creating a potential-CORS request given URL, corsAttributeState, and with the same-origin fallback flag set.
- Set request’s client to the
track
element’s node document’sWindow
object’s environment settings object and type to "track
". - Fetch request.
The tasks queued by the fetching algorithm on the networking task source to process the data as it is being fetched must determine the type of the resource. If the type of the resource is not a supported text track format, the load will fail, as described below. Otherwise, the resource’s data must be passed to the appropriate parser (e.g., the WebVTT parser) as it is received, with the text track list of cues being used for that parser’s output. [WEBVTT]
The appropriate parser will incrementally update the text track list of cues during these networking task source tasks, as each such task is run with whatever data has been received from the network).
This specification does not currently say whether or how to check the MIME types of text tracks, or whether or how to perform file type sniffing using the actual file data. Implementors differ in their intentions on this matter and it is therefore unclear what the right solution is. In the absence of any requirement here, the HTTP specification’s strict requirement to follow the Content-Type header prevails ("Content-Type specifies the media type of the underlying data." ... "If and only if the media type is not given by a Content-Type field, the recipient MAY attempt to guess the media type via inspection of its content and/or the name extension(s) of the URI used to identify the resource.").
If the fetching algorithm fails for any reason (network error, the server returns an error code, a cross-origin check fails, etc), or if URL is the empty string, then queue a task to first change the text track readiness state to failed to load and then fire a simple event named
error
at thetrack
element. This task must use the DOM manipulation task source.If the fetching algorithm does not fail, but the type of the resource is not a supported text track format, or the file was not successfully processed (e.g., the format in question is an XML format and the file contained a well-formedness error that the XML specification requires be detected and reported to the application), then the task that is queued by the networking task source in which the aforementioned problem is found must change the text track readiness state to failed to load and fire a simple event named
error
at thetrack
element.If the fetching algorithm does not fail, and the file was successfully processed, then the final task that is queued by the networking task source, after it has finished parsing the data, must change the text track readiness state to loaded, and fire a simple event named
load
at thetrack
element.If, while fetching is ongoing, either:
- the track URL changes so that it is no longer equal to URL, while the text track mode is set to or showing; or
- the text track mode changes to or showing, while the track URL is not equal to URL
...then the user agent must abort fetching, discarding any pending tasks generated by that algorithm (and in particular, not adding any cues to the text track list of cues after the moment the URL changed), and then queue a task that first changes the text track readiness state to failed to load and then fires a simple event named
error
at thetrack
element. This task must use the DOM manipulation task source. - Wait until the text track readiness state is no longer set to loading.
- Wait until the track URL is no longer equal to URL, at the same time as the text track mode is set to or showing.
- Jump to the step labeled top.
Whenever a
track
element has itssrc
attribute set, changed, or removed, the user agent must immediately empty the element’s text track’s text track list of cues. (This also causes the algorithm above to stop adding cues from the resource being obtained using the previously given URL, if any.)4.7.13.11.4. Guidelines for exposing cues in various formats as text track cues
How a specific format’s text track cues are to be interpreted for the purposes of processing by an HTML user agent is defined by that format [INBANDTRACKS]. In the absence of such a specification, this section provides some constraints within which implementations can attempt to consistently expose such formats.
To support the text track model of HTML, each unit of timed data is converted to a text track cue. Where the mapping of the format’s features to the aspects of a text track cue as defined in this specification are not defined, implementations must ensure that the mapping is consistent with the definitions of the aspects of a text track cue as defined above, as well as with the following constraints:
- The text track cue identifier
- Should be set to the empty string if the format has no obvious analog to a per-cue identifier.
- The text track cue pause-on-exit flag
- Should be set to false.
For media-resource-specific text tracks of kind
metadata
, text track cues are exposed using theDataCue
object unless there is a more appropriateTextTrackCue
interface available. For example, if the media-resource-specific text track format is WebVTT, thenVTTCue
is more appropriate.4.7.13.11.5. Text track API
interface
TextTrackList
: EventTarget { readonly attribute unsigned long length; getter TextTrack (unsigned longindex
); TextTrack? getTrackById(DOMStringid
); attribute EventHandler onchange; attribute EventHandler onaddtrack; attribute EventHandler onremovetrack; };- media .
textTracks
.length
- Returns the number of text tracks associated with the media element (e.g., from
track
elements). This is the number of text tracks in the media element’s list of text tracks. - media .
textTracks[
n]
- Returns the
TextTrack
object representing the nth text track in the media element’s list of text tracks. - textTrack = media .
textTracks
.getTrackById
( id ) -
Returns the
TextTrack
object with the given identifier, or null if no track has that identifier.
A
TextTrackList
object represents a dynamically updating list of text tracks in a given order.The
textTracks
attribute of media elements must return aTextTrackList
object representing theTextTrack
objects of the text tracks in the media element’s list of text tracks, in the same order as in the list of text tracks.The
length
attribute of aTextTrackList
object must return the number of text tracks in the list represented by theTextTrackList
object.The supported property indices of a
TextTrackList
object at any instant are the numbers from zero to the number of text tracks in the list represented by theTextTrackList
object minus one, if any. If there are no text tracks in the list, there are no supported property indices.To determine the value of an indexed property of a
TextTrackList
object for a given index index, the user agent must return the indexth text track in the list represented by theTextTrackList
object.The
getTrackById(id)
method must return the firstTextTrack
in theTextTrackList
object whose id IDL attribute would return a value equal to the value of the id argument. When no tracks match the given argument, the method must return null.
enum
TextTrackMode
{ "disabled", , "showing" }; enumTextTrackKind
{"subtitles"
,"captions"
,"descriptions"
,"chapters"
,"metadata"
}; interfaceTextTrack
: EventTarget { readonly attribute TextTrackKind kind; readonly attribute DOMString label; readonly attribute DOMString language; readonly attribute DOMString id; readonly attribute DOMString inBandMetadataTrackDispatchType; attribute TextTrackMode mode; readonly attribute TextTrackCueList? cues; readonly attribute TextTrackCueList? activeCues; void addCue(TextTrackCuecue
); void removeCue(TextTrackCuecue
); attribute EventHandler oncuechange; };- textTrack = media .
addTextTrack
( kind [, label [, language ] ] ) -
Creates and returns a new
TextTrack
object, which is also added to the media element’s list of text tracks. - textTrack .
kind
-
Returns the text track kind string.
- textTrack .
label
-
Returns the text track label, if there is one, or the empty string otherwise (indicating that a custom label probably needs to be generated from the other attributes of the object if the object is exposed to the user).
- textTrack .
language
- Returns the text track language string.
- textTrack .
id
-
Returns the ID of the given track.
For in-band tracks, this is the ID that can be used with a fragment if the format supports the media fragments syntax/cite>, and that can be used with the
getTrackById()
method. [MEDIA-FRAGS]For
TextTrack
objects corresponding totrack
elements, this is the ID of thetrack
element. - textTrack .
inBandMetadataTrackDispatchType
-
Returns the text track in-band metadata track dispatch type string.
- textTrack .
mode
[ = value ] -
Returns the text track mode, represented by a string from the following list:
- "disabled"
- The text track disabled mode.
- " "
- The mode.
- "showing"
- The text track showing mode.
Can be set, to change the mode.
- textTrack .
cues
- Returns the text track list of cues, as a
TextTrackCueList
object. - textTrack .
activeCues
-
Returns the text track cues from the text track list of cues that are currently active (i.e., that start before the current playback position and end after it), as a
TextTrackCueList
object. - textTrack .
addCue
( cue ) - Adds the given cue to textTrack’s text track list of cues.
- textTrack .
removeCue
( cue ) - Removes the given cue from textTrack’s text track list of cues.
The
addTextTrack(kind, label, language)
method of media elements, when invoked, must run the following steps:-
Create a new
TextTrack
object. -
Create a new text track corresponding to the new object, and set its text track kind to kind, its text track label to label, its text track language to language, its text track readiness state to the text track loaded state, its text track mode to the mode, and its text track list of cues to an empty list.
Initially, the text track list of cues is not associated with any rules for updating the text track rendering. When a text track cue is added to it, the text track list of cues has its rules permanently set accordingly.
-
Add the new text track to the media element’s list of text tracks.
-
Queue a task to fire a trusted event with the name
addtrack
, that does not bubble and is not cancelable, and that uses theTrackEvent
interface, with thetrack
attribute initialized to the new text track’sTextTrack
object, at the media element’stextTracks
attribute’sTextTrackList
object. -
Return the new
TextTrack
object.
The
kind
attribute must return the text track kind of the text track that theTextTrack
object represents.The
label
attribute must return the text track label of the text track that theTextTrack
object represents.The
language
attribute must return the text track language of the text track that theTextTrack
object represents.The
id
attribute returns the track’s identifier, if it has one, or the empty string otherwise. For tracks that correspond totrack
elements, the track’s identifier is the value of the element’sid
attribute, if any. For in-band tracks, the track’s identifier is specified by the media resource. If the media resource is in a format that supports the media fragments syntax, the identifier returned for a particular track must be the same identifier that would enable the track if used as the name of a track in the track dimension of such a fragment. [MEDIA-FRAGS]The
inBandMetadataTrackDispatchType
attribute must return the text track in-band metadata track dispatch type of the text track that theTextTrack
object represents.The
mode
attribute, on getting, must return the string corresponding to the text track mode of the text track that theTextTrack
object represents, as defined by the following list:- "
disabled
" - The text track disabled mode.
- "
hidden
" - The mode.
- "
showing
" - The text track showing mode.
On setting, if the new value isn’t equal to what the attribute would currently return, the new value must be processed as follows:
- If the new value is "disabled"
-
Set the text track mode of the text track that the
TextTrack
object represents to the text track disabled mode. - If the new value is " "
-
Set the text track mode of the text track that the
TextTrack
object represents to the mode. - If the new value is "showing"
-
Set the text track mode of the text track that the
TextTrack
object represents to the text track showing mode.
If the text track mode of the text track that the
TextTrack
object represents is not the text track disabled mode, then thecues
attribute must return a liveTextTrackCueList
object that represents the subset of the text track list of cues of the text track that theTextTrack
object represents whose end times occur at or after the earliest possible position when the script started, in text track cue order. Otherwise, it must return null. For eachTextTrack
object, when an object is returned, the sameTextTrackCueList
object must be returned each time.The earliest possible position when the script started is whatever the earliest possible position was the last time the event loop reached step 1.
If the text track mode of the text track that the
TextTrack
object represents is not the text track disabled mode, then theactiveCues
attribute must return a liveTextTrackCueList
object that represents the subset of the text track list of cues of the text track that theTextTrack
object represents whose active flag was set when the script started, in text track cue order. Otherwise, it must return null. For eachTextTrack
object, when an object is returned, the sameTextTrackCueList
object must be returned each time.A text track cue’s active flag was set when the script started if its text track cue active flag was set the last time the event loop reached step 1.
The
addCue(cue)
method ofTextTrack
objects, when invoked, must run the following steps:- If the text track list of cues does not yet have any associated rules for updating the text track rendering, then associate the text track list of cues with the rules for updating the text track rendering appropriate to cue.
- If text track list of cues' associated rules for updating the text
track rendering are not the same rules for updating the text track rendering as appropriate for cue, then throw an
InvalidStateError
exception and abort these steps. - If the given cue is in a text track list of cues, then remove cue from that text track list of cues.
- Add cue to the method’s
TextTrack
object’s text track’s text track list of cues.
The
removeCue(cue)
method ofTextTrack
objects, when invoked, must run the following steps:- If the given cue is not currently listed in the method’s
TextTrack
object’s text track’s text track list of cues, then throw aNotFoundError
exception and abort these steps. - Remove cue from the method’s
TextTrack
object’s text track’s text track list of cues.
In this example, anaudio
element is used to play a specific sound-effect from a sound file containing many sound effects. A cue is used to pause the audio, so that it ends exactly at the end of the clip, even if the browser is busy running some script. If the page had relied on script to pause the audio, then the start of the next clip might be heard if the browser was not able to run the script at the exact time specified.var sfx = new Audio('sfx.wav'); var sounds = sfx.addTextTrack('metadata'); // add sounds we care about function addFX(start, end, name) { var cue = new VTTCue(start, end, ''); cue.id = name; cue.pauseOnExit = true; sounds.addCue(cue); } addFX(12.783, 13.612, 'dog bark'); addFX(13.612, 15.091, 'kitten mew')) function playSound(id) { sfx.currentTime = sounds.getCueById(id).startTime; sfx.play(); } // play a bark as soon as we can sfx.oncanplaythrough = function () { playSound('dog bark'); } // meow when the user tries to leave window.onbeforeunload = function () { playSound('kitten mew'); return 'Are you sure you want to leave this awesome page?'; }
interface
TextTrackCueList
{ readonly attribute unsigned long length; getter TextTrackCue (unsigned longindex
); TextTrackCue? getCueById(DOMStringid
); };- cuelist .
length
- Returns the number of cues in the list.
- cuelist[index]
- Returns the text track cue with index index in the list. The cues are sorted in text track cue order.
- cuelist .
getCueById
( id ) - Returns the first text track cue (in text track cue order) with text track cue identifier id. Returns null if none of the cues have the given identifier or if the argument is the empty string.
A
TextTrackCueList
object represents a dynamically updating list of text track cues in a given order.The
length
attribute must return the number of cues in the list represented by theTextTrackCueList
object.The supported property indices of a
TextTrackCueList
object at any instant are the numbers from zero to the number of cues in the list represented by theTextTrackCueList
object minus one, if any. If there are no cues in the list, there are no supported property indices.To determine the value of an indexed property for a given index index, the user agent must return the indexth text track cue in the list represented by the
TextTrackCueList
object.The
getCueById(id)
method, when called with an argument other than the empty string, must return the first text track cue in the list represented by theTextTrackCueList
object whose text track cue identifier is id, if any, or null otherwise. If the argument is the empty string, then the method must return null.
interface
TextTrackCue
: EventTarget { readonly attribute TextTrack? track; attribute DOMString id; attribute double startTime; attribute double endTime; attribute boolean pauseOnExit; attribute EventHandler onenter; attribute EventHandler onexit; };- cue .
track
- Returns the
TextTrack
object to which this text track cue belongs, if any, or null otherwise. - cue .
id
[ = value ] - Returns the text track cue identifier. Can be set.
- cue .
startTime
[ = value ] - Returns the text track cue start time, in seconds. Can be set.
- cue .
endTime
[ = value ] - Returns the text track cue end time, in seconds. Can be set.
- cue .
pauseOnExit
[ = value ] - Returns true if the text track cue pause-on-exit flag is set, false otherwise. Can be set.
The
track
attribute, on getting, must return theTextTrack
object of the text track in whose list of cues the text track cue that theTextTrackCue
object represents finds itself, if any; or null otherwise.The
id
attribute, on getting, must return the text track cue identifier of the text track cue that theTextTrackCue
object represents. On setting, the text track cue identifier must be set to the new value.The
startTime
attribute, on getting, must return the text track cue start time of the text track cue that theTextTrackCue
object represents, in seconds. On setting, the text track cue start time must be set to the new value, interpreted in seconds; then, if theTextTrackCue
object’s text track cue is in a text track’s list of cues, and that text track is in a media element’s list of text tracks, and the media element’s show poster flag is not set, then run the time marches on steps for that media element.The
endTime
attribute, on getting, must return the text track cue end time of the text track cue that theTextTrackCue
object represents, in seconds. On setting, the text track cue end time must be set to the new value, interpreted in seconds; then, if theTextTrackCue
object’s text track cue is in a text track’s list of cues, and that text track is in a media element’s list of text tracks, and the media element’s show poster flag is not set, then run the time marches on steps for that media element.The
pauseOnExit
attribute, on getting, must return true if the text track cue pause-on-exit flag of the text track cue that theTextTrackCue
object represents is set; or false otherwise. On setting, the text track cue pause-on-exit flag must be set if the new value is true, and must be unset otherwise.4.7.13.11.6. Text tracks exposing in-band metadata
Media resources often contain one or more media-resource-specific text tracks containing data that browsers don’t render, but want to expose to script to allow being dealt with.
If the browser is unable to identify a
TextTrackCue
interface that is more appropriate to expose the data in the cues of a media-resource-specific text track, theDataCue
object is used. [INBANDTRACKS][
Constructor
(doublestartTime
, doubleendTime
, ArrayBufferdata
)] interfaceDataCue
: TextTrackCue { attribute ArrayBuffer data; };- cue = new
DataCue
( [ startTime, endTime, data ] ) - Returns a new
DataCue
object, for use with theaddCue()
method. The startTime argument sets the text track cue start time. The endTime argument sets the text track cue end time. The data argument is copied as the text track cue data. - cue .
data
[ = value ] - Returns the text track cue data in raw unparsed form. Can be set.
The
data
attribute, on getting, must return the raw text track cue data of the text track cue that theTextTrackCue
object represents. On setting, the text track cue data must be set to the new value.The user agent will use
DataCue
to expose only text track cue objects that belong to a text track that has a text track kind of metadata.DataCue
has a constructor to allow script to createDataCue
objects in cases where generic metadata needs to be managed for a text track.The rules for updating the text track rendering for a
DataCue
simply state that there is no rendering, even when the cues are in showing mode and the text track kind is one of subtitles or captions or descriptions or chapters.4.7.13.11.7. Text tracks describing chapters
Chapters are segments of a media resource with a given title. Chapters can be nested, in the same way that sections in a document outline can have subsections.
Each text track cue in a text track being used for describing chapters has three key features: the text track cue start time, giving the start time of the chapter, the text track cue end time, giving the end time of the chapter, and the text track rules for extracting the chapter title.
The rules for constructing the chapter tree from a text track are as follows. They produce a potentially nested list of chapters, each of which have a start time, end time, title, and a list of nested chapters. This algorithm discards cues that do not correctly nest within each other, or that are out of order.
- Let list be a copy of the list of cues of the text track being processed.
- Remove from list any text track cue whose text track cue end time is before its text track cue start time.
- Let output be an empty list of chapters, where a chapter is a record consisting of a start time, an end time, a title, and a (potentially empty) list of nested chapters. For the purpose of this algorithm, each chapter also has a parent chapter.
- Let current chapter be a stand-in chapter whose start time is negative infinity, whose end time is positive infinity, and whose list of nested chapters is output. (This is just used to make the algorithm easier to describe.)
- Loop: If list is empty, jump to the step labeled end.
- Let current cue be the first cue in list, and then remove it from list.
- If current cue’s text track cue start time is less than the start time of current chapter, then return to the step labeled loop.
- While current cue’s text track cue start time is greater than or equal to current chapter’s end time, let current chapter be current chapter’s parent chapter.
- If current cue’s text track cue end time is greater than the end time of current chapter, then return to the step labeled loop.
-
Create a new chapter new chapter, whose start time is current cue’s text track cue start time, whose end time is current cue’s text track cue end time, whose title is current cue’s text track cue data interpreted according to its rules for rendering the cue in isolation, and whose list of nested chapters is empty.
- Append new chapter to current chapter’s list of nested chapters, and let current chapter be new chapter’s parent.
- Let current chapter be new chapter.
- Return to the step labeled loop.
- End: Return output.
The following snippet of a WebVTT file shows how nested chapters can be marked up. The file describes three 50-minute chapters, "Astrophysics", "Computational Physics", and "General Relativity". The first has three subchapters, the second has four, and the third has two. [WEBVTT]WEBVTT 00:00:00.000 --> 00:50:00.000 Astrophysics 00:00:00.000 --> 00:10:00.000 Introduction to Astrophysics 00:10:00.000 --> 00:45:00.000 The Solar System 00:00:00.000 --> 00:10:00.000 Coursework Description 00:50:00.000 --> 01:40:00.000 Computational Physics 00:50:00.000 --> 00:55:00.000 Introduction to Programming 00:55:00.000 --> 01:30:00.000 Data Structures 01:30:00.000 --> 01:35:00.000 Answers to Last Exam 01:35:00.000 --> 01:40:00.000 Coursework Description 01:40:00.000 --> 02:30:00.000 General Relativity 01:40:00.000 --> 02:00:00.000 Tensor Algebra 02:00:00.000 --> 02:30:00.000 The General Relativistic Field Equations
4.7.13.11.8. Event handlers for objects of the text track APIs
The following are the event handlers that (and their corresponding event handler event types) must be supported, as event handler IDL attributes, by all objects implementing the
TextTrackList
interface:Event handler Event handler event type onchange
change
onaddtrack
addtrack
onremovetrack
removetrack
The following are the event handlers that (and their corresponding event handler event types) must be supported, as event handler IDL attributes, by all objects implementing the
TextTrack
interface:Event handler Event handler event type oncuechange
cuechange
The following are the event handlers that (and their corresponding event handler event types) must be supported, as event handler IDL attributes, by all objects implementing the
TextTrackCue
interface:Event handler Event handler event type onenter
enter
onexit
exit
4.7.13.11.9. Best practices for metadata text tracks
This section is non-normative.
Text tracks can be used for storing data relating to the media data, for interactive or augmented views.
For example, a page showing a sports broadcast could include information about the current score. Suppose a robotics competition was being streamed live. The image could be overlayed with the scores, as follows:
In order to make the score display render correctly whenever the user seeks to an arbitrary point in the video, the metadata text track cues need to be as long as is appropriate for the score. For example, in the frame above, there would be maybe one cue that lasts the length of the match that gives the match number, one cue that lasts until the blue alliance’s score changes, and one cue that lasts until the red alliance’s score changes. If the video is just a stream of the live event, the time in the bottom right would presumably be automatically derived from the current video time, rather than based on a cue. However, if the video was just the highlights, then that might be given in cues also.
The following shows what fragments of this could look like in a WebVTT file:
WEBVTT ... 05:10:00.000 --> 05:12:15.000 matchtype:qual matchnumber:37 ... 05:11:02.251 --> 05:11:17.198 red:78 05:11:03.672 --> 05:11:54.198 blue:66 05:11:17.198 --> 05:11:25.912 red:80 05:11:25.912 --> 05:11:26.522 red:83 05:11:26.522 --> 05:11:26.982 red:86 05:11:26.982 --> 05:11:27.499 red:89 ...
The key here is to notice that the information is given in cues that span the length of time to which the relevant event applies. If, instead, the scores were given as zero-length (or very brief, nearly zero-length) cues when the score changes, for example saying "red+2" at 05:11:17.198, "red+3" at 05:11:25.912, etc, problems arise: primarily, seeking is much harder to implement, as the script has to walk the entire list of cues to make sure that no notifications have been missed; but also, if the cues are short it’s possible the script will never see that they are active unless it listens to them specifically.
When using cues in this manner, authors are encouraged to use the
cuechange
event to update the current annotations. (In particular, using thetimeupdate
event would be less appropriate as it would require doing work even when the cues haven’t changed, and, more importantly, would introduce a higher latency between when the metadata cues become active and when the display is updated, sincetimeupdate
events are rate-limited.)4.7.13.12. Identifying a track kind through a URL
Other specifications or formats that need a URL to identify the return values of the
AudioTrack.kind
orVideoTrack.kind
IDL attributes, or identify the kind of text track, must use theabout:html-kind
URL.4.7.13.13. User interface
The
controls
attribute is a boolean attribute. If present, it indicates that the author has not provided a scripted controller and would like the user agent to provide its own set of controls.If the attribute is present, or if scripting is disabled for the media element, then the user agent should expose a user interface to the user. This user interface should include features to begin playback, pause playback, seek to an arbitrary position in the content (if the content supports arbitrary seeking), change the volume, change the display of closed captions or embedded sign-language tracks, select different audio tracks or turn on audio descriptions, and show the media content in manners more suitable to the user (e.g., fullscreen video or in an independent resizable window). Other controls may also be made available.
Even when the attribute is absent, however, user agents may provide controls to affect playback of the media resource (e.g., play, pause, seeking, track selection, and volume controls), but such features should not interfere with the page’s normal rendering. For example, such features could be exposed in the media element’s platform media keys, or a remote control. The user agent may implement this simply by exposing a user interface to the user as described above (as if the
controls
attribute was present).If the user agent exposes a user interface to the user by displaying controls over the media element, then the user agent should suppress any user interaction events while the user agent is interacting with this interface. (For example, if the user clicks on a video’s playback control,
mousedown
events and so forth would not simultaneously be fired at elements on the page.)Where possible (specifically, for starting, stopping, pausing, and unpausing playback, for seeking, for changing the rate of playback, for fast-forwarding or rewinding, for listing, enabling, and disabling text tracks, and for muting or changing the volume of the audio), user interface features exposed by the user agent must be implemented in terms of the DOM API described above, so that, e.g., all the same events fire.
For the purposes of listing chapters in the media resource, only text tracks in the media element’s list of text tracks that are showing and whose text track kind is
chapters
should be used. Such tracks must be interpreted according to the rules for constructing the chapter tree from a text track. When seeking in response to a user manipulating a chapter selection interface, user agents should not use the approximate-for-speed flag.The
controls
IDL attribute must reflect the content attribute of the same name.
- media .
volume
[ = value ] -
Returns the current playback volume, as a number in the range 0.0 to 1.0, where 0.0 is the quietest and 1.0 the loudest.
Can be set, to change the volume.
Throws an
IndexSizeError
exception if the new value is not in the range 0.0 .. 1.0. - media .
muted
[ = value ] -
Returns true if audio is muted, overriding the
volume
attribute, and false if thevolume
attribute is being honored.Can be set, to change whether the audio is muted or not.
A media element has a playback volume, which is a fraction in the range 0.0 (silent) to 1.0 (loudest). Initially, the volume should be 1.0, but user agents may remember the last set value across sessions, on a per-site basis or otherwise, so the volume may start at other values.
The
volume
IDL attribute must return the playback volume of any audio portions of the media element. On setting, if the new value is in the range 0.0 to 1.0 inclusive, the media element’s playback volume must be set to the new value. If the new value is outside the range 0.0 to 1.0 inclusive, then, on setting, anIndexSizeError
exception must be thrown instead.A media element can also be muted. If anything is muting the element, then it is muted. (For example, when the direction of playback is backwards, the element is muted.)
The
muted
IDL attribute must return the value to which it was last set. When a media element is created, if the element has amuted
content attribute specified, then themuted
IDL attribute should be set to true; otherwise, the user agents may set the value to the user’s preferred value (e.g., remembering the last set value across sessions, on a per-site basis or otherwise). While themuted
IDL attribute is set to true, the media element must be muted.Whenever either of the values that would be returned by the
volume
andmuted
IDL attributes change, the user agent must queue a task to fire a simple event namedvolumechange
at the media element.An element’s effective media volume is determined as follows:
- If the user has indicated that the user agent is to override the volume of the element, then the element’s effective media volume is the volume desired by the user. Abort these steps.
- If the element’s audio output is muted, the element’s effective media volume is zero. Abort these steps.
- Let volume be the playback volume of the audio portions of the media element, in range 0.0 (silent) to 1.0 (loudest).
- The element’s effective media volume is volume, interpreted relative to the range 0.0 to 1.0, with 0.0 being silent, and 1.0 being the loudest setting, values in between increasing in loudness. The range need not be linear. The loudest setting may be lower than the system’s loudest possible setting; for example the user could have set a maximum volume.
The
muted
content attribute on media elements is a boolean attribute that controls the default state of the audio output of the media resource, potentially overriding user preferences.The
defaultMuted
IDL attribute must reflect themuted
content attribute.This attribute has no dynamic effect (it only controls the default state of the element).
This video (an advertisement) autoplays, but to avoid annoying users, it does so without sound, and allows the user to turn the sound on.<video src="advert.webm" controls autoplay loop muted></video>
4.7.13.14. Time ranges
Objects implementing the
TimeRanges
interface represent a list of ranges (periods) of time.interface
TimeRanges
{ readonly attribute unsigned long length; double start(unsigned longindex
); double end(unsigned longindex
); };- media .
length
-
Returns the number of ranges in the object.
- time = media .
start
(index) -
Returns the time for the start of the range with the given index.
Throws an
IndexSizeError
exception if the index is out of range. - time = media .
end
(index) -
Returns the time for the end of the range with the given index.
Throws an
IndexSizeError
exception if the index is out of range.
The
length
IDL attribute must return the number of ranges represented by the object.The
start(index)
method must return the position of the start of the indexth range represented by the object, in seconds measured from the start of the timeline that the object covers.The
end(index)
method must return the position of the end of the indexth range represented by the object, in seconds measured from the start of the timeline that the object covers.These methods must throw
IndexSizeError
exceptions if called with an index argument greater than or equal to the number of ranges represented by the object.When a
TimeRanges
object is said to be a normalizedTimeRanges
object, the ranges it represents must obey the following criteria:- The start of a range must be greater than the end of all earlier ranges.
- The start of a range must be less than or equal to the end of that same range.
In other words, the ranges in such an object are ordered, don’t overlap, and don’t touch (adjacent ranges are folded into one bigger range). A range can be empty (referencing just a single moment in time), e.g., to indicate that only one frame is currently buffered in the case that the user agent has discarded the entire media resource except for the current frame, when a media element is paused.
Ranges in a
TimeRanges
object must be inclusive.Thus, the end of a range would be equal to the start of a following adjacent (touching but not overlapping) range. Similarly, a range covering a whole timeline anchored at zero would have a start equal to zero and an end equal to the duration of the timeline.
The timelines used by the objects returned by the
buffered
,seekable
andplayed
IDL attributes of media elements must be that element’s media timeline.4.7.13.15. The
TrackEvent
interface[
Constructor
(DOMStringtype
, optional TrackEventIniteventInitDict
)] interfaceTrackEvent
: Event { readonly attribute (VideoTrack or AudioTrack or TextTrack)? track; }; dictionaryTrackEventInit
: EventInit { (VideoTrack or AudioTrack or TextTrack)?track
= null; };- event .
track
- Returns the track object (
TextTrack
,AudioTrack
, orVideoTrack
) to which the event relates.
The
track
attribute must return the value it was initialized to. When the object is created, this attribute must be initialized to null. It represents the context information for the event.4.7.13.16. Event summary
This section is non-normative.
The following events fire on media elements as part of the processing model described above:
Event name Interface Fired when... Preconditions loadstart
Event
The user agent begins looking for media data, as part of the resource selection algorithm. networkState
equalsNETWORK_LOADING
progress
Event
The user agent is fetching media data. networkState
equalsNETWORK_LOADING
suspend
Event
The user agent is intentionally not currently fetching media data. networkState
equalsNETWORK_IDLE
abort
Event
The user agent stops fetching the media data before it is completely downloaded, but not due to an error. error
is an object with the codeMEDIA_ERR_ABORTED
.networkState
equals eitherNETWORK_EMPTY
orNETWORK_IDLE
, depending on when the download was aborted.error
Event
An error occurs while fetching the media data or the type of the resource is not supported media format. error
is an object with the codeMEDIA_ERR_NETWORK
or higher.networkState
equals eitherNETWORK_EMPTY
orNETWORK_IDLE
, depending on when the download was aborted.emptied
Event
A media element whose networkState
was previously not in theNETWORK_EMPTY
state has just switched to that state (either because of a fatal error during load that’s about to be reported, or because theload()
method was invoked while the resource selection algorithm was already running).networkState
isNETWORK_EMPTY
; all the IDL attributes are in their initial states.stalled
Event
The user agent is trying to fetch media data, but data is unexpectedly not forthcoming. networkState
isNETWORK_LOADING
.loadedmetadata
Event
The user agent has just determined the duration and dimensions of the media resource and the text tracks are ready. readyState
is newly equal toHAVE_METADATA
or greater for the first time.loadeddata
Event
The user agent can render the media data at the current playback position for the first time. readyState
newly increased toHAVE_CURRENT_DATA
or greater for the first time.canplay
Event
The user agent can resume playback of the media data, but estimates that if playback were to be started now, the media resource could not be rendered at the current playback rate up to its end without having to stop for further buffering of content. readyState
newly increased toHAVE_FUTURE_DATA
or greater.canplaythrough
Event
The user agent estimates that if playback were to be started now, the media resource could be rendered at the current playback rate all the way to its end without having to stop for further buffering. readyState
is newly equal toHAVE_ENOUGH_DATA
.playing
Event
Playback is ready to start after having been paused or delayed due to lack of media data. readyState
is newly equal to or greater thanHAVE_FUTURE_DATA
andpaused
is false, orpaused
is newly false andreadyState
is equal to or greater thanHAVE_FUTURE_DATA
. Even if this event fires, the element might still not be potentially playing, e.g., if the element is paused for user interaction or paused for in-band content.waiting
Event
Playback has stopped because the next frame is not available, but the user agent expects that frame to become available in due course. readyState
is equal to or less thanHAVE_CURRENT_DATA
, andpaused
is false. Eitherseeking
is true, or the current playback position is not contained in any of the ranges inbuffered
. It is possible for playback to stop for other reasons withoutpaused
being false, but those reasons do not fire this event (and when those situations resolve, a separateplaying
event is not fired either): e.g., the playback ended, or playback stopped due to errors, or the element has paused for user interaction or paused for in-band content.seeking
Event
The seeking
IDL attribute changed to true, and the user agent has started seeking to a new position.seeked
Event
The seeking
IDL attribute changed to false after the current playback position was changed.ended
Event
Playback has stopped because the end of the media resource was reached. currentTime
equals the end of the media resource;ended
is true.durationchange
Event
The duration
attribute has just been updated.timeupdate
Event
The current playback position changed as part of normal playback or in an especially interesting way, for example discontinuously. play
Event
The element is no longer paused. Fired after the play()
method has returned, or when theautoplay
attribute has caused playback to begin.paused
is newly false.pause
Event
The element has been paused. Fired after the pause()
method has returned.paused
is newly true.ratechange
Event
Either the defaultPlaybackRate
or theplaybackRate
attribute has just been updated.resize
Event
One or both of the videoWidth
andvideoHeight
attributes have just been updated.Media element is a video
element;readyState
is notHAVE_NOTHING
volumechange
Event
Either the volume
attribute or themuted
attribute has changed. Fired after the relevant attribute’s setter has returned.The following event fires on
source
element:Event name Interface Fired when... error
Event
An error occurs while fetching the media data or the type of the resource is not supported media format. The following events fire on
AudioTrackList
,VideoTrackList
, andTextTrackList
objects:Event name Interface Fired when... change
Event
One or more tracks in the track list have been enabled or disabled. addtrack
TrackEvent
A track has been added to the track list. removetrack
TrackEvent
A track has been removed from the track list. The following event fires on
TextTrack
objects andtrack
elements:Event name Interface Fired when... cuechange
Event
One or more cues in the track have become active or stopped being active. The following events fire on
track
elements:The following events fire on
TextTrackCue
objects:Event name Interface Fired when... enter
Event
The cue has become active. exit
Event
The cue has stopped being active. 4.7.13.17. Security and privacy considerations
The main security and privacy implications of the
video
andaudio
elements come from the ability to embed media cross-origin. There are two directions that threats can flow: from hostile content to a victim page, and from a hostile page to victim content.
If a victim page embeds hostile content, the threat is that the content might contain scripted code that attempts to interact with the
Document
that embeds the content. To avoid this, user agents must ensure that there is no access from the content to the embedding page. In the case of media content that uses DOM concepts, the embedded content must be treated as if it was in its own unrelated top-level browsing context.For instance, if an SVG animation was embedded in a
video
element, the user agent would not give it access to the DOM of the outer page. From the perspective of scripts in the SVG resource, the SVG file would appear to be in a lone top-level browsing context with no parent.
If a hostile page embeds victim content, the threat is that the embedding page could obtain information from the content that it would not otherwise have access to. The API does expose some information: the existence of the media, its type, its duration, its size, and the performance characteristics of its host. Such information is already potentially problematic, but in practice the same information can be obtained using the
img
element, and so it has been deemed acceptable.However, significantly more sensitive information could be obtained if the user agent further exposes metadata within the content such as subtitles or chapter titles. Such information is therefore only exposed if the video resource passes a CORS resource sharing check. The
crossorigin
attribute allows authors to control how this check is performed. [FETCH]Without this restriction, an attacker could trick a user running within a corporate network into visiting a site that attempts to load a video from a previously leaked location on the corporation’s intranet. If such a video included confidential plans for a new product, then being able to read the subtitles would present a serious confidentiality breach.
4.7.13.18. Best practices for authors using media elements
This section is non-normative.
Playing audio and video resources on small devices such as set-top boxes or mobile phones is often constrained by limited hardware resources in the device. For example, a device might only support three simultaneous videos. For this reason, it is a good practice to release resources held by media elements when they are done playing, either by being very careful about removing all references to the element and allowing it to be garbage collected, or, even better, by removing the element’s
src
attribute and anysource
element descendants, and invoking the element’sload()
method.Similarly, when the playback rate is not exactly 1.0, hardware, software, or format limitations can cause video frames to be dropped and audio to be choppy or muted.
4.7.13.19. Best practices for implementors of media elements
This section is non-normative.
How accurately various aspects of the media element API are implemented is considered a quality-of-implementation issue.
For example, when implementing the
buffered
attribute, how precise an implementation reports the ranges that have been buffered depends on how carefully the user agent inspects the data. Since the API reports ranges as times, but the data is obtained in byte streams, a user agent receiving a variable-bit-rate stream might only be able to determine precise times by actually decoding all of the data. User agents aren’t required to do this, however; they can instead return estimates (e.g., based on the average bitrate seen so far) which get revised as more information becomes available.As a general rule, user agents are urged to be conservative rather than optimistic. For example, it would be bad to report that everything had been buffered when it had not.
Another quality-of-implementation issue would be playing a video backwards when the codec is designed only for forward playback (e.g., there aren’t many key frames, and they are far apart, and the intervening frames only have deltas from the previous frame). User agents could do a poor job, e.g., only showing key frames; however, better implementations would do more work and thus do a better job, e.g., actually decoding parts of the video forwards, storing the complete frames, and then playing the frames backwards.
Similarly, while implementations are allowed to drop buffered data at any time (there is no requirement that a user agent keep all the media data obtained for the lifetime of the media element), it is again a quality of implementation issue: user agents with sufficient resources to keep all the data around are encouraged to do so, as this allows for a better user experience. For example, if the user is watching a live stream, a user agent could allow the user only to view the live video; however, a better user agent would buffer everything and allow the user to seek through the earlier material, pause it, play it forwards and backwards, etc.
When a media element that is paused is removed from a document and not reinserted before the next time the event loop reaches step 1, implementations that are resource constrained are encouraged to take that opportunity to release all hardware resources (like video planes, networking resources, and data buffers) used by the media element. (User agents still have to keep track of the playback position and so forth, though, in case playback is later restarted.)
4.7.14. The
map
element- Categories:
- Flow content.
- Phrasing content.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Transparent.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
name
- Name of image map to reference from theusemap
attribute - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLMapElement
: HTMLElement { attribute DOMString name; [SameObject] readonly attribute HTMLCollection areas; [SameObject] readonly attribute HTMLCollection images; };
The
map
element, in conjunction with animg
element and anyarea
element descendants, defines an image map. The element represents its children.The
name
attribute gives the map a name so that it can be referenced. The attribute must be present and must have a non-empty value with no space characters. The value of thename
attribute must not be equal to the value of thename
attribute of anothermap
element in the same document. If theid
attribute is also specified, both attributes must have the same value.- map .
areas
- map .
images
-
Returns an
HTMLCollection
of theimg
andobject
elements that use themap
.
The
areas
attribute must return anHTMLCollection
rooted at themap
element, whose filter matches onlyarea
elements.The
images
attribute must return anHTMLCollection
rooted at theDocument
node, whose filter matches onlyimg
andobject
elements that are associated with thismap
element according to the image map processing model.The IDL attribute
name
must reflect the content attribute of the same name.Image maps can be defined in conjunction with other content on the page, to ease maintenance. This example is of a page with an image map at the top of the page and a corresponding set of text links at the bottom.<header> <h1>Shop</h1> <img src="/images/menu.png" alt="Shop navigation menu. Select a department to go to its page." usemap="#nav"> </header> ... <footer> <map name="nav"> <p> <a href="/clothes/">Clothes</a> <area alt="Clothes" coords="0,0,100,50" href="/clothes/"> | <a href="/toys/">Toys</a> <area alt="Toys" coords="100,0,200,50" href="/toys/"> | <a href="/food/">Food</a> <area alt="Food" coords="200,0,300,50" href="/food/"> | <a href="/books/">Books</a> <area alt="Books" coords="300,0,400,50" href="/books/"> </p> </map> </footer>
4.7.15. The
area
element- Categories:
- Flow content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected, but only if there is a
map
element ancestor or atemplate
element ancestor. - Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
alt
- Replacement text for use when images are not availablecoords
- Coordinates for the shape to be created in an image mapdownload
- Whether to download the resource instead of navigating to it, and its file name if sohref
- Address of the hyperlinkhreflang
- Language of the linked resourcerel
- Relationship of this document (or subsection/topic) to the destination resourceshape
- The kind of shape to be created in an image maptarget
- browsing context for hyperlink navigationtype
- Hint for the type of the referenced resourcereferrerpolicy
- Referrer policy for fetches initiated by the element - Allowed ARIA role attribute values:
-
link
role (default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to thelink
role. - Any
- DOM interface:
-
interface
HTMLAreaElement
: HTMLElement { attribute DOMString alt; attribute DOMString coords; attribute DOMString shape; attribute DOMString target; attribute DOMString download; attribute DOMString rel; [SameObject, PutForwards=value] readonly attribute DOMTokenList relList; attribute DOMString hreflang; attribute DOMStringtype
; attribute DOMString referrerPolicy; }; HTMLAreaElement implements HTMLHyperlinkElementUtils;
The
area
element represents either a hyperlink with some text and a corresponding area on an image map, or a dead area on an image map.An
area
element with a parent node must have amap
element ancestor or atemplate
element ancestor.If the
area
element has anhref
attribute, then thearea
element represents a hyperlink. In this case, thealt
attribute must be present. It specifies the text of the hyperlink. Its value must be text that informs the user about the destination of the link.If the
area
element has nohref
attribute, then the area represented by the element cannot be selected, and thealt
attribute must be omitted.In both cases, the
shape
andcoords
attributes specify the area.The
shape
attribute is an enumerated attribute. The following table lists the keywords defined for this attribute. The states given in the first cell of the rows with keywords give the states to which those keywords map. Some of the keywords are non-conforming, as noted in the last column.State Keywords Notes Circle state circle
circ
Non-conforming Default state default
Polygon state poly
polygon
Non-conforming Rectangle state rect
rectangle
Non-conforming The attribute may be omitted. The missing value default is the rectangle state.
The
coords
attribute must, if specified, contain a valid list of floating-point numbers. This attribute gives the coordinates for the shape described by theshape
attribute. The processing for this attribute is described as part of the image map processing model.In the circle state,
area
elements must have acoords
attribute present, with three integers, the last of which must be non-negative. The first integer must be the distance in CSS pixels from the left edge of the image to the center of the circle, the second integer must be the distance in CSS pixels from the top edge of the image to the center of the circle, and the third integer must be the radius of the circle, again in CSS pixels.In the default state state,
area
elements must not have acoords
attribute. (The area is the whole image.)In the polygon state,
area
elements must have acoords
attribute with at least six integers, and the number of integers must be even. Each pair of integers must represent a coordinate given as the distances from the left and the top of the image in CSS pixels respectively, and all the coordinates together must represent the points of the polygon, in order.In the rectangle state,
area
elements must have acoords
attribute with exactly four integers, the first of which must be less than the third, and the second of which must be less than the fourth. The four points must represent, respectively, the distance from the left edge of the image to the left side of the rectangle, the distance from the top edge to the top side, the distance from the left edge to the right side, and the distance from the top edge to the bottom side, all in CSS pixels.When user agents allow users to follow hyperlinks or download hyperlinks created using the
area
element, as described in the next section, thehref
,target
, anddownload
attributes decide how the link is followed. Therel
, andhreflang
attributes may be used to indicate to the user the likely nature of the target resource before the user follows the link.The
target
,download
,rel
,hreflang
,type
, andreferrerpolicy
attributes must be omitted if thehref
attribute is not present.The activation behavior of
area
elements is to run the following steps:- If the
area
element’s node document is not fully active, then abort these steps. -
If the
area
element has adownload
attribute and the algorithm is not allowed to show a popup; or, if the user has not indicated a specific browsing context for following the link, and the element’starget
attribute is present, and applying the rules for choosing a browsing context given a browsing context name, using the value of thetarget
attribute as the browsing context name, would result in there not being a chosen browsing context, then run these substeps:- If there is an entry settings object, throw an
InvalidAccessError
exception. - Abort these steps without following the hyperlink.
- If there is an entry settings object, throw an
- Otherwise, the user agent must follow the
hyperlink or download the hyperlink created
by the
area
element, if any, and as determined by thedownload
attribute and any expressed user preference.
The IDL attributes
alt
,coords
,target
,download
,rel
, andhreflang
, each must reflect the respective content attributes of the same name.The IDL attribute
shape
must reflect theshape
content attribute.The IDL attribute
relList
must reflect therel
content attribute.The IDL attribute
referrerPolicy
must reflect thereferrerpolicy
content attribute, limited to only known values.
The
area
element also supports theHTMLHyperlinkElementUtils
interface. [URL]When the element is created, and whenever the element’s
href
content attribute is set, changed, or removed, the user agent must invoke the element’sHTMLHyperlinkElementUtils
interface’s set the input algorithm with the value of thehref
content attribute, if any, or the empty string otherwise, as the given value.The element’s
HTMLHyperlinkElementUtils
interface’s get the base algorithm must simply return the document base URL.The element’s
HTMLHyperlinkElementUtils
interface’s query encoding is the document’s character encoding.When the element’s
HTMLHyperlinkElementUtils
interface invokes its update steps with a string value, the user agent must set the element’shref
content attribute to the string value.4.7.16. Image maps
4.7.16.1. Authoring
An image map allows geometric areas on an image to be associated with hyperlinks.
An image, in the form of an
img
element, may be associated with an image map (in the form of amap
element) by specifying ausemap
attribute on theimg
element. Theusemap
attribute, if specified, must be a valid hash-name reference to amap
element.Consider an image that looks as follows:If we wanted just the colored areas to be clickable, we could do it as follows:
<p> Please select a shape: <img src="shapes.png" usemap="#shapes" alt="Four shapes are available: a red hollow box, a green circle, a blue triangle, and a yellow four-pointed star."> <map name="shapes"> <area shape="rect" coords="50,50,100,100"> <!-- the hole in the red box --> <area shape="rect" coords="25,25,125,125" href="red.html" alt="Red box."> <area shape="circle" coords="200,75,50" href="green.html" alt="Green circle."> <area shape="poly" coords="325,25,262,125,388,125" href="blue.html" alt="Blue triangle."> <area shape="poly" coords="450,25,435,60,400,75,435,90,450,125,465,90,500,75,465,60" href="yellow.html" alt="Yellow star."> </map> </p>
4.7.16.2. Processing model
If an
img
element has ausemap
attribute specified, user agents must process it as follows:- Parse the attribute’s value using the rules for parsing a hash-name reference to a
map
element, with the element’s node document as the context node. This will return either an element (the map) or null. - If that returned null, then abort these steps. The image is not associated with an image map after all.
- Otherwise, the user agent must collect all the
area
elements that are descendants of the map. Let those be the areas.
Having obtained the list of
area
elements that form the image map (the areas), interactive user agents must process the list in one of two ways.If the user agent intends to show the text that the
img
element represents, then it must use the following steps.In user agents that do not support images, or that have images disabled,
object
elements cannot represent images, and thus this section never applies (the fallback content is shown instead). The following steps therefore only apply toimg
elements.- Remove all the
area
elements in areas that have nohref
attribute. - Remove all the
area
elements in areas that have noalt
attribute, or whosealt
attribute’s value is the empty string, if there is anotherarea
element in areas with the same value in thehref
attribute and with a non-emptyalt
attribute. -
Each remaining
area
element in areas represents a hyperlink. Those hyperlinks should all be made available to the user in a manner associated with the text of theimg
.In this context, user agents may represent
area
andimg
elements with no specifiedalt
attributes, or whosealt
attributes are the empty string or some other non-visible text, in a user-agent-defined fashion intended to indicate the lack of suitable author-provided text.
If the user agent intends to show the image and allow interaction with the image to select hyperlinks, then the image must be associated with a set of layered shapes, taken from the
area
elements in areas, in reverse tree order (so the last specifiedarea
element in the map is the bottom-most shape, and the first element in the map, in tree order, is the top-most shape).Each
area
element in areas must be processed as follows to obtain a shape to layer onto the image:- Find the state that the element’s
shape
attribute represents. - Use the rules for parsing a list of floating-point numbers to parse the element’s
coords
attribute, if it is present, and let the result be the coords list. If the attribute is absent, let the coords list be the empty list. -
If the number of items in the coords list is less than the minimum number given for the
area
element’s current state, as per the following table, then the shape is empty; abort these steps.State Minimum number of items Circle state 3 Default state 0 Polygon state 6 Rectangle state 4 -
Check for excess items in the coords list as per the entry in the following list corresponding to the
shape
attribute’s state:- Circle state
- Drop any items in the list beyond the third.
- Default state
- Drop all items in the list.
- Polygon state
- Drop the last item if there’s an odd number of items.
- Rectangle state
- Drop any items in the list beyond the fourth.
- If the
shape
attribute represents the rectangle state, and the first number in the list is numerically greater than the third number in the list, then swap those two numbers around. - If the
shape
attribute represents the rectangle state, and the second number in the list is numerically greater than the fourth number in the list, then swap those two numbers around. - If the
shape
attribute represents the circle state, and the third number in the list is less than or equal to zero, then the shape is empty; abort these steps. -
Now, the shape represented by the element is the one described for the entry in the list
below corresponding to the state of the
shape
attribute:- Circle state
-
Let x be the first number in coords, y be the second number, and r be the third number.
The shape is a circle whose center is x CSS pixels from the left edge of the image and y CSS pixels from the top edge of the image, and whose radius is r CSS pixels.
- Default state
-
The shape is a rectangle that exactly covers the entire image.
- Polygon state
-
Let xi be the (2i)th entry in coords, and yi be the (2i+1)th entry in coords (the first entry in coords being the one with index 0).
Let the coordinates be (xi, yi), interpreted in CSS pixels measured from the top left of the image, for all integer values of i from 0 to (N/2)-1, where N is the number of items in coords.
The shape is a polygon whose vertices are given by the coordinates, and whose interior is established using the even-odd rule. [GRAPHICS]
- Rectangle state
-
Let x1 be the first number in coords, y1 be the second number, x2 be the third number, and y2 be the fourth number.
The shape is a rectangle whose top-left corner is given by the coordinate (x1, y1) and whose bottom right corner is given by the coordinate (x2, y2), those coordinates being interpreted as CSS pixels from the top left corner of the image.
For historical reasons, the coordinates must be interpreted relative to the displayed image after any stretching caused by the CSS width and height properties (or, for non-CSS browsers, the image element’s
width
andheight
attributes — CSS browsers map those attributes to the aforementioned CSS properties).Browser zoom features and transforms applied using CSS or SVG do not affect the coordinates.
Pointing device interaction with an image associated with a set of layered shapes per the above algorithm must result in the relevant user interaction events being first fired to the top-most shape covering the point that the pointing device indicated, if any, or to the image element
itself, if there is no shape covering that point. User agents should make
area
elements representing hyperlinks focusable, to ensure that they can be selected and activated by all users.Because a
map
element (and itsarea
elements) can be associated with multipleimg
andobject
elements, it is possible for anarea
element to correspond to multiple focusable areas of the document.Image maps are live; if the DOM is mutated, then the user agent must act as if it had rerun the algorithms for image maps.
4.7.17. MathML
The MathML
math
element falls into the embedded content, phrasing content, flow content, and palpable content categories for the purposes of the content models in this specification.When the MathML
annotation-xml
element contains elements from the HTML namespace, such elements must all be flow content.When the MathML token elements (MathML
mi
, MathMLmo
, MathMLmn
, MathMLms
, and MathMLmtext
) are descendants of HTML elements, they may contain phrasing content elements from the HTML namespace. [MATHML]User agents must handle text other than inter-element white space found in MathML elements whose content models do not allow straight text by pretending for the purposes of MathML content models, layout, and rendering that the text is actually wrapped in an MathML
mtext
element in the MathML namespace. (Such text is not, however, conforming.)User agents must act as if any MathML element whose contents does not match the element’s content model was replaced, for the purposes of MathML layout and rendering, by an MathML
merror
element containing some appropriate error message.To enable authors to use MathML tools that only accept MathML in its XML form, interactive HTML user agents are encouraged to provide a way to export any MathML fragment as an XML namespace-well-formed XML fragment.
The semantics of MathML elements are defined by the MathML specification and other applicable specifications. [MATHML]
Here is an example of the use of MathML in an HTML document. Some browsers may not be able to render it correctly.The quadratic formula
<h1>The quadratic formula</h1> <p> <math> <mi>x</mi> <mo>=</mo> <mfrac> <mrow> <mo form="prefix">-</mo> <mi>b</mi> <mo>±</mo> <msqrt> <msup> <mi>b</mi> <mn>2</mn> </msup> <mo>-</mo> <mn>4</mn> <mo>⁢</mo> <mi>a</mi> <mo>⁢</mo> <mi>c</mi> </msqrt> </mrow> <mrow> <mn>2</mn> <mo>⁢</mo> <mi>a</mi> </mrow> </mfrac> </math> </p>
4.7.18. SVG
The SVG
svg
element falls into the embedded content, phrasing content, flow content, and palpable content categories for the purposes of the content models in this specification.To enable authors to use SVG tools that only accept SVG in its XML form, interactive HTML user agents are encouraged to provide a way to export any SVG fragment as an XML namespace-well-formed XML fragment.
When the SVG
foreignObject
element contains elements from the HTML namespace, such elements must all be flow content. [SVG11]The content model for SVG
title
elements inside HTML documents is phrasing content. (This further constrains the requirements given in the SVG specification.)The semantics of SVG elements are defined by the SVG specification and other applicable specifications. [SVG11]
4.7.19. Dimension attributes
Author requirements: The
width
andheight
attributes onimg
,iframe
,embed
,object
,video
, and, when theirtype
attribute is in theImage Button
state,input
elements may be specified to give the dimensions of the visual content of the element (the width and height respectively, relative to the nominal direction of the output medium), in CSS pixels. The attributes, if specified, must have values that are valid non-negative integers.The specified dimensions given may differ from the dimensions specified in the resource itself, since the resource may have a resolution that differs from the CSS pixel resolution. (On screens, CSS pixels have a resolution of 96ppi, but in general the CSS pixel resolution depends on the reading distance.) If both attributes are specified, then one of the following statements must be true:
- specified width - 0.5 ≤ specified height * target ratio ≤ specified width + 0.5
- specified height - 0.5 ≤ specified width / target ratio ≤ specified height + 0.5
- specified height = specified width = 0
The target ratio is the ratio of the intrinsic width to the intrinsic height in the resource. The specified width and specified height are the values of the
width
andheight
attributes respectively.The two attributes must be omitted if the resource in question does not have both an intrinsic width and an intrinsic height.
If the two attributes are both zero, it indicates that the element is not intended for the user (e.g., it might be a part of a service to count page views).
The dimension attributes are not intended to be used to stretch the image.
User agent requirements: User agents are expected to use these attributes as hints for the rendering.
The
width
andheight
IDL attributes on theiframe
,embed
,object
, andvideo
elements must reflect the respective content attributes of the same name.For
iframe
,embed
, andobject
the IDL attributes areDOMString
; forvideo
the IDL attributes areunsigned long
.The corresponding IDL attributes for
img
andinput
elements are defined in those respective elements' sections, as they are slightly more specific to those elements' other behaviors.
4.8. Links
4.8.1. Introduction
Links are a conceptual construct, created by a
, area
, and link
elements. They represent a connection between two resources, one of which is the current Document
.
There are two kinds of links in HTML:
- Links to external resources
- These are links to resources that are to be used to augment the current document, generally automatically processed by the user agent.
- Hyperlinks
- These are links to other resources that are exposed to users by the user agent. The user can cause the user agent to navigate to those resources (for example to visit them in the browser or to download them).
For link
elements with an href
attribute and a rel
attribute, links
must be created for the keywords of the rel
attribute, as defined for those keywords
in the link types section.
Similarly, for a
and area
elements with an href
attribute and a rel
attribute, links must be created for the keywords of the rel
attribute
as defined for those keywords in the link types section. Unlike link
elements,
however, a
and area
elements with an href
attribute that either do not have
a rel
attribute, or whose rel
attribute has no keywords that are defined as
specifying hyperlinks, must also create a hyperlink.
This implied hyperlink has no special meaning (it has no link type)
beyond linking the element’s node document to the resource given by the element’s href
attribute.
A hyperlink can have one or more hyperlink annotations that modify the processing semantics of that hyperlink.
4.8.2. Links created by a
, area
and link
elements
The href
attribute on a
, area
and link
elements must have a value that is a valid URL potentially surrounded by spaces.
The href
attribute on a
and area
elements is not required; when those
elements do not have href
attributes they do not create hyperlinks. If a link
element lacks the href
attribute, then it does not define a link.
The target
attribute, if present, must be
a valid browsing context name or keyword. It gives the name of the browsing context that will be used. User agents use this name when following hyperlinks.
When an a
or area
element’s activation behavior is
invoked, the user agent may allow the user to indicate a preference regarding whether the
hyperlink is to be used for navigation or whether the resource it
specifies is to be downloaded.
In the absence of a user preference, the default should be navigation if the element has no download
attribute, and should be to download the specified resource if it does.
Whether determined by the user’s preferences or via the presence or absence of the attribute, if the decision is to use the hyperlink for navigation then the user agent must follow the hyperlink, and if the decision is to use the hyperlink to download a resource, the user agent must download the hyperlink. These terms are defined in subsequent sections below.
The download
attribute, if present,
indicates that the author intends the hyperlink to be used for downloading the linked resource.
The attribute may have a value; if any, it specifies the author’s recommended default file
name for labeling the resource in a local file system. The author’s recommended default file name
does not need to match the file name of the linked resource. There are no restrictions on
allowed values, but authors are cautioned that most file systems have limitations with regard
to what punctuation is supported in file names, and user agents are likely to adjust file names
accordingly.
<a href="/images/IMG-d5644aBUd89z6e8.jpg" download="arranged-cakes.jpg"> Download photo of cakes! </a>
The ping
attribute, if present,
gives the URLs of the resources that are interested in being notified if the user follows the hyperlink.
The value must be a set of space-separated tokens, each of which must be a valid non-empty URL whose scheme is an HTTP(S) scheme. The value is used by the user
agent for hyperlink auditing.
The rel
attribute on a
and area
elements controls what kinds of links the elements create. The attribute’s value
must be a set of space-separated tokens (keywords).
The allowed keywords and their meanings are defined below.
rel
's supported tokens are the keywords defined in HTML link types which are allowed on a
and area
elements, impact the processing model, and are supported
by the user agent.
The possible supported tokens for a
and area
elements are noreferrer
,
and noopener
. rel
's supported tokens must only include the tokens
from this list that the user agent implements the processing model for.
The rel
attribute has a different listing of supported tokens for the link
element.
Other specifications may add HTML link types as defined in Other link types, with the following additional requirements:
-
Such specifications may require that their link types be included in
rel
's supported tokens. -
Such specifications may specify that their link types are body-ok.
The rel
attribute has no default value. If the
attribute is omitted or if none of the values in the attribute are recognized by the user agent,
then the document has no particular relationship with the destination resource other than there
being a hyperlink between the two.
link
and a
elements may also have a rev
attribute, which is used to describe
a reverse link relationship from the resource specified by the href
to the
current document. If present, the value of this attribute must be a set of space-separated
tokens. Like the rel
attribute, link types describes the allowed
keywords and their meanings for the rev
attribute. Both the rel
and rev
attributes may be present on the same element.
Reverse links are a way to express the reverse
directional relationship of a link. In contrast to the rel
attribute, whose value
conveys a forward directional relationship ("how is the link related to me"), the rev
attribute allows for similar relationships to be expressed in the reverse direction ("how am I
related to this link"). These values can enable user agents to build a more comprehensive map of
linked documents.
rel
and rev
attributes as follows:
Document with URL "chapter1.html"
<link href="chapter2.html" rel="next" rev="prev">
Document with URL "chapter2.html"
<link href="chapter1.html" rel="prev" rev="next"> <link href="chapter3.html" rel="next" rev="prev">
From chapter1.html, the link to chapter2.html is the "next
" chapter in the series
in the forward direction, and the "previous
" chapter in the reverse direction
(from chapter2.html to chapter1.html).
rel
and rev
as follows:
<ol> <li><a href="chapter1.html" rev="toc" rel="next">chapter 1</a></li> <li><a href="chapter2.html" rev="toc"></a>chapter 2</li> <li><a href="chapter3.html" rev="toc"></a>chapter 3</li> </ol>
From the table of contents, the "next
" logical path is to the first chapter,
expressed using rel
. Each chapter link has a "toc
" rev
value
which indicates that the current document is the table of contents document for every chapter.
The hreflang
attribute on a
elements that create hyperlinks, if present, gives
the language of the linked resource. It is purely advisory. The value must be a valid BCP 47
language tag. [BCP47] User agents must not consider this attribute
authoritative — upon fetching the resource, user agents must use only language information
associated with the resource to determine its language, not metadata included in the link to the
resource.
The as
attribute specifies the destination for a
preload request for the resource given by the href
attribute. If the attribute is present,
the value must case-sensitively match one of the potential destination keywords. The default value
is the empty string. The attribute may be omitted. The attribute must not be specified on link
elements
that do not have a rel
attribute that contains the preload
keyword. User agents must
implement the processing model of the as
attribute described in the Preload specification. [Preload]
The type
attribute, if present, gives the MIME type of the linked resource. It is purely advisory. The value must be a valid mime type. User agents must not consider the type
attribute authoritative — upon fetching the
resource, user agents must not use metadata included in the link to the resource to determine its
type.
The referrerpolicy
attribute is a referrer policy attribute.
Its purpose is to set the referrer policy used when following hyperlinks. [REFERRERPOLICY]
4.8.3. API for a
and area
elements
[NoInterfaceObject]
interface HTMLHyperlinkElementUtils
{
stringifier attribute USVString href;
readonly attribute USVString origin;
attribute USVString protocol;
attribute USVString username;
attribute USVString password;
attribute USVString host;
attribute USVString hostname;
attribute USVString port;
attribute USVString pathname;
attribute USVString search;
attribute USVString hash;
};
- hyperlink .
toString()
- hyperlink .
href
- hyperlink .
-
Returns the hyperlink’s URL.
Can be set, to change the URL.
- hyperlink .
origin
-
Returns the hyperlink’s URL’s origin.
- hyperlink .
protocol
-
Returns the hyperlink’s URL’s scheme.
Can be set, to change the URL’s scheme.
- hyperlink .
username
-
Returns the hyperlink’s URL’s username.
Can be set, to change the URL’s username.
- hyperlink .
password
-
Returns the hyperlink’s URL’s password.
Can be set, to change the URL’s password.
- hyperlink .
host
-
Returns the hyperlink’s URL’s host and port (if different from the default port for the scheme).
Can be set, to change the URL’s host and port.
- hyperlink .
hostname
-
Returns the hyperlink’s URL’s host.
Can be set, to change the URL’s host.
- hyperlink .
port
-
Returns the hyperlink’s URL’s port.
Can be set, to change the URL’s port.
- hyperlink .
pathname
-
Returns the hyperlink’s URL’s path.
Can be set, to change the URL’s path.
- hyperlink .
search
-
Returns the hyperlink’s URL’s query (includes leading "
?
" if non-empty).Can be set, to change the URL’s query (ignores leading "
?
"). - hyperlink .
hash
-
Returns the hyperlink’s URL’s fragment (includes leading "
#
" if non-empty).Can be set, to change the URL’s fragment (ignores leading "
#
").
An element implementing the HTMLHyperlinkElementUtils
mixin has an associated url (null or a URL). It is initially null.
An element implementing the HTMLHyperlinkElementUtils
mixin has an associated set the url algorithm, which sets this
element’s URL to the resulting URL string of parsing this element’s href
content attribute value relative to this element. If parsing was aborted with an error, set this element’s URL to null.
When elements implementing the HTMLHyperlinkElementUtils
mixin are created, and
whenever those elements have their href
content
attribute set, changed, or removed, the user agent must set the url.
This is only observable for blob:
URLs as parsing them involves the StructuredSerialize abstract operation.
An element implementing the HTMLHyperlinkElementUtils
mixin has an associated reinitialize url algorithm, which runs these steps:
- If element’s URL is non-null, its scheme is "
blob
", and its non-relative flag is set, terminate these steps. - Set the url.
To update href
, set the element’s href
content attribute’s value to the element’s URL, serialized.
The href
attribute’s getter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null and this element has no
href
content attribute, return the empty string. - Otherwise, if url is null, return this element’s
href
content attribute’s value. - Return url, serialized.
The href
attribute’s setter must set this element’s href
content attribute’s value to the given value.
The origin
attribute’s getter must run
these steps:
- Reinitialize url.
- If this element’s URL is null, return the empty string.
- Return the Unicode serialization of this element’s URL's origin.
It returns the Unicode rather than the ASCII serialization for
compatibility with MessageEvent
.
The protocol
attribute’s getter must
run these steps:
- Reinitialize url.
-
If this element’s URL is null, return "
:
". - Return this element’s URL's scheme, followed by "
:
".
The protocol
attribute’s setter must run these
steps:
- Reinitialize url.
- If this element’s URL is null, terminate these steps.
- Basic URL parse the given value, followed by
:
", with this element’s URL as url and scheme start state as state override. - Update
href
.
The username
attribute’s getter must
run these steps:
- Reinitialize url.
- If this element’s URL is null, return the empty string.
- Return this element’s URL's username.
The username
attribute’s setter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s host is null, or url’s non-relative flag is set, terminate these steps.
- set the username, given url and the given value.
- Update
href
.
The password
attribute’s getter must
run these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s password is null, return the empty string.
- Return url’s password.
The password
attribute’s setter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s host is null, or url’s non-relative flag is set, terminate these steps.
- Set the password, given url and the given value.
- Update
href
.
The host
attribute’s getter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s host is null, return the empty string.
- If url’s port is null, return url’s host, serialized.
- Return url’s host, serialized, followed by "
:
" and url’s port, serialized.
The host
attribute’s setter must run these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null or url’s non-relative flag is set, terminate these steps.
- Basic URL parse the given value, with url as url and host state as state override.
- Update
href
.
The hostname
attribute’s getter must
run these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s host is null, return the empty string.
- Return url’s host, serialized.
The hostname
attribute’s setter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null or url’s non-relative flag is set, terminate these steps.
- Basic URL parse the given value, with url as url and hostname state as state override.
- Update
href
.
The port
attribute’s getter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s port is null, return the empty string.
- Return url’s port, serialized.
The port
attribute’s setter must run these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url or url’s host is null, url’s non-relative flag is set, or url’s scheme is "
file
", terminate these steps. - Basic URL parse the given value, with url as url and port state as state override.
- Update
href
.
The pathname
attribute’s getter must
run these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null, return the empty string.
- If url’s non-relative flag is set, return the first string in url’s path.
- Return "
/
", followed by the strings in url’s path (including empty strings), separated from each other by "/
".
The pathname
attribute’s setter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null or url’s non-relative flag is set, terminate these steps.
- Set url’s path to the empty list.
- Basic URL parse the given value, with url as url and path start state as state override.
- Update
href
.
The search
attribute’s getter must run
these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null, or url’s query is either null or the empty string, return the empty string.
- Return "
?
", followed by url’s query.
The search
attribute’s setter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null, terminate these steps.
- If the given value is the empty string, set url’s query to null.
-
Otherwise, run these substeps:
- Let input be the given value with a single leading "
?
" removed, if any. - Set url’s query to the empty string.
- Basic URL parse input, with url as url and query state as state override, and this element’s node document’s document’s character encoding as encoding override.
- Let input be the given value with a single leading "
- Update
href
.
The hash
attribute’s getter must run these
steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null, or url’s fragment is either null or the empty string, return the empty string.
- Return "
#
", followed by url’s fragment.
The hash
attribute’s setter must run these steps:
- Reinitialize url.
- Let url be this element’s URL.
- If url is null or url’s scheme is "
javascript
", terminate these steps. - If the given value is the empty string, set url’s fragment to null.
-
Otherwise, run these substeps:
- Let input be the given value with a single leading "
#
" removed, if any. - Set url’s fragment to the empty string.
- Basic URL parse input, with url as url and fragment state as state override.
- Let input be the given value with a single leading "
- Update
href
.
4.8.4. Following hyperlinks
When a user follows a hyperlink created by an element subject, optionally with a hyperlink suffix, the user agent must run the following steps:
- Let replace be false.
- Let source be the browsing context that contains the
Document
object with which subject in question is associated. -
If the user indicated a specific browsing context when following the hyperlink, or if the user agent is configured to follow hyperlinks by navigating a particular browsing context, then let target be that browsing context. If this is a new top-level browsing context (e.g., when the user followed the hyperlink using "Open in New Tab"), then source must be set as the new browsing context’s one permitted sandboxed navigator.
Otherwise, if subject is an
a
orarea
element that has atarget
attribute, then let target be the browsing context that is chosen by applying the rules for choosing a browsing context given a browsing context name, using the value of thetarget
attribute as the browsing context name. If these rules result in the creation of a new browsing context, set replace to true.Otherwise, if target is an
a
orarea
element with notarget
attribute, but theDocument
contains abase
element with atarget
attribute, then let target be the browsing context that is chosen by applying the rules for choosing a browsing context given a browsing context name, using the value of thetarget
attribute of the first suchbase
element as the browsing context name. If these rules result in the creation of a new browsing context, set replace to true.Otherwise, let target be the browsing context that subject itself is in.
- If subject’s link types include the
noreferrer
ornoopener
keyword, and replace is true, then disown target’s opener. - Parse the URL given by subject’s
href
attribute, relative to subject’s node document. -
If that is successful, let URL be the resulting URL string.
Otherwise, if parsing the URL failed, the user agent may report the error to the user in a user-agent-specific manner, may queue a task to navigate the target browsing context to an error page to report the error, or may ignore the error and do nothing. In any case, the user agent must then abort these steps.
- If there is a hyperlink suffix, append it to URL.
-
Let resource be a new request whose url is URL and whose referrer policy is the current state of subject’s
referrerpolicy
content attribute. - Queue a task to navigate the target browsing context to resource. If replace is true, the navigation must be performed with replacement enabled. The source browsing context must be source.
The task source for the tasks mentioned above is the DOM manipulation task source.
4.8.5. Downloading resources
In some cases, resources are intended for later use rather than immediate viewing. To indicate
that a resource is intended to be downloaded for use later, rather than immediately used, the download
attribute can be specified on the a
or area
element that creates
the hyperlink to that resource.
The attribute can furthermore be given a value, to specify the file name that user agents are
to use when storing the resource in a file system. This value can be overridden by the Content-Disposition
HTTP header’s filename parameters. [RFC6266]
In cross-origin situations, the download
attribute has to be combined with the Content-Disposition
HTTP header, specifically with the attachment
disposition type, to avoid the user being warned of possibly
nefarious activity. (This is to protect users from being made to download sensitive personal or
confidential information without their full understanding.)
When a user downloads a hyperlink created by an element subject, optionally with a hyperlink suffix, the user agent must run the following steps:
- Parse the URL given by subject’s
href
attribute, relative to subject. - If parsing the URL fails, the user agent may report the error to the user in a user-agent-specific manner, may navigate to an error page to report the error, or may ignore the error and do nothing. In either case, the user agent must abort these steps.
- Otherwise, let URL be the resulting URL string.
- If there is a hyperlink suffix, append it to URL.
- Return to whatever algorithm invoked these steps and continue these steps in parallel.
- Fetch URL and handle the resulting resource as a download.
When a user agent is to handle a resource obtained from a fetch as a download, it should provide the user with a way to save the resource for later use, if a resource is successfully obtained; or otherwise should report any problems downloading the file to the user.
If the user agent needs a file name for a resource being handled as a download, it should select one using the following algorithm.
This algorithm is intended to mitigate security dangers involved in downloading files from untrusted sites, and user agents are strongly urged to follow it.
- Let filename be the void value.
- If the resource has a
Content-Disposition
header, that header specifies theattachment
disposition type, and the header includes file name information, then let filename have the value specified by the header, and jump to the step labeled sanitize below. [RFC6266] - Let interface origin be the origin of the
Document
in which the download or navigate action resulting in the download was initiated, if any. - Let resource origin be the origin of the URL of the
resource being downloaded, unless that URL’s scheme component is
data
, in which case let resource origin be the same as the interface origin, if any. - If there is no interface origin, then let trusted operation be true. Otherwise, let trusted operation be true if resource origin is the same origin as interface origin, and false otherwise.
- If trusted operation is true and the resource has a
Content-Disposition
header and that header includes file name information, then let filename have the value specified by the header, and jump to the step labeled sanitize below. [RFC6266] - If the download was not initiated from a hyperlink created by an
a
orarea
element, or if the element of the hyperlink from which it was initiated did not have adownload
attribute when the download was initiated, or if there was such an attribute but its value when the download was initiated was the empty string, then jump to the step labeled no proposed file name. - Let proposed filename have the value of the
download
attribute of the element of the hyperlink that initiated the download at the time the download was initiated. - If trusted operation is true, let filename have the value of proposed filename, and jump to the step labeled sanitize below.
- If the resource has a
Content-Disposition
header and that header specifies theattachment
disposition type, let filename have the value of proposed filename, and jump to the step labeled sanitize below. [RFC6266] - No proposed file name: If trusted operation is true, or if the user indicated a preference for having the resource in question downloaded, let filename have a value derived from the URL of the resource in a user-agent-defined manner, and jump to the step labeled sanitize below.
-
Act in a user-agent-defined manner to safeguard the user from a potentially hostile
cross-origin download. If the download is not to be aborted, then let filename be
set to the user’s preferred file name or to a file name selected by the user agent, and jump
to the step labeled sanitize below.
If the algorithm reaches this step, then a download was begun from a different origin than the resource being downloaded, and the origin did not mark the file as suitable for downloading, and the download was not initiated by the user. This could be because a
download
attribute was used to trigger the download, or because the resource in question is not of a type that the user agent supports.This could be dangerous, because, for instance, a hostile server could be trying to get a user to unknowingly download private information and then re-upload it to the hostile server, by tricking the user into thinking the data is from the hostile server.
Thus, it is in the user’s interests that the user be somehow notified that the resource in question comes from quite a different source, and to prevent confusion, any suggested file name from the potentially hostile interface origin should be ignored.
- Sanitize: Optionally, allow the user to influence filename. For example, a user agent could prompt the user for a file name, potentially providing the value of filename as determined above as a default value.
-
Adjust filename to be suitable for the local file system.
For example, this could involve removing characters that are not legal in file names, or trimming leading and trailing white space.
- If the platform conventions do not in any way use extensions to determine the types of file on the file system, then return filename as the file name and abort these steps.
- Let claimed type be the type given by the resource’s Content-Type metadata, if any is known. Let named type be the type given by filename’s extension, if any is known. For the purposes of this step, a type is a mapping of a MIME type to an extension.
- If named type is consistent with the user’s preferences (e.g., because the value of filename was determined by prompting the user), then return filename as the file name and abort these steps.
- If claimed type and named type are the same type (i.e., the type given by the resource’s Content-Type metadata is consistent with the type given by filename’s extension), then return filename as the file name and abort these steps.
-
If the claimed type is known, then alter filename to add an extension corresponding to claimed type.
Otherwise, if named type is known to be potentially dangerous (e.g., it will be treated by the platform conventions as a native executable, shell script, HTML application, or executable-macro-capable document) then optionally alter filename to add a known-safe extension (e.g., "
.txt
").This last step would make it impossible to download executables, which might not be desirable. As always, implementors are forced to balance security and usability in this matter.
- Return filename as the file name.
For the purposes of this algorithm, a file extension consists of any part of the file name that platform conventions dictate will be used for
identifying the type of the file. For example, many operating systems use the part of the file
name following the last dot (".
") in the file name to determine the type of
the file, and from that the manner in which the file is to be opened or executed.
User agents should ignore any directory or path information provided by the resource itself,
its URL, and any download
attribute, in
deciding where to store the resulting file in the user’s file system.
4.8.5.1. Hyperlink auditing
If a hyperlink created by an a
or area
element has a ping
attribute whose href
attribute can be parsed relative to the element’s node document without failure, and the user follows the hyperlink,
then the user agent must take the ping
attribute’s value, split that string on spaces,
parse each resulting token relative to the element’s node document,
then run these steps for each resulting URL record ping URL (ignoring tokens that fail to parse):
-
If ping URL’s scheme is not an HTTP(S) scheme, then return.
-
Optionally, return (for example the user agent may ignore any or all ping URLs in accordance with the user’s express preferences).
-
Let request be a new request, whose URL is ping URL, method is post, body is ping, client is the environment settings object of the document containing the hyperlink, destination is the empty string, credentials mode is include, referrer is "no-referrer", and whose use-URL-credentials flag is set.
-
Let target URL be the resulting URL string obtained from parsing the value of the element’s
href
attribute, and then:- If the URL of the document object containing the hyperlink being audited and the ping URL have the same origin
- Or if the origins are different but the HTTPS state of the document containing the hyperlink being audited is "none"
- request must include a ping-from header with the URL of the document containing the hyperlink as its value, and a ping-to HTTP header with the target URL as its value.
- Otherwise
- request must include a ping-to HTTP header with target URL as its value. Note: request does not include a ping-from header.
- If the URL of the document object containing the hyperlink being audited and the ping URL have the same origin
-
Fetch request.
This may be done in parallel with the primary fetch, and is independent of the result of that fetch.
User agents should allow the user to alter this behavior.
For example, in conjunction with a setting that disables the sending of HTTP referrer (sic) headers.
Based on the user’s preferences, user agents may ignore the ping
attribute completely,
or selectively ignore URLs (for example third party URLs); this is explicitly accounted for in the steps above.
User agents must ignore any entity bodies returned in the responses. User agents may close the connection prematurely once they start receiving a response body.
When the ping
attribute is present, user agents should make it clear to the user
that following the hyperlink will also cause secondary requests to be sent in the background.
ping
attribute is redundant with pre-existing technologies like HTTP redirects
and JavaScript, in allowing web pages to track which off-site links are most popular, or
allowing advertisers to track click-through rates.
However, the ping
attribute provides these advantages over those alternatives:
-
It allows the user to see the unobscured final target URL.
-
It allows the user agent to inform the user about out-of-band notifications.
-
It allows the user to disable notifications without losing the underlying functionality.
-
It allows the user agent to optimize the use of available bandwidth, so the target page loads faster.
So while it is possible to track users without this feature, authors are encouraged to use
the ping
attribute, so the user agent can make the experience more transparent.
4.8.6. Link types
The following table summarizes the link types that are defined by this specification, by their corresponding keywords. This table is non-normative; the actual definitions for the link types are given in the next few sections.
In this section, the term referenced document refers to the resource identified by the element representing the link, and the term current document refers to the resource within which the element representing the link finds itself.
To determine which link types apply to a link
, a
, or area
element, the element’s rel
attribute must be split on spaces. The
resulting tokens are the keywords for the link types that apply to that element.
Except where otherwise specified, a keyword must not be specified more than once per rel
attribute.
Some of the sections that follow the table below list synonyms for certain keywords. The indicated
synonyms are to be handled as specified by user agents, but must not be used in documents (for
example, the keyword "copyright
").
Keywords are always ASCII case-insensitive, and must be compared as such.
So rel="next"
is the same as rel="NEXT"
.
Keywords that are body-ok affect whether link
elements are allowed in the body. The body-ok keywords defined by this specification are dns-prefetch
, preconnect
, prefetch
, preload
, prerender
, and stylesheet
.
Other applicable specifications may define body-ok keywords.
Link type | Effect on... | body-ok | Brief description | |
---|---|---|---|---|
link
| a and area
| |||
alternate
| hyperlink | hyperlink | · | Gives alternate representations of the current document. |
author
| hyperlink | hyperlink | · | Gives a link to the author of the current document or article. |
bookmark
| not allowed | hyperlink | · | Gives the permalink for the nearest ancestor section. |
canonical
| not allowed | hyperlink | · | Gives the preferred URL for the current document. |
dns-prefetch
| not allowed | hyperlink | Yes | Gives the origin for resources so the User Agent can resolve it as early as possible. |
external
| not allowed | Annotation | · | Indicates that the referenced document is not part of the same site as the current document. |
help
| hyperlink | hyperlink | · | Provides a link to context-sensitive help. |
icon
| External Resource | not allowed | · | Imports an icon to represent the current document. |
license
| hyperlink | hyperlink | · | Indicates that the main content of the current document is covered by the copyright license described by the referenced document. |
next
| hyperlink | hyperlink | · | Indicates that the current document is a part of a series, and that the next document in the series is the referenced document. |
nofollow
| not allowed | Annotation | · | Indicates that the current document’s original author or publisher does not endorse the referenced document. |
noopener
| not allowed | Annotation | · | Requires that any browsing context created by following the hyperlink to disown its opener. |
noreferrer
| not allowed | Annotation | · | Requires that the user agent not send an HTTP Referer (sic) header if the user follows the hyperlink.
|
preconnect
| External Resource | not allowed | Yes | Specifies that the target resource should be preemptively cached and cache the target resource as it is likely to be required for a followup navigation. |
prefetch
| External Resource | not allowed | Yes | Specifies that the target resource should be preemptively cached and cache the target resource as it is likely to be required for a followup navigation. |
preload
| External Resource | not allowed | Yes | Specifies that the user agent must preemptively fetch and cache the target resource for current navigation according to the potential destination given by the as attribute (and the priority associated with the corresponding destination).
|
prerender
| External Resource | not allowed | Yes | Specifies that the target resource should be preemptively cached and cache the target resource as it is likely to be required for a followup navigation. |
prev
| hyperlink | hyperlink | · | Indicates that the current document is a part of a series, and that the previous document in the series is the referenced document. |
search
| hyperlink | hyperlink | · | Gives a link to a resource that can be used to search through the current document and its related pages. |
stylesheet
| External Resource | not allowed | Yes | Imports a stylesheet. |
tag
| not allowed | hyperlink | · | Gives a tag (identified by the given address) that applies to the current document. |
4.8.6.1. Link type "alternate
"
The alternate
keyword may be used with link
, a
, and area
elements.
The meaning of this keyword depends on the values of the other attributes.
- If the element is a
link
element and therel
attribute also contains the keywordstylesheet
-
The
alternate
keyword modifies the meaning of thestylesheet
keyword in the way described for that keyword. Thealternate
keyword does not create a link of its own.A document does not need to have a single style sheet. It can have a default style and any number of alternatives for the reader to choose from. In the following example, a set oflink
elements provide some alternate style sheets:<!-- a persistent style sheet --> <link rel="stylesheet" href="default.css"> <!-- some alternate style sheets --> <link rel="alternate stylesheet" href="contrast.css" title="High contrast"> <link rel="alternate stylesheet" href="big.css" title="Big fonts"> <link rel="alternate stylesheet" href="wide.css" title="Wide screen">
How the user can select the alternate style sheets will depend on the browser. Not all browsers offer a user interface for selecting style sheets.
- If the
alternate
keyword is used with thetype
attribute set to the valueapplication/rss+xml
or the valueapplication/atom+xml
-
The keyword creates a hyperlink referencing a syndication feed (though not necessarily syndicating exactly the same content as the current page).
The first
link
ora
element in the document (in tree order) with thealternate
keyword used with thetype
attribute set to the valueapplication/rss+xml
or the valueapplication/atom+xml
must be treated as the default syndication feed for the purposes of feed autodiscovery.The followinglink
element gives the syndication feed for the current page:<link rel="alternate" type="application/atom+xml" href="data.xml">
The following extract offers various different syndication feeds:
<p>You can access the planets database using Atom feeds:</p> <ul> <li><a href="recently-visited-planets.xml" rel="alternate" type="application/atom+xml">Recently Visited Planets</a></li> <li><a href="known-bad-planets.xml" rel="alternate" type="application/atom+xml">Known Bad Planets</a></li> <li><a href="unexplored-planets.xml" rel="alternate" type="application/atom+xml">Unexplored Planets</a></li> </ul>
- Otherwise
-
The keyword creates a hyperlink referencing an alternate representation of the current document.
The nature of the referenced document is given by the
hreflang
, andtype
attributes.If the
alternate
keyword is used with thehreflang
attribute, and that attribute’s value differs from the document element’s language, it indicates that the referenced document is a translation.If the
alternate
keyword is used with thetype
attribute, it indicates that the referenced document is a reformulation of the current document in the specified format.The
hreflang
andtype
attributes can be combined when specified with thealternate
keyword.The following example shows how you can specify versions of the page that use alternative formats, are aimed at other languages, and that are intended for other media:<link rel="alternate" href="/en/html" hreflang="en" type="text/html" title="English HTML"> <link rel="alternate" href="/fr/html" hreflang="fr" type="text/html" title="French HTML"> <link rel="alternate" href="/en/html/print" hreflang="en" type="text/html" media="print" title="English HTML (for printing)"> <link rel="alternate" href="/fr/html/print" hreflang="fr" type="text/html" media="print" title="French HTML (for printing)"> <link rel="alternate" href="/en/pdf" hreflang="en" type="application/pdf" title="English PDF"> <link rel="alternate" href="/fr/pdf" hreflang="fr" type="application/pdf" title="French PDF">
This relationship is transitive — that is, if a document links to two other documents with the link type "
alternate
", then, in addition to implying that those documents are alternative representations of the first document, it is also implying that those two documents are alternative representations of each other.
4.8.6.2. Link type "author
"
The author
keyword may be used with link
, a
, and area
elements.
This keyword creates a hyperlink.
For a
and area
elements, the author
keyword indicates that the referenced
document provides further information about the author of the nearest article
element
ancestor of the element defining the hyperlink, if there is one, or of the page as a whole,
otherwise.
For link
elements, the author
keyword indicates that the referenced document
provides further information about the author for the page as a whole.
The "referenced document" can be, and often is, a mailto:
URL giving the e-mail address of the author. [RFC6068]
Synonyms: For historical reasons, user agents must also treat link
, a
,
and area
elements that have a rev
attribute with the value "made
" as
having the author
keyword specified as a link relationship.
4.8.6.3. Link type "bookmark
"
The bookmark
keyword may be used with a
and area
elements. This keyword creates a hyperlink.
The bookmark
keyword gives a permalink for the nearest
ancestor article
element of the linking element in question, or of the section the linking element is most closely associated with, if
there are no ancestor article
elements.
<body> <h1>Example of permalinks</h1> <div id="a"> <h2>First example</h2> <p><a href="a.html" rel="bookmark">This permalink applies to only the content from the first h2 to the second h2</a>. The div isn’t exactly that section, but it roughly corresponds to it.</p> </div> <h2>Second example</h2> <article id="b"> <p><a href="b.html" rel="bookmark">This permalink applies to the outer article element</a> (which could be, e.g., a blog post).</p> <article id="c"> <p><a href="c.html" rel="bookmark">This permalink applies to the inner article element</a> (which could be, e.g., a blog comment).</p> </article> </article> </body>
4.8.6.4. Link type "canonical
"
The canonical
keyword may be used with the link
element.
This keyword creates a hyperlink
The canonical
keyword indicates that the URL given by the href
attribute
is the preferred URL for the current document. Indicating the preferred URL helps search engines
reduce duplicate content, as described in more detail in The Canonical Link Relation specification [rfc6596].
4.8.6.5. Link type "dns-prefetch
"
The dns-prefetch
keyword may be used with link
.This keyword is body-ok.
The dns-prefetch
keyword is used to indicate an origin that will be used to fetch
required resources, and that the user agent SHOULD resolve as early as possible.
See [resource-hints] for full definition.
4.8.6.6. Link type "external
"
The external
keyword may be used with a
, and area
elements. This keyword
creates a hyperlink. The external
keyword indicates that the referenced document
is not part of the same site as the current document. It is informational, and requires no
specific browser behaviour.
4.8.6.7. Link type "help
"
The help
keyword may be used with link
, a
, and area
elements.
This keyword creates a hyperlink.
For a
and area
elements, the help
keyword indicates that the referenced
document provides further help information for the parent of the element defining the hyperlink, and its children.
<label> Topic: <input name="topic"> <a href="help/topic.html" rel="help">(Help)</a> </label>
For link
elements, the help
keyword indicates that
the referenced document provides help for the page as a whole.
For a
and area
elements, on some browsers, the help
keyword causes the link to use a different cursor.
4.8.6.8. Link type "icon
"
The icon
keyword may be used with link
elements.
This keyword creates an external resource link.
The specified resource is an icon representing the page or site, and should be used by the user agent when representing the page in the user interface.
Icons could be auditory icons, visual icons, or other kinds of icons. If multiple icons are
provided, the user agent must select the most appropriate icon according to the type
, media
, and sizes
attributes. If there are multiple
equally appropriate icons, user agents must use the last one declared in tree order at
the time that the user agent collected the list of icons. If the user agent tries to use an icon
but that icon is determined, upon closer examination, to in fact be inappropriate (e.g., because
it uses an unsupported format), then the user agent must try the next-most-appropriate icon as
determined by the attributes.
User agents are not required to update icons when the list of icons changes, but are encouraged to do so.
There is no default type for resources given by the icon
keyword. However, for the
purposes of determining the type of the resource, user agents must expect the resource
to be an image.
The sizes
keyword represent icon sizes in raw pixels (as opposed to CSS pixels).
An icon that is 50 CSS pixels wide intended for displays with a device pixel density of two device pixels per CSS pixel (2x, 192dpi) would have a width of 100 raw pixels. This feature does not support indicating that a different resource is to be used for small high-resolution icons vs large low-resolution icons (e.g., 50×50 2x vs 100×100 1x).
To parse and process the attribute’s value, the user agent must first split the attribute’s value on spaces, and must then parse each resulting keyword to determine what it represents.
The any
keyword represents that the
resource contains a scalable icon, e.g., as provided by an SVG image.
Other keywords must be further parsed as follows to determine what they represent:
- If the keyword doesn’t contain exactly one U+0078 LATIN SMALL LETTER X or U+0058 LATIN CAPITAL LETTER X character, then this keyword doesn’t represent anything. Abort these steps for that keyword.
- Let width string be the string before the "
x
" or "X
". - Let height string be the string after the "
x
" or "X
". - If either width string or height string start with a U+0030 DIGIT ZERO (0) character or contain any characters other than ASCII digits, then this keyword doesn’t represent anything. Abort these steps for that keyword.
- Apply the rules for parsing non-negative integers to width string to obtain width.
- Apply the rules for parsing non-negative integers to height string to obtain height.
- The keyword represents that the resource contains a bitmap icon with a width of width device pixels and a height of height device pixels.
The keywords specified on the sizes
attribute must not
represent icon sizes that are not actually available in the linked resource.
In the absence of a link
with the icon
keyword, for Document
objects
obtained over HTTP or HTTPS, user agents may instead run these steps in parallel:
- Let request be a new request whose URL is the absolute URL obtained by
resolving the URL "
/favicon.ico
" against the document’s URL, client is theDocument
object’sWindow
object’s environment settings object, type is "image
", destination is "subresource
", synchronous flag is set, credentials mode is "include
", and whose use-URL-credentials flag is set. - Let response be the result of fetching request.
- Use response’s unsafe response as an icon as if it had been
declared using the
icon
keyword.
<!DOCTYPE html> <html lang="en"> <head> <title>Example App</title> <link rel="icon" href="favicon.png" sizes="16x16" type="image/png" > <link rel="icon" href="windows.ico" sizes="32x32 48x48" type="image/vnd.microsoft.icon"> <link rel="icon" href="mac.icns" sizes="128x128 512x512 8192x8192 32768x32768"> <link rel="icon" href="favicon.svg" sizes="any" type="image/svg+xml"> </head> <body> ...
For historical reasons, the icon
keyword may be preceded by the keyword
"shortcut
". If the "shortcut
" keyword is present, the rel
attribute’s entire value must be an ASCII case-insensitive match for the string
"shortcut icon
" (with a single U+0020 SPACE character between the tokens and
no other space characters).
4.8.6.9. Link type "license
"
The license
keyword may be used with link
, a
, and area
elements. This keyword creates a hyperlink.
The license
keyword indicates that the referenced document provides the copyright
license terms under which the main content of the current document is provided.
This specification defines the main content of a document and content that is not deemed to be
part of that main content via the main
element. The distinction should be made clear to
the user.
... <main> <figure> <img src="/pix/39627052_fd8dcd98b5.jpg"> <figcaption>My Cats</figcaption> </figure> <p>One of them has six toes!</p> <p><small>This photograph is <a rel="license" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Licensed (CC BY 4.0)</a></small></p> </main> <footer> <p><small>© copyright Example Pictures. All Rights Reserved.</small></p> </footer> ...
In this case the license
applies to just the photo (the primary content of the
document), not document as a whole, nor the design of the page itself, which is
covered by the copyright given at the bottom of the document, within the footer
.
This should be made clear in the text referencing the licensing link, and could also be made
clearer in the styling (e.g., making the license link prominently positioned near the
photograph, while having the page copyright in small text at the foot of the page, or adding
a border to the main
element.)
Synonyms: For historical reasons, user agents must also treat the keyword
"copyright
" like the license
keyword.
4.8.6.10. Link type "nofollow
"
The nofollow
keyword may be used with a
and area
elements. This keyword does
not create a hyperlink, but annotates any other hyperlinks created by the element
(the implied hyperlink, if no other keywords create one).
The nofollow
keyword indicates that the link is not endorsed by the original author or
publisher of the page, or that the link to the referenced document was included primarily
because of a commercial relationship between people affiliated with the two pages.
4.8.6.11. Link type "noopener
"
The noopener
keyword may be used with a
and area
elements. This keyword does
not create a hyperlink, but annotates any other hyperlinks created by the element (the
implied hyperlink, if no other keywords create one).
The keyword indicates that any newly created browsing context which results from following
the hyperlink will have disowned its opener, which means that its window.opener
property will be null
.
4.8.6.12. Link type "noreferrer
"
The noreferrer
keyword may be used with a
and area
elements. This keyword does
not create a hyperlink, but annotates any other hyperlinks created by the element
(the implied hyperlink, if no other keywords create one).
It indicates that no referrer information is to be leaked when following the link.
If a user agent follows a link defined by an a
or area
element that has the noreferrer
keyword, the user agent must set their request’s referrer to "no-referrer
".
noreferrer
keyword implies the behavior associated with
the noopener
keyword when present on a hyperlink that creates a new browsing context.
For example, the following two hyperlinks behave the same:
4.8.6.13. Link type "preconnect
"
The preconnect
keyword may be used with link
.This keyword is body-ok.
The preconnect
keyword is used to initiate an early connection, which includes the DNS lookup, TCP handshake,
and optional TLS negotiation, allows the user agent to mask the
high latency costs of establishing a connection.
See [resource-hints] for full definition.
4.8.6.14. Link type "prefetch
"
The prefetch
keyword may be used with link
. This keyword creates an external resource link.
This keyword is body-ok.
The prefetch
keyword is used to identify a resource that might be required
by the next navigation, and that the user agent SHOULD fetch,
such that the user agent can deliver a faster response once the
resource is requested in the future.
See [resource-hints] for full definition.
4.8.6.15. Link type "preload
"
The preload
keyword may be used with link
. This keyword creates an external resource link. This keyword is body-ok.
The preload
keyword indicates that the user agent must preemptively fetch and cache the specified resource according to the potential destination given by the as
attribute (and the priority associated with the corresponding destination), as it is highly likely that the user will require this resource for current navigation. User agents must implement the processing model of the preload
keyword described in the Preload specification. [Preload]
There is no default type for resources given by the preload
keyword.
4.8.6.16. Link type "prerender
"
The prerender
keyword may be used with link
. This keyword creates an external resource link.
This keyword is body-ok.
The prerender
keyword identifies a resource that might be required
by the next navigation from the link context, and that the user agent ought
to fetch and execute, such that the user agent can deliver a faster
response once the resource is requested in the future.
See [resource-hints] for full definition.
4.8.6.17. Link type "search
"
The search
keyword may be used with link
, a
, and area
elements. This keyword creates a hyperlink.
The search
keyword indicates that the referenced document
provides an interface specifically for searching the document and its related resources.
OpenSearch description documents can be used with link
elements and
the search
link type to enable user agents to autodiscover search
interfaces. [OPENSEARCH]
4.8.6.18. Link type "stylesheet
"
The stylesheet
keyword may be used with link
elements. This keyword creates an external resource link that contributes to the styling processing model. This keyword is body-ok.
The specified resource is a resource that describes how to present the document. Exactly how the resource is to be processed depends on the actual type of the resource.
If the alternate
keyword is also specified on the link
element, then the link is an alternative stylesheet; in this case,
the title
attribute must be specified on the link
element, with a non-empty value.
The default type for resources given by the stylesheet
keyword is text/css
.
The appropriate times to obtain the resource are:
-
When the external resource link is created on a
link
element that is already in aDocument
. -
When the external resource link’s
link
element is inserted into a document. -
When the
href
attribute of thelink
element of an external resource link that is already in aDocument
is changed. -
When the
crossorigin
attribute of thelink
element of an external resource link that is already in aDocument
is set, changed, or removed. -
When the
type
attribute of thelink
element of an external resource link that is already in aDocument
is set or changed to a value that does not or no longer matches the Content-Type metadata of the previous obtained external resource, if any. -
When the
type
attribute of thelink
element of an external resource link that is already in aDocument
but was previously not obtained due to thetype
attribute specifying an unsupported type is set, removed, or changed. -
When the external resource link changes from being an alternative stylesheet to not being one, or vice versa.
Quirk: If the document has been set to quirks mode, has the same origin as the URL of the external resource,
and the Content-Type metadata of the external resource is not a
supported style sheet type, the user agent must instead assume it to be text/css
.
Once a resource has been obtained, if its Content-Type metadata is text/css
, the user
agent must run these steps:
-
Let element be the
link
element that created the external resource link. -
If element has an associated CSS style sheet, remove the CSS style sheet in question.
-
If element no longer creates an external resource link that contributes to the styling processing model, or if, since the resource in question was obtained, it has become appropriate to obtain it again (meaning this algorithm is about to be invoked again for a newly obtained resource), then abort these steps.
-
Create a CSS style sheet with the following properties:
- type
-
text/css
- location
-
The resulting URL string determined during the obtain algorithm.
This is before any redirects get applied.
- owner node
-
element
- media
-
The
media
attribute of element.This is a reference to the (possibly absent at this time) attribute, rather than a copy of the attribute’s current value. The CSSOM specification defines what happens when the attribute is dynamically set, changed, or removed.
- title
-
The
title
attribute of element.This is similarly a reference to the attribute, rather than a copy of the attribute’s current value.
- alternate flag
-
Set if the link is an alternative stylesheet; unset otherwise.
- origin-clean flag
-
Set if the resource is CORS-same-origin; unset otherwise.
- parent CSS style sheet
- owner CSS rule
-
null
- disabled flag
-
Left at its default value.
- CSS rules
-
Left uninitialized.
The CSS environment encoding is the result of running the following steps: [CSS-SYNTAX-3]
-
If the element has a
charset
attribute, get an encoding from that attribute’s value. If that succeeds, return the resulting encoding and abort these steps. [ENCODING] -
Otherwise, return the document’s character encoding. [DOM]
4.8.6.19. Link type "tag
"
The tag
keyword may be used with a
and area
elements. This keyword creates a hyperlink.
The tag
keyword indicates that the tag that the
referenced document represents applies to the current document.
Since it indicates that the tag applies to the current document, it would be inappropriate to use this keyword in the markup of a tag cloud, which lists the popular tags across a set of pages.
https://en.wikipedia.org/wiki/Gemstone
" to unambiguously categorize it as applying
to the "jewel" kind of gems.
<body> <p>Recently I managed to dispose of a red gem that had been bothering me. I now have a much nicer blue sapphire.</p> <footer> Tags: <a rel="tag" href="https://en.wikipedia.org/wiki/Gemstone">Gemstone</a> </footer> </body>
tag
" link applies
to the whole page. It will do so wherever it is placed, including if it is within the article
elements).
<body> <article> <h1>801: Steinbock</h1> <p>The number 801 Gem 4/4 electro-diesel has an ibex and was rebuilt in 2002.</p> </article> <article> <h1>802: Murmeltier</h1> <p>The number 802 Gem 4/4 electro-diesel has a marmot and was rebuilt in 2003.</p> </article> <p class="topic"><a rel="tag" href="https://en.wikipedia.org/wiki/Rhaetian_Railway_Gem_4/4">Gem 4/4</a></p> </body>
4.8.6.20. Sequential link types
Some documents form part of a sequence of documents.
A sequence of documents is one where each document can have a previous sibling and a next sibling. A document with no previous sibling is the start of its sequence, a document with no next sibling is the end of its sequence.
A document may be part of multiple sequences.
4.8.6.20.1. Link type "next
"
The next
keyword may be used with link
, a
, and area
elements. This keyword creates a hyperlink.
The next
keyword indicates that the document is part of a
sequence, and that the link is leading to the document that is the next logical document in the
sequence.
4.8.6.20.2. Link type "prev
"
The prev
keyword may be used with link
, a
, and area
elements. This keyword creates a hyperlink.
The prev
keyword indicates that the document is part of a
sequence, and that the link is leading to the document that is the previous logical document in
the sequence.
Synonyms: For historical reasons, user agents must also treat the keyword
"previous
" like the prev
keyword.
4.8.6.21. Other link types
Extensions to the predefined set of link types may be registered in the HTML link extensions section of the microformats wiki existing-rel-values page [MFREL], or filed as an issue on this specification.
Proposed extension types should be specified with the following information:
- Keyword
-
The actual value being defined. The value should not be confusingly similar to any other defined value (e.g., differing only in case).
If the value contains a U+003A COLON character (:), it must also be an absolute URL.
- Effect on...
link
-
One of the following:
- Not allowed
- The keyword must not be specified on
link
elements. - Hyperlink
- The keyword may be specified on a
link
element; it creates a hyperlink. - External Resource
- The keyword may be specified on a
link
element; it creates an external resource link.
- Effect on...
a
andarea
-
One of the following:
- Not allowed
- The keyword must not be specified on
a
andarea
elements. - Hyperlink
- The keyword may be specified on
a
andarea
elements; it creates a hyperlink. - External Resource
- The keyword may be specified on
a
andarea
elements; it creates an external resource link. - Hyperlink Annotation
- The keyword may be specified on
a
andarea
elements; it annotates other hyperlinks created by the element.
- Brief description
- A short non-normative description of what the keyword’s meaning is.
- Specification
- A link to a more detailed description of the keyword’s semantics and requirements. It could be another page on the Wiki, or a link to an external page.
- Synonyms
- A list of other keyword values that have exactly the same processing requirements. Authors should not use the values defined to be synonyms, they are only intended to allow user agents to support legacy content. Anyone may remove synonyms that are not used in practice; only names that need to be processed as synonyms for compatibility with legacy content are to be registered in this way.
- Status
-
One of the following:
- Proposed
- The keyword has not received wide peer review and approval. Someone has proposed it and is, or soon will be, using it.
- Ratified
- The keyword has received wide peer review and approval. It has a specification that unambiguously defines how to handle pages that use the keyword, including when they use it in incorrect ways.
- Discontinued
- The keyword has received wide peer review and it has been found wanting. Existing pages are using this keyword, but new pages should avoid it. The "brief description" and "specification" entries will give details of what authors should use instead, if anything.
If a keyword is found to be redundant with existing values, it should be removed and listed as a synonym for the existing value.
If a keyword is registered in the "proposed" state for a period of a month or more without being used or specified, then it may be removed from the registry.
If a keyword is added with the "proposed" status and found to be redundant with existing values, it should be removed and listed as a synonym for the existing value. If a keyword is added with the "proposed" status and found to be harmful, then it should be changed to "discontinued" status.
Anyone can change the status at any time, but should only do so in accordance with the definitions above.
Conformance checkers may use the information given on the microformats wiki existing-rel-values page to establish if a value is allowed or not: values defined in this specification or marked as "proposed" or "ratified" must be accepted when used on the elements for which they apply as described in the "Effect on..." field, whereas values marked as "discontinued" or values not containing a U+003A COLON character but not listed in either this specification or on the aforementioned page must be reported as invalid. The remaining values must be accepted as valid if they are absolute URLs containing US-ASCII characters only and rejected otherwise. Conformance checkers may cache this information (e.g., for performance reasons or to avoid the use of unreliable network connectivity).
Note: Even URL-valued link types are compared ASCII-case-insensitively. Validators might choose to warn about characters U+0041 (LATIN CAPITAL LETTER A) through U+005A (LATIN CAPITAL LETTER Z) (inclusive) in the pre-case-folded form of link types that contain a colon.
When an author uses a new type not defined by either this specification or the Wiki page, conformance checkers should offer to add the value to the Wiki, with the details described above, with the "proposed" status.
Types defined as extensions in the microformats
wiki existing-rel-values page with the status "proposed" or "ratified" may be used with the rel
attribute on link
, a
, and area
elements in accordance to the "Effect on..." field. [MFREL]
4.9. Tabular data
4.9.1. The table
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- In this order: optionally a
caption
element, followed by zero or morecolgroup
elements, followed optionally by athead
element, followed by either zero or moretbody
elements or one or moretr
elements, followed optionally by atfoot
element, optionally intermixed with one or more script-supporting elements. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
border
- Allowed ARIA role attribute values:
-
table
role (default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLTableElement
: HTMLElement { attribute HTMLTableCaptionElement? caption; HTMLTableCaptionElement createCaption(); void deleteCaption(); attribute HTMLTableSectionElement? tHead; HTMLTableSectionElement createTHead(); void deleteTHead(); attribute HTMLTableSectionElement? tFoot; HTMLTableSectionElement createTFoot(); void deleteTFoot(); [SameObject] readonly attribute HTMLCollection tBodies; HTMLTableSectionElement createTBody(); [SameObject] readonly attribute HTMLCollection rows; HTMLTableRowElement insertRow(optional longindex
= -1); void deleteRow(longindex
); };
The table
element represents data with more than one dimension, in
the form of a table.
The table
element takes part in the table model.
Tables have rows, columns, and cells given by their descendants. The rows and
columns form a grid; a table’s cells must completely cover that grid without overlap.
Precise rules for determining whether this conformance requirement is met are described in the description of the table model.
Authors are encouraged to provide information describing how to interpret complex tables. Guidance on how to provide such information is given below.
Tables should not be used as layout aids.
Historically, many Web authors have tables in HTML as a way to control their page layout making it difficult to extract tabular data from such documents.
In particular, users of accessibility tools, like screen readers, are likely to find it very difficult to navigate pages with tables used for layout.
If a table is used for layout purposes, it must be marked with the attribute role="presentation"
for a user agent to properly represent the table to an
assistive technology, and to properly convey the intent of the author to tools that wish to
extract tabular data from the document.
There are a variety of alternatives to using HTML tables for layout, primarily using CSS positioning and the CSS table model. [CSS-2015]
The border
content attribute may be
specified on a table
element to explicitly indicate that the table
element represents
tabular data and is not being used for layout purposes. If specified, the attribute’s value
must either be the empty string or the value "1
". If a value other than the empty
string, or "1
" is set, such as a text string, user agents should interpret the
value as the empty string.
The border
content attribute is used by certain user agents as an indication that
borders should be drawn around cells of the table. These user agents may treat values greater
than 1
as indicators to render wider borders for the table. Authors should instead
use CSS to provide styling for tables.
Tables can be complicated to understand and navigate. To help users with this, user agents should clearly delineate cells in a table from each other, unless the user agent has classified the table as a layout table.
Authors and implementors are encouraged to consider using some of the table design techniques described below to make tables easier to navigate for users.
User agents, especially those that do table analysis on arbitrary content, are encouraged to find heuristics to determine which tables actually contain data and which are merely being used for layout. This specification does not define a precise heuristic, but the following are suggested as possible indicators:
Feature | Indication |
---|---|
The use of the role attribute with the value presentation
| Probably a layout table |
The use of the border attribute with the non-conforming value 0
| Probably a layout table |
The use of the non-conforming cellspacing and cellpadding attributes with the value 0
| Probably a layout table |
The use of caption , thead , or th elements
| Probably a non-layout table |
The use of the headers and scope attributes
| Probably a non-layout table |
The use of the border attribute with a value other than 0
| Probably a non-layout table |
Explicit visible borders set using CSS | Probably a non-layout table |
The use of the non-conforming summary attribute
| Not a good indicator (both layout and non-layout tables have historically been given this attribute) |
It is quite possible that the above suggestions are wrong. Implementors are urged to provide feedback elaborating on their experiences with trying to create a layout table detection heuristic.
If a table
element has a (non-conforming) summary
attribute, and the user agent
has not classified the table as a layout table, the user agent may report the contents of that
attribute to the user.
- table .
caption
[ = value ] -
Returns the table’s
caption
element.Can be set, to replace the
caption
element. - caption = table .
createCaption
() -
Ensures the table has a
caption
element, and returns it. - table .
deleteCaption
() -
Ensures the table does not have a
caption
element. - table .
tHead
[ = value ] -
Returns the table’s
thead
element.Can be set, to replace the
thead
element. If the new value is not athead
element, throws aHierarchyRequestError
exception. - thead = table .
createTHead
() -
Ensures the table has a
thead
element, and returns it. - table .
deleteTHead
() -
Ensures the table does not have a
thead
element. - table .
tFoot
[ = value ] -
Returns the table’s
tfoot
element.Can be set, to replace the
tfoot
element. If the new value is not atfoot
element, throws aHierarchyRequestError
exception. - tfoot = table .
createTFoot
() -
Ensures the table has a
tfoot
element, and returns it. - table .
deleteTFoot
() -
Ensures the table does not have a
tfoot
element. - table .
tBodies
-
Returns an
HTMLCollection
of thetbody
elements of the table. - tbody = table .
createTBody
() -
Creates a
tbody
element, inserts it into the table, and returns it. - table .
rows
-
Returns an
HTMLCollection
of thetr
elements of the table. - tr = table .
insertRow
( [ index ] ) -
Creates a
tr
element, along with atbody
if required, inserts them into the table at the position given by the argument, and returns thetr
.The position is relative to the rows in the table. The index -1, which is the default if the argument is omitted, is equivalent to inserting at the end of the table.
If the given position is less than -1 or greater than the number of rows, throws an
IndexSizeError
exception. - table .
deleteRow
(index) -
Removes the
tr
element with the given position in the table.The position is relative to the rows in the table. The index -1 is equivalent to deleting the last row of the table.
If the given position is less than -1 or greater than the index of the last row, or if there are no rows, throws an
IndexSizeError
exception.
The caption
IDL attribute must return,
on getting, the first caption
element child of the table
element, if any, or null
otherwise. On setting, the first caption
element child of the table
element, if any,
must be removed, and the new value, if not null, must be inserted as the first node of the table
element.
The createCaption()
method must return
the first caption
element child of the table
element, if any; otherwise
a new caption
element must be created, inserted as the first node of the table
element, and then returned.
The deleteCaption()
method must remove
the first caption
element child of the table
element, if any.
The tHead
IDL attribute must return, on
getting, the first thead
element child of the table
element, if any, or null otherwise.
On setting, if the new value is null or a thead
element, the first thead
element child
of the table
element, if any, must be removed, and the new value, if not null, must be
inserted immediately before the first element in the table
element that is neither a caption
element nor a colgroup
element, if any, or at the end of the table if there
are no such elements. If the new value is neither null nor a thead
element, then a HierarchyRequestError
DOM exception must be thrown instead.
The createTHead()
method must return the
first thead
element child of the table
element, if any; otherwise a new thead
element must be created and inserted immediately before the first element in
the table
element that is neither a caption
element nor a colgroup
element,
if any, or at the end of the table if there are no such elements, and then that new element
must be returned.
The deleteTHead()
method must remove the
first thead
element child of the table
element, if any.
The tFoot
IDL attribute must return, on
getting, the first tfoot
element child of the table
element, if any, or
null otherwise. On setting, if the new value is null or a tfoot
element, the first tfoot
element child of the table
element, if any, must be removed, and
the new value, if not null, must be inserted at the end of the table. If the new value is neither
null nor a tfoot
element, then a HierarchyRequestError
DOM exception
must be thrown instead.
The createTFoot()
method must return the
first tfoot
element child of the table
element, if any; otherwise a new tfoot
element must be created and inserted at the end of the table, and then that new
element must be returned.
The deleteTFoot()
method must remove the
first tfoot
element child of the table
element, if any.
The tBodies
attribute must return an HTMLCollection
rooted at the table
node, whose filter matches only tbody
elements that are children of the table
element.
The createTBody()
method must create a
new tbody
element, insert it immediately after the last tbody
element child in the table
element, if any, or at the end of the table
element if the table
element
has no tbody
element children, and then must return the new tbody
element.
The rows
attribute must return an HTMLCollection
rooted at the table
node, whose filter matches only tr
elements that are either children of the table
element, or children of thead
, tbody
, or tfoot
elements that are themselves children of the table
element.
The elements in the collection must be ordered such that those elements whose parent is a thead
are included first, in tree order, followed by those elements whose
parent is either a table
or tbody
element, again in tree order,
followed finally by those elements whose parent is a tfoot
element, still in tree order.
The behavior of the insertRow(index)
method depends
on the state of the table. When it is called, the method must act as required by the first item
in the following list of conditions that describes the state of the table and the index argument:
- If index is less than -1 or greater than the number of elements
in
rows
collection: - The method must throw an
IndexSizeError
exception. - If the
rows
collection has zero elements in it, and thetable
has notbody
elements in it: - The method must create a
tbody
element, then create atr
element, then append thetr
element to thetbody
element, then append thetbody
element to thetable
element, and finally return thetr
element. - If the
rows
collection has zero elements in it: - The method must create a
tr
element, append it to the lasttbody
element in the table, and return thetr
element. - If index is -1 or equal to the number of items in
rows
collection: - The method must create a
tr
element, and append it to the parent of the lasttr
element in therows
collection. Then, the newly createdtr
element must be returned. - Otherwise:
- The method must create a
tr
element, insert it immediately before the indexthtr
element in therows
collection, in the same parent, and finally must return the newly createdtr
element.
When the deleteRow(index)
method is called, the user agent must run the following steps:
- If index is equal to -1, then index must be
set to the number of items in the
rows
collection, minus one. - Now, if index is less than zero, or greater than or equal to the
number of elements in the
rows
collection, the method must instead throw anIndexSizeError
exception, and these steps must be aborted. - Otherwise, the method must remove the indexth element in the
rows
collection from its parent.
<table> <tbody> <tr> <td>X</td> <td>X</td> <td>0</td> </tr> <tr> <td>0</td> <td>X</td> <td>0</td> </tr> <tr> <td>X</td> <td>0</td> <td> </td> </tr> </tbody> </table>
4.9.1.1. Techniques for describing tables
For tables that consist of more than just a grid of cells with headers in the first row and headers in the first column, and for any table in general where the reader might have difficulty understanding the content, authors should include explanatory information introducing the table. This information is useful for all users, but is especially useful for users who cannot see the table, e.g., users of screen readers.
Such explanatory information should introduce the purpose of the table, outline its basic cell structure, highlight any trends or patterns, and generally teach the user how to understand the contents of the table.
For instance, the following table:
Negative | Characteristic | Positive |
---|---|---|
Sad | Mood | Happy |
Failing | Grade | Passing |
...could benefit from a description explaining the way the table is laid out, something like "Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column".
There are a variety of ways to include this information, such as:
- In prose, surrounding the table
-
<p id="summary"> In the following table, characteristics are given in the second column, with the negative side in the left column and the positive side in the right column. </p> <table aria-describedby="summary"> <caption>Characteristics with positive and negative sides</caption> <thead> <tr> <th id="n"> Negative </th> <th> Characteristic </th> <th> Positive </th> </tr> </thead> <tbody> <tr> <td headers="n r1"> Sad </td> <th id="r1"> Mood </th> <td> Happy </td> </tr> <tr> <td headers="n r2"> Failing </td> <th id="r2"> Grade </th> <td> Passing </td> </tr> </table>
In the example above the
aria-describedby
attribute is used to explicitly associate the information with the table for assistive technology users. - Next to the table, in the same
figure
-
<figure aria-labelledby="caption"> <p> Characteristics are given in the second column, with the negative side in the left column and the positive side in the right column. </p> <table> <caption id="caption">Characteristics with positive and negative sides</caption> <thead> <tr> <th id="n"> Negative </th> <th> Characteristic </th> <th> Positive </th> </tr> </thead> <tbody> <tr> <td headers="n r1"> Sad </td> <th id="r1"> Mood </th> <td> Happy </td> </tr> <tr> <td headers="n r2"> Failing </td> <th id="r2"> Grade </th> <td> Passing </td> </tr> </table> </figure>
The
figure
in this example has been labeled by thetable
caption
usingaria-labelledby
.
Authors may also use other techniques, or combinations of the above techniques, as appropriate.
Regardless of the method used to provide additional descriptive information for a table
, if a table
needs a caption, authors should use a caption
element
as it is the most robust method for providing an accessible caption for a table
.
The best option, of course, rather than writing a description explaining the way the table is laid out, is to adjust the table such that no explanation is needed.
headers
attributes:
<table> <caption>Characteristics with positive and negative sides</caption> <thead> <tr> <th> Characteristic </th> <th> Negative </th> <th> Positive </th> </tr> <tbody> <tr> <th> Mood </th> <td> Sad </td> <td> Happy </td> </tr> <tr> <th> Grade </th> <td> Failing </td> <td> Passing </td> </tr> </tbody> </table>
4.9.1.2. Techniques for table design
Good table design is key to making tables more readable and usable.
In visual media, providing column and row borders and alternating row backgrounds can be very effective to make complicated tables more readable.
For tables with large volumes of numeric content, using monospaced fonts can help users see patterns, especially in situations where a user agent does not render the borders. (Unfortunately, for historical reasons, not rendering borders on tables is a common default.)
Authors are encouraged to use CSS to achieve these visual effects.
In speech media, table cells can be distinguished by reporting the corresponding headers before reading the cell’s contents, and by allowing users to navigate the table in a grid fashion, rather than serializing the entire contents of the table in source order.
User agents are encouraged to render tables using these techniques whenever the page does not use CSS and the table is not classified as a layout table.
4.9.2. The caption
element
- Categories:
- None.
- Contexts in which this element can be used:
- As the first element child of a
table
element. - Content model:
- Flow content, but with no
main
, ortable
element descendants. - Tag omission in text/html:
- A
caption
element’s end tag may be omitted. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- DOM interface:
-
interface
HTMLTableCaptionElement
: HTMLElement {};
If the closing tag is omitted, the element will be closed by the next element that takes part in the table model. Content up to that element will be part of the caption.
The caption
element represents the title of the table
that is its parent, if it has a parent and that is a table
element.
The caption
element takes part in the table model.
When a table
element is the only content in a figure
element other than the figcaption
, the caption
element should be omitted in favor of the figcaption
.
As noted in techniques for describing tables, a caption
is the most robust method for providing an accessible caption to
a table
.
A caption can introduce context for a table, making it significantly easier to understand.
1 | 2 | 3 | 4 | 5 | 6 | |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 |
2 | 3 | 4 | 5 | 6 | 7 | 8 |
3 | 4 | 5 | 6 | 7 | 8 | 9 |
4 | 5 | 6 | 7 | 8 | 9 | 10 |
5 | 6 | 7 | 8 | 9 | 10 | 11 |
6 | 7 | 8 | 9 | 10 | 11 | 12 |
In the abstract, this table is not clear. However, with a caption giving the table’s number (for reference in the main prose) and explaining its use, it makes more sense:
<table> <caption> Table 1. This table shows the total score obtained from rolling two six-sided dice. The first row represents the value of the first die, the first column the value of the second die. The total is given in the cell that corresponds to the values of the two dice. </caption> <tbody> <!-- ... --> </tbody> </table>
This provides the user with more context:
1 | 2 | 3 | 4 | 5 | 6 | |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 |
2 | 3 | 4 | 5 | 6 | 7 | 8 |
3 | 4 | 5 | 6 | 7 | 8 | 9 |
4 | 5 | 6 | 7 | 8 | 9 | 10 |
5 | 6 | 7 | 8 | 9 | 10 | 11 |
6 | 7 | 8 | 9 | 10 | 11 | 12 |
4.9.3. The colgroup
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
table
element, after anycaption
elements and before anythead
,tbody
,tfoot
, andtr
elements. - Content model:
- If the
span
attribute is present: Nothing.- If the
span
attribute is absent: Zero or morecol
andtemplate
elements. - If the
- Tag omission in text/html:
- A
colgroup
element’s start tag may be omitted if the first thing inside thecolgroup
element is acol
element, and if the element is not immediately preceded by anothercolgroup
element whose end tag has been omitted. (It can’t be omitted if the element is empty). Acolgroup
element’s end tag may be omitted if thecolgroup
element is not immediately followed by a space character or a comment - Content attributes:
- Global attributes
span
- Number of columns spanned by the element - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
interface
HTMLTableColElement
: HTMLElement { attribute unsigned long span; };
The colgroup
element represents a group of one or more columns in the table
that is its parent, if it has a parent and that is a table
element.
If the colgroup
element contains no col
elements, then the element may have a span
content attribute specified,
whose value must be a valid non-negative integer greater than zero.
The colgroup
element and its span
attribute take part in the table model.
The span
IDL attribute must reflect the content attribute of the same name. The value must be limited to only non-negative numbers greater than zero.
colgroup
consisting of three col
elements can
utilize CSS to help visually format the columns of a table
.
<table style="width: 100%;"> <colgroup style="background: #ccc;"> <col style="background: #ddd; width: 30%;"> <col style="background: #eee; width: 50%;"> <col style="width: 20%;"> </colgroup> <tbody> <tr> <td>...</td> <td>...</td> <td>...</td> </tr> <!-- ... --> </tbody> </table>
The next example shows how a colgroup
with no child col
elements can use
the span
attribute. The applied CSS will render the first two columns with
a background color, and set their width to 25%, leaving the last column with no background
color, and taking up the remaining width of the table
.
<table style="width: 100%;"> <colgroup style="background: #eee; width: 25%;" span="2"></colgroup> <tbody> <tr> <td>...</td> <td>...</td> <td>...</td> </tr> <!-- ... --> </tbody> </table>
4.9.4. The col
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
colgroup
element that doesn’t have aspan
attribute. - Content model:
- Nothing.
- Tag omission in text/html:
- No end tag.
- Content attributes:
- Global attributes
span
- Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- None
- DOM interface:
-
HTMLTableColElement
, same as forcolgroup
elements. This interface defines one member,span
.
If a col
element has a parent and that is a colgroup
element that itself has a parent
that is a table
element, then the col
element represents one or more columns in the column group represented by that colgroup
.
The element may have a span
content attribute
specified, whose value must be a valid non-negative integer greater than zero.
The col
element and its span
attribute take part in the table model.
The span
IDL attribute must reflect the content attribute of the
same name. The value must be limited to only non-negative numbers greater than zero.
For examples of the col
element, refer to the examples within the colgroup
section,
and the section for table examples.
4.9.5. The tbody
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
table
element, after anycaption
,colgroup
, andthead
elements, but only if there are notr
elements that are children of thetable
element. - Content model:
- Zero or more
tr
and script-supporting elements. - Tag omission in text/html:
- A
tbody
element’s start tag may be omitted if the first thing inside thetbody
element is atr
element, and if the element is not immediately preceded by atbody
,thead
, ortfoot
element whose end tag has been omitted. (It can’t be omitted if the element is empty.). Atbody
element’s end tag may be omitted if thetbody
element is immediately followed by atbody
ortfoot
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
rowgroup
role (default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLTableSectionElement
: HTMLElement { [SameObject] readonly attribute HTMLCollection rows; HTMLElement insertRow(optional longindex
= -1); void deleteRow(longindex
); };The
HTMLTableSectionElement
interface is also used forthead
andtfoot
elements.
The tbody
element represents a block of rows that consist of a body
of data for the parent table
element, if the tbody
element has a parent and it is a table
.
The tbody
element takes part in the table model.
For examples of the tbody
element, refer to the table
examples within techniques for describing tables, and
the section for table examples.
- tbody .
rows
-
Returns an
HTMLCollection
of thetr
elements of the table section. - tr = tbody .
insertRow
( [ index ] ) -
Creates a
tr
element, inserts it into the table section at the position given by the argument, and returns thetr
.The position is relative to the rows in the table section. The index -1, which is the default if the argument is omitted, is equivalent to inserting at the end of the table section.
If the given position is less than -1 or greater than the number of rows, throws an
IndexSizeError
exception. - tbody .
deleteRow
(index) -
Removes the
tr
element with the given position in the table section.The position is relative to the rows in the table section. The index -1 is equivalent to deleting the last row of the table section.
If the given position is less than -1 or greater than the index of the last row, or if there are no rows, throws an
IndexSizeError
exception.
The rows
attribute must return an HTMLCollection
rooted at the element, whose filter matches only tr
elements that are children of the element.
The insertRow(index)
method must, when invoked on an element table section, act as follows:
If index is less than -1 or greater than the number of elements in
the rows
collection, the method must throw an IndexSizeError
exception.
If index is -1 or equal to the number of items in the rows
collection,
the method must create a tr
element, append it to the element table section,
and return the newly created tr
element.
Otherwise, the method must create a tr
element, insert it as a child of the table section element, immediately before the indexth tr
element
in the rows
collection, and finally must return the newly created tr
element.
The deleteRow(index)
method must, when invoked, act as follows:
If index is less than -1 or greater than the number of elements in
the rows
collection, the method must throw an IndexSizeError
exception.
If index is -1, remove the last element in the rows
collection from
its parent.
Otherwise, remove the indexth element in the rows
collection from
its parent.
4.9.6. The thead
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
table
element, after anycaption
, andcolgroup
elements and before anytbody
,tfoot
, andtr
elements, but only if there are no otherthead
elements that are children of thetable
element. - Content model:
- Zero or more
tr
and script-supporting elements. - Tag omission in text/html:
- A
thead
element’s end tag may be omitted if thethead
element is immediately followed by atbody
ortfoot
element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
rowgroup
role (default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
HTMLTableSectionElement
, as defined fortbody
elements.
The thead
element represents the block of rows that consist of
the column labels (headers) for the parent table
element, if the thead
element has a parent and it is a table
.
The thead
element takes part in the table model.
thead
element being used. Notice the use of the th
element to provide headers in the thead
element:
<table border="1"> <caption> School auction sign-up sheet </caption> <thead> <tr> <th><label for="e1">Sellers Name</label></th> <th><label for="e2">Product for sale</label></th> <th><label for="e3">Picture of product</label></th> <th><label for="e4">Reserve Price</label></th> </tr> </thead> <tbody> <tr> <td>Ms Danus</td> <td>Doughnuts</td> <td><img src="https://example.com/mydoughnuts.png" alt="a wide variety of donuts flavors organized into multiple boxes of a dozen donuts"></td> <td>$45</td> </tr> <tr> <td><input id="e1" name="who" required form="f" type="text"></td> <td><input id="e2" name="what" required form="f" type="text"></td> <td><input id="e3" name="pic" form="f" type="url"></td> <td><input id="e4" step="0.01" min="0" value="0" required form="f" type="number"></td> </tr> </tbody> </table>
4.9.7. The tfoot
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
table
element, after anycaption
,colgroup
,thead
,tbody
, andtr
elements, but only if there are no othertfoot
elements that are children of thetable
element. - Content model:
- Zero or more
tr
and script-supporting elements. - Tag omission in text/html:
- A
tfoot
element’s end tag may be omitted if there is no more content in the parenttable
element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
rowgroup
role (default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
HTMLTableSectionElement
, as defined fortbody
elements.
The tfoot
element represents the block of rows that consist of
the column summaries (footers) for the parent table
element, if the tfoot
element has
a parent and it is a table
.
The tfoot
element takes part in the table model.
tfoot
to indicate a summary of the total monthly spending,
earnings, and holdings.
<table> <thead> <tr> <th scope="col">Month</th> <th scope="col">Spending</th> <th scope="col">Earnings</th> <th scope="col">Holdings</th> </tr> </thead> <tbody> <tr> <th scope="row">January</th> <td>$800</td> <td>$700</td> <td>-$100</td> </tr> <tr> <th scope="row">February</th> <td>$900</td> <td>$935</td> <td>+$35</td> </tr> </tbody> <tfoot> <tr> <th scope="row">Totals</th> <td>$1,700</td> <td>$1,635</td> <td>-$65</td> </tr> </tfoot> </table>
4.9.8. The tr
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
thead
element.- As a child of a
tbody
element.- As a child of a
tfoot
element.- As a child of a
table
element, after anycaption
,colgroup
, andthead
elements, but only if there are notbody
elements that are children of thetable
element. - As a child of a
- Content model:
- Zero or more
td
,th
, and script-supporting elements. - Tag omission in text/html:
- A
tr
element’s end tag may be omitted if thetr
element is immediately followed by anothertr
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
row
role (default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLTableRowElement
: HTMLElement { readonly attribute long rowIndex; readonly attribute long sectionRowIndex; [SameObject] readonly attribute HTMLCollection cells; HTMLElement insertCell(optional longindex
= -1); void deleteCell(longindex
); };
The tr
element represents a row of cells in a table.
The tr
element takes part in the table model.
- tr .
rowIndex
-
Returns the position of the row in the table’s
rows
list.Returns -1 if the element isn’t in a table.
- tr .
sectionRowIndex
-
Returns the position of the row in the table section’s
rows
list.Returns -1 if the element isn’t in a table section.
- tr .
cells
-
Returns an
HTMLCollection
of thetd
andth
elements of the row. - cell = tr .
insertCell
( [ index ] ) -
Creates a
td
element, inserts it into the table row at the position given by the argument, and returns thetd
.The position is relative to the cells in the row. The index -1, which is the default if the argument is omitted, is equivalent to inserting at the end of the row.
If the given position is less than -1 or greater than the number of cells, throws an
IndexSizeError
exception. - tr .
deleteCell
(index) -
Removes the
td
orth
element with the given position in the row.The position is relative to the cells in the row. The index -1 is equivalent to deleting the last cell of the row.
If the given position is less than -1 or greater than the index of the last cell, or if there are no cells, throws an
IndexSizeError
exception.
The rowIndex
attribute must,
if the element has a parent table
element, or a parent tbody
, thead
, or tfoot
element and a grandparent table
element, return the index
of the tr
element in that table
element’s rows
collection.
If there is no such table
element, then the attribute must return -1.
The sectionRowIndex
attribute must,
if the element has a parent table
, tbody
, thead
, or tfoot
element, return the
index of the tr
element in the parent element’s rows
collection (for tables,
that’s the HTMLTableElement.rows
collection; for table sections, that’s the HTMLTableRowElement.rows
collection). If there is no such parent element, then
the attribute must return -1.
The cells
attribute must return an HTMLCollection
rooted at the tr
element, whose filter matches only td
and th
elements that are children of the tr
element.
The insertCell(index)
method must act as follows:
If index is less than -1 or greater than the number of elements in
the cells
collection, the method must throw an IndexSizeError
exception.
If index is equal to -1 or equal to the number of items in cells
collection, the method must create a td
element, append it to the tr
element, and
return the newly created td
element.
Otherwise, the method must create a td
element, insert it as a child of the tr
element,
immediately before the indexth td
or th
element in the cells
collection, and finally must return the newly created td
element.
The deleteCell(index)
method must act as follows:
If index is less than -1 or greater than the number of elements in
the cells
collection, the method must throw an IndexSizeError
exception.
If index is -1, remove the last element in the cells
collection
from its parent.
Otherwise, remove the indexth element in the cells
collection
from its parent.
For examples of the tr
element, refer to the table
examples within techniques for describing tables, and
the section for table examples.
4.9.9. The td
element
- Categories:
- Sectioning root.
- Contexts in which this element can be used:
- As a child of a
tr
element. - Content model:
- Flow content but with no
main
element descendant. - Tag omission in text/html:
- A
td
element’s end tag may be omitted if the element is immediately followed by anothertd
element orth
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
colspan
- Number of columns that the cell is to spanrowspan
- Number of rows that the cell is to spanheaders
- The header cells for this cell - Allowed ARIA role attribute values:
-
cell
role (default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLTableDataCellElement
: HTMLTableCellElement {};
The td
element represents a data cell in a table.
The td
element and its colspan
, rowspan
, and headers
attributes take part in the table model.
User agents, especially in environments where displaying the table as a 2D grid is impractical, (e.g. in speech output), sometimes add information about a cell when rendering its contents; for instance, giving its position in the table model, or listing its header cells as determined by the algorithm for assigning header cells.
When referring to a cell’s header cells are being listed, user agents may use the value of abbr
to present to the user through a voice interface, instead of the full contents of the header cells themselves.
A cell’s header cells are determined by the algorithm for Forming relationships between data cells and header cells or can be explicitly defined using the headers
attribute.
For examples of the td
element and its content attributes, refer to the table
examples within techniques for describing tables, and
the section for table examples.
4.9.10. The th
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
tr
element. - Content model:
- Flow content, but with no
header
,footer
,main
, sectioning content, or heading content descendants. - Tag omission in text/html:
- A
th
element’s end tag may be omitted if theth
element is immediately followed by atd
orth
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
colspan
- Number of columns that the cell is to spanrowspan
- Number of rows that the cell is to spanheaders
- The headers for this cellscope
- Specifies which cells the header cell applies toabbr
- Alternative label to use for the header cell when referencing the cell in other contexts - Allowed ARIA role attribute values:
-
columnheader
,rowheader
role (each are default - do not set) or Any other role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the default or allowed roles. - Any
- DOM interface:
-
interface
HTMLTableHeaderCellElement
: HTMLTableCellElement { attribute DOMString scope; attribute DOMString abbr; };
The th
element represents a header cell in a table.
The th
element may have a scope
content
attribute specified. The scope
attribute is an enumerated attribute with
five states, four of which have explicit keywords:
- The
row
keyword, which maps to the row state - The row state means the header cell applies to some of the subsequent cells in the same row(s).
- The
col
keyword, which maps to the column state - The column state means the header cell applies to some of the subsequent cells in the same column(s).
- The
rowgroup
keyword, which maps to the row group state - The row group state means the header cell applies to all
the remaining cells in the row group. A
th
element’sscope
attribute must not be in the row group state if the element is not anchored in a row group. - The
colgroup
keyword, which maps to the column group state - The colgroup group state means the header cell applies to
all the remaining cells in the column group. A
th
element’sscope
attribute must not be in the column group state if the element is not anchored in a column group. - The auto state
- The auto state makes the header cell apply to a set of cells selected based on context.
The scope
attribute’s missing value default is the auto state.
The th
element may have an abbr
content attribute specified. Its value must be an alternative label for the header cell, to be
used when referencing the cell in other contexts (e.g., when describing the header cells that
apply to a data cell). It is typically an abbreviated form of the full header cell, but can
also be an expansion, or merely a different phrasing.
The th
element and its colspan
, rowspan
, headers
, and scope
attributes take part in the table model.
The scope
IDL attribute must reflect the content attribute of the same name, limited to only known values.
The abbr
IDL attribute must reflect the content attribute of the same name.
scope
attribute’s rowgroup
value affects which data cells a header cell applies to.
Here is a markup fragment showing a table:
The tbody
elements in this example identify the range of the row groups.
<table> <caption>Measurement of legs and tails in Cats and English speakers</caption> <thead> <tr> <th> ID </th> <th> Measurement </th> <th> Average </th> <th> Maximum </th> </tr> </thead> <tbody> <tr> <td> </td> <th scope="rowgroup"> Cats </th> <td> </td> <td> </td> </tr> <tr> <td> 93 </td> <th scope="row"> Legs </th> <td> 3.5 </td> <td> 4 </td> </tr> <tr> <td> 10 </td> <th scope="row"> Tails </th> <td> 1 </td> <td> 1 </td> </tr> </tbody> <tbody> <tr> <td> </td> <th scope="rowgroup"> English speakers </th> <td> </td> <td> </td> </tr> <tr> <td> 32 </td> <th scope="row"> Legs </th> <td> 2.67 </td> <td> 4 </td> </tr> <tr> <td> 35 </td> <th scope="row"> Tails </th> <td> 0.33 </td> <td> 1 </td> </tr> </tbody> </table>
This would result in the following table:
ID | Measurement | Average | Maximum |
---|---|---|---|
Cats | |||
93 | Legs | 3.5 | 4 |
10 | Tails | 1 | 1 |
English speakers | |||
32 | Legs | 2.67 | 4 |
35 | Tails | 0.33 | 1 |
The header cells in row 1 ("ID", "Measurement", "Average" and "Maximum") each apply only to the cells in their column.
The header cells with a scope="rowgroup"
("Cats" and 'English speakers') apply to
all the cells in their row group other than the cells (to their left) in column 1:
The header "Cats" (row 2, column 2) applies to the headers "Legs" (row 3, column 2) and "Tails" (row 4, column 2) and to the data cells in rows 2, 3 and 4 of the "Average" and "Maximum" columns.
The header 'English speakers' (row 5, column 2) applies to the headers "Legs" (row 6, column 2) and "Tails" (row 7, column 2) and to the data cells in rows 5, 6 and 7 of the "Average" and "Maximum" columns.
Each of the "Legs" and "Tails" header cells has a scope="row"
and therefore
apply to the data cells (to the right) in their row, from the "Average" and "Maximum" columns.
4.9.11. Attributes common to td
and th
elements
The td
and th
elements may have a colspan
content attribute specified,
whose value must be a valid non-negative integer greater than zero.
The td
and th
elements may also have a rowspan
content attribute specified,
whose value must be a valid non-negative integer. For this attribute, the value zero
means that the cell is to span all the remaining rows in the row group.
These attributes give the number of columns and rows respectively that the cell is to span. These attributes must not be used to overlap cells, as described in the table model.
The td
and th
element may have a headers
content attribute specified.
The headers
attribute, if specified, must contain a string consisting of an unordered set of unique space-separated tokens that are case-sensitive, each of
which must have the value of an id
of a th
element taking part in the same table as the td
or th
element (as defined by the table model).
A th
element with id
id is said to be directly targeted by all td
and th
elements in the same table that have headers
attributes whose values include as one of their tokens the ID id. A th
element A is said to be targeted by a th
or td
element B if either A is directly targeted by B or if there
exists an element C that is itself targeted by the element B and A is directly targeted by C.
A th
element must not be targeted by itself.
The colspan
, rowspan
, and headers
attributes take part in the table model.
The td
and th
elements implement interfaces that inherit from the HTMLTableCellElement
interface:
interface HTMLTableCellElement
: HTMLElement {
attribute unsigned long colSpan;
attribute unsigned long rowSpan;
[SameObject, PutForwards=value] readonly attribute DOMTokenList headers;
readonly attribute long cellIndex;
};
- cell .
cellIndex
-
Returns the position of the cell in the row’s
cells
list. This does not necessarily correspond to the x-position of the cell in the table, since earlier cells might cover multiple rows or columns.Returns -1 if the element isn’t in a row.
The colSpan
IDL attribute must reflect the colspan
content attribute. Its default value is 1.
The rowSpan
IDL attribute must reflect the rowspan
content attribute. Its default value is 1.
The headers
IDL attribute must reflect the content attribute of the same name.
The cellIndex
IDL attribute must,
if the element has a parent tr
element, return the index of the cell’s element in the parent
element’s cells
collection. If there is no such parent element,
then the attribute must return -1.
4.9.12. Processing model
The various table elements and their content attributes together define the table model.
A table consists of cells aligned on a two-dimensional grid of slots with coordinates (x, y). The grid is finite, and
is either empty or has one or more slots. If the grid has one or more slots, then
the x coordinates are always in the range
0 ≤ x < xwidth,
and the y coordinates are always in the range
0 ≤ y < yheight.
If one or both of xwidth and yheight are zero,
then the table is empty (has no slots). Tables correspond to table
elements.
A cell is a set of slots anchored at a slot
(cellx, celly), and with
a particular width and height such that the cell covers
all the slots with coordinates (x, y) where cellx ≤ x < cellx+width and celly ≤ y < celly+height.
Cells can either be data cells or header cells. Data cells correspond
to td
elements, and header cells correspond to th
elements. Cells of both types
can have zero or more associated header cells.
It is possible, in certain error cases, for two cells to occupy the same slot.
A row is a complete set of slots from x=0 to x=xwidth-1, for a particular value of y. Rows usually correspond to tr
elements, though a row group can have
some implied rows at the end in some cases involving cells spanning multiple rows.
A column is a complete set of slots from y=0 to y=yheight-1, for a particular value of x. Columns can correspond to col
elements. In the absence of col
elements,
columns are implied.
A row group is a set of rows anchored at a slot (0, groupy) with a particular height such that the row group
covers all the slots with coordinates (x, y) where 0 ≤ x < xwidth and groupy ≤ y < groupy+height. Row groups correspond
to tbody
, thead
, and tfoot
elements. Not every row is necessarily in a row group.
A column group is a set of columns anchored at a slot (groupx, 0) with a particular width such
that the column group covers all the slots with coordinates (x, y)
where groupx ≤ x < groupx+width and 0 ≤ y < yheight.
Column groups correspond to colgroup
elements. Not every column is necessarily in a column
group.
Row groups cannot overlap each other. Similarly, column groups cannot overlap each other.
A cell cannot cover slots that are from two or more row groups. However, it is possible for a cell to be in multiple column groups. All the slots that form part of one cell are part of zero or one row groups and zero or more column groups.
In addition to cells, columns, rows, row groups, and column groups, tables can have a caption
element
associated with them. This gives the table a heading, or legend.
A table model error is an error with the data represented by table
elements and their descendants. Documents must not have table model errors.
4.9.12.1. Forming a table
User agents must use the following algorithm to determine
- which elements correspond to which slots in a table associated with a
table
element, - the dimensions of the table (xwidth and yheight), and
- if there are any table model errors
.
The algorithm selects the first
caption
encountered and assigns it as thecaption
for the table, and selects the firstthead
and processes it. Until there is athead
,tfoot
,tbody
ortr
element, it processes anycolgroup
elements encountered, and anycol
children, to create column groups. Finally, from the firstthead
,tfoot
,tbody
ortr
element encountered as a child of thetable
it processes those elements, moving the firsttfoot
encountered to the end of the table respectively.-
Let xwidth be zero.
-
Let yheight be zero.
-
Let table footer be null.
-
Let table header be null.
-
Let the table be the table represented by the
table
element. The xwidth and yheight variables give the table’s dimensions. The table is initially empty. -
If the
table
element has no children elements, then return the table (which will be empty), and abort these steps. -
Associate the first
caption
element child of thetable
element with the table. If there are no such children, then it has no associatedcaption
element. -
Let the current element be the first element child of the
table
element.If a step in this algorithm ever requires the current element to be advanced to the next child of the
table
when there is no such next child, then the user agent must jump to the step labeled end, near the end of this algorithm. -
While the current element is not one of the following elements, advance the current element to the next child of the
table
: -
If the current element is a
colgroup
, follow these substeps:-
Column groups: Process the current element according to the appropriate case below:
- If the current element has any
col
element children -
Follow these steps:
-
Let xstart have the value of xwidth.
-
Let the current column be the first
col
element child of thecolgroup
element. -
Columns: If the current column
col
element has aspan
attribute, then parse its value using the rules for parsing non-negative integers.If the result of parsing the value is not an error or zero, then let span be that value.
Otherwise, if the
col
element has nospan
attribute, or if trying to parse the attribute’s value resulted in an error or zero, then let span be 1. -
Increase xwidth by span.
-
Let the last span columns in the table correspond to the current column
col
element. -
If current column is not the last
col
element child of thecolgroup
element, then let the current column be the nextcol
element child of thecolgroup
element, and return to the step labeled columns. -
Let all the last columns in the table from x=xstart to x=xwidth-1 form a new column group, anchored at the slot (xstart, 0), with width xwidth-xstart, corresponding to the
colgroup
element.
-
- If the current element has no
col
element children -
-
If the
colgroup
element has aspan
attribute, then parse its value using the rules for parsing non-negative integers.If the result of parsing the value is not an error or zero, then let span be that value.
Otherwise, if the
colgroup
element has nospan
attribute, or if trying to parse the attribute’s value resulted in an error or zero, then let span be 1. -
Increase xwidth by span.
-
Let the last span columns in the table form a new column group, anchored at the slot (xwidth-span, 0), with width span, corresponding to the
colgroup
element.
-
- If the current element has any
-
While the current element is not one of the following elements, advance the current element to the next child of the
table
: -
If the current element is a
colgroup
element, jump to the step labeled column groups above.
-
-
Let ycurrent be zero.
-
Let the list of downward-growing cells be an empty list.
-
Rows: While the current element is not one of the following elements, advance the current element to the next child of the
table
:Run the algorithm for processing row groups for the first
thead
child of thetable
. -
If the current element is a
tfoot
and the value of table footer is null, then run the following substeps: -
If the current element is a
thead
and the value of table header is null, then run the following substeps: -
If the current element is a
tr
then run the algorithm for processing rows, advance the current element to the next child of thetable
, and return to the step labeled rows. -
Run the algorithm for ending a row group.
-
The current element is either a
thead
,tfoot
, or atbody
.Run the algorithm for processing row groups.
-
Return to the step labeled rows.
-
End: run the algorithm for processing row groups to process table footer.
-
If there exists a row or column in the table containing only slots that do not have a cell anchored to them, then this is a table model error.
-
Return the table.
The algorithm for processing row groups, which is invoked by the set of steps above for processing
thead
,tbody
, andtfoot
elements, is:-
Let ystart have the value of yheight.
-
For each
tr
element that is a child of the element being processed, in tree order, run the algorithm for processing rows. -
If yheight > ystart, then let all the last rows in the table from y=ystart to y=yheight-1 form a new row group, anchored at the slot with coordinate (0, ystart), with height yheight-ystart, corresponding to the element being processed.
-
Run the algorithm for ending a row group.
The algorithm for ending a row group, which is invoked by the set of steps above when starting and ending a block of rows, is:
-
While ycurrent is less than yheight, follow these steps:
-
Increase ycurrent by 1.
-
Empty the list of downward-growing cells.
The algorithm for processing rows, which is invoked by the set of steps above for processing
tr
elements, is:-
If yheight is equal to ycurrent, then increase yheight by
-
(ycurrent is never greater than yheight.)
-
-
Let xcurrent be 0.
-
If the
tr
element being processed has notd
orth
element children, then increase ycurrent by 1, abort this set of steps, and return to the algorithm above. -
Let current cell be the first
td
orth
element child in thetr
element being processed. -
Cells: While xcurrent is less than xwidth and the slot with coordinate (xcurrent, ycurrent) already has a cell assigned to it, increase xcurrent by 1.
-
If xcurrent is equal to xwidth, increase xwidth by 1. (xcurrent is never greater than xwidth.)
-
If the current cell has a
colspan
attribute, then parse that attribute’s value, and let colspan be the result.If parsing that value failed, or returned zero, or if the attribute is absent, then let colspan be 1, instead.
-
If the current cell has a
rowspan
attribute, then parse that attribute’s value, and let rowspan be the result.If parsing that value failed or if the attribute is absent, then let rowspan be 1, instead.
-
If rowspan is zero and the
table
element’s node document is not set to quirks mode, then let cell grows downward be true, and set rowspan to 1. Otherwise, let cell grows downward be false. -
If xwidth < xcurrent+colspan, then let xwidth be xcurrent+colspan.
-
If yheight < ycurrent+rowspan, then let yheight be ycurrent+rowspan.
-
Let the slots with coordinates (x, y) such that xcurrent ≤ x < xcurrent+colspan and ycurrent ≤ y < ycurrent+rowspan be covered by a new cell c, anchored at (xcurrent, ycurrent), which has width colspan and height rowspan, corresponding to the current cell element.
If the current cell element is a
th
element, let this new cell c be a header cell; otherwise, let it be a data cell.To establish which header cells apply to the current cell element, use the algorithm for assigning header cells described in the next section.
If any of the slots involved already had a cell covering them, then this is a table model error. Those slots now have two cells overlapping.
-
If cell grows downward is true, then add the tuple {c, xcurrent, colspan} to the list of downward-growing cells.
-
Increase xcurrent by colspan.
-
If current cell is the last
td
orth
element child in thetr
element being processed, then increase ycurrent by 1, abort this set of steps, and return to the algorithm above. -
Let current cell be the next
td
orth
element child in thetr
element being processed. -
Return to the step labeled cells.
When the algorithms above require the user agent to run the algorithm for growing downward-growing cells, the user agent must, for each {cell, cellx, width} tuple in the list of downward-growing cells, if any, extend the cell cell so that it also covers the slots with coordinates (x, ycurrent), where cellx ≤ x < cellx+width.
4.9.12.2. Forming relationships between data cells and header cells
Each cell can be assigned zero or more header cells. The algorithm for assigning header cells to a cell principal cell is as follows.
-
Let header list be an empty list of cells.
-
Let (principalx, principaly) be the coordinate of the slot to which the principal cell is anchored.
-
- If the principal cell has a
headers
attribute specified -
-
Take the value of the principal cell’s
headers
attribute and split it on spaces, letting id list be the list of tokens obtained. -
For each token in the id list, if the first element in the
Document
with an ID equal to the token is a cell in the same table, and that cell is not the principal cell, then add that cell to header list.
-
- If principal cell does not have a
headers
attribute specified -
-
Let principalwidth be the width of the principal cell.
-
Let principalheight be the height of the principal cell.
-
For each value of y from principaly to principaly+principalheight-1, run the internal algorithm for scanning and assigning header cells, with the principal cell, the header list, the initial coordinate (principalx,y), and the increments Δx=-1 and Δy=0.
-
For each value of x from principalx to principalx+principalwidth-1, run the internal algorithm for scanning and assigning header cells, with the principal cell, the header list, the initial coordinate (x,principaly), and the increments Δx=0 and Δy=-1.
-
If the principal cell is anchored in a row group, then add all header cells that are row group headers and are anchored in the same row group with an x-coordinate less than or equal to principalx+principalwidth-1 and a y-coordinate less than or equal to principaly+principalheight-1 to header list.
-
If the principal cell is anchored in a column group, then add all header cells that are column group headers and are anchored in the same column group with an x-coordinate less than or equal to principalx+principalwidth-1 and a y-coordinate less than or equal to principaly+principalheight-1 to header list.
-
- If the principal cell has a
-
Remove all the empty cells from the header list.
-
Remove any duplicates from the header list.
-
Remove principal cell from the header list if it is there.
-
Assign the headers in the header list to the principal cell.
The internal algorithm for scanning and assigning header cells, given a principal cell, a header list, an initial coordinate (initialx, initialy), and Δx and Δy increments, is as follows:
-
Let x equal initialx.
-
Let y equal initialy.
-
Let opaque headers be an empty list of cells.
-
- If principal cell is a header cell
- Let in header block be true, and let headers from current header block be a list of cells containing just the principal cell.
- Otherwise
- Let in header block be false and let headers from current header block be an empty list of cells.
-
Loop: Increment x by Δx; increment y by Δy.
For each invocation of this algorithm, one of Δx and Δy will be -1, and the other will be 0.
-
If either x or y is less than 0, then abort this internal algorithm.
-
If there is no cell covering slot (x, y), or if there is more than one cell covering slot (x, y), return to the substep labeled loop.
-
Let current cell be the cell covering slot (x, y).
-
- If current cell is a header cell
-
- Set in header block to true.
- Add current cell to headers from current header block.
- Let blocked be false.
-
- If Δx is 0
-
If there are any cells in the opaque headers list anchored with the same x-coordinate as the current cell, and with the same width as current cell, then let blocked be true.
If the current cell is not a column header, then let blocked be true.
- If Δy is 0
-
If there are any cells in the opaque headers list anchored with the same y-coordinate as the current cell, and with the same height as current cell, then let blocked be true.
If the current cell is not a row header, then let blocked be true.
- If blocked is false, then add the current cell to the headers list.
- If current cell is a data cell and in header block is true
- Set in header block to false. Add all the cells in headers from current header block to the opaque headers list, and empty the headers from current header block list.
-
Return to the step labeled loop.
A header cell anchored at the slot with coordinate (x, y) with width width and height height is said to be a column header if any of the following conditions are true:
- The cell’s
scope
attribute is in the column state, or - The cell’s
scope
attribute is in the auto state, and there are no data cells in any of the cells covering slots with x-coordinates x .. x+width-1.
A header cell anchored at the slot with coordinate (x, y) with width width and height height is said to be a row header if any of the following conditions are true:
- The cell’s
scope
attribute is in the row state, or - The cell’s
scope
attribute is in the auto state, the cell is not a column header, and there are no data cells in any of the cells covering slots with y-coordinates y .. y+height-1.
A header cell is said to be a column group header if its
scope
attribute is in the column group state.A header cell is said to be a row group header if its
scope
attribute is in the row group state.A cell is said to be an empty cell if it contains no elements and its text content, if any, consists only of White_Space characters.
4.9.13. Examples
This section is non-normative.
The following examples showcase different
table
markup patterns, and how they could appear in browsers with some styling provided by CSS.This first example shows how an one might mark up the bottom part of table 45 of the Smithsonian physical tables, Volume 71:
<table> <caption> Specification values: <b>Steel</b>, <b>Castings</b>, Ann. A.S.T.M. A27-16, Class B;* P max. 0.06; S max. 0.05. </caption> <thead> <tr> <th rowspan="2">Grade.</th> <th rowspan="2">Yield Point.</th> <th colspan="2">Ultimate tensile strength</th> <th rowspan="2">Per cent elong. 50.8mm or 2 in.</th> <th rowspan="2">Per cent reduct. area.</th> </tr> <tr> <th>kg/mm<sup>2</sup></th> <th>lb/in<sup>2</sup></th> </tr> </thead> <tbody> <tr> <td>Hard</td> <td>0.45 ultimate</td> <td>56.2</td> <td>80,000</td> <td>15</td> <td>20</td> </tr> <tr> <td>Medium</td> <td>0.45 ultimate</td> <td>49.2</td> <td>70,000</td> <td>18</td> <td>25</td> </tr> <tr> <td>Soft</td> <td>0.45 ultimate</td> <td>42.2</td> <td>60,000</td> <td>22</td> <td>30</td> </tr> </tbody> </table>
This example produces the following table in a browser:
Specification values: Steel, Castings, Ann. A.S.T.M. A27-16, Class B;* P max. 0.06; S max. 0.05. Grade. Yield Point. Ultimate tensile strength Per cent elong. 50.8mm or 2 in. Per cent reduct. area. kg/mm2 lb/in2 Hard 0.45 ultimate 56.2 80,000 15 20 Medium 0.45 ultimate 49.2 70,000 18 25 Soft 0.45 ultimate 42.2 60,000 22 30
The following shows how one might mark up the gross margin table on page 46 of Apple, Inc’s 10-K filing for fiscal year 2008:
<table> <thead> <tr> <th> </th> <th>2008</th> <th>2007</th> <th>2006</th> </tr> </thead> <tbody> <tr> <th>Net sales</th> <td>$ 32,479</td> <td>$ 24,006</td> <td>$ 19,315</td> </tr> <tr> <th>Cost of sales</th> <td>21,334</td> <td>15,852</td> <td>13,717</td> </tr> </tbody> <tbody> <tr> <th>Gross margin</th> <td>$ 11,145</td> <td>$ 8,154</td> <td>$ 5,598</td> </tr> </tbody> <tfoot> <tr> <th>Gross margin percentage</th> <td>34.3%</td> <td>34.0%</td> <td>29.0%</td> </tr> </tfoot> </table>
This example produces the following table in a browser:
2008 2007 2006 Net sales $ 32,479 $ 24,006 $ 19,315 Cost of sales 21,334 15,852 13,717 Gross margin $ 11,145 $ 8,154 $ 5,598 Gross margin percentage 34.3% 34.0% 29.0%
The following shows how one might mark up the operating expenses table from lower on the same page of that document:
<table> <colgroup> <col> </colgroup> <colgroup> <col> <col> <col> </colgroup> <thead> <tr> <th> </th> <th>2008 </th> <th>2007 </th> <th>2006 </th> </tr> </thead> <tbody> <tr> <th scope="rowgroup"> Research and development </th> <td> $ 1,109 </td> <td> $ 782 </td> <td> $ 712 </td> </tr> <tr> <th scope="row"> Percentage of net sales </th> <td> 3.4% </td> <td> 3.3% </td> <td> 3.7% </td> </tr> </tbody> <tbody> <tr> <th scope="rowgroup"> Selling, general, and administrative </th> <td> $ 3,761 </td> <td> $ 2,963 </td> <td> $ 2,433 </td> </tr> <tr> <th scope="row"> Percentage of net sales </th> <td> 11.6% </td> <td> 12.3% </td> <td> 12.6% </td> </tr> </tbody> </table>
This example produces the following table in a browser:
2008 2007 2006 Research and development $ 1,109 $ 782 $ 712 Percentage of net sales 3.4% 3.3% 3.7% Selling, general, and administrative $ 3,761 $ 2,963 $ 2,433 Percentage of net sales 11.6% 12.3% 12.6%
The following shows how one might mark up a coffee order that includes the team, types of coffee, how many cups, and if sugar is needed to fulfill the order:
<table> <caption> Daily coffee order for team meetings </caption> <thead> <tr> <th id="t1">Team</th> <th id="t3" abbr="Types" colspan="2">Types of Coffee</th> <th id="t2" colspan="2">Cups</th> <th id="t4">Sugar Packets?</th> </tr> </thead> <tbody> <tr> <td headers="t1">Design</td> <td headers="t3" id="c1">House Blend</td> <td headers="t3" id="c2">French Roast</td> <td headers="t2 c1">8</td> <td headers="t2 c2">3</td> <td headers="t4">Yes</td> </tr> <tr> <td headers="t1">Development</td> <td headers="t3" id="c3">Cold Brew</td> <td headers="t3" id="c4">Espresso</td> <td headers="t2 c3">6</td> <td headers="t2 c4">5</td> <td headers="t4">No</td> </tr> <tbody> </table>
This example produces the following table in a browser:
Daily coffee order for team meetings Team Types of Coffee Cups Sugar Packets? Design House Blend French Roast 8 3 Yes Development Cold Brew Espresso 6 5 No -
4.10. Forms
4.10.1. Introduction
This section is non-normative.
A form is a component of a Web page that has form controls, such as text fields, buttons, checkboxes, range controls, or color pickers. A user can interact with such a form, providing data that can then be sent to the server for further processing (e.g., returning the results of a search or calculation). No client-side scripting is needed in many cases, though an API is available so that scripts can augment the user experience or use forms for purposes other than submitting data to a server.
Writing a form consists of several steps, which can be performed in any order: writing the user interface, implementing the server-side processing, and configuring the user interface to communicate with the server.
4.10.1.1. Writing a form’s user interface
This section is non-normative.
For the purposes of this brief introduction, we will create a pizza ordering form.
Any form starts with a form
element, inside which are placed the controls. Most controls are
represented by the input
element, which by default provides a one-line text field. To label
a control, the label
element is used. One way to associate a label with a control is to nest
the label text, and the control itself, inside a label
element. Each area within a form is
typically represented using a div
element. Putting this all together, here is how one might
ask for the customer’s name:
<form> <div> <label> Customer name: <input> </label> </div> </form>
For an alternate method to associate a label
with a form control, please refer to the label
’s for
attribute.
To assist users with entering their names, an autocapitalize
attribute with the value
of "words" can be added to the input
so that user agents are provided a suggestion to
automatically capitalize the first character(s) of a user’s entered name.
<form> <div> <label> Customer name: <input autocapitalize="words"> </label> </div> </form>
To let the user select the size of the pizza, we can use a set of radio buttons. Radio buttons
also use the input
element, but with a type
attribute with the value radio
. To make the radio buttons work as a group, they are each given a common name
using the name
attribute. To group a batch of controls together, such as, in this
case, the radio buttons, one can use the fieldset
element. The title of such a group of
controls is given by the first element in the fieldset
, which has to be a legend
element.
<form> <div> <label> Customer name: <input autocapitalize="words"> </label> </div> <fieldset> <legend>Pizza Size</legend> <ul> <li> <label> <input type="radio" name="size"> Small </label> </li> <li> <label> <input type="radio" name="size"> Large </label> </li> </ul> </fieldset> </form>
To choose toppings, checkboxes can be added to this form. Checkboxes use the input
element
with a type
attribute with the value checkbox
:
<form> <div> <label> Customer name: <input autocapitalize="words"> </label> </div> <fieldset> <legend>Pizza Size</legend> <ul> <li> <label> <input type="radio" name="size"> Small </label> </li> <li> <label> <input type="radio" name="size"> Large </label> </li> </ul> </fieldset> <fieldset> <legend>Pizza Toppings</legend> <ul> <li> <label> <input type="checkbox"> Bacon </label> </li> <li> <label> <input type="checkbox"> Onion </label> </li> <li> <label> <input type="checkbox"> Mushroom </label> </li> </ul> </fieldset> </form>
In the event there is a problem with a customer’s order, the pizzeria needs a way to be able to
collect the customer’s contact information. For this purpose, form controls for telephone numbers
(input
elements with a type
attribute set to tel
) and
e-mail addresses (input
elements with a type
attribute set to code>email)
can be added:
<form> <div> <label> Customer name: <input autocapitalize="words"> </label> </div> <div> <label> Telephone: <input type="tel"> </label> </div> <div> <label> E-mail: <input type="email"> </label> </div> ... </form>
To let customers request a specific delivery time an input
element with its type
attribute set to time
can be used. Many form controls have attributes to help
authors dictate the values a user can enter; in this case, three attributes of particular
interest are min
, max
, and step
. Respectively, these set the
minimum time, the maximum time, and the interval between allowed values (in seconds).
For this example, the pizzeria only delivers between 11am and 9pm, and allows users to choose a
delivery window in 15 minute increments. As the min
, max
attributes take
values in 24-hour time, this means the min
value would be "11:00" and the max
value would be "21:00". Since the step
attribute is set in seconds,
to set the form control to accept values in 15 minute increments, the 15 minutes would need to
be converted to seconds (900 seconds).
<form> ... <div> <label> Preferred delivery time: <input type="time" min="11:00" max="21:00" step="900"> </label> </div> </form>
The textarea
element can be used to provide a free-form text field. In this instance, it will
allow a space for customers to provide delivery instructions:
<form> ... <div> <label> Delivery instructions: <textarea></textarea> </label> </div> </form>
Finally, to make the form submittable, add a button
element:
<form> <div> <label> Customer name: <input autocapitalize="words"> </label> </div> <div> <label> Telephone: <input type="tel"> </label> </div> <div> <label> E-mail: <input type="email"> </label> </div> <fieldset> <legend>Pizza Size</legend> <ul> <li> <label> <input type="radio" name="size"> Small </label> </li> <li> <label> <input type="radio" name="size"> Large </label> </li> </ul> </fieldset> <fieldset> <legend>Pizza Toppings</legend> <ul> <li> <label> <input type="checkbox"> Bacon </label> </li> <li> <label> <input type="checkbox"> Onion </label> </li> <li> <label> <input type="checkbox"> Mushroom </label> </li> </ul> </fieldset> <div> <label> Preferred delivery time: <input type="time" min="11:00" max="21:00" step="900"> </label> </div> <div> <label> Delivery instructions: <textarea></textarea> </label> </div> <div> <button>Submit order</button> </div> </form>
4.10.1.2. Implementing the server-side processing for a form
This section is non-normative.
The exact details for writing a server-side processor are out of scope for this specification.
For the purposes of this introduction, we will assume that the script at https://pizza.example.com/order
is configured to accept submissions using the application/x-www-form-urlencoded
format, expecting the following parameters sent
in an HTTP POST body:
custname
-
Customer’s name
custtel
-
Customer’s telephone number
custemail
-
Customer’s e-mail
size
-
The pizza size, either
small
orlarge
topping
-
A topping, specified once for each selected topping, with the allowed values being
bacon
,onion
, andmushroom
delivery
-
The requested delivery time
comments
-
The delivery instructions
4.10.1.3. Configuring a form to communicate with a server
This section is non-normative.
Form submissions are exposed to servers in a variety of ways, most commonly as HTTP GET or
POST requests. To specify the exact method used, the method
attribute is specified on the form
element. This doesn’t specify how the form data is
encoded, though; to specify that, you use the enctype
attribute. You also have to specify the URL of the service that will handle the
submitted data, using the action
attribute.
For each form control you want submitted, you then have to give a name that will be used to
refer to the data in the submission. We already specified the name for the group of radio buttons;
the same attribute (name
) also specifies the submission name.
Radio buttons can be distinguished from each other in the submission by giving them different
values, using the value
attribute.
Multiple controls can have the same name; for example, here we give all the checkboxes the same
name, and the server distinguishes which checkbox was checked by seeing which values are submitted
with that name — like the radio buttons, they are also given unique values with the value
attribute.
Given the settings in the previous section, this all becomes:
<form method="post" enctype="application/x-www-form-urlencoded" action="https://pizza.example.com/order"> <div> <label> Customer name: <input name="custname"> </label> </div> <div> <label> Telephone: <input type="tel" name="custtel"> </label> </div> <div> <label> E-mail: <input type="email" name="custemail"> </label> </div> <fieldset> <legend>Pizza Size</legend> <ul> <li> <label> <input type="radio" name="size"> Small </label> </li> <li> <label> <input type="radio" name="size"> Large </label> </li> </ul> </fieldset> <fieldset> <legend>Pizza Toppings</legend> <ul> <li> <label> <input type="checkbox"> Bacon </label> </li> <li> <label> <input type="checkbox"> Onion </label> </li> <li> <label> <input type="checkbox"> Mushroom </label> </li> </ul> </fieldset> <div> <label> Preferred delivery time: <input type="time" min="11:00" max="21:00" step="900" name="delivery"> </label> </div> <div> <label> Delivery instructions: <textarea name="comments"></textarea> </label> </div> <div> <button>Submit order</button> </div> </form>
For example, if the customer entered "Denise Lawrence" as their name, "555-555-8642" as their telephone number, did not specify an e-mail, asked for a small pizza, selected the Onion and Mushroom toppings, entered a delivery time of 7pm, and left the delivery instructions text field blank, the user agent would submit the following to the online Web service:
custname=Denise+Lawrence&custtel=555-555-8642&custemail=&size=small&topping=onion&topping=mushroom&delivery=19%3A00&comments=
4.10.1.4. Client-side form validation
This section is non-normative.
Forms can be annotated in such a way that the user agent will check the user’s input before the form is submitted. The server still has to verify the input is valid (since hostile users can easily bypass the form validation), but it allows the user to avoid the wait incurred by having the server be the sole checker of the user’s input.
The simplest annotation is the required
attribute, which can be specified on input
elements to indicate that the form is not to be submitted until a value is given. By adding this
attribute to the customer name, pizza size, and delivery time fields, we allow the user agent to
notify the user when the user submits the form without filling in the necessary fields:
<form method="post" enctype="application/x-www-form-urlencoded" action="https://pizza.example.com/order"> <div> <label> Customer name: <input name="custname" required> </label> </div> <div> <label> Telephone: <input type="tel" name="custtel"> </label> </div> <div> <label> E-mail: <input type="email" name="custemail"> </label> </div> <fieldset> <legend>Pizza Size</legend> <ul> <li> <label> <input type="radio" name="size" required> Small </label> </li> <li> <label> <input type="radio" name="size" required> Large </label> </li> </ul> </fieldset> <fieldset> <legend>Pizza Toppings</legend> <ul> <li> <label> <input type="checkbox" name="topping" value="bacon"> Bacon </label> </li> <li> <label> <input type="checkbox" name="topping" value="onion"> Onion </label> </li> <li> <label> <input type="checkbox" name="topping" value="mushroom"> Mushroom </label> </li> </ul> </fieldset> <div> <label> Preferred delivery time: <input type="time" min="11:00" max="21:00" step="900" name="delivery" required> </label> </div> <div> <label> Delivery instructions: <textarea name="comments"></textarea> </label> </div> <div> <button>Submit order</button> </div> </form>
It is also possible to limit the length of an input, using the maxlength
attribute.
By adding this to the textarea
element, we can limit users to 1000 characters, preventing
them from writing huge essays to the busy delivery drivers instead of staying focused and to
the point:
... <div> <label> Delivery instructions: <textarea name="comments" maxlength="1000"></textarea> </label> </div> <div> <button>Submit order</button> </div> </form>
When a form is submitted, invalid
events are fired at each form control that is
invalid, and then at the form
element itself. This can be useful for displaying a summary
of the problems with the form, since typically the browser itself will only report one problem
at a time.
4.10.1.5. Enabling client-side automatic filling of form controls
This section is non-normative.
Some browsers attempt to aid the user by automatically filling form controls rather than having the user reenter their information each time. For example, a field asking for the user’s telephone number can be automatically filled with the user’s phone number.
To help the user agent with this, the autocomplete
attribute can be used to describe the field’s purpose. In the case of this form, we have three
fields that can be usefully annotated in this way: the information about who the pizza is to be
delivered to. Adding this information looks like this:
<form method="post" enctype="application/x-www-form-urlencoded" action="https://pizza.example.com/order"> <div> <label> Customer name: <input name="custname" required autocomplete="shipping name"> </label> </div> <div> <label> Telephone: <input type="tel" name="custtel" autocomplete="shipping tel"> </label> </div> <div> <label> E-mail: <input type="email" name="custemail" autocomplete="shipping email"> </label> </div> ...
4.10.1.6. The difference between the field type, the autofill field name, and the input modality
This section is non-normative.
The type
and autocomplete
attributes can seem confusingly
similar. For instance, in all three cases, the string "email
" is a valid value.
This section attempts to illustrate the difference between the three attributes and provides
advice suggesting how to use them.
The type
attribute on input
elements decides
what kind of control the user agent will use to expose the field. Choosing between different
values of this attribute is the same choice as choosing whether to use an input
element, a textarea
element, a select
element, etc.
The autocomplete
attribute, in contrast, describes
what the value that the user will enter actually represents. Choosing between different values of
this attribute is the same choice as choosing what the label for the element will be.
First, consider telephone numbers. If a page is asking for a telephone number from the user,
the right form control to use is <input type="tel">
.
However, which autocomplete
value to use depends on
which phone number the page is asking for, whether they expect a telephone number in the
international format or just the local format, and so forth.
For example, a page that forms part of a checkout process on an e-commerce site for a customer buying a gift to be shipped to a friend might need both the buyer’s telephone number (in case of payment issues) and the friend’s telephone number (in case of delivery issues). If the site expects international phone numbers (with the country code prefix), this could thus look like this:
<p>Please enter complete phone numbers including the country code prefix, as in "+1 555 123 4567".</p> <div> <label> Your phone number: <input type="tel" name="custtel" autocomplete="billing tel"> </label> </div> <div> <label> Recipient’s phone number: <input type="tel" name="shiptel" autocomplete="shipping tel"> </label> </div>
But if the site only supports British customers and recipients, it might instead look like this
(notice the use of tel-national
rather than tel
):
<p>Please enter complete UK phone numbers, as in "(01632) 960 123".</p> <div> <label> Your phone number: <input type="tel" name="custtel" autocomplete="billing tel-national"> </label> </div> <div> <label> Recipient’s phone number: <input type="tel" name="shiptel" autocomplete="shipping tel-national"> </label> </div>
Now, consider a person’s preferred languages. The right autocomplete
value is language
. However, there could be a number of different form controls used for
the purpose: a free text field (<input type="text">
), a drop-down list
(<select>
), radio buttons (<input type="radio">
), etc.
It only depends on what kind of interface is desired.
4.10.1.7. Date, time, and number formats
This section is non-normative.
In this pizza delivery example, the times are specified in the format "HH:MM": two digits for the hour, in 24-hour format, and two digits for the time. (Seconds could also be specified, though they are not necessary in this example.)
In some locales, however, times are often expressed differently when presented to users. For example, in the United States, it is still common to use the 12-hour clock with an am/pm indicator, as in "2pm". In France, it is common to use the 24-hour clock, and separate the hours from the minutes using an "h" character, as in "14h00".
Similar issues exist with dates, with the added complication that even the order of the components is not always consistent — for example, in Cyprus the first of February 2003 would typically be written "1/2/03", while that same date in Japan would typically be written as "2003年02月01日" — and even with numbers, where locales differ, for example, in what punctuation is used as the decimal separator and the thousands separator.
It is therefore important to distinguish the time, date, and number formats used in HTML and in form submissions, which are always the formats defined in this specification (and based on the well-established ISO 8601 standard for computer-readable date and time formats), from the time, date, and number formats presented to the user by the browser and accepted as input from the user by the browser.
The format used "on the wire", i.e. in HTML markup and in form submissions, is intended to be computer-readable and consistent irrespective of the user’s locale. Dates, for instance, are always written in the format "YYYY-MM-DD", as in "2003-02-01". Users are not expected to ever see this format.
The time, date, or number given by the page in the wire format is then translated to the user’s preferred presentation (based on user preferences or on the locale of the page itself), before being displayed to the user. Similarly, after the user inputs a time, date, or number using their preferred format, the user agent converts it back to the wire format before putting it in the DOM or submitting it.
This allows scripts in pages and on servers to process times, dates, and numbers in a consistent manner without needing to support dozens of different formats, while still supporting the users' needs.
See also the implementation notes regarding localization of form controls.
In places that change from, such as Standard Time to Daylight Saving Time, the same time can
occur twice in the same day when the clocks are moved backwards.
An input
element with a type
of datetime-local
or time
cannot differentiate between two identical instances of time.
If this difference matters, applications should allow users to specify which occurrence of the
duplicated time they mean, for example by choosing between "Winter time" and "Summer Time".
4.10.2. Categories
Mostly for historical reasons, elements in this section fall into several overlapping (but subtly different) categories in addition to the usual ones like flow content, phrasing content, and interactive content.
A number of the elements are form-associated elements, which means they can have a form owner.
The form-associated elements fall into several subcategories:
- Listed elements
-
Denotes elements that are listed in the
form.elements
andfieldset.elements
APIs. - Submittable elements
-
Denotes elements that can be used for constructing the form data set when a
form
element is submitted.Some submittable elements can be, depending on their attributes, buttons. The prose below defines when an element is a button. Some buttons are specifically submit buttons.
- Resettable elements
-
Denotes elements that can be affected when a
form
element is reset. - Reassociateable elements
-
Denotes elements that have a
form
content attribute, and a matchingform
IDL attribute, that allow authors to specify an explicit form owner.
Some elements, not all of them form-associated, are categorized as labelable elements.
These are elements that can be associated with a label
element.
The following table is non-normative and summarizes the above categories of form elements:
form-associated | listed | submittable | resettable | reassociateable | labelable | |
---|---|---|---|---|---|---|
can have a form owner | listed in the form.elements and fieldset.elements APIs
| can be used for constructing the form data set when a form element is submitted | can be affected when a form element is reset | have a form attribute (allows authors to specify an explicit form owner)
| can be associated with a label element
| |
input
| yes | yes | yes | yes | yes | yes (except "hidden") |
button
| yes | yes | yes | no | yes | yes |
select
| yes | yes | yes | yes | yes | yes |
textarea
| yes | yes | yes | yes | yes | yes |
fieldset
| yes | yes | no | no | yes | no |
output
| yes | yes | no | yes | yes | yes |
object
| yes | yes | yes | no | yes | no |
meter
| no | no | no | no | no | yes |
progress
| no | no | no | no | no | yes |
label
| yes | no | no | no | no | no |
img
| yes | no | no | no | no | no |
4.10.3. The form
element
- Categories:
- Flow content.
- Palpable content.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Flow content, but with no
form
element descendants. - Tag omission in text/html:
- Neither tag is omissible.
- Content attributes:
- Global attributes
accept-charset
- Character encodings to use for §4.10.21 Form submissionaction
- URL to use for §4.10.21 Form submissionautocomplete
- Default setting for autofill feature for controls in the formenctype
- Form data set encoding type to use for §4.10.21 Form submissionmethod
- HTTP method to use for §4.10.21 Form submissionname
- Name of form to use in thedocument.forms
APInovalidate
- Bypass form control validation for §4.10.21 Form submissiontarget
- browsing context for §4.10.21 Form submission - Allowed ARIA role attribute values:
-
form
(default - do not set),none
,presentation
orsearch
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
[OverrideBuiltins] interface
HTMLFormElement
: HTMLElement { attribute DOMString acceptCharset; attribute DOMString action; attribute DOMString autocomplete; attribute DOMString enctype; attribute DOMString encoding; attribute DOMString method; attribute DOMString name; attribute boolean noValidate; attribute DOMString target; [SameObject] readonly attribute HTMLFormControlsCollection elements; readonly attribute unsigned long length; getter Element (unsigned longindex
); getter (RadioNodeList or Element) (DOMStringname
); void submit(); void reset(); boolean checkValidity(); boolean reportValidity(); };
The form
element represents a collection of form-associated elements, some of which can represent
editable values that can be submitted to a server for processing.
The accept-charset
content attribute gives the
character encodings that are to be used for the submission. If specified, the value must be an ordered set of unique space-separated tokens that are ASCII
case-insensitive, and each token must be an ASCII case-insensitive match for
one of the labels of an ASCII-compatible encoding. [ENCODING]
The name
content attribute represents the form
's name within the forms
collection. The
value must not be the empty string, and the value must be unique amongst the form
elements in the forms
collection that it is in, if any.
The autocomplete
content attribute is an enumerated attribute. The attribute has two states. The on
keyword maps to the on state, and the off
keyword maps to the off state. The attribute may also be omitted.
The missing value default is the on state.
The off state indicates that by default, form controls in the form will have their autofill field name set to "off
";
the on state indicates that by default, form controls in the form will have their autofill field name set to "on
".
The action
, enctype
, method
, enctype
, novalidate
,
and target
attributes are attributes for form submission.
- form .
elements
-
Returns an
HTMLFormControlsCollection
of the form controls in the form (excluding image buttons for historical reasons). - form .
length
-
Returns the number of form controls in the form (excluding image buttons for historical reasons).
- form[index]
-
Returns the indexth element in the form (excluding image buttons for historical reasons).
- form[name]
-
Returns the form control (or, if there are several, a
RadioNodeList
of the form controls) in the form with the given ID orname
(excluding image buttons for historical reasons); or, if there are none, returns theimg
element with the given ID.Once an element has been referenced using a particular name, that name will continue being available as a way to reference that element in this method, even if the element’s actual ID or
name
changes, for as long as the element remains in theDocument
.If there are multiple matching items, then a
RadioNodeList
object containing all those elements is returned. - form .
submit()
-
Submits the form.
- form .
reset()
-
Resets the form.
- form .
checkValidity()
-
Returns true if the form’s controls are all valid; otherwise, returns false.
- form .
reportValidity()
-
Returns true if the form’s controls are all valid; otherwise, returns false and informs the user.
The autocomplete
IDL attribute must reflect the content attribute of the same name, limited to only known values.
The name
IDL attribute must reflect the content attribute of the same name.
The acceptCharset
IDL attribute must reflect the accept-charset
content attribute.
The elements
IDL attribute must return an HTMLFormControlsCollection
rooted at the form
element, whose filter matches listed elements whose form owner is the form
element, with the exception of input
elements whose type
attribute is in the Image Button
state,
which must, for historical reasons, be excluded from this particular collection.
The length
IDL attribute must return the
number of nodes represented by the elements
collection.
The supported property indices at any instant are the indices supported by the object
returned by the elements
attribute at that instant.
When a form
element is indexed for indexed property retrieval, the user agent
must return the value returned by the item
method on the elements
collection, when invoked with the given index as its argument.
Each form
element has a mapping of names to elements called the past names map.
It is used to persist names of controls even when they change names.
The supported property names consist of the names obtained from the following algorithm, in the order obtained from this algorithm:
- Let sourced names be an initially empty ordered list of tuples consisting of a string, an element, a source, where the source is either id, name, or past, and, if the source is past, an age.
-
For each listed element candidate whose form owner is the
form
element, with the exception of anyinput
elements whosetype
attribute is in theImage Button
state, run these substeps:- If candidate has an
id
attribute, add an entry to sourced names with thatid
attribute’s value as the string, candidate as the element, and id as the source. - If candidate has a
name
attribute, add an entry to sourced names with thatname
attribute’s value as the string, candidate as the element, and name as the source.
- If candidate has an
-
For each
img
element candidate whose form owner is theform
element, run these substeps:- If candidate has an
id
attribute, add an entry to sourced names with thatid
attribute’s value as the string, candidate as the element, and id as the source. - If candidate has a
name
attribute, add an entry to sourced names with thatname
attribute’s value as the string, candidate as the element, and name as the source.
- If candidate has an
- For each entry past entry in the past names map add an entry to sourced names with the past entry’s name as the string, past entry’s element as the element, past as the source, and the length of time past entry has been in the past names map as the age.
- Sort sourced names by tree order of the element entry of each tuple, sorting entries with the same element by putting entries whose source is id first, then entries whose source is name, and finally entries whose source is past, and sorting entries with the same element and source by their age, oldest first.
- Remove any entries in sourced names that have the empty string as their name.
- Remove any entries in sourced names that have the same name as an earlier entry in the map.
- Return the list of names from sourced names, maintaining their relative order.
The properties exposed in this way must be unenumerable.
When a form
element is indexed for named property retrieval, the user agent must
run the following steps:
-
Let candidates be a live
RadioNodeList
object containing all the listed elements whose form owner is theform
element that have either anid
attribute or aname
attribute equal to name, with the exception ofinput
elements whosetype
attribute is in theImage Button
state, in tree order. -
If candidates is empty, let candidates be a live
RadioNodeList
object containing all theimg
elements that are descendants of theform
element and that have either anid
attribute or aname
attribute equal to name, in tree order. -
If candidates is empty, name is the name of one of the entries in the
form
element’s past names map: return the object associated with name in that map. -
If candidates contains more than one node, return candidates and abort these steps.
-
Otherwise, candidates contains exactly one node. Add a mapping from name to the node in candidates in the
form
element’s past names map, replacing the previous entry with the same name, if any. -
Return the node in candidates.
If an element listed in a form
element’s past names map changes form owner, then
its entries must be removed from that map.
The submit()
method, when invoked, must submit the form
element from the form
element itself, with the submitted from submit()
method flag set.
The reset()
method, when invoked, must run
the following steps:
- If the
form
element is marked as locked for reset, then abort these steps. - Mark the
form
element as locked for reset. - Reset the
form
element. - Unmark the
form
element as locked for reset.
If the checkValidity()
method is
invoked, the user agent must statically validate the constraints of the form
element, and return true if the constraint validation return a positive result, and false if it returned a negative result.
If the reportValidity()
method is invoked,
the user agent must interactively validate the constraints of the form
element, and
return true if the constraint validation return a positive result, and false if it
returned a negative result.
<form action="https://www.google.com/search" method="get"> <label> Google: <input type="search" name="q"> </label> <input type="submit" value="Search..."> </form> <form action="https://www.bing.com/search" method="get"> <label> Bing: <input type="search" name="q"> </label> <button type="submit">Search...</button> </form>
4.10.4. The label
element
- Categories:
- Flow content.
- Phrasing content.
- Interactive content.
- form-associated element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content, but with no descendant labelable elements unless it is the element’s labeled control, and no descendant
label
elements. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
for
- Associate the label with form control - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- DOM interface:
-
interface
HTMLLabelElement
: HTMLElement { readonly attribute HTMLFormElement? form; attribute DOMString htmlFor; readonly attribute HTMLElement? control; };
The label
element represents a caption in a user interface. The caption can be
associated with a specific form control, known as the label
element’s labeled control, either using the for
attribute, or by putting the
form control inside the label
element itself.
Except where otherwise specified by the following rules, a label
element has no labeled control.
The for
attribute may be specified to indicate a
form control with which the caption is to be associated. If the attribute is specified, the
attribute’s value must be the ID of a labelable element in the same Document
as the label
element. If the attribute is specified and there is an element in the Document
whose ID is equal to the value of the for
attribute, and the
first such element is a labelable element, then that element is the label
element’s labeled control.
for
attributes being used to associate label
s
with the form controls that are not a child elements of the label
s. The first example is of a simple form to input the full name of a user.
<form> <div> <label for="fname"> Full name: </label> <input type="text" name="fullname" id="fname"> </div> ... </form>
The second example shows how an author could use a for
attribute to associate a label
with a form control, within the context of a table
element.
<form> <table> <caption>Manage Customers</caption> <thead> <tr> <th> Archive </th> <th> Customer Name </th> </tr> </thead> <tbody> <tr> <td> <input type="checkbox" id="c1" name="customer1"> </td> <td> <label for="c1">Laura Nelson</label> </td> </tr> <!-- ... --> </tbody> </table> <button type="submit">Archive customers</button> </form>
The id
attribute is required to associate the for
attribute,
while the name
attribute is required so the value of the input will be submitted
as part of the form.
If the for
attribute is not specified, but the label
element has a labelable element descendant, then the first such descendant in tree order is the label
element’s labeled control.
The label
element’s activation behavior should match the platform’s label behavior.
Similarly, any additional presentation hints should match the platform’s label presentation.
label
"Lost" in the following
snippet could trigger the user agent to run synthetic click activation steps on the checkbox, as if the element itself had been triggered by the user, while clicking
the label
"Where?" would queue a task that runs the focusing steps for the element to the text input:
<div> <input type="checkbox" name="lost"> <label>Lost</label> </div> <div> <label>Where?</label> <input type="text" name="where"> </div>
If a label
element has interactive content other than its labeled control,
the activation behavior of the label
element for events targeted at those interactive content descendants and any descendants of those must be to do nothing.
In the following example, clicking on the link does not toggle the checkbox, even if the platform normally toggles a checkbox when clicking on a label. Instead, clicking the link triggers the normal activation behavior of following the link.
<!-- bad example - link inside label reduces checkbox activation area --> <label> <input type="checkbox" name="tac"> I agree to <a href="tandc.html">the terms and conditions</a> </label>
The ability to click or press a label
to trigger an event on a control provides
usability and accessibility benefits by increasing the hit area of a control,
making it easier for a user to operate.
These benefits may be lost or reduced, if the label
element contains an element with
its own activation behavior, such as a link:
<!-- bad example - all label text inside the link reduces activation area to checkbox only --> <label> <input type="checkbox" name="tac"> <a href="tandc.html">I agree to the terms and conditions</a> </label>
The usability and accessibility benefits can be maintained by placing such elements outside
the label
element:
<!-- good example - link outside label means checkbox activation area includes the checkbox and all the label text --> <label> <input type="checkbox" name="tac"> I agree to the terms and conditions </label> (read <a href="tandc.html">Terms and Conditions</a>)
<div> <label> Full name: <input name="fn"> <small>Format: First Last</small> </label> </div> <div> <label> Age: <input name="age" type="number" min="0"> </label> </div> <div> <label> Post code: <input name="pc"> <small>Format: AB12 3CD</small> </label> </div>
- label .
control
-
Returns the form control that is associated with this element.
The htmlFor
IDL attribute must reflect the for
content attribute.
The control
IDL attribute must return
the label
element’s labeled control, if any, or null if there isn’t one.
- control .
labels
-
Returns a
NodeList
of all thelabel
elements that the form control is associated with.
Labelable elements have a NodeList
object
associated with them that represents the list of label
elements, in tree
order, whose labeled control is the element in question. The labels
IDL attribute of labelable elements, on getting, must return that NodeList
object.
4.10.5. The input
element
- Categories:
- Flow content.
- Phrasing content.
- If the
type
attribute is not in theHidden
state: interactive content.- If the
type
attribute is not in theHidden
state: listed, labelable, submittable, resettable, and reassociateable form-associated element.- If the
type
attribute is in theHidden
state: listed, submittable, resettable, and reassociateable form-associated element.- If the
type
attribute is not in theHidden
state: Palpable content. - Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Nothing.
- Tag omission in text/html:
- No end tag
- Content attributes:
- Global attributes
accept
- Hint for expected file type inFile Upload
controlsalt
- Replacement text for use when images are not availableautocapitalize
- Hint for helping to capitalize user inputautocomplete
- Hint for form autofill featureautofocus
- Automatically focus the form control when the page is loadedcapture
- Specifies the preferred facing mode for the media capture mechanism, defined in [html-media-capture]checked
- Whether the command or control is checkeddirname
- Name of form field to use for sending the element’s directionality in §4.10.21 Form submissiondisabled
- Whether the form control is disabledform
- Associates the control with aform
elementformaction
- URL to use for §4.10.21 Form submissionformenctype
- Form data set encoding type to use for §4.10.21 Form submissionformmethod
- HTTP method to use for §4.10.21 Form submissionformnovalidate
- Bypass form control validation for §4.10.21 Form submissionformtarget
- browsing context for §4.10.21 Form submissionheight
- Vertical dimensionlist
- List of autocomplete optionsmax
- Maximum valuemaxlength
- Maximum length of valuemin
- Minimum valueminlength
- Minimum length of valuemultiple
- Whether to allow multiple valuesname
- Name of form control to use for §4.10.21 Form submission and in theform.elements
APIpattern
- Pattern to be matched by the form control’s valueplaceholder
- User-visible label to be placed within the form controlreadonly
- Whether to allow the value to be edited by the userrequired
- Whether the control is required for §4.10.21 Form submissionsize
- Size of the controlsrc
- Address of the resourcestep
- Granularity to be matched by the form control’s valuetype
- Type of form controlvalue
- Value of the form controlwidth
- Horizontal dimension- Also, the
title
attribute has special semantics on this element when used in conjunction with thepattern
attribute. - Allowed ARIA role attribute values:
- Depends upon state of the
type
attribute. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLInputElement
: HTMLElement { attribute DOMString accept; attribute DOMString alt; attribute DOMString autocapitalize; attribute DOMString autocomplete; attribute boolean autofocus; attribute boolean defaultChecked; attribute boolean checked; attribute DOMString dirName; attribute boolean disabled; readonly attribute HTMLFormElement? form; readonly attribute FileList? files; attribute DOMString formAction; attribute DOMString formEnctype; attribute DOMString formMethod; attribute boolean formNoValidate; attribute DOMString formTarget; attribute unsigned long height; attribute boolean indeterminate; readonly attribute HTMLElement? list; attribute DOMString max; attribute long maxLength; attribute DOMString min; attribute long minLength; attribute boolean multiple; attribute DOMString name; attribute DOMString pattern; attribute DOMString placeholder; attribute boolean readOnly; attribute boolean _required; attribute unsigned long size; attribute DOMString src; attribute DOMString step; attribute DOMString type; attribute DOMString defaultValue; [TreatNullAs=EmptyString] attribute DOMString value; attribute object? valueAsDate; attribute unrestricted double valueAsNumber; attribute unsigned long width; void stepUp(optional longn
= 1); void stepDown(optional longn
= 1); readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); boolean reportValidity(); void setCustomValidity(DOMStringerror
); [SameObject] readonly attribute NodeList labels; void select(); attribute unsigned long? selectionStart; attribute unsigned long? selectionEnd; attribute DOMString? selectionDirection; void setRangeText(DOMStringreplacement
); void setRangeText(DOMStringreplacement
, unsigned longstart
, unsigned longend
, optional SelectionModeselectionMode
= "preserve"); void setSelectionRange(unsigned longstart
, unsigned longend
, optional DOMStringdirection
); };
The input
element represents a typed data field, usually with a form
control to allow the user to edit the data.
The type
attribute controls the data type of the
element. It is an enumerated attribute. The data type is used to select the control to
use for the input
. Some data types allow either a text field or combo box control to be used,
based on the absence or presence of a list
attribute on the element.
The following table lists the keywords and states for the attribute — the keywords in the
left column map to the state, data type and control(s) in the cells on the same row.
Keyword | State | Data type | Control type |
---|---|---|---|
hidden
|
| An arbitrary string | n/a |
text
| Text
| Text with no line breaks | A text field or combo box |
search
| Search
| Text with no line breaks | Search field or combo box |
tel
| Telephone
| Text with no line breaks | A text field or combo box |
url
| URL
| An absolute URL | A text field or combo box |
email
| E-mail
| An e-mail address or list of e-mail addresses | A text field or combo box |
password
| Password
| Text with no line breaks (sensitive information) | A text field that obscures data entry |
date
| Date
| A date (year, month, day) with no time zone | A date control |
month
| Month
| A date consisting of a year and a month with no time zone | A month control |
week
| Week
| A date consisting of a week-year number and a week number with no time zone | A week control |
time
| Time
| A time (hour, minute, seconds, fractional seconds) with no time zone | A time control |
datetime-local
| Local Date and Time
| A date and time (year, month, day, hour, minute, second, fraction of a second) with no timezone offset | A date and time control |
number
| Number
| A numerical value | A text field or combo box or spinner control |
range
| Range
| A numerical value, with the extra semantic that the exact value is not important | A slider control or similar |
color
| Color
| An sRGB color with 8-bit red, green, and blue components | A color well |
checkbox
| Checkbox
| A set of zero or more values from a predefined list | A checkbox |
radio
| Radio Button
| An enumerated value | A radio button |
file
| File Upload
| Zero or more files each with a MIME type and optionally a file name | A label and a button |
submit
| Submit Button
| An enumerated value, with the extra semantic that it must be the last value selected and initiates form submission | A button |
image
| Image Button
| A coordinate, relative to a particular image’s size, with the extra semantic that it must be the last value selected and initiates form submission | Either a clickable image, or a button |
reset
| Reset Button
| n/a | A button |
button
| Button
| n/a | A button |
The missing value default is the Text
state.
Which of the accept
, alt
, autocapitalize
, autocomplete
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, step
, and width
content attributes, the checked
, files
, valueAsDate
, valueAsNumber
, and list
IDL attributes, the select()
method, the selectionStart
, selectionEnd
, and selectionDirection
, IDL attributes, the setRangeText()
and setSelectionRange()
methods, the stepUp()
and stepDown()
methods, and the input
and change
events apply to an input
element depends on the state of its type
attribute.
The subsections that define each type also clearly define in normative "bookkeeping" sections
which of these feature apply, and which do not apply, to each type. The behavior of
these features depends on whether they apply or not, as defined in their various sections (q.v.
for Content attributes, for APIs, for events).
The following table is non-normative and summarizes which of those content attributes, IDL attributes, methods, and events apply to each state:
| Text , Search
| URL , Telephone
| E-mail
| Password
| Local Date and Time , Date , Month , Week , Time
| Number
| Range
| Color
| Checkbox , Radio Button
| File Upload
| Submit Button
| Image Button
| Reset Button , Button
| |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Content attributes | ||||||||||||||
accept
| · | · | · | · | · | · | · | · | · | · | Yes | · | · | · |
alt
| · | · | · | · | · | · | · | · | · | · | · | · | Yes | · |
autocomplete
| · | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | · | · | · | · | · |
autocapitalize
| . | Yes | Yes (URL only) | Yes | Yes | . | · | · | · | · | · | · | · | . |
capture
| · | · | · | · | · | · | · | · | · | · | Yes | · | · | · |
checked
| · | · | · | · | · | · | · | · | · | Yes | · | · | · | · |
dirname
| · | Yes | · | · | · | · | · | · | · | · | · | · | · | · |
formaction
| · | · | · | · | · | · | · | · | · | · | · | Yes | Yes | · |
formenctype
| · | · | · | · | · | · | · | · | · | · | · | Yes | Yes | · |
formmethod
| · | · | · | · | · | · | · | · | · | · | · | Yes | Yes | · |
formnovalidate
| · | · | · | · | · | · | · | · | · | · | · | Yes | Yes | · |
formtarget
| · | · | · | · | · | · | · | · | · | · | · | Yes | Yes | · |
height
| · | · | · | · | · | · | · | · | · | · | · | · | Yes | · |
list
| · | Yes | Yes | Yes | · | Yes | Yes | Yes | Yes | · | · | · | · | · |
max
| · | · | · | · | · | Yes | Yes | Yes | · | · | · | · | · | · |
maxlength
| · | Yes | Yes | Yes | Yes | · | · | · | · | · | · | · | · | · |
min
| · | · | · | · | · | Yes | Yes | Yes | · | · | · | · | · | · |
minlength
| · | Yes | Yes | Yes | Yes | · | · | · | · | · | · | · | · | · |
multiple
| · | · | · | Yes | · | · | · | · | · | · | Yes | · | · | · |
pattern
| · | Yes | Yes | Yes | Yes | · | · | · | · | · | · | · | · | · |
placeholder
| · | Yes | Yes | Yes | Yes | · | Yes | · | · | · | · | · | · | · |
readonly
| · | Yes | Yes | Yes | Yes | Yes | Yes | · | · | · | · | · | · | · |
required
| · | Yes | Yes | Yes | Yes | Yes | Yes | · | · | Yes | Yes | · | · | · |
size
| · | Yes | Yes | Yes | Yes | · | · | · | · | · | · | · | · | · |
src
| · | · | · | · | · | · | · | · | · | · | · | · | Yes | · |
step
| · | · | · | · | · | Yes | Yes | Yes | · | · | · | · | · | · |
width
| · | · | · | · | · | · | · | · | · | · | · | · | Yes | · |
IDL attributes and methods | ||||||||||||||
checked
| · | · | · | · | · | · | · | · | · | Yes | · | · | · | · |
files
| · | · | · | · | · | · | · | · | · | · | Yes | · | · | · |
value
| default | value | value | value | value | value | value | value | value | default/on | filename | default | default | default |
valueAsDate
| · | · | · | · | · | Yes | · | · | · | · | · | · | · | · |
valueAsNumber
| · | · | · | · | · | Yes | Yes | Yes | · | · | · | · | · | · |
list
| · | Yes | Yes | Yes | · | Yes | Yes | Yes | Yes | · | · | · | · | · |
select()
| · | Yes | Yes† | Yes | Yes† | Yes† | Yes† | · | Yes† | · | Yes† | · | · | · |
selectionStart
| · | Yes | Yes | · | Yes | · | · | · | · | · | · | · | · | · |
selectionEnd
| · | Yes | Yes | · | Yes | · | · | · | · | · | · | · | · | · |
selectionDirection
| · | Yes | Yes | · | Yes | · | · | · | · | · | · | · | · | · |
setRangeText()
| · | Yes | Yes | · | Yes | · | · | · | · | · | · | · | · | · |
setSelectionRange()
| · | Yes | Yes | · | Yes | · | · | · | · | · | · | · | · | · |
stepDown()
| · | · | · | · | · | Yes | Yes | Yes | · | · | · | · | · | · |
stepUp()
| · | · | · | · | · | Yes | Yes | Yes | · | · | · | · | · | · |
Events | ||||||||||||||
input event
| · | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | · | · | · |
change event
| · | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | · | · | · |
† If the control has no text field, the select()
method
results in a no-op, with no "InvalidStateError
" DOMException
.
Some states of the type
attribute define a value sanitization algorithm.
Each input
element has a value, which is
exposed by the value
IDL attribute. Some states define an algorithm to convert a string to a number,
an algorithm to convert a number to a
string, an algorithm to convert a string to a Date
object, and an algorithm to
convert a Date
object to a string, which are used by max
, min
, step
, valueAsDate
, valueAsNumber
, stepDown()
, and stepUp()
.
Each input
element has a boolean dirty value flag. The dirty value flag must be initially set to false when the element is created,
and must be set to true whenever the user interacts with the control in a way that changes the value. (It is also set to true when the value is programmatically changed,
as described in the definition of the value
IDL attribute.)
The value
content attribute gives the default value of the input
element. When the value
content attribute is
added, set, or removed, if the control’s dirty value flag is false, the user agent must set the value of the element
to the value of the value
content attribute, if there is
one, or the empty string otherwise, and then run the current value sanitization algorithm, if one is defined.
Each input
element has a checkedness,
which is exposed by the checked
IDL attribute.
Each input
element has a boolean dirty checkedness flag. When it is true, the
element is said to have a dirty checkedness.
The dirty checkedness flag must be initially set to false when the element is created,
and must be set to true whenever the user interacts with the control in a way that changes
the checkedness.
The checked
content attribute is a boolean attribute that gives the default checkedness of the input
element. When the checked
content attribute is added, if the control does
not have dirty checkedness, the user agent must set the checkedness of the element to true; when the checked
content attribute is removed, if
the control does not have dirty checkedness, the user
agent must set the checkedness of the element to false.
The reset algorithm for input
elements is to set the dirty value flag and dirty checkedness flag back to false, set
the value of the element to the value of the value
content
attribute, if there is one, or the empty string otherwise, set the checkedness of the element to true if the element has a checked
content attribute and false if it does not, empty the list of selected files, and then
invoke the value sanitization algorithm, if the type
attribute’s current
state defines one.
Each input
element can be mutable. Except where
otherwise specified, an input
element is always mutable. Similarly,
except where otherwise specified, the user agent should not allow the user to
modify the element’s value or checkedness.
When an input
element is disabled, it is not mutable.
The readonly
attribute can also in some
cases (e.g., for the Date
state, but not the Checkbox
state) stop an input
element from being mutable.
The cloning steps for input
elements must propagate the value, dirty value flag, checkedness, and dirty checkedness flag from the node being cloned to the copy.
When an input
element is first created, the element’s rendering and behavior must
be set to the rendering and behavior defined for the type
attribute’s state, and the value sanitization algorithm, if one is defined for the type
attribute’s state, must be invoked.
When an input
element’s type
attribute
changes state, the user agent must run the following steps:
- If the previous state of the element’s
type
attribute put thevalue
IDL attribute in the value mode, and the element’s value is not the empty string, and the new state of the element’stype
attribute puts thevalue
IDL attribute in either the default mode or the default/on mode, then set the element’svalue
content attribute to the element’s value. - Otherwise, if the previous state of the element’s
type
attribute put thevalue
IDL attribute in any mode other than the value mode, and the new state of the element’stype
attribute puts thevalue
IDL attribute in the value mode, then set the value of the element to the value of thevalue
content attribute, if there is one, or the empty string otherwise, and then set the control’s dirty value flag to false. - Otherwise, if the previous state of the element’s
type
attribute put thevalue
IDL attribute in any mode other than the filename mode, and the new state of the element’stype
attribute puts thevalue
IDL attribute in the filename mode, then set the value of the element to the empty string. - Update the element’s rendering and behavior to the new state’s.
- Signal a type change for the element.
(The
Radio Button
state uses this, in particular.) - Invoke the value sanitization algorithm, if one is defined for the
type
attribute’s new state.
The name
attribute represents the element’s name.
The dirname
attribute controls how the element’s directionality is submitted.
The disabled
attribute is used to make the control non-interactive and to prevent its value from being submitted.
The form
attribute is used to explicitly associate the input
element with its form owner.
The autofocus
attribute controls focus.
The autocapitalize
attribute provides a hint for the user agent to help the user automatically capitalize text they enter.
The autocomplete
attribute controls how the user agent provides autofill behavior.
The indeterminate
IDL attribute must
initially be set to false. On getting, it must return the last value it was set to. On setting,
it must be set to the new value. It has no effect except for changing the appearance of checkbox
controls.
The accept
, alt
, max
, min
, multiple
, pattern
, placeholder
, required
, size
, src
, and step
IDL attributes must reflect the respective content attributes of the same name.
The dirName
IDL attribute must reflect the dirname
content attribute.
The readOnly
IDL attribute must reflect the readonly
content attribute.
The defaultChecked
IDL attribute must reflect the checked
content attribute.
The defaultValue
IDL attribute must reflect the value
content attribute.
The type
and autocapitalize
IDL attributes must reflect the respective content attributes of the same name, limited to only known values.
The maxLength
IDL attribute must reflect the maxlength
content attribute, limited to only non-negative numbers.
The minLength
IDL attribute must reflect the minlength
content attribute, limited to only non-negative numbers.
The IDL attributes width
and height
must return the rendered
width and height of the image, in CSS pixels, if an image is being rendered, and is
being rendered to a visual medium; or else the intrinsic width and height of the image,
in CSS pixels, if an image is available but not being rendered to a visual medium;
or else 0, if no image is available. When the input
element’s type
attribute is not in the Image Button
state,
then no image is available. [CSS-2015]
On setting, they must act as if they reflected the respective content attributes of the same name.
The willValidate
, validity
, and validationMessage
IDL attributes, and
the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of
the constraint validation API.
The labels
IDL attribute provides a list of the element’s label
s.
The select()
, selectionStart
, selectionEnd
, selectionDirection
, setRangeText()
, and setSelectionRange()
methods and IDL
attributes expose the element’s text selection.
The autofocus
, disabled
, form
, and name
IDL attributes are part of the
element’s forms API.
4.10.5.1. States of the type
attribute
4.10.5.1.1. Hidden
state (type=hidden
)
When an input
element’s type
attribute is in
the state, the rules in this section apply.
The input
element represents a value that is not intended to be
examined or manipulated by the user.
Constraint validation: If an input
element’s type
attribute is in the state, it is barred from constraint
validation.
If the name
attribute is present and has a value that is a case-sensitive match for the string "_charset_
", then the element’s value
attribute must be omitted.
The value
IDL attribute applies to this element and is
in mode default.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, autocapitalize
, autocomplete
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
The input
and change
events do not apply.
4.10.5.1.2. Text
(type="text"
) state and Search
state (type="search"
)
- Allowed ARIA role attribute values:
-
textbox
,searchbox
with nolist
attribute (default - do not set) or with alist
attribute:combobox
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Text
state or the Search
state, the rules in this section apply.
The input
element represents a one line plain text edit control for
the element’s value.
The difference between the Text
state
and the Search
state is primarily stylistic: on
platforms where search fields are distinguished from regular text fields, the Search
state might result in an appearance consistent with
the platform’s search fields rather than appearing like a regular text field.
If the element is mutable, its value should be editable by the user. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the element’s value.
If the element is mutable, the user agent should allow the user to change the writing direction of the element, setting it either to a left-to-right writing direction or a right-to-left writing direction. If the user does so, the user agent must then run the following steps:
- Set the element’s
dir
attribute to "ltr" if the user selected a left-to-right writing direction, and "rtl
" if the user selected a right-to-left writing direction. - Queue a task to fire a simple event that bubbles named
input
at theinput
element.
The value
attribute, if specified, must have a value that
contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters.
The value sanitization algorithm is as follows: Strip line breaks from the value.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocapitalize
, autocomplete
, dirname
, list
, maxlength
, minlength
, pattern
, placeholder
, readonly
, required
, and size
content attributes; list
, selectionStart
, selectionEnd
, selectionDirection
, and value
IDL attributes; select()
, setRangeText()
, and setSelectionRange()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, capture
, checked
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, max
, min
, multiple
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, valueAsDate
, and valueAsNumber
IDL attributes; stepDown()
and stepUp()
methods.
4.10.5.1.3. Telephone
state (type="tel"
)
- Allowed ARIA role attribute values:
-
textbox
with nolist
attribute (default - do not set) or with alist
attribute:combobox
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Telephone
state, the rules in this section apply.
The input
element represents a control for editing a telephone number
given in the element’s value.
If the element is mutable, its value should be editable by the user. User agents may change the spacing and, with care, the punctuation of values that the user enters. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the element’s value.
The value
attribute, if specified, must have a value that
contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters.
The value sanitization algorithm is as follows: Strip line breaks from the value.
Unlike the URL
and E-mail
types, the Telephone
type does not enforce a particular syntax. This is
intentional; in practice, telephone number fields tend to be free-form fields, because there are a
wide variety of valid phone numbers. Systems that need to enforce a particular format are
encouraged to use the pattern
attribute or the setCustomValidity()
method to hook into the client-side
validation mechanism.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocomplete
, list
, maxlength
, minlength
, pattern
, placeholder
, readonly
, required
, and size
content attributes; list
, selectionStart
, selectionEnd
, selectionDirection
, and value
IDL attributes; select()
, setRangeText()
, and setSelectionRange()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, max
, min
, multiple
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, valueAsDate
, and valueAsNumber
IDL attributes; stepDown()
and stepUp()
methods.
4.10.5.1.4. URL
state (type="url"
)
- Allowed ARIA role attribute values:
-
textbox
with nolist
attribute (default - do not set) or with alist
attribute:combobox
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the URL
state, the rules in this section apply.
The input
element represents a control for editing a single absolute URL given in the element’s value.
If the element is mutable, the user agent should allow the user to change the URL represented by its value. User agents may allow the user to set the value to a string that is not a valid absolute URL, but may also or instead automatically escape characters entered by the user so that the value is always a valid absolute URL (even if that isn’t the actual value seen and edited by the user in the interface). User agents should allow the user to set the value to the empty string. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the value.
The value
attribute, if specified and not empty, must
have a value that is a valid URL potentially surrounded by spaces that is also an absolute URL.
The value sanitization algorithm is as follows: Strip line breaks from the value, then strip leading and trailing white space from the value.
Constraint validation: While the value of the element is neither the empty string nor a valid absolute URL, the element is suffering from a type mismatch.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocapitalize
, autocomplete
, list
, maxlength
, minlength
, pattern
, placeholder
, readonly
, required
, and size
content attributes; list
, selectionStart
, selectionEnd
, selectionDirection
, and value
IDL attributes; select()
, setRangeText()
, and setSelectionRange()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, max
, min
, multiple
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, valueAsDate
, and valueAsNumber
IDL attributes; stepDown()
and stepUp()
methods.
<input type="url" name="location" list="urls"> <datalist id="urls"> <option label="MIME: Format of Internet Message Bodies" value="https://tools.ietf.org/html/rfc2045"> <option label="HTML 4.01 Specification" value="https://www.w3.org/TR/html4/"> <option label="Form Controls" value="https://www.w3.org/TR/xforms/slice8.html#ui-commonelems-hint"> <option label="Scalable Vector Graphics (SVG) 1.1 Specification" value="https://www.w3.org/TR/SVG/"> <option label="Feature Sets - SVG 1.1 - 20030114" value="https://www.w3.org/TR/SVG/feature.html"> <option label="The Single UNIX Specification, Version 3" value="https://www.unix-systems.org/version3/"> </datalist>
...and the user had typed "www.w3", and the user agent had also found that the user
had visited https://www.w3.org/Consortium/#membership
and https://www.w3.org/TR/XForms/
in the recent past, then the rendering might look
like this:
The first four URLs in this sample consist of the four URLs in the author-specified list that match the text the user has entered, sorted in some user agent-defined manner (maybe by how frequently the user refers to those URLs). Note how the user agent is using the knowledge that the values are URLs to allow the user to omit the scheme part and perform intelligent matching on the domain name.
The last two URLs (and probably many more, given the scrollbar’s indications of more values being available) are the matches from the user agent’s session history data. This data is not made available to the page DOM. In this particular case, the user agent has no titles to provide for those values.
4.10.5.1.5. E-mail
state (type="email"
)
- Allowed ARIA role attribute values:
-
textbox
with nolist
attribute (default - do not set) or with alist
attribute:combobox
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the E-mail
state, the rules in this section apply.
User agents may transform the values for display and editing.
User agents should convert punycode in the domain labels of the value to Internationalized Domain Names in the display, and vice versa.
User agents should allow the user to set the value to a string that is not a valid e-mail address or valid e-mail address list.
User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the value.
Some aspects of how the E-mail
state operates depend on whether the multiple
attribute is present.
- When the
multiple
attribute is not specified on the element -
The
input
element represents a control for editing an e-mail address given in the element’s value.If the element is mutable, the user agent should allow the user to change the e-mail address represented by its value, including setting the value to the empty string.
The user agent should act in a manner consistent with expecting the user to provide a single e-mail address.
Constraint validation: While the user interface is representing input that the user agent cannot convert to a valid email address, the control is suffering from bad input.
The
value
attribute, if specified and not empty, must have a value that is a single valid e-mail address.The value sanitization algorithm is as follows: Strip line breaks from the value, then strip leading and trailing white space from the value.
Constraint validation: While the value of the element is neither the empty string nor a single valid e-mail address, the element is suffering from a type mismatch.
- When the
multiple
attribute is specified on the element -
The
input
element represents a control for adding, removing, and editing a list of e-mail addresses given in the element’s values.If the element is mutable, the user agent should allow the user to add, remove, and edit the e-mail addresses represented by its values, including removing all addresses and setting the value to the empty string.
User agents may allow the user to set any individual value in the list of values to a string that is not a valid e-mail address, but must not allow users to set any individual value to a string containing U+002C COMMA (,) as well as the U+000A LINE FEED (LF), or U+000D CARRIAGE RETURN (CR) characters.
Constraint validation: While the user interface describes a situation where an individual value contains a U+002C COMMA (,) or is representing input that the user agent cannot convert to a valid email address, the control is suffering from bad input.
Whenever the user changes the element’s values, the user agent must run the following steps:
- Let latest values be a copy of the element’s values.
- Strip leading and trailing white space from each value in latest values.
- Let the element’s value be the result of concatenating all the values in latest values, separating each value from the next by a single U+002C COMMA character (,), maintaining the list’s order.
The
value
attribute, if specified, must have a value that is a valid e-mail address list.The value sanitization algorithm is as follows:
- Split on commas the element’s value, strip leading and trailing white space from each resulting token, if any, and let the element’s values be the (possibly empty) resulting list of (possibly empty) tokens, maintaining the original order.
- Let the element’s value be the result of concatenating the element’s values, separating each value from the next by a single U+002C COMMA character (,), maintaining the list’s order.
Constraint validation: While the value of the element is not a valid e-mail address list, the element is suffering from a type mismatch.
When the multiple
attribute is set or removed, the
user agent must run the value sanitization algorithm.
A valid e-mail address is defined in [RFC6531].
A user agent should present and consume Unicode text in the user interface, and expose it to other applications, except when sending to a Mail Transfer Agent that does not support SMTPUTF8 [RFC6531].
This allows fully internationalised email addresses such as 我買@屋企.香港, and e-mail addresses with Internationalised Domain Names as defined by [RFC5890], such as example@яндекс.рф.
A valid e-mail address list is a set of comma-separated tokens, where each token is itself a valid e-mail address. To obtain the list of tokens from a valid e-mail address list, an implementation must split the string on commas.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocapitalize
, autocomplete
, list
, maxlength
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, and size
content attributes; list
and value
IDL attributes; select()
method.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, max
, min
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
and stepUp()
methods.
4.10.5.1.6. Password
state (type="password"
)
- Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- Global aria-* attributes and
aria-required
When an input
element’s type
attribute is in
the Password state, the rules in this section
apply.
The input
element represents a one line plain text edit control for
the element’s value. The user agent should obscure the value
so that people other than the user cannot see it.
If the element is mutable, its value should be editable by the user. User agents must not allow users to insert U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters into the value.
The value
attribute, if specified, must have a value that
contains no U+000A LINE FEED (LF) or U+000D CARRIAGE RETURN (CR) characters.
The value sanitization algorithm is as follows: Strip line breaks from the value.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocapitalize
, autocomplete
, maxlength
, minlength
, pattern
, placeholder
, readonly
, required
, and size
content attributes; selectionStart
, selectionEnd
, selectionDirection
, and value
IDL attributes; select()
, setRangeText()
, and setSelectionRange()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, min
, multiple
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, list
, valueAsDate
, and valueAsNumber
IDL attributes; stepDown()
and stepUp()
methods.
4.10.5.1.7. Date
state (type="date"
)
When an input
element’s type
attribute is in
the Date
state, the rules in this section apply.
The input
element represents a control for setting the element’s value to a string representing a specific date.
date values represent a "floating" time and do not include time zone information. Care is needed when converting values of this type to or from date data types in JavaScript and other programming languages. In many cases, an implicit time-of-day and time zone are used to create a global ("incremental") time (an integer value that represents the offset from some arbitrary epoch time). Processing or conversion of these values, particularly across time zones, can change the value of the date itself. [TIMEZONE]
If the element is mutable, the user agent should allow the user to change the date represented by its value, as obtained by parsing a date from it. User agents must not allow the user to set the value to a non-empty string that is not a valid date string. If the user agent provides a user interface for selecting a date, then the value must be set to a valid date string representing the user’s selection. User agents should allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid date string, the control is suffering from bad input.
See §4.10.1.7 Date, time, and number formats for a discussion of the difference between the input format and submission format for date, time, and number form controls, and the implementation notes regarding localization of form controls.
The value
attribute, if specified and not empty, must
have a value that is a valid date string.
The value sanitization algorithm is as follows: If the value of the element is not a valid date string, then set it to the empty string instead.
The min
attribute, if specified, must have a value that is
a valid date string. The max
attribute, if
specified, must have a value that is a valid date string.
The step
attribute is expressed in days. The step scale factor is 86,400,000 (which converts the days to milliseconds, which is the base unit of comparison for
the conversion algorithms below). The default step is 1 day.
When the element is suffering from a step mismatch, the user agent may round the element’s value to the nearest date for which the element would not suffer from a step mismatch.
The change
event is fired whenever the user selects a new valid date string.
Moving focus away from the date picker component or explicitly confirming with a button are unambigous triggers that the user wants the value changed.
The event must be fired on all such cases if the new date value is different than the previous one.
User agents are not required to firing the event on intermediate values reached as the user cycles through a sequence of values. For example, user agents may employ a timeout between changes, to avoid firing too many change events.
The algorithm to convert a string to a number, given a string input,
is as follows: If parsing a date from input results in an
error, then return an error; otherwise, return the number of milliseconds elapsed from midnight
UTC on the morning of 1970-01-01 (the time represented by the value
"1970-01-01T00:00:00.0Z
") to midnight UTC on the morning of the parsed date, ignoring leap seconds.
The algorithm to convert a number to a
string, given a number input, is as follows: Return a valid date string that represents the date that, in
UTC, is current input milliseconds after midnight UTC on the morning of
1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z
").
The algorithm to convert a string to a Date
object,
given a string input, is as follows:
If parsing a date from input results
in an error, then return an error; otherwise, return a new Date
object representing midnight UTC on the morning of the parsed date.
The algorithm to convert a Date
object to a string,
given a Date
object input, is as follows: Return a valid date string that represents the date current at the
time represented by input in the UTC time zone.
See the note on historical dates in the Local Date and Time
state section.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocomplete
, list
, max
, min
, readonly
, required
, and step
content attributes; list
, value
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, stepDown()
, and stepUp()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, placeholder
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, selectionStart
, selectionEnd
, and selectionDirection
IDL attributes; setRangeText()
, and setSelectionRange()
methods.
4.10.5.1.8. Month
state (type="month"
)
When an input
element’s type
attribute is in
the Month state, the rules in this section apply.
The input
element represents a control for setting the element’s value to a string representing a specific month.
If the element is mutable, the user agent should allow the user to change the month represented by its value, as obtained by parsing a month from it. User agents must not allow the user to set the value to a non-empty string that is not a valid month string. If the user agent provides a user interface for selecting a month, then the value must be set to a valid month string representing the user’s selection. User agents should allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid month string, the control is suffering from bad input.
See §4.10.1.7 Date, time, and number formats for a discussion of the difference between the input format and submission format for date, time, and number form controls, and the implementation notes regarding localization of form controls.
The value
attribute, if specified and not empty, must
have a value that is a valid month string.
The value sanitization algorithm is as follows: If the value of the element is not a valid month string, then set it to the empty string instead.
The min
attribute, if specified, must have a value that is
a valid month string. The max
attribute, if
specified, must have a value that is a valid month string.
The step
attribute is expressed in months. The step scale factor is 1
(units of whole months are the base unit of comparison for the conversion algorithms below).
The default step is 1 month.
When the element is suffering from a step mismatch, the user agent may round the element’s value to the nearest month for which the element would not suffer from a step mismatch.
The algorithm to convert a string to a number, given a string input, is as follows: If parsing a month from input results in an error, then return an error; otherwise, return the number of months between January 1970 and the parsed month.
The algorithm to convert a number to a string, given a number input, is as follows: Return a valid month string that represents the month that has input months between it and January 1970.
The algorithm to convert a string to a Date
object, given a string input, is as follows:
If parsing a month from input results in an error, then return an error; otherwise, return a
new Date
object representing midnight UTC on the morning of the first day of
the parsed month.
The algorithm to convert a Date
object to a string,
given a Date
object input, is as follows:
Return a valid month string that
represents the month current at the time represented by input in the UTC time zone.
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocomplete
, list
, max
, min
, readonly
, required
, and step
content attributes; list
, value
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, stepDown()
, and stepUp()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, placeholder
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, selectionStart
, selectionEnd
, and selectionDirection
IDL attributes; setRangeText()
, and setSelectionRange()
methods.
4.10.5.1.9. Week
state (type="week"
)
When an input
element’s type
attribute is in
the Week state, the rules in this section apply.
The input
element represents a control for setting the element’s value to a string representing a specific week beginning on a Monday, at midnight UTC.
If the element is mutable, the user agent should allow the user to change the week represented by its value, as obtained by parsing a week from it. User agents must not allow the user to set the value to a non-empty string that is not a valid week string. If the user agent provides a user interface for selecting a week, then the value must be set to a valid week string representing the user’s selection. User agents should allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid week string, the control is suffering from bad input.
See §4.10.1.7 Date, time, and number formats for a discussion of the difference between the input format and submission format for date, time, and number form controls, and the implementation notes regarding localization of form controls.
The value
attribute, if specified and not empty, must
have a value that is a valid week string.
The value sanitization algorithm is as follows: If the value of the element is not a valid week string, then set it to the empty string instead.
The min
attribute, if specified, must have a value that is
a valid week string. The max
attribute, if
specified, must have a value that is a valid week string.
The step
attribute is expressed in weeks. The step scale factor is 604,800,000
(which converts the weeks to milliseconds, which is the base unit of comparison for the conversion
algorithms below). The default step is 1 week. The default step base is -259,200,000
(the start of week 1970-W01 which is the Monday 3 days before 1970-01-01).
When the element is suffering from a step mismatch, the user agent may round the element’s value to the nearest week for which the element would not suffer from a step mismatch.
The algorithm to convert a string to a
number, given a string input, is as follows: If parsing a week string from input results in
an error, then return an error; otherwise, return the number of milliseconds elapsed from midnight
UTC on the morning of 1970-01-01 (the time represented by the value
"1970-01-01T00:00:00.0Z
") to midnight UTC on the morning of the Monday of the
parsed week, ignoring leap seconds.
The algorithm to convert a number to a string, given a number input, is as follows: Return a valid week string that represents the week that, in
UTC, is current input milliseconds after midnight UTC on the morning of
1970-01-01 (the time represented by the value "1970-01-01T00:00:00.0Z
").
The algorithm to convert a string to a Date
object, given a string input, is as follows:
If parsing a week from input results
in an error, then return an error; otherwise, return a new Date
object representing midnight UTC on the morning of the Monday of the
parsed week.
The algorithm to convert a Date
object to a string, given a Date
object input, is as follows: Return a valid week string that
represents the week current at the time represented by input in the UTC time zone.
The following common input
element content attributes, IDL attributes, and
methods apply to the element: autocomplete
, list
, max
, min
, readonly
, required
, and step
content attributes; list
, value
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, stepDown()
, and stepUp()
methods.
The value
IDL attribute is in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, placeholder
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, selectionStart
, selectionEnd
, and selectionDirection
IDL attributes; setRangeText()
, and setSelectionRange()
methods.
4.10.5.1.10. Time
state (type="time"
)
When an input
element’s type
attribute is in
the Time state, the rules in this section apply.
The input
element represents a control for setting the element’s value to a string representing a specific time.
If the element is mutable, the user agent should allow the user to change the time represented by its value, as obtained by parsing a time from it. User agents must not allow the user to set the value to a non-empty string that is not a valid time string. If the user agent provides a user interface for selecting a time, then the value must be set to a valid time string representing the user’s selection. User agents should allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid time string, the control is suffering from bad input.
See §4.10.1.7 Date, time, and number formats for a discussion of the difference between the input format and submission format for date, time, and number form controls, and the implementation notes regarding localization of form controls.
The value
attribute, if specified and not empty, must
have a value that is a valid time string.
The value sanitization algorithm is as follows: If the value of the element is not a valid time string, then set it to the empty string instead.
The form control has a periodic domain.
The min
attribute, if specified, must have a value that is
a valid time string. The max
attribute, if
specified, must have a value that is a valid time string.
The step
attribute is expressed in seconds. The step scale factor is 1000
(which converts the seconds to milliseconds, which is the base unit of comparison for the
conversion algorithms below). The default step is 60 seconds.
When the element is suffering from a step mismatch, the user agent may round the element’s value to the nearest time for which the element would not suffer from a step mismatch.
The algorithm to convert a string to a number, given a string input, is as follows: If parsing a time from input results in an error, then return an error; otherwise, return the number of milliseconds elapsed from midnight to the parsed time on a day with no time changes.
The algorithm to convert a number to a string, given a number input, is as follows: Return a valid time string that represents the time that is input milliseconds after midnight on a day with no time changes.
The algorithm to convert a string to a Date
object, given a string input, is as follows:
If parsing a time from input results
in an error, then return an error; otherwise, return a new Date
object representing the parsed time in
UTC on 1970-01-01.
The algorithm to convert a Date
object to a string,
given a Date
object input, is as follows: Return a valid time string that
represents the UTC time component that is represented by input.
The following common input
element content attributes, IDL attributes, and
methods apply to the element: autocomplete
, list
, max
, min
, readonly
, required
, and step
content attributes; list
, value
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, stepDown()
, and stepUp()
methods.
The value
IDL attribute is in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, placeholder
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, selectionStart
, selectionEnd
, and selectionDirection
IDL attributes; setRangeText()
, and setSelectionRange()
methods.
4.10.5.1.11. Local Date and Time
state (type="datetime-local"
)
When an input
element’s type
attribute is in
the Local Date and Time
state, the rules in
this section apply.
The input
element represents a control for setting the element’s value to a string representing a Local Date and Time
,
with no time-zone offset information.
If the element is mutable, the user agent should allow the
user to change the date and time represented by its value, as obtained by parsing a date and time from it.
User agents must not allow the user to set the value to a non-empty string
that is not a valid normalized global date and time string.
If the user agent provides a user interface for selecting a Local Date and Time
, then the value must be set to a valid normalized global date and time string representing the user’s selection. User agents should allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid normalized global date and time string, the control is suffering from bad input.
The Local Date and Time
state and other date-related states are not
useful for vague values, and are only useful for dates ranging from recent history through a
few thousand years. For example, "one millisecond after the big bang", "the Ides of March, 44BC",
"the early part of the Jurassic period", or "a winter around 250 BCE", and many other expressions
of time cannot be sensibly expressed in HTML form
states.
For the input of dates before the introduction of the Gregorian calendar, authors are
encouraged to not use the Local Date and Time
state (and
the other date- and time-related states described in subsequent sections), as user agents are not
required to support converting dates and times from earlier periods to the Gregorian calendar,
and asking users to do so manually puts an undue burden on users. (This is complicated by the
manner in which the Gregorian calendar was phased in, which occurred at different times in
different countries, ranging from partway through the 16th century all the way to early in the
20th.) Instead, authors are encouraged to provide fine-grained input controls using the select
element and input
elements with the Number
state.
See §4.10.1.7 Date, time, and number formats for a discussion of the difference between the input format and submission format for date, time, and number form controls, and the implementation notes regarding localization of form controls.
Applications need to use care when working with datetime-local
values,
since most date time objects (in languages such as JavaScript or server-side languages such as Java) use
incremental time values tied to the UTC time zone. Implicit conversion of a floating time value to an incremental
time can cause the actual value used to be different from user expectations.
For more information, refer to: Working with Time Zones §floating
The value
attribute, if specified and not empty, must
have a value that is a valid floating date and time string.
The value sanitization algorithm is as follows: If the value of the element is a valid floating date and time string, then set it to a valid normalized floating date and time string representing the same date and time; otherwise, set it to the empty string instead.
The min
attribute, if specified, must have a value that is
a valid floating date and time string. The max
attribute, if specified, must have a value that is a valid floating date and time string.
The step
attribute is expressed in seconds. The step scale factor is 1000
(which converts the seconds to milliseconds, which is the base unit of comparison for the
conversion algorithms below). The default step is 60 seconds.
When the element is suffering from a step mismatch, the user agent may round the element’s value to the nearest floating date and time for which the element would not suffer from a step mismatch.
The algorithm to convert a string to a number, given a string input, is as follows: If parsing a date and time from input results in an error, then return an error; otherwise, return the number of
milliseconds elapsed from midnight on the morning of 1970-01-01 (the time represented by the value
"1970-01-01T00:00:00.0
") to the parsed floating date and time, ignoring leap seconds.
The algorithm to convert a number to a string, given a number input, is as follows: Return a valid normalized floating date and time string that represents the date and time that is input milliseconds after midnight on the morning of 1970-01-01 (the time
represented by the value "1970-01-01T00:00:00.0
").
The following common input
element content
attributes, IDL attributes, and methods apply to the element: autocomplete
, list
, max
, min
, readonly
, required
, and step
content attributes; list
, value
, and valueAsNumber
IDL attributes; select()
, stepDown()
, and stepUp()
methods.
The value
IDL attribute is
in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not
apply to the element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, placeholder
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the
element: checked
, files
, selectionStart
, selectionEnd
, selectionDirection
, and valueAsDate
IDL attributes; setRangeText()
, and setSelectionRange()
methods.
input
element with its type
attribute set to datetime-local
,
and it then interprets the given date and time in the time zone of the selected airport.
<fieldset> <legend>Destination</legend> <div> <label> Airport: <input type="text" name="to" list="airports"> </label> </div> <div> <label> Departure time: <input type="datetime-local" name="totime" step="3600"> </label> </div> </fieldset> <datalist id="airports"> <option value="ATL" label="Atlanta"> <option value="MEM" label="Memphis"> <option value="LHR" label="London Heathrow"> <option value="LAX" label="Los Angeles"> <option value="FRA" label="Frankfurt"> </datalist>
4.10.5.1.12. Number
state (type="number"
)
- Allowed ARIA role attribute values:
-
spinbutton
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Number
state, the rules in this section apply.
The input
element represents a control for setting the element’s value to a string representing a number.
If the element is mutable, the user agent should allow the user to change the number represented by its value, as obtained from applying the rules for parsing floating-point number values to it. User agents must not allow the user to set the value to a non-empty string that is not a valid floating-point number. If the user agent provides a user interface for selecting a number, then the value must be set to the best representation of the number representing the user’s selection as a floating-point number. User agents should allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid floating-point number, the control is suffering from bad input.
See §4.10.1.7 Date, time, and number formats for a discussion of the difference between the input format and submission format for date, time, and number form controls, and the implementation notes regarding localization of form controls.
The value
attribute, if specified and not empty, must
have a value that is a valid floating-point number.
The value sanitization algorithm is as follows: If the value of the element is not a valid floating-point number, then set it to the empty string instead.
The min
attribute, if specified, must have a value that is
a valid floating-point number. The max
attribute,
if specified, must have a value that is a valid floating-point number.
The step scale factor is 1. The default step is 1 (allowing only integers to be selected by the user, unless the step base has a non-integer value).
When the element is suffering from a step mismatch, the user agent may round the element’s value to the nearest number for which the element would not suffer from a step mismatch. If there are two such numbers, user agents are encouraged to pick the one nearest positive infinity.
The algorithm to convert a string to a number, given a string input, is as follows: If applying the rules for parsing floating-point number values to input results in an error, then return an error; otherwise, return the resulting number.
The algorithm to convert a number to a string, given a number input, is as follows: Return a valid floating-point number that represents input.
The following common input
element content attributes, IDL attributes, and
methods apply to the element: autocomplete
, list
, max
, min
, placeholder
, readonly
, required
, and step
content attributes; list
, value
, and valueAsNumber
IDL attributes; select()
, stepDown()
, and stepUp()
methods.
The value
IDL attribute is in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, selectionStart
, selectionEnd
, selectionDirection
, and valueAsDate
IDL attributes; setRangeText()
, and setSelectionRange()
methods.
<label> How much do you want to charge? $<input type="number" min="0" step="0.01" name="price"> </label>
As described above, a user agent might support numeric input in the user’s local format, converting it to the format required for submission as described above. This might include handling grouping separators (as in "872,000,000,000") and various decimal separators (such as "3,99" vs "3.99") or using local digits (such as those in Arabic, Devanagari, Persian, and Thai).
The type="number"
state is not appropriate for input that
happens to only consist of numbers but isn’t strictly speaking a number. For example, it would be
inappropriate for credit card numbers or US postal codes. A simple way of determining whether to
use type="number"
is to consider whether it would make sense for the input
control to have a spinbox interface (e.g., with "up" and "down" arrows). Getting a credit card
number wrong by 1 in the last digit isn’t a minor mistake, it’s as wrong as getting every digit
incorrect. So it would not make sense for the user to select a credit card number using "up" and
"down" buttons. When a spinbox interface is not appropriate, type="text"
is
probably the right choice (possibly with a pattern
attribute).
4.10.5.1.13. Range
state (type=range
)
- Allowed ARIA role attribute values:
-
slider
(default - do not set). - Allowed ARIA state and property attributes:
-
Any
aria-*
attributes applicable to the allowed roles.
When an input
element’s type
attribute is in the Range
state, the rules
in this section apply.
The input
element represents a control for setting the element’s value to a string representing a number, but with the caveat that the exact
value is not important, letting user agents provide a simpler interface than they do for the Number
state.
If the element is mutable, the user agent should allow the user to change the number represented by its value, as obtained from applying the rules for parsing floating-point number values to it. User agents must not allow the user to set the value to a string that is not a valid floating-point number. If the user agent provides a user interface for selecting a number, then the value must be set to a best representation of the number representing the user’s selection as a floating-point number. User agents must not allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid floating-point number, the control is suffering from bad input.
The value
attribute, if specified, must have a value that is a valid floating-point number.
The value sanitization algorithm is as follows: If the value of the element is not a valid floating-point number, then set it to the best representation, as a floating-point number, of the default value.
The default value is the minimum plus half the difference between the minimum and the maximum, unless the maximum is less than the minimum, in which case the default value is the minimum.
When the element is suffering from an underflow, the user agent must set the element’s value to the best representation, as a floating-point number, of the minimum.
When the element is suffering from an overflow, if the maximum is not less than the minimum, the user agent must set the element’s value to a valid floating-point number that represents the maximum.
When the element is suffering from a step mismatch, the user agent must round the element’s value to the nearest number for which the element would not suffer from a step mismatch, and which is greater than or equal to the minimum, and, if the maximum is not less than the minimum, which is less than or equal to the maximum, if there is a number that matches these constraints. If two numbers match these constraints, then user agents must use the one nearest to positive infinity.
<input type="range" min="0" max="100" step="20" value="50">
list
attribute. This could be useful if there are values along the full range of the control that
are especially important, such as preconfigured light levels or typical speed limits in a range
control used as a speed control. The following markup fragment:
<input type="range" min="-100" max="100" value="0" step="10" name="power" list="powers"> <datalist id="powers"> <option value="0"> <option value="-30"> <option value="30"> <option value="++50"> </datalist>
...with the following style sheet applied:
input[type="range"] { height: 75px; width: 49px; background: #D5CCBB; color: #000; }
...might render as:
Note how the user agent determined the orientation of the control from the ratio of the
style-sheet-specified height and width properties. The colors were similarly derived from the
style sheet. The tick marks, however, were derived from the markup. In particular, the step
attribute has not affected the placement of tick marks, the user agent deciding
to only use the author-specified completion values and then adding longer tick marks at the
extremes.
Note how the invalid value ++50
was completely ignored.
<input name="x" type="range" min="100" max="700" step="9.09090909" value="509.090909">
A user agent could display in a variety of ways, for instance:
Or, alternatively, for instance:
The user agent could pick which one to display based on the dimensions given in the style sheet. This would allow it to maintain the same resolution for the tick marks, despite the differences in width.
<input type="range" name="a" list="a-values"> <datalist id="a-values"> <option value="10" label="Low"> <option value="90" label="High"> </datalist>
With styles that make the control draw vertically, it might look as follows:
In this state, the range and step constraints are enforced even during user input, and there is no way to set the value to the empty string.
The min
attribute, if specified, must have a value that is a valid floating-point number. The default minimum is 0. The max
attribute,
if specified, must have a value that is a valid floating-point number.
The default maximum is 100.
The step scale factor is 1. The default step is 1 (allowing only integers, unless
the min
attribute has a non-integer value).
The algorithm to convert a string to a number, given a string input, is as follows: If applying the rules for parsing floating-point number values to input results in an error, then return an error; otherwise, return the resulting number.
The algorithm to convert a number to a string, given a number input, is as follows: Return the best representation, as a floating-point number, of input.
The following common input
element content attributes, IDL attributes, and
methods apply to the element: autocomplete
, list
, max
, min
, and step
content attributes; list
, value
, and valueAsNumber
IDL attributes; stepDown()
and stepUp()
methods.
The value
IDL attribute is in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, maxlength
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, selectionStart
, selectionEnd
, selectionDirection
, and valueAsDate
IDL attributes; select()
, setRangeText()
, and setSelectionRange()
methods.
4.10.5.1.14. Color
state (type="color"
)
When an input
element’s type
attribute is in
the Color
state, the rules in this section apply.
The input
element represents a color well control, for setting the
element’s value to a string representing a simple
color.
In this state, there is always a color picked, and there is no way to set the value to the empty string.
If the element is mutable, the user agent should allow the user to change the color represented by its value, as obtained from applying the rules for parsing simple color values to it. User agents must not allow the user to set the value to a string that is not a valid lowercase simple color. If the user agent provides a user interface for selecting a color, then the value must be set to the result of using the rules for serializing simple color values to the user’s selection. User agents must not allow the user to set the value to the empty string.
Constraint validation: While the user interface describes input that the user agent cannot convert to a valid lowercase simple color, the control is suffering from bad input.
The value
attribute, if specified and not empty, must
have a value that is a valid simple color.
The value sanitization algorithm is as follows: If the value of the element is a valid simple color, then set it to the value of the element in ASCII lowercase; otherwise, set it to
the string "#000000
".
The following common input
element content attributes and IDL attributes apply to the
element: autocomplete
and list
content attributes; list
and value
IDL attributes; select()
method.
The value
IDL attribute is in mode value.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
4.10.5.1.15. Checkbox
state (type="checkbox"
)
- Allowed ARIA role attribute values:
-
checkbox
(default - do not set),button
(when used in conjunction witharia-pressed
),menuitemcheckbox
,option
orswitch
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Checkbox
state, the rules in this section apply.
The input
element represents a two-state control that represents the
element’s checkedness state. If the element’s checkedness state is true, the control represents a positive
selection, and if it is false, a negative selection. If the element’s indeterminate
IDL attribute is set to true, then the
control’s selection should be obscured as if the control was in a third, indeterminate, state.
The control is never a true tri-state control, even if the element’s indeterminate
IDL attribute is set to true. The indeterminate
IDL attribute only gives the appearance of a
third state.
If the element is mutable, then: The pre-click
activation steps consist of setting the element’s checkedness to its opposite value (i.e., true if it is false,
false if it is true), and of setting the element’s indeterminate
IDL attribute to false. The canceled
activation steps consist of setting the checkedness and the element’s indeterminate
IDL attribute back to the values they had
before the pre-click activation steps were run. The activation behavior is to fire a simple event that bubbles named input
at the element and then fire a simple event that bubbles named change
at the element.
If the element is not mutable, it has no activation behavior.
Constraint validation: If the element is required and its checkedness is false, then the element is suffering from being missing.
- input .
indeterminate
[ = value ] -
When set, overrides the rendering of
checkbox
controls so that the current value is not visible.
The following common input
element content attributes and IDL attributes apply to the element: checked
, and required
content attributes; checked
and value
IDL attributes.
The value
IDL attribute is in mode default/on.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, autocomplete
, capture
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
4.10.5.1.16. Radio Button
state (type="radio"
)
- Allowed ARIA role attribute values:
-
radio
(default - do not set) ormenuitemradio
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Radio Button
state, the rules in this section
apply.
The input
element represents a control that, when used in conjunction
with other input
elements, forms a radio button group in which only one
control can have its checkedness state set to true. If
the element’s checkedness state is true, the control
represents the selected control in the group, and if it is false, it indicates a control in the
group that is not selected.
The radio button group that contains an input
element a also contains all the other input
elements b that fulfill all
of the following conditions:
- The
input
element b’stype
attribute is in theRadio Button
state. - Either a and b have the same form owner, or they both have no form owner.
- Both a and b are in the same tree.
- They both have a
name
attribute, theirname
attributes are not empty, and the value of a’sname
attribute is a match for the value of b’sname
attribute.
A document must not contain an input
element whose radio button group contains only that element.
When any of the following phenomena occur, if the element’s checkedness state is true after the occurrence, the checkedness state of all the other elements in the same radio button group must be set to false:
- The element’s checkedness state is set to true (for whatever reason).
- The element’s
name
attribute is set, changed, or removed. - The element’s form owner changes.
- A type change is signalled for the element.
If the element R is mutable, then: The pre-click activation steps for R consist of getting a reference to the
element in R’s radio button group that has its checkedness set to true, if any, and then setting R’s checkedness to true. The canceled
activation steps for R consist of checking if the element to which a reference
was obtained in the pre-click activation steps, if any, is still in what is now R’s radio button group, if it still has one, and if so, setting that
element’s checkedness to true; or else, if there was no
such element, or that element is no longer in R’s radio button group, or
if R no longer has a radio button group, setting R’s checkedness to false. The activation behavior for R is to fire a simple event that bubbles named input
at R and then fire a simple event that bubbles named change
at R.
If the element is not mutable, it has no activation behavior.
Constraint validation: If an element in the radio button group is required, and all of the input
elements in the radio button group have a checkedness that is
false, then the element is suffering from being missing.
If none of the radio buttons in a radio button group are checked when they are inserted into the document, then they will all be initially unchecked in the interface, until such time as one of them is checked (either by the user or by script).
The following common input
element content attributes and IDL attributes apply to
the element: checked
and required
content attributes; checked
and value
IDL attributes.
The value
IDL attribute is in mode default/on.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, autocomplete
, capture
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
4.10.5.1.17. File Upload
state (type="file"
)
When an input
element’s type
attribute is in
the File Upload
state, the rules in this section
apply.
The input
element represents a list of selected files, each file
consisting of a file name, a file type, and a file body (the contents of the file).
File names must not contain path components, even
in the case that a user has selected an entire directory hierarchy or multiple files with the same
name from different directories. Path components, for
the purposes of the File Upload
state, are those parts
of file names that are separated by U+005C REVERSE SOLIDUS character (\) characters.
Unless the multiple
attribute is set, there must be no more than one file in the
list of selected files.
If the element is mutable, then the element’s activation behavior is to run the following steps:
- If the algorithm is not allowed to show a popup, then abort these steps without doing anything else.
- Return, but continue running these steps in parallel.
- Optionally, wait until any prior execution of this algorithm has terminated.
- Display a prompt to the user requesting that the user specify some files. If the
multiple
attribute is not set, there must be no more than one file selected; otherwise, any number may be selected. Files can be from the filesystem or created on the fly, e.g., a picture taken from a camera connected to the user’s device. - Wait for the user to have made their selection.
- Queue a task to first update the element’s selected files so that it represents the user’s
selection, then fire a simple event that bubbles named
input
at theinput
element, and finally fire a simple event that bubbles namedchange
at theinput
element.
If the element is mutable, the user agent should allow the
user to change the files on the list in other ways also, e.g., adding or removing files by
drag-and-drop. When the user does so, the user agent must queue a task to first
update the element’s selected files so that
it represents the user’s new selection, then fire a simple event that bubbles named input
at the input
element, and finally fire a simple event that bubbles named change
at the input
element.
If the element is not mutable, it has no activation behavior and the user agent must not allow the user to change the element’s selection.
Constraint validation: If the element is required and the list of selected files is empty, then the element is suffering from being missing.
The accept
attribute may be specified to
provide user agents with a hint of what file types will be accepted.
If specified, the attribute must consist of a set of comma-separated tokens, each of which must be an ASCII case-insensitive match for one of the following:
- The string "
audio/*
" - Indicates that sound files are accepted.
- The string "
video/*
" - Indicates that video files are accepted.
- The string "
image/*
" - Indicates that image files are accepted.
- A valid MIME type with no parameters
- Indicates that files of the specified type are accepted.
- A string whose first character is a U+002E FULL STOP character (.)
- Indicates that files with the specified file extension are accepted.
The tokens must not be ASCII case-insensitive matches for any of the other tokens (i.e., duplicates are not allowed). To obtain the list of tokens from the attribute, the user agent must split the attribute value on commas.
User agents may use the value of this attribute to display a more appropriate user interface
than a generic file picker. For instance, given the value image/*
, a user
agent could offer the user the option of using a local camera or selecting a photograph from their
photo collection; given the value audio/*
, a user agent could offer the user
the option of recording a clip using a headset microphone.
User agents should prevent the user from selecting files that are not accepted by one (or more) of these tokens.
Authors are encouraged to specify both any MIME types and any corresponding extensions when looking for data in a specific format.
<input type="file" accept=".doc,.docx,.xml,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document">
On platforms that only use file extensions to describe file types, the extensions listed here can be used to filter the allowed documents, while the MIME types can be used with the system’s type registration table (mapping MIME types to extensions used by the system), if any, to determine any other extensions to allow. Similarly, on a system that does not have file names or extensions but labels documents with MIME types internally, the MIME types can be used to pick the allowed files, while the extensions can be used if the system has an extension registration table that maps known extensions to MIME types used by the system.
Extensions tend to be ambiguous (e.g., there are an untold number of formats
that use the ".dat
" extension, and users can typically quite easily rename
their files to have a ".doc
" extension even if they are not Microsoft Word
documents), and MIME types tend to be unreliable (e.g., many formats have no formally registered
types, and many formats are in practice labeled using a number of different MIME types). Authors
are reminded that, as usual, data received from a client should be treated with caution, as it may
not be in an expected format even if the user is not hostile and the user agent fully obeyed the accept
attribute’s requirements.
value
IDL attribute prefixes
the file name with the string "C:\fakepath\
". Some legacy user agents
actually included the full path (which was a security vulnerability). As a result of this,
obtaining the file name from the value
IDL attribute in a
backwards-compatible way is non-trivial. The following function extracts the file name in a
suitably compatible manner:
function extractFilename(path) { if (path.substr(0, 12) == "C:\\fakepath\\") return path.substr(12); // modern browser var x; x = path.lastIndexOf('/'); if (x >= 0) // Unix-based path return path.substr(x+1); x = path.lastIndexOf('\\'); if (x >= 0) // Windows-based path return path.substr(x+1); return path; // just the file name }
This can be used as follows:
<div> <label> Choose file: <input type="file" name="image" onchange="updateFilename(this.value)"> </label> </div> <p> The name of the file you picked is: <span id="filename">(none)</span>. </p> <script> function updateFilename(path) { var name = extractFilename(path); document.getElementById("filename").textContent = name; } </script>
input
element content attributes and IDL attributes apply to the element: accept
, capture
, multiple
, and required
content attributes; files
and value
IDL attributes; select()
method.
The value
IDL attribute is in mode filename.
The input
and change
events apply.
The following content attributes must not be specified and do not apply to the
element: alt
, autocapitalize
, autocomplete
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, pattern
, placeholder
, readonly
, size
, src
, step
, and width
.
The element’s value
attribute must be omitted.
The following IDL attributes and methods do not apply to the element: checked
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
4.10.5.1.18. Submit Button
state (type="submit"
)
- Allowed ARIA role attribute values:
-
button
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Submit Button
state, the rules in this section
apply.
The input
element represents a button that, when activated, submits
the form. If the element has a value
attribute,
the button’s label must be the value of that attribute;
otherwise, it must be an implementation-defined string that means "Submit" or some such.
The element is a button, specifically a submit button.
Since the default label is implementation-defined, and the width of the button typically depends on the button’s label, the button’s width can leak a few bits of fingerprintable information. These bits are likely to be strongly correlated to the identity of the user agent and the user’s locale.
If the element is mutable, then the element’s activation behavior is as follows: if the element has a form owner,
and the element’s node document is fully active, submit the form owner from the input
element; otherwise, do nothing.
If the element is not mutable, it has no activation behavior.
The formaction
, formenctype
, formmethod
, formnovalidate
, and formtarget
attributes are attributes for form
submission.
The formnovalidate
attribute can be
used to make submit buttons that do not trigger the constraint validation.
The following common input
element content attributes and IDL attributes apply to the element: formaction
, formenctype
, formmethod
, formnovalidate
, and formtarget
content attributes; value
IDL attribute.
The value
IDL attribute is in mode default.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, autocomplete
, capture
, checked
, dirname
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
The input
and change
events do not apply.
4.10.5.1.19. Image Button
state (type="image"
)
- Allowed ARIA role attribute values:
-
button
(default - do not set),link
,menuitem
,menuitemcheckbox
,menuitemradio
,radio
orswitch
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Image Button
state, the rules in this section
apply.
The input
element represents either an image from which a user can
select a coordinate and submit the form, or alternatively a button from which the user can submit
the form. The element is a button, specifically a Submit Button
.
The coordinate is sent to the server during form submission by sending two entries for the element, derived from the name
of the control but with ".x
" and ".y
" appended to the
name with the x and y components of the coordinate
respectively.
The image is given by the src
attribute. The src
attribute must be present, and must contain a valid
non-empty URL potentially surrounded by spaces referencing a non-interactive, optionally
animated, image resource that is neither paged nor scripted.
When any of the these events occur
- the
input
element’stype
attribute is first set to theImage Button
state (possibly when the element is first created), and thesrc
attribute is present - the
input
element’stype
attribute is changed back to theImage Button
state, and thesrc
attribute is present, and its value has changed since the last time thetype
attribute was in theImage Button
state - the
input
element’stype
attribute is in theImage Button
state, and thesrc
attribute is set or changed
then unless the user agent cannot support images, or its support for images has been disabled,
or the user agent only fetches images on demand, or the src
attribute’s value is the empty string, the user agent must parse the value of the src
attribute value, relative to the element’s node document, and if that is successful, run these substeps:
- Let request be a new request whose URL is the resulting URL string, client is the element’s node document’s
Window
object’s environment settings object, type is "image
", destination is "subresource
", omit-Origin
-header flag is set, credentials mode is "include
", and whose use-URL-credentials flag is set. - Fetch request.
Fetching the image must delay the load event of the element’s node document until the task that is queued by the networking task source once the resource has been fetched (defined below) has been run.
If the image was successfully obtained, with no network errors, and the image’s type is a supported image type, and the image is a valid image of that type, then the image is said to be available. If this is true before the image is completely downloaded, each task that is queued by the networking task source while the image is being fetched must update the presentation of the image appropriately.
The user agent should apply the image sniffing rules to determine the type of the image, with the image’s associated Content-Type headers giving the official type. If these rules are not applied, then the type of the image must be the type given by the image’s associated Content-Type headers.
User agents must not support non-image resources with the input
element. User
agents must not run executable code embedded in the image resource. User agents must only display
the first page of a multipage resource. User agents must not allow the resource to act in an
interactive fashion, but should honor any animation in the resource.
The task that is queued by the networking task source once the resource has been fetched, must, if the
download was successful and the image is available, queue a task to fire a simple event named load
at the input
element; and otherwise, if the fetching
process fails without a response from the remote server, or completes but the image is not a valid
or supported image, queue a task to fire a simple event named error
on the input
element.
The alt
attribute provides the textual label for
the button for users and user agents who cannot use the image. The alt
attribute must be present, and must contain a non-empty string
giving the label that would be appropriate for an equivalent button if the image was
unavailable.
The input
element supports dimension attributes.
If the src
attribute is set, and the image is available and the user agent is configured to display that image,
then: The element represents a control for selecting a coordinate from the image specified by the src
attribute; if the element is mutable, the user agent should allow the user to select this coordinate, and the element’s activation
behavior is as follows: if the element has a form owner, and the element’s node document is fully active, take the user’s selected coordinate, and submit the input
element’s form owner from the input
element. If the user activates the control without explicitly
selecting a coordinate, then the coordinate (0,0) must be assumed.
Otherwise, the element represents a submit button whose label is given by the
value of the alt
attribute; if the element is mutable, then the element’s activation behavior is as
follows: if the element has a form owner, and the element’s node document is fully active, set the selected
coordinate to (0,0), and submit the input
element’s form owner from the input
element.
In either case, if the element is mutable but has no form owner or the element’s node document is not fully active, then its activation behavior must be to do nothing. If the element is not mutable, it has no activation behavior.
The selected coordinate must consist of an x-component and a y-component. The coordinates represent the position relative to the edge of the image, with the coordinate space having the positive x direction to the right, and the positive y direction downwards.
The x-component must be a valid integer representing a number x in the range -(borderleft+paddingleft) ≤ x ≤ width+borderright+paddingright, where width is the rendered width of the image, borderleft is the width of the border on the left of the image, paddingleft is the width of the padding on the left of the image, borderright is the width of the border on the right of the image, and paddingright is the width of the padding on the right of the image, with all dimensions given in CSS pixels.
The y-component must be a valid integer representing a number y in the range -(bordertop+paddingtop) ≤ y ≤ height+borderbottom+paddingbottom, where height is the rendered height of the image, bordertop is the width of the border above the image, paddingtop is the width of the padding above the image, borderbottom is the width of the border below the image, and paddingbottom is the width of the padding below the image, with all dimensions given in CSS pixels.
Where a border or padding is missing, its width is zero CSS pixels.
The formaction
, formenctype
, formmethod
, formnovalidate
, and formtarget
attributes are attributes for form
submission.
- image .
width
[ = value ]- image .
height
[ = value ] - image .
-
These attributes return the actual rendered dimensions of the image, or zero if the dimensions are not known.
They can be set, to change the corresponding content attributes.
The following common input
element content attributes and IDL attributes apply to the element: alt
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, src
, and width
content attributes; value
IDL attribute.
The value
IDL attribute is in mode default.
The following content attributes must not be specified and do not apply to the
element: accept
, autocapitalize
, autocomplete
, capture
, checked
, dirname
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, and step
.
The element’s value
attribute must be omitted.
The following IDL attributes and methods do not apply to the element: checked
, files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
The input
and change
events do not apply.
Many aspects of this state’s behavior are similar to the behavior of the img
element. Readers are encouraged to read that section, where many of the same
requirements are described in more detail.
<form action="/process"> <input type="image" src="map.png" name="where" alt="Show location list"> </form>
If the user clicked on the image at coordinate (127,40) then the URL used to submit the form
would be "/process?where.x=127&where.y=40
".
(In this example, it’s assumed that for users who don’t see the map, and who instead just see a button labeled "Show location list", clicking the button will cause the server to show a list of locations to pick from instead of the map.)
4.10.5.1.20. Reset Button
state (type="reset"
)
- Allowed ARIA role attribute values:
-
button
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Reset Button
state, the rules in this section
apply.
The input
element represents a button that, when activated, resets
the form. If the element has a value
attribute, the button’s label must be the value of that attribute; otherwise, it must be an
implementation-defined string that means "Reset" or some such. The element is a button.
Since the default label is implementation-defined, and the width of the button typically depends on the button’s label, the button’s width can leak a few bits of fingerprintable information. These bits are likely to be strongly correlated to the identity of the user agent and the user’s locale.
If the element is mutable, then the element’s activation behavior, if the element has a form owner and the element’s node document is fully active, is to reset the form owner; otherwise, it is to do nothing.
If the element is not mutable, it has no activation behavior.
Constraint validation: The element is barred from constraint validation.
The value
IDL attribute applies to this element and is in mode default.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, autocomplete
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
The input
and change
events do not apply.
4.10.5.1.21. Button
state (type="button"
)
- Allowed ARIA role attribute values:
-
button
(default - do not set),link
,menuitem
,menuitemcheckbox
,menuitemradio
,option
,radio
,switch
, ortab
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
When an input
element’s type
attribute is in
the Button state, the rules in this section apply.
The input
element represents a button with no default behavior. A
label for the button must be provided in the value
attribute, though it may be the empty string. If the element has a value
attribute,
the button’s label must be the value of that attribute; otherwise, it must be the empty string.
The element is a button.
If the element is mutable, the element’s activation behavior is to do nothing.
If the element is not mutable, it has no activation behavior.
Constraint validation: The element is barred from constraint validation.
The value
IDL attribute applies to this element and is in mode default.
The following content attributes must not be specified and do not apply to the
element: accept
, alt
, autocapitalize
, autocomplete
, capture
, checked
, dirname
, formaction
, formenctype
, formmethod
, formnovalidate
, formtarget
, height
, list
, max
, maxlength
, min
, minlength
, multiple
, pattern
, placeholder
, readonly
, required
, size
, src
, step
, and width
.
The following IDL attributes and methods do not apply to the element: checked
, files
, list
, selectionStart
, selectionEnd
, selectionDirection
, valueAsDate
, and valueAsNumber
IDL attributes; select()
, setRangeText()
, setSelectionRange()
, stepDown()
, and stepUp()
methods.
The input
and change
events do not apply.
4.10.5.2. Implementation notes regarding localization of form controls
This section is non-normative.
The formats shown to the user in date, time, and number controls is independent of the format used for form submission.
Browsers should use user interfaces that present locale-affected formats such as dates, times,
and numbers according to the conventions of either the locale implied by the input
element’s language or the user’s preferred locale. Using the page’s locale will ensure
consistency with page-provided data.
For example, it would be confusing to users if an American English page claimed that a Cirque De Soleil show was going to be showing on 02/03, but their browser, configured to use the British English locale, only showed the date 03/02 in the ticket purchase date picker. Using the page’s locale would at least ensure that the date was presented in the same format everywhere. (There’s still a risk that the user would end up arriving a month late, of course, but there’s only so much that can be done about such cultural differences...)
4.10.5.3. Common input
element attributes
These attributes only apply to an input
element if its type
attribute is in a state whose definition
declares that the attribute applies. When an attribute doesn’t apply to an input
element, user agents must ignore the attribute, regardless of the requirements and definitions below.
4.10.5.3.1. The maxlength
and minlength
attributes
The maxlength
attribute, when it applies,
is a form control maxlength
attribute controlled by the input
element’s dirty value flag.
The minlength
attribute, when it applies,
is a form control minlength
attribute controlled by the input
element’s dirty value flag.
If the input
element has a maximum allowed value length, then the code-unit length of the value of the element’s value
attribute must be
equal to or less than the element’s maximum allowed value length.
<label> What are you doing? <input name="status" maxlength="140"> </label>
<div> <label for="uname"> Username: </label> <input id="uname" name="u" required> </div> <div> <label for="pword"> Password: </label> <input id="pword" name="p" type="password" required minlength="12"> </div>
4.10.5.3.2. The size
attribute
The size
attribute gives the number of
characters that, in a visual rendering, the user agent is to allow the user to see while editing
the element’s value.
The size
attribute, if specified, must have a value that
is a valid non-negative integer greater than zero.
If the attribute is present, then its value must be parsed using the rules for parsing non-negative integers, and if the result is a number greater than zero, then the user agent should ensure that at least that many characters are visible.
The size
IDL attribute is limited to only
non-negative numbers greater than zero and has a default value of 20.
4.10.5.3.3. The readonly
attribute
The readonly
attribute is a boolean
attribute that controls whether or not the user can edit the form control.
When specified, the element is not mutable.
Constraint validation: If the readonly
attribute is specified
on an input
element, the element is barred from constraint validation.
The difference between disabled
and readonly
is that
read-only controls are still focusable, so the user can still select the text and interact with it,
whereas disabled controls are entirely non-interactive.
Only text controls can be made read-only.
<form action="/products" method="post" enctype="multipart/form-data"> <table> <tr> <th>Product ID</th> <th>Product name</th> <th>Price</th> <th>Action</th> </tr> <tr> <td> <input readonly name="1.pid" value="H412"> </td> <td> <input required name="1.pname" value="Floor lamp Ulke"> </td> <td> $<input required type="number" min="0" step="0.01" name="1.pprice" value="49.99"> </td> <td> <button formnovalidate="formnovalidate" name="action" value="delete:1">Delete</button> </td> </tr> <tr> <td> <input readonly name="2.pid" value="FG28"> </td> <td> <input required name="2.pname" value="Table lamp Ulke"> </td> <td> $<input required type="number" min="0" step="0.01" name="2.pprice" value="24.99"> </td> <td> <button formnovalidate="formnovalidate" name="action" value="delete:2">Delete</button> </td> </tr> <tr> <td> <input required name="3.pid" value="" pattern="[A-Z0-9]+"> </td> <td> <input required name="3.pname" value=""> </td> <td> $<input required type="number" min="0" step="0.01" name="3.pprice" value=""> </td> <td> <button formnovalidate="formnovalidate" name="action" value="delete:3">Delete</button> </td> </tr> </table> <div> <button formnovalidate="formnovalidate" name="action" value="add">Add</button> <button name="action" value="update">Save</button> </div> </form>
4.10.5.3.4. The required
attribute
The required
attribute is a boolean attribute. When specified, the element is required.
Constraint validation: If the element is required, and its value
IDL attribute applies and is in the mode value,
and the element is mutable, and the element’s value is the empty string,
then the element is suffering from being missing.
<h1>Create new account</h1> <form action="/newaccount" method="post" oninput='up2.setCustomValidity(up2.value != up.value ? "Passwords do not match." : "")'> <div> <label for="username">E-mail:</label> <input id="username" type="email" required name="un"> </div> <div> <label for="password1">Password:</label> <input id="password1" type="password" required name="up"> </div> <div> <label for="password2">Confirm password:</label> <input id="password2" type="password" name="up2"> </div> <div> <button type="submit">Create account</button> </div> </form>
required
attribute is
satisfied if any of the radio buttons in the group is
selected. Thus, in the following example, any of the radio buttons can be checked, not just the
one marked as required:
<fieldset> <legend>Did the movie pass the Bechdel test?</legend> <div> <label> <input type="radio" name="bechdel" value="no-characters"> No, there are not even two female characters in the movie. </label> </div> <div> <label> <input type="radio" name="bechdel" value="no-names"> No, the female characters never talk to each other. </label> </div> <div> <label> <input type="radio" name="bechdel" value="no-topic"> No, when female characters talk to each other it’s always about a male character. </label> </div> <div> <label> <input type="radio" name="bechdel" value="yes" required> Yes. </label> </div> <div> <label> <input type="radio" name="bechdel" value="unknown"> I don’t know. </label> </div> </fieldset>
To avoid confusion as to whether a radio button group is required or not, authors are encouraged to specify the attribute on all the radio buttons in a group. In general, authors are encouraged to avoid having radio button groups that do not have any initially checked controls in the first place, as this is a state that the user cannot return to, and is therefore generally considered a poor user interface.
4.10.5.3.5. The multiple
attribute
The multiple
attribute is a boolean attribute that indicates whether the user is to be allowed to specify more than one
value.
<label> Cc: <input type="email" multiple name="cc"> </label>
If the user had, amongst many friends in their user contacts database, two friends "Arthur Dent" (with address "art@example.net") and "Adam Josh" (with address "adamjosh@example.net"), then, after the user has typed "a", the user agent might suggest these two e-mail addresses to the user.
The page could also link in the user’s contacts database from the site:
<label> Cc: <input type="email" multiple name="cc" list="contacts"> </label> ... <datalist id="contacts"> <option value="hedral@example.cat"> <option value="pillar@example.com"> <option value="astrophy@cute.example"> <option value="astronomy@science.example.org"> </datalist>
Suppose the user had entered "bob@example.net" into this text field, and then started typing a
second e-mail address starting with "a". The user agent might show both the two friends mentioned
earlier, as well as the "astrophy" and "astronomy" values given in the datalist
element.
<label> Attachments: <input type="file" multiple name="att"> </label>
4.10.5.3.6. The pattern
attribute
The pattern
attribute specifies a regular
expression against which the control’s value, or, when the multiple
attribute applies and is set, the control’s values, are to be checked.
If specified, the attribute’s value must match the JavaScript Pattern production. [ECMA-262]
If an input
element has a pattern
attribute specified, and the attribute’s value, when compiled as a JavaScript regular expression
with only the "u
" flag specified, compiles successfully, then the resulting regular expression is the element’s compiled pattern regular expression. If the element has no such attribute, or if the
value doesn’t compile successfully, then the element has no compiled pattern regular
expression. [ECMA-262]
If the value doesn’t compile successfully, user agents are encouraged to log this fact in a developer console, to aid debugging.
Constraint validation: If the element’s value is not the empty string, and either the element’s multiple
attribute is not specified or it does not apply to the input
element given its type
attribute’s current state, and the element has a compiled pattern regular expression but that regular expression does not match the
entirety of the element’s value, then the element is suffering from a pattern mismatch.
Constraint validation: If the element’s value is not the empty string, and the element’s multiple
attribute is specified and applies to the input
element, and the element has
a compiled pattern regular expression but that regular expression does not match the
entirety of each of the element’s values, then the
element is suffering from a pattern mismatch.
The compiled pattern regular expression, when matched against a string, must have its start anchored to the start of the string and its end anchored to the end of the string.
This implies that the regular expression language used for this attribute is the
same as that used in JavaScript, except that the pattern
attribute is matched against the entire value, not just any subset (somewhat as if it implied a ^(?:
at the start of the pattern and a )$
at the
end).
When an input
element has a pattern
attribute specified, authors should provide a description of the pattern in text near the
control. Authors may also include a title
attribute to give a description of the pattern. User agents may use
the contents of this attribute, if it is present, when informing the
user that the pattern is not matched, or at any other suitable time,
such as in a tooltip or read out by assistive technology when the
control gains focus.
Relying on the title
attribute for the visual display
of text content 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,
which excludes keyboard-only users and touch-only users, such as anyone with a modern phone or
tablet).
<label> Part number: <input pattern="[0-9][A-Z]{3}" name="part" title="A part number is a digit followed by three uppercase letters."> </label>
...could cause the user agent to display an alert such as:
A part number is a digit followed by three uppercase letters.You cannot submit this form when the field is incorrect.
When a control has a pattern
attribute, the title
attribute, if used, must describe the pattern. Additional
information could also be included, so long as it assists the user in filling in the control.
Otherwise, assistive technology would be impaired.
For instance, if the title attribute contained the caption of the control, assistive technology could end up saying something like The text you have entered does not match the required pattern. Birthday, which is not useful.
user agents may still show the title
in non-error situations (for
example, as a tooltip when hovering over the control), so authors should be careful not to word title
s as if an error has necessarily occurred.
4.10.5.3.7. The min
and max
attributes
Some form controls can have explicit constraints applied limiting the allowed range of values that the user can provide. Normally, such a range would be linear and continuous. A form control can have a periodic domain, however, in which case the form control’s broadest possible range is finite, and authors can specify explicit ranges within it that span the boundaries.
Specifically, the broadest range of a type="time"
control is midnight to midnight (24 hours), and
authors can set both continuous linear ranges (such as 9pm to 11pm) and discontinuous ranges
spanning midnight (such as 11pm to 1am).
The min
and max
attributes indicate the allowed range of values for
the element.
Their syntax is defined by the section that defines the type
attribute’s current state.
If the element has a min
attribute, and the result of
applying the algorithm to convert a string to a
number to the value of the min
attribute is a number,
then that number is the element’s minimum; otherwise, if the type
attribute’s current state defines a default minimum, then that is the minimum; otherwise, the element has no minimum.
The min
attribute also defines the step base.
If the element has a max
attribute, and the result of
applying the algorithm to convert a string to a
number to the value of the max
attribute is a number,
then that number is the element’s maximum; otherwise, if the type
attribute’s current state defines a default maximum, then that is the maximum; otherwise, the element has no maximum.
If the element does not have a periodic domain, the max
attribute’s value
(the maximum) must not be less than the min
attribute’s value
(its minimum).
If an element that does not have a periodic domain has a maximum that is less than its minimum, then so long as the element has a value, it will either be suffering from an underflow or suffering from an overflow.
An element has a reversed range if it has a periodic domain and its maximum is less than its minimum.
An element has range limitations if it has a defined minimum or a defined maximum.
How these range limitations apply depends on whether the element has a multiple
attribute.
- If the element does not have a
multiple
attribute specified or if themultiple
attribute does not apply -
Constraint validation: When the element has a minimum and does not have a reversed range, and the result of applying the algorithm to convert a string to a number to the string given by the element’s value is a number, and the number obtained from that algorithm is less than the minimum, the element is suffering from an underflow.
Constraint validation: When the element has a maximum and does not have a reversed range, and the result of applying the algorithm to convert a string to a number to the string given by the element’s value is a number, and the number obtained from that algorithm is more than the maximum, the element is suffering from an overflow.
Constraint validation: When an element has a reversed range, and the result of applying the algorithm to convert a string to a number to the string given by the element’s value is a number, and the number obtained from that algorithm is more than the maximum and less than the minimum, the element is simultaneously suffering from an underflow and suffering from an overflow.
- If the element does have a
multiple
attribute specified and themultiple
attribute does apply -
Constraint validation: When the element has a minimum, and the result of applying the algorithm to convert a string to a number to any of the strings in the element’s values is a number that is less than the minimum, the element is suffering from an underflow.
Constraint validation: When the element has a maximum, and the result of applying the algorithm to convert a string to a number to any of the strings in the element’s values is a number that is more than the maximum, the element is suffering from an overflow.
<input name="bday" type="date" max="1979-12-31">
<input name="quantity" required type="number" min="1" value="1">
<input name="sleepStart" type="time" min="21:00" max="06:00" step="60" value="00:00">
4.10.5.3.8. The step
attribute
The step
attribute indicates the granularity
that is expected (and required) of the value or values,
by limiting the allowed values. The section that defines the type
attribute’s current state
also defines the default step, the step scale factor,
and in some cases the default step base,
which are used in processing the attribute as described below.
The step
attribute, if specified, must either have a
value that is a valid floating-point number that parses to a number that is greater than zero, or must have a
value that is an ASCII case-insensitive match for the string "any
".
The attribute provides the allowed value step for the element, as follows:
-
If the
step
attribute is absent, then the allowed value step is the default step multiplied by the step scale factor. -
Otherwise, if the attribute’s value is an ASCII case-insensitive match for the string "
any
", then there is no allowed value step. -
Otherwise, let step value be the result of running the rules for parsing floating-point number values, when they are applied to the
step
attribute’s value. -
If the previous step returned an error, or step value is zero, or a number less than zero, then the allowed value step is the default step multiplied by the step scale factor.
-
If the element’s
type
attribute is in theLocal Date and Time
,Date
,Month
,Week
, orTime
state, then round step value to the nearest whole number using the "round to nearest + round half up" technique, unless the value is less-than one, in which case let step value be 1. -
The allowed value step is step value multiplied by the step scale factor.
The step base is the value returned by the following algorithm:
-
If the element has a
min
content attribute, and the result of applying the algorithm to convert a string to a number to the value of themin
content attribute is not an error, then return that result and abort these steps. -
If the element has a
value
content attribute, and the result of applying the algorithm to convert a string to a number to the value of thevalue
content attribute is not an error, then return that result and abort these steps. -
If a default step base is defined for this element given its
type
attribute’s state, then return it and abort these steps. -
Return zero.
How these range limitations apply depends on whether the element has a multiple
attribute.
- If the element does not have a
multiple
attribute specified or if themultiple
attribute does not apply -
Constraint validation: When the element has an allowed value step, and the result of applying the algorithm to convert a string to a number to the string given by the value is a number, and that number is not step aligned, the element is suffering from a step mismatch.
- If the element does have a
multiple
attribute specified and themultiple
attribute does apply -
Constraint validation: When the element has an allowed value step, and the result of applying the algorithm to convert a string to a number to any of the strings in the values is a number that is not step aligned, the element is suffering from a step mismatch.
<input name="opacity" type="range" min="0" max="1" step="0.00392156863">
<label> What’s your favorite time of day? <input name="favtime" type="time" step="any"> </label>
Normally, time controls are limited to an accuracy of one minute.
4.10.5.3.9. The list
attribute
The list
attribute is used to identify an
element that lists predefined options suggested to the user.
If present, its value must be the ID of a datalist
element in the same document.
The suggestions source element is the first element in
the document in tree order to have an ID equal to the
value of the list
attribute, if that element is a datalist
element. If there is no list
attribute,
or if there is no element with that ID, or if the first element
with that ID is not a datalist
element, then there is
no suggestions source element.
If there is a suggestions source element, then, when
the user agent is allowing the user to edit the input
element’s value, the user agent should offer the suggestions represented by
the suggestions source element to the user in a manner
suitable for the type of control used. The user agent may use the suggestion’s label to identify the suggestion if appropriate.
User agents are encouraged to filter the suggestions represented by the suggestions source element when the number of suggestions is
large, including only the most relevant ones (e.g., based on the user’s input so far). No precise
threshold is defined, but capping the list at four to seven values is reasonable.
User agents that perform filtering should implement substring matching on the label
attribute.
Existing user agents filter on either value
or label
so the behavior may be inconsistent.
How user selections of suggestions are handled depends on whether the element is a control accepting a single value only, or whether it accepts multiple values:
- If the element does not have a
multiple
attribute specified or if themultiple
attribute does not apply -
When the user selects a suggestion, the
input
element’s value must be set to the selected suggestion’s value, as if the user had written that value themself. - If the element’s
type
attribute is in theRange
state and the element has amultiple
attribute specified -
When the user selects a suggestion, the user agent must identify which value in the element’s values the user intended to update, and must then update the element’s values so that the relevant value is changed to the value given by the selected suggestion’s value, as if the user had themself set it to that value.
- If the element’s
type
attribute is in theE-mail
state and the element has amultiple
attribute specified -
When the user selects a suggestion, the user agent must either add a new entry to the
input
element’s values, whose value is the selected suggestion’s value, or change an existing entry in theinput
element’s values to have the value given by the selected suggestion’s value, as if the user had themself added an entry with that value, or edited an existing entry to be that value. Which behavior is to be applied depends on the user interface in a user-agent-defined manner.
If the list
attribute does not apply, there is no suggestions source element.
<label> Homepage: <input name="hp" type="url" list="hpurls"> </label> <datalist id="hpurls"> <option value="https://www.example.com/" label="Example"> <option value="https://w3.org/" label="W3C"> </datalist>
Other URLs from the user’s history might show also; this is up to the user agent.
If the autocompletion list is merely an aid, and is not important to the content, then simply
using a datalist
element with children option
elements is enough. To
prevent the values from being rendered in legacy user agents, they need to be placed inside the value
attribute instead of inline.
<div> <label> Enter a breed: <input type="text" name="breed" list="breeds"> </label> <datalist id="breeds"> <option value="Abyssinian"> <option value="Alpaca"> <!-- ... --> </datalist> </div>
However, if the values need to be shown in legacy user agents, then fallback content can
be placed inside the datalist
element, as follows:
<div> <label> Enter a breed: <input type="text" name="breed" list="breeds"> </label> <datalist id="breeds"> <label> or select one from the list: <select name="breed"> <option value="">(none selected)</option> <option>Abyssinian</option> <option>Alpaca</option> <!-- ... --> </select> </label> </datalist> </div>
The fallback content will only be shown in user agents that don’t support datalist
. The
options, on the other hand, will be detected by all user agents, even though they are not
children of the datalist
element.
Note that if an option
element used in a datalist
is selected
, it will
be selected by default by legacy user agents (because it affects the select
), but it
will not have any effect on the input
element in user agents that support datalist
.
4.10.5.3.10. The placeholder
attribute
The placeholder
attribute represents a short hint (a word or short phrase) intended to aid the user with data entry when the
control has no value. A hint could be a sample value or a brief description of the expected
format. The attribute, if specified, must have a value that contains no U+000A LINE FEED (LF) or
U+000D CARRIAGE RETURN (CR) characters.
The placeholder
attribute should not be used as a
replacement for a label
. For a longer hint or other advisory text, place the text
next to the control.
Use of the placeholder
attribute as a replacement for a label
can reduce the
accessibility and usability of the control for a range of users including older
users and users with cognitive, mobility, fine motor skill or vision impairments.
While the hint given by the control’s label
is shown at all times, the short
hint given in the placeholder
attribute is only shown before the user enters a value. Furthermore, placeholder
text may be mistaken for
a pre-filled value, and as commonly implemented the default color of the placeholder text
provides insufficient contrast and the lack of a separate visible label
reduces the size of the hit region available for setting focus on the control.
User agents should present this hint to the user, after having stripped line breaks from it, when the element’s value is the empty string, especially if the control is not focused.
If a user agent normally doesn’t show this hint to the user when the control is focused, then the user agent should nonetheless show the hint for the control if it
was focused as a result of the autofocus
attribute, since
in that case the user will not have had an opportunity to examine the control before focusing
it.
placeholder
attribute:
<fieldset> <legend>Mail Account</legend> <div> <label> Name: <input type="text" name="fullname" placeholder="Johnny Five"> </label> </div> <div> <label> Address: <input type="email" name="address" placeholder="john@example.net"> </label> </div> <div> <label> Password: <input type="password" name="password"> </label> </div> <div> <label> Description: <input type="text" name="desc" placeholder="My Email Account"> </label> </div> </fieldset>
<input name="t1" type="tel" placeholder="‫ رقم الهاتف 1 ‮"> <input name="t2" type="tel" placeholder="‫ رقم الهاتف 2 ‮">
Here’s the same example using numeric character references instead of inline Arabic:
<input name="t1" type="tel" placeholder="‫رقم الهاتف 1‮"> <input name="t2" type="tel" placeholder="‫رقم الهاتف 2‮">
4.10.5.3.11. The autocapitalize
attribute
The autocapitalize
content attribute is an enumerated attribute. It provides a suggestion to the user agent, to help automatically capitalize text entered by the user in input
and textarea
elements. For example when an onscreen keyboard is provided, default word suggestions may be capitalized as described.
If the user agent sets capitalization automatically, the user must be able to alter the capitalization of the text they enter.
The value must be one of the following: sentences
, words
, characters
or none
.
The attribute may be omitted. The missing value default is sentences
for input
elements in the Text
and Search
states and textarea
elements, and none
for input
elements in the URL
, E-mail
, and Password
states.
When an input
or a textarea
element has an autocapitalize
attribute, text entered by the user should be capitalized as described in the following table:
4.10.5.3.12. The capture
attribute
The capture
attribute is defined in the [html-media-capture] specification.
Implementors should note the requirements for user agents defined in the [html-media-capture] specification have security and privacy implications.
The capture
attribute requests a specific microphone or camera for the media capture mechanism,
for example the user-facing and outward facing cameras on smartphones. It has one of the two values user
or environment
.
4.10.5.4. Common input
element APIs
- input .
value
[ = value ] -
Returns the current value of the form control.
Can be set, to change the value.
Throws an "
InvalidStateError
"DOMException
if it is set to any value other than the empty string when the control is aFile Upload
control. - input .
checked
[ = value ] -
Returns the current checkedness of the form control.
Can be set, to change the checkedness.
- input .
files
-
Returns a
FileList
object listing the selected files of the form control.Returns null if the control isn’t a file control.
- input .
valueAsDate
[ = value ] -
Returns a
Date
object representing the form control’s value, if applicable; otherwise, returns null.Can be set, to change the value.
Throws an "
InvalidStateError
"DOMException
if the control isn’t date- or time-based. - input .
valueAsNumber
[ = value ] -
Returns a number representing the form control’s value, if applicable;
otherwise, returns NaN.
Can be set, to change the value. Setting this to NaN will set the underlying value to the empty string.
Throws an "
InvalidStateError
"DOMException
if the control is neither date- or time-based nor numeric. - input .
stepUp
( [ n ] )- input .
stepDown
( [ n ] ) - input .
-
Changes the form control’s value by the value given in the
step
attribute, multiplied by n. The default value for n is 1.Throws "
InvalidStateError
"DOMException
if the control is neither date- or time-based nor numeric, or if thestep
attribute’s value is "any
". - input .
list
- Returns the
datalist
element indicated by thelist
attribute.
The value
IDL attribute allows scripts to
manipulate the value of an input
element. The
attribute is in one of the following modes, which define its behavior:
- value
-
On getting, it must return the current value of the element. On setting, it must set the element’s value to the new value, set the element’s dirty value flag to true, invoke the value sanitization algorithm, if the element’s
type
attribute’s current state defines one, and then, if the element has a text entry cursor position, should move the text entry cursor position to the end of the text field, unselecting any selected text and resetting the selection direction to none. - default
-
On getting, if the element has a
value
attribute, it must return that attribute’s value; otherwise, it must return the empty string. On setting, it must set the element’svalue
attribute to the new value. - default/on
-
On getting, if the element has a
value
attribute, it must return that attribute’s value; otherwise, it must return the string "on
". On setting, it must set the element’svalue
attribute to the new value. - filename
-
On getting, it must return the string "
C:\fakepath\
" followed by the name of the first file in the list of selected files, if any, or the empty string if the list is empty. On setting, if the new value is the empty string, it must empty the list of selected files; otherwise, it must throw an "InvalidStateError
"DOMException
.This "fakepath" requirement is a sad accident of history. See the example in the
File Upload
state section for more information.Since path components are not permitted in file names in the list of selected files, the "
\fakepath\
" cannot be mistaken for a path component.
The checked
IDL attribute allows scripts to
manipulate the checkedness of an input
element. On getting, it must return the current checkedness of the element; and on setting, it must set the
element’s checkedness to the new value and set the
element’s dirty checkedness flag to
true.
The files
IDL attribute allows scripts to
access the element’s selected files. On
getting, if the IDL attribute applies, it must return a FileList
object that represents the current selected files. The same object must be returned
until the list of selected files changes. If
the IDL attribute does not apply, then it must instead return
null. [FILEAPI]
The valueAsDate
IDL attribute represents
the value of the element, interpreted as a date.
On getting, if the valueAsDate
attribute does not apply, as defined for the input
element’s type
attribute’s current state, then return null. Otherwise, run
the algorithm to convert a string to a Date
object defined for that state to the element’s value; if the algorithm returned a Date
object, then
return it, otherwise, return null.
On setting, if the valueAsDate
attribute does not apply, as defined for the input
element’s type
attribute’s current state, then throw an InvalidStateError
exception; otherwise, if the new value is not null and not a Date
object throw a TypeError
exception; otherwise if the new value is null or a Date
object representing the NaN time value, then set the value of the element to the empty string; otherwise, run the algorithm to convert a Date
object to
a string, as defined for that state, on the new value, and set the value of the element to the resulting string.
The valueAsNumber
IDL attribute
represents the value of the element, interpreted as a
number.
On getting, if the valueAsNumber
attribute does not apply, as defined for the input
element’s type
attribute’s current state, then return a Not-a-Number (NaN)
value. Otherwise, if the valueAsDate
attribute applies, run the algorithm to convert a string to a Date
object defined for that state to the element’s value; if the algorithm returned a Date
object, then
return the time value of the object (the number of milliseconds from midnight UTC the
morning of 1970-01-01 to the time represented by the Date
object), otherwise, return
a Not-a-Number (NaN) value. Otherwise, run the algorithm to convert a string to a number defined for that state to the element’s value; if the
algorithm returned a number, then return it, otherwise, return a Not-a-Number (NaN) value.
On setting, if the new value is infinite, then throw a TypeError
exception.
Otherwise, if the valueAsNumber
attribute does not apply, as defined for the input
element’s type
attribute’s current state, then throw an InvalidStateError
exception. Otherwise, if the new value is a Not-a-Number (NaN)
value, then set the value of the element to the empty
string. Otherwise, if the valueAsDate
attribute applies, run the algorithm to convert a Date
object to a
string defined for that state, passing it a Date
object whose time
value is the new value, and set the value of the
element to the resulting string. Otherwise, run the algorithm to convert a number to a string, as
defined for that state, on the new value, and set the value of the element to the resulting string.
The stepDown(n)
and stepUp(n)
methods, when invoked, must run the following algorithm:
-
If the
stepDown()
andstepUp()
methods do not apply, as defined for theinput
element’stype
attribute’s current state, then throw an "InvalidStateError
"DOMException
, and abort these steps. -
If the element has no allowed value step, then throw an "
InvalidStateError
"DOMException
, and abort these steps. -
If the element has a minimum and a maximum and the minimum is greater than the maximum, then abort these steps.
-
If the element has a minimum and a maximum and there is no step aligned value greater than or equal to the element’s minimum and less than or equal to the element’s maximum, then abort these steps.
-
If applying the algorithm to convert a string to a number to the string given by the element’s value does not result in an error, then let value be the result of that algorithm. Otherwise, let value be zero.
-
Let valueBeforeStepping be value.
-
If value is not step aligned, then:
-
If the method invoked was the
stepDown()
method, then step-align value with negative preference. Otherwise step-align value with positive preference. In either case, let value be the result.This ensures that the value first snaps to a step-aligned value when it doesn’t start step-aligned. For example, starting with the followinginput
withvalue
of 3:<input type="number" value="3" min="1" max="10" step="2.6">
Invoking the
stepUp()
method will snap thevalue
to 3.6; subsequent invocations will increment the value by 2.6 (e.g., 6.2, then 8.8). Likewise, the followinginput
element in theWeek
state will also step-align in similar fashion, though in this state, thestep
value is rounded to 3, per the derivation of the allowed value step.<input type="week" value="2016-W20" min="2016-W01" max="2017-W01" step="2.6">
Invoking
stepUp()
will result in avalue
of "2016-W22
" because the nearest step-aligned value from the step base of "2016-W01
" (themin
value) with 3 weekstep
s that is greater than thevalue
of "2016-W20
" is "2016-W22
" (i.e.: W01, W04, W07, W10, W13, W16, W19, W22).
Otherwise (value is step aligned), run the following substeps:
-
Let n be the argument.
-
Let delta be the allowed value step multiplied by n.
-
If the method invoked was the
stepDown()
method, negate delta. -
Let value be the result of adding delta to value.
-
-
If the element has a minimum, and value is less than that minimum, then set value to the step-aligned minimum value with positive preference.
-
If the element has a maximum, and value is greater than that maximum, then set value to the step-aligned maximum value with negative preference.
-
If either the method invoked was the
stepDown()
method and value is greater than valueBeforeStepping, or the method invoked was thestepUp()
method and value is less than valueBeforeStepping, then abort these steps. -
Let value as string be the result of running the algorithm to convert a number to a string, as defined for the
input
element’stype
attribute’s current state, on value. -
Set the value of the element to value as string.
To determine if a value v is step aligned do the following:
This algorithm checks to see if a value falls along an input
element’s
defined step
intervals, with the interval’s origin at the step base value. It is
used to determine if the element’s value is suffering from a step mismatch and for various checks in the stepUp()
and stepDown()
methods.
-
Subtract the step base from v and let the result be relative distance.
-
If dividing the relative distance by the allowed value step results in a value with a remainder then v is not step aligned. Otherwise it is step aligned.
To step-align a value v with either negative preference or positive preference, do the following:
negative preference selects a step-aligned value that is less than or equal to v, while positive preference step-aligns with a value greater than or equal to v.
-
Subtract the step base from v and let the result be relative distance.
-
Let step interval count be the result of integer dividing (or divide and throw out any remainder) relative distance by the allowed value step.
-
Let candidate be the step interval count multiplied by the allowed value step.
-
If this algorithm was invoked with negative preference and the value of v is less than candidate, then decrement candidate by the allowed value step.
Otherwise, if this algorithm was invoked with positive preference and the value of v is greater than candidate, then increment candidate by the allowed value step.
-
The step-aligned value is candidate. Return candidate.
The list
IDL attribute must return the
current suggestions source element, if any, or null otherwise.
4.10.5.5. Common event behaviors
When the input
and change
events apply (which is the case for all input
controls other than buttons and those with the type
attribute in the state), the events are fired to indicate that the
user has interacted with the control. The
input
event fires whenever the user has modified the data of the control. The change
event fires when the value is committed, if
that makes sense for the control, or else when the control loses focus. In all cases, the input
event comes before the corresponding change
event (if any).
When an input
element has a defined activation behavior, the rules
for dispatching these events, if they apply, are given
in the section above that defines the type
attribute’s
state. (This is the case for all input
controls with the type
attribute in the Checkbox
state,
the Radio Button
state, or the File Upload
state.)
For input
elements without a defined activation behavior, but to
which these events apply, and for which the user
interface involves both interactive manipulation and an explicit commit action, then when the user
changes the element’s value, the user agent must queue a task to fire a simple event that bubbles named input
at the input
element, and any time the user
commits the change, the user agent must queue a task to fire a simple
event that bubbles named change
at the input
element.
An example of a user interface involving both interactive manipulation and a
commit action would be a Range
controls that use a
slider, when manipulated using a pointing device. While the user is dragging the control’s knob, input
events would fire whenever the position changed,
whereas the change
event would only fire when the user
let go of the knob, committing to a specific value.
For input
elements without a defined activation behavior, but to
which these events apply, and for which the user
interface involves an explicit commit action but no intermediate manipulation, then any time the
user commits a change to the element’s value, the user
agent must queue a task to first fire a simple event that bubbles named input
at the input
element, and then fire a simple event that bubbles named change
at the input
element.
An example of a user interface with a commit action would be a Color
control that consists of a single button that brings
up a color wheel: if the value only changes when the dialog
is closed, then that would be the explicit commit action. On the other hand, if manipulating the
control changes the color interactively, then there might be no commit action.
Another example of a user interface with a commit action would be a Date
control that allows both text-based user input and user
selection from a drop-down calendar: while text input does not have an explicit commit step,
selecting a date from the drop down calendar and then dismissing the drop down would be a commit
action.
The Range
control is also an example of a
user interface that has a commit action when used with a pointing device (rather than a keyboard):
during the time that the pointing device starts manipulating the slider until the time that the
slider is released, no commit action is taken (though input
events are fired as the
value is changed). Only after the slider is release is the commit action taken.
For input
elements without a defined activation behavior, but to
which these events apply, any time the user causes the
element’s value to change without an explicit commit
action, the user agent must queue a task to fire a simple event that
bubbles named input
at the input
element. The
corresponding change
event, if any, will be fired when
the control loses focus.
Examples of a user changing the element’s value would include the user typing into a text field, pasting a new value into the field, or undoing an edit in that field. Some user interactions do not cause changes to the value, e.g., hitting the "delete" key in an empty text field, or replacing some text in the field with text from the clipboard that happens to be exactly the same text.
A Range
control in the form of a
slider that the user has focused and is interacting with using a keyboard would be
another example of the user changing the element’s value without a commit step.
In the case of tasks that just fire an input
event, user agents may wait for a suitable break in the
user’s interaction before queuing the tasks; for example, a
user agent could wait for the user to have not hit a key for 100ms, so as to only fire the event
when the user pauses, instead of continuously for each keystroke.
When the user agent is to change an input
element’s value on behalf of the user (e.g., as part of a form prefilling
feature), the user agent must queue a task to first update the value accordingly, then fire a simple event that
bubbles named input
at the input
element,
then fire a simple event that bubbles named change
at the input
element.
These events are not fired in response to changes made to the values of form controls by scripts. (This is to make it easier to update the values of form controls in response to the user manipulating the controls, without having to then filter out the script’s own changes to avoid an infinite loop.)
The task source for these tasks is the user interaction task source.
4.10.6. The button
element
- Categories:
- Flow content.
- Phrasing content.
- Interactive content.
- listed, labelable, submittable, and reassociateable form-associated element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content, but there must be no interactive content descendant.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
autofocus
- Automatically focus the form control when the page is loadeddisabled
- Whether the form control is disabledform
- Associates the control with aform
elementformaction
- URL to use for §4.10.21 Form submissionformenctype
- Form data set encoding type to use for §4.10.21 Form submissionformmethod
- HTTP method to use for §4.10.21 Form submissionformnovalidate
- Bypass form control validation for §4.10.21 Form submissionformtarget
- browsing context for §4.10.21 Form submissionname
- Name of form control to use for §4.10.21 Form submission and in theform.elements
APItype
- Type of buttonvalue
- Value to be used for §4.10.21 Form submission - Allowed ARIA role attribute values:
-
button
(default - do not set),checkbox
,link
,menuitem
,menuitemcheckbox
,menuitemradio
,option
,radio
,switch
ortab
.- If
button type="menu"
:button
(default - do not set) ormenuitem
. - If
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLButtonElement
: HTMLElement { attribute boolean autofocus; attribute boolean disabled; readonly attribute HTMLFormElement? form; attribute DOMString formAction; attribute DOMString formEnctype; attribute DOMString formMethod; attribute boolean formNoValidate; attribute DOMString formTarget; attribute DOMString name; attribute DOMString type; attribute DOMString value; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); boolean reportValidity(); void setCustomValidity(DOMStringerror
); [SameObject] readonly attribute NodeList labels; };
The button
element represents a control allowing a user to trigger actions, when enabled.
It is labeled by its content.
The element is a button.
The type
attribute controls the behavior of
the button when it is activated. It is an enumerated attribute. The following table
lists the keywords and states for the attribute — the keywords in the left column map to the
states in the cell in the second column on the same row as the keyword.
Keyword | State | Brief description |
---|---|---|
submit
| submit button
| Submits the form. |
reset
| reset button
| Resets the form. |
button
| Button
| Does nothing. |
The missing value default is the submit button state.
If the type
attribute is in the submit button state, the element is specifically a submit button.
Constraint validation: If the type
attribute is in the reset button state, or the Button state, the element is barred from constrain validation.
When a button
element is not disabled,
its activation behavior element is to run the steps defined in the following list for
the current state of the element’s type
attribute:
- submit button
- If the element has a form owner and the element’s node document is fully active, the element must submit the form owner from the
button
element. - reset button
- If the element has a form owner and the element’s node document is fully active, the element must reset the form owner.
- Button
- Do nothing.
The form
attribute is used to explicitly associate the button
element with its form owner. The name
attribute represents the element’s name. The disabled
attribute is used to make the control non-interactive and
to prevent its value from being submitted. The autofocus
attribute controls focus. The formaction
, formenctype
, formmethod
, formnovalidate
, and formtarget
attributes are attributes for form submission.
The formnovalidate
attribute can be
used to make submit buttons that do not trigger the constraint validation.
The formaction
, formenctype
, formmethod
, formnovalidate
, and formtarget
must not be specified if the element’s type
attribute is not in the submit button state.
The value
attribute gives the element’s value
for the purposes of form submission. The element’s value is
the value of the element’s value
attribute, if there is
one, or the empty string otherwise.
A button (and its value) is only included in the form submission if the button itself was used to initiate the form submission.
The value
IDL attributes must reflect the content attributes of the same name.
The type
IDL attribute must reflect the content attribute of the same name, limited to only known values.
The willValidate
, validity
, and validationMessage
IDL attributes, and
the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of
the constraint validation API.
The labels
IDL attribute provides a list of the element’s label
s.
The autofocus
, disabled
, form
, and name
IDL attributes are
part of the element’s forms API.
<button type="button" onclick="alert('This 15-20 minute piece was composed by George Gershwin.')"> Show hint </button>
4.10.7. The select
element
- Categories:
- Flow content.
- Phrasing content.
- Interactive content.
- listed, labelable, submittable, resettable, and reassociateable form-associated element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Zero or more
option
,optgroup
, and script-supporting elements. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
autocomplete
- Hint for form autofill featureautofocus
- Automatically focus the form control when the page is loadeddisabled
- Whether the form control is disabledform
- Associates the control with aform
elementmultiple
- Whether to allow multiple valuesname
- Name of form control to use for §4.10.21 Form submission and in theform.elements
APIrequired
- Whether the control is required for §4.10.21 Form submissionsize
- Size of the control - Allowed ARIA role attribute values:
- With NO
multiple
orsize
attribute having value greater than1
:combobox
(default - do not set) ormenu
.- With a
multiple
orsize
attribute having a value greater than1
:listbox
(default - do not set). - With a
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLSelectElement
: HTMLElement { attribute DOMString autocomplete; attribute boolean autofocus; attribute boolean disabled; readonly attribute HTMLFormElement? form; attribute boolean multiple; attribute DOMString name; attribute boolean _required; attribute unsigned long size; readonly attribute DOMString type; [SameObject] readonly attribute HTMLOptionsCollection options; attribute unsigned long length; getter Element? item(unsigned longindex
); HTMLOptionElement? namedItem(DOMStringname
); void add((HTMLOptionElement or HTMLOptGroupElement)element
, optional (HTMLElement or long)?before
= null); void remove(); // ChildNode overload void remove(longindex
); setter void (unsigned longindex
, HTMLOptionElement?option
); [SameObject] readonly attribute HTMLCollection selectedOptions; attribute long selectedIndex; attribute DOMString value; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); boolean reportValidity(); void setCustomValidity(DOMStringerror
); [SameObject] readonly attribute NodeList labels; };
The select
element represents a control for selecting amongst a set of
options.
The multiple
attribute is a boolean
attribute. If the attribute is present, then the select
element represents a control for selecting zero or more options from the list of options. If the attribute is absent, then the select
element represents a control for selecting a single option from
the list of options.
The size
attribute gives the number of options
to show to the user. The size
attribute, if specified, must
have a value that is a valid non-negative integer greater than zero.
The display size of a select
element is the
result of applying the rules for parsing non-negative integers to the value of
element’s size
attribute, if it has one and parsing it is
successful. If applying those rules to the attribute’s value is not successful,
or if the size
attribute is absent,
then the element’s display size is 4 if the element’s multiple
content attribute is present, and 1 otherwise.
The list of options for a select
element consists of all the option
element children of the select
element, and all the option
element children of all the optgroup
element
children of the select
element, in tree order.
The required
attribute is a boolean
attribute. When specified, the user will be required to select a value before submitting
the form.
If a select
element has a required
attribute specified, does not have a multiple
attribute
specified, and has a display size of 1; and if the value of the first option
element in the select
element’s list of options (if
any) is the empty string, and that option
element’s parent node is the select
element (and not an optgroup
element), then that option
is the select
element’s placeholder label option.
If a select
element has a required
attribute specified, does not have a multiple
attribute
specified, and has a display size of 1, then the select
element must have a placeholder label option.
In practice, the requirement stated in the paragraph above can only apply when a select
element does not have a sizes
attribute
with a value greater than 1.
Constraint validation: If the element has its required
attribute specified, and either none of the option
elements in the select
element’s list of options have their selectedness set to true, or the only option
element in the select
element’s list of options with its selectedness set to true is the placeholder label option,
then the element is suffering from being missing.
If the multiple
attribute is absent, and the element
is not disabled, then the user agent should allow the
user to pick an option
element in its list
of options that is itself not disabled. Upon
this option
element being picked (whether
through a click, or using the keyboard, or any other mechanism), and before the
relevant user interaction event is queued (e.g., before the click
event), the user agent must set the selectedness of the picked option
element
to true, set its dirtiness to true, and then send select
update notifications.
If the multiple
attribute is absent, whenever an option
element in the select
element’s list of options has its selectedness set to true, and whenever an option
element with its selectedness set to true is added to the select
element’s list of options,
the user agent must set the selectedness of all
the other option
elements in its list of
options to false.
If the multiple
attribute is absent and the
element’s display size is greater than 1, then the user
agent should also allow the user to request that the option
whose selectedness is true, if any, be unselected. Upon this
request being conveyed to the user agent, and before the relevant user interaction event is queued (e.g., before the click
event), the user agent must set the selectedness of that option
element to
false, set its dirtiness to true, and then send select
update notifications.
If nodes are inserted or nodes are removed causing the list of options to gain or lose one or more option
elements, or if an option
element in the list of options asks for a reset, then, if the select
element’s multiple
attribute is absent, the user agent must run the
first applicable set of steps from the following list:
- If the
select
element’s display size is 1, and nooption
elements in theselect
element’s list of options have their selectedness set to true - Set the selectedness of the first
option
element in the list of options in tree order that is not disabled, if any, to true. - If two or more
option
elements in theselect
element’s list of options have their selectedness set to true - Set the selectedness of all but the last
option
element with its selectedness set to true in the list of options in tree order to false.
If the multiple
attribute is present, and the
element is not disabled, then the user agent should
allow the user to toggle the selectedness of the option
elements in
its list of options that are themselves not disabled. Upon such an element being toggled (either through a click, or any other mechanism), and before the
relevant user interaction event is queued (e.g., before a related click
event),
the selectedness of the option
element must
be changed (from true to false or false to true), the dirtiness of the element must be set to true, and the
user agent must send select
update notifications.
When the user agent is to send select
update notifications, queue a task to first fire a simple event that bubbles named input
at the select
element, and then fire a simple event that bubbles named change
at the select
element, using the user interaction task source as the task
source. If the JavaScript execution context stack was not empty when the user agent was
to send select
update notifications, then the resulting input
and change
events must not be trusted.
The reset algorithm for select
elements is to go through all the option
elements in the element’s list of options, set their selectedness to true if the option
element has a selected
attribute, and false otherwise,
set their dirtiness to false, and then have the option
elements ask for a reset.
The form
attribute is used to explicitly associate the select
element with its form owner.
The name
attribute represents the element’s name.
The disabled
attribute is used to make the control non-interactive and to prevent its value from being submitted.
The autofocus
attribute controls focus.
The autocomplete
attribute controls how the user agent provides autofill behavior.
A select
element that is not disabled is mutable.
- select .
type
-
Returns "
select-multiple
" if the element has amultiple
attribute, and "select-one
" otherwise. - select .
options
-
Returns an
HTMLOptionsCollection
of the list of options. - select .
length
[ = value ] -
Returns the number of elements in the list of options.
When set to a smaller number, truncates the number of
option
elements in theselect
.When set to a greater number, adds new blank
option
elements to theselect
. - element = select .
item
(index)- select[index]
-
Returns the item with index index from the list of options. The items are sorted in tree order.
- element = select .
namedItem
(name) -
Returns the first item with ID or
name
name from the list of options.Returns null if no element with that ID could be found.
- select .
add
(element [, before ] ) -
Inserts element before the node given by before.
The before argument can be a number, in which case element is inserted before the item with that number, or an element from the list of options, in which case element is inserted before that element.
If before is omitted, null, or a number out of range, then element will be added at the end of the list.
This method will throw a
HierarchyRequestError
exception if element is an ancestor of the element into which it is to be inserted. - select .
selectedOptions
-
Returns an
HTMLCollection
of the list of options that are selected. - select .
selectedIndex
[ = value ] -
Returns the index of the first selected item, if any, or -1 if there is no selected item.
Can be set, to change the selection.
- select .
value
[ = value ] -
Returns the value of the first selected item, if any, or the empty string if there is no selected item.
Can be set, to change the selection.
The type
IDL attribute, on getting, must
return the string "select-one
" if the multiple
attribute is absent, and the string "select-multiple
" if the multiple
attribute is present.
The options
IDL attribute must return an HTMLOptionsCollection
rooted at the select
node, whose filter matches
the elements in the list of options.
The options
collection is also mirrored on the HTMLSelectElement
object. The supported property indices at any instant
are the indices supported by the object returned by the options
attribute at that instant.
The length
IDL attribute must return the
number of nodes represented by the options
collection. On setting, it must act like the attribute
of the same name on the options
collection.
The item(index)
method
must return the value returned by the method of the same
name on the options
collection, when invoked with
the same argument.
The namedItem(name)
method must return the value returned by the
method of the same name on the options
collection,
when invoked with the same argument.
When the user agent is to set the value of a new
indexed property for a given property index index to a new value value, it must instead set the
value of a new indexed property with the given property index index to
the new value value on the options
collection.
Similarly, the add(element, before)
method must act like its
namesake method on that same options
collection.
The remove(index)
method must act like its
namesake method on that same options
collection when it
has arguments, and like its namesake method on the ChildNode
interface implemented by
the HTMLSelectElement
ancestor interface Element
when it has no
arguments.
The selectedOptions
IDL attribute
must return an HTMLCollection
rooted at the select
node, whose filter
matches the elements in the list of options that
have their selectedness set to true.
The selectedIndex
IDL attribute, on
getting, must return the index of the first option
element in the list of
options in tree order that has its selectedness set to true, if any. If there isn’t one,
then it must return -1.
On setting, the selectedIndex
attribute must set
the selectedness of all the option
elements in the list of options to false, and
then the option
element in the list of
options whose index is the given new value, if
any, must have its selectedness set to true and
its dirtiness set to true.
This can result in no element having a selectedness set to true even in the case of the select
element having no multiple
attribute and a display size of 1.
The value
IDL attribute, on getting, must
return the value of the first option
element in the list of options in tree
order that has its selectedness set to
true, if any. If there isn’t one, then it must return the empty string.
On setting, the value
attribute must set the selectedness of all the option
elements
in the list of options to false, and then the
first option
element in the list of
options, in tree order, whose value is equal to the given new value, if any, must have its selectedness set to true and its dirtiness set to true.
This can result in no element having a selectedness set to true even in the case of the select
element having no multiple
attribute and a display size of 1.
The multiple
, required
, and size
IDL attributes must reflect the
respective content attributes of the same name. The size
IDL
attribute has a default value of zero.
For historical reasons, the default value of the size
IDL attribute does not return the actual size used, which, in
the absence of the size
content attribute, is either 1 or 4
depending on the presence of the multiple
attribute.
The willValidate
, validity
, and validationMessage
IDL attributes, and
the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of
the constraint validation API.
The labels
IDL attribute provides a list of the element’s label
s.
The autofocus
, disabled
, form
, and name
IDL attributes are part of the
element’s forms API.
select
element can be used to offer the user
with a set of options from which the user can select a single option. The default option is
preselected.
<div> <label for="unittype"> Select unit type: </label> <select id="unittype" name="unittype"> <option value="1">Miner</option> <option value="2">Puffer</option> <option value="3" selected>Snipey</option> <option value="4">Max</option> <option value="5">Firebot</option> </select> </div>
When there is no default option, a value that provides instructions or a hint (placeholder option) can be used instead:
<label for="unittype"> Unit type: </label> <select id="unittype" name="unittype" required> <option value="">Make a selection</option> <option value="1">Miner</option> <option value="2">Puffer</option> <option value="3">Snipey</option> <option value="4">Max</option> <option value="5">Firebot</option> </select>
<div> <label for="allowedunits"> Select unit types to enable on this map: </label> <select id="allowedunits" name="allowedunits" multiple> <option value="1" selected>Miner</option> <option value="2" selected>Puffer</option> <option value="3" selected>Snipey</option> <option value="4" selected>Max</option> <option value="5" selected>Firebot</option> </select> </div>
<label for="multiselect"> Select the songs from that you would like on your Act II Mix Tape: </label> <select multiple required id="multiselect" name="act2"> <option value="s1">It Sucks to Be Me (Reprise)</option> <option value="s2">There is Life Outside Your Apartment</option> <option value="s3">The More You Ruv Someone</option> <option value="s4">Schadenfreude</option> <option value="s5">I Wish I Could Go Back to College</option> <option value="s6">The Money Song</option> <option value="s7">School for Monsters</option> <option value="s8">The Money Song (Reprise)</option> <option value="s9">There’s a Fine, Fine Line (Reprise)</option> <option value="s10">What Do You Do With a B.A. in English? (Reprise)</option> <option value="s11">For Now</option> </select>
4.10.8. The datalist
element
- Categories:
- Flow content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Either: phrasing content.
- Or: Zero or more
option
and script-supporting elements. - Or: Zero or more
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
-
listbox
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLDataListElement
: HTMLElement { [SameObject] readonly attribute HTMLCollection options; };
The datalist
element represents a set of option
elements that
represent predefined options for other controls. In the rendering, the datalist
element represents nothing and it, along with its children, should be hidden.
The datalist
element can be used in two ways. In the simplest case, the datalist
element has just option
element children.
<label> Favorite Muppet: <input name="muppet" list="muppets"> <datalist id="muppets"> <option value="Kermit"> <option value="Miss Piggy"> </datalist> </label>
In the more elaborate case, the datalist
element can be given contents that are to
be displayed for down-level clients that don’t support datalist
. In this case, the option
elements are provided inside a select
element inside the datalist
element.
<label> Favourite Muppet: <input name="muppet" list="muppets"> </label> <datalist id="muppets"> <label> or select from the list: <select name="muppet"> <option value=""></option> <option>Kermit</option> <option>Miss Piggy</option> </select> </label> </datalist>
The datalist
element is hooked up to an input
element using the list
attribute on the input
element.
Each option
element that is a descendant of the datalist
element,
that is not disabled, and whose value is a string that isn’t the empty string,
represents a suggestion. Each suggestion has a value and a label.
- datalist .
options
- Returns an
HTMLCollection
of theoption
elements of thedatalist
element.
The options
IDL attribute must return an HTMLCollection
rooted at the datalist
node, whose filter matches option
elements.
Constraint validation: If an element has a datalist
element
ancestor, it is barred from constraint validation.
4.10.9. The optgroup
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
select
element. - Content model:
- Zero or more
option
and script-supporting elements. - Tag omission in text/html:
- An
optgroup
element’s end tag may be omitted if theoptgroup
element is immediately followed by anotheroptgroup
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
disabled
- Whether the form control is disabledlabel
- User-visible label - Allowed ARIA role attribute values:
-
group
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLOptGroupElement
: HTMLElement { attribute boolean disabled; attribute DOMString label; };
The optgroup
element represents a group of option
elements with a common label.
The element’s group of option
elements consists of the option
elements that are children of the optgroup
element.
When showing option
elements in select
elements, user agents should
show the option
elements of such groups as being related to each other and separate
from other option
elements.
The disabled
content attribute is a boolean attribute and can be used to disable a group of option
elements
together.
The label
content attribute must be specified. Its
value gives the name of the group, for the purposes of the user interface.
User agents should use this attribute’s value when labeling the group of option
elements
in a select
element.
The disabled
and label
IDL attributes must reflect the
respective content attributes of the same name.
There is no way to select an optgroup
element. Only option
elements can be selected. An optgroup
element merely provides a
label for a group of option
elements.
select
drop-down widget:
<form action="/courseselector" method="get"> <p>Which course would you like to watch today?</p> <div> <label> Course: <select name="c"> <optgroup label="8.01 Physics I: Classical Mechanics"> <option value="8.01.1">Lecture 01: Powers of Ten</option> <option value="8.01.2">Lecture 02: 1D Kinematics</option> <option value="8.01.3">Lecture 03: Vectors</option> </optgroup> <optgroup label="8.02 Electricity and Magnestism"> <option value="8.02.1">Lecture 01: What holds our world together?</option> <option value="8.02.2">Lecture 02: Electric Field</option> <option value="8.02.3">Lecture 03: Electric Flux</option> </optgroup> <optgroup label="8.03 Physics III: Vibrations and Waves"> <option value="8.03.1">Lecture 01: Periodic Phenomenon</option> <option value="8.03.2">Lecture 02: Beats</option> <option value="8.03.3">Lecture 03: Forced Oscillations with Damping</option> </optgroup> </select> </label> </div> <div> <input type="submit" value="Play"> </div> </form>
4.10.10. The option
element
- Categories:
- None.
- Contexts in which this element can be used:
- As a child of a
select
element.- As a child of a
datalist
element.- As a child of an
optgroup
element. - As a child of a
- Content model:
- If the element has a
label
attribute and avalue
attribute: Nothing.- If the element has a
label
attribute but novalue
attribute: Text.- If the element has no
label
attribute: and is not a child of adatalist
element: Text that is not inter-element white space.- If the element has no
label
attribute and is a child of adatalist
element: Text. - If the element has a
- Tag omission in text/html:
- An
option
element’s end tag may be omitted if theoption
element is immediately followed by anotheroption
element, or if it is immediately followed by anoptgroup
element, or if there is no more content in the parent element. - Content attributes:
- Global attributes
disabled
- Whether the form control is disabledlabel
- User-visible labelselected
- Whether the option is selected by defaultvalue
- Value to be used for §4.10.21 Form submission - Allowed ARIA role attribute values:
-
option
(default - do not set) - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
[NamedConstructor=Option(optional DOMString
text
= "", optional DOMStringvalue
, optional booleandefaultSelected
= false, optional booleanselected
= false)] interfaceHTMLOptionElement
: HTMLElement { attribute boolean disabled; readonly attribute HTMLFormElement? form; attribute DOMString label; attribute boolean defaultSelected; attribute boolean selected; attribute DOMString value; attribute DOMString text; readonly attribute long index; };
The option
element represents an option in a select
element or as part of a list of
suggestions in a datalist
element.
In certain circumstances described in the definition of the select
element, an option
element can be a select
element’s placeholder label option. A placeholder label option does not represent an actual option, but instead represents a
label for the select
control.
The disabled
content attribute is a boolean attribute. An option
element is disabled if its disabled
attribute
is present or if it is a child of an optgroup
element whose disabled
attribute is
present.
An option
element that is disabled must prevent any click
events
that are queued on the user interaction task source from being dispatched on the
element.
The label
content attribute provides a label for
the element. The label of an option
element is the value of the label
content attribute, if there is one and its value is not the empty string, or, otherwise, the value
of the element’s text
IDL attribute if its value is not the empty string.
The label
content attribute, if specified, must not be empty.
The value
content attribute provides a value for
element. The value of an option
element is the value of the value
content
attribute, if there is one, or, if there is not, the value of the element’s text
IDL attribute (which may be the empty string).
The selected
content attribute is a boolean attribute. It represents the default selectedness of the
element.
The dirtiness of an option
element is a boolean state, initially
false. It controls whether adding or removing the selected
content attribute has any
effect.
The selectedness of an option
element is a boolean state,
initially false. Except where otherwise specified, when the element is created, its selectedness must be set to true if the element has a selected
attribute. Whenever an option
element’s selected
attribute is
added, if its dirtiness is false, its selectedness must be set to true. Whenever an option
element’s selected
attribute is removed, if its dirtiness is
false, its selectedness must be set to false.
The Option()
constructor,
when called with three or fewer arguments, overrides the initial state of the selectedness state to always be false even if the third argument is true
(implying that a selected
attribute is to be set). The fourth argument can be used to
explicitly set the initial selectedness state when using the
constructor.
A select
element whose multiple
attribute is not specified must not have more than
one descendant option
element with its selected
attribute set.
An option
element’s index is the number of option
elements that are
in the same list of options but that come before it in tree order. If the option
element is not in a list of options, then the option
element’s index
is zero.
- option .
selected
-
Returns true if the element is selected, and false otherwise.
Can be set, to override the current state of the element.
- option .
index
- Returns the index of the element in its
select
element’soptions
list. - option .
form
- Returns the element’s
form
element, if any, or null otherwise. - option .
text
- Same as
textContent
, except that spaces are collapsed andscript
elements are skipped. - option = new
Option()
( [ text [, value [, defaultSelected [, selected ] ] ] ] ) -
Returns a new
option
element.The text argument sets the contents of the element.
The value argument sets the
value
attribute.The defaultSelected argument sets the
selected
attribute.The selected argument sets whether or not the element is selected. If it is omitted, even if the defaultSelected argument is true, the element is not selected.
The disabled
IDL attribute must reflect the content attribute of the same name. The defaultSelected
IDL attribute must reflect the selected
content attribute.
The label
IDL attribute, on getting, if
there is a label
content attribute, must return that attribute’s value; otherwise, it
must return the element’s label. On setting, the element’s label
content
attribute must be set to the new value.
The value
IDL attribute, on getting,
must return the element’s value. On setting, the element’s value
content attribute must be set to the new value.
The selected
IDL attribute, on getting,
must return true if the element’s selectedness is true, and false
otherwise. On setting, it must set the element’s selectedness to the new
value, set its dirtiness to true, and then cause the element to ask for a reset.
The index
IDL attribute must return the
element’s index.
The text
IDL attribute, on getting, must
return the result of stripping and collapsing white space from the child text content of the option
element, in tree order,
excluding any that are descendants of descendants of the option
element that are themselves script
elements in the HTML namespace or script
elements in the SVG namespace.
On setting, the text
attribute must act as if the textContent
IDL
attribute on the element had been set to the new value.
The form
IDL attribute’s behavior depends on whether the option
element
is in a select
element or not. If the option
has a select
element as its parent, or
has an optgroup
element as its parent and that optgroup
element has a select
element
as its parent, then the form
IDL attribute must return the same value as the form
IDL attribute on that select
element. Otherwise, it must return
null.
A constructor is provided for creating HTMLOptionElement
objects (in addition to the factory
methods from DOM such as createElement()
): Option(text, value, defaultSelected, selected)
.
When invoked as a constructor, it must return a new HTMLOptionElement
object (a new option
element). If the first argument is not the empty string, the new object must have as its only
child a Text
node whose data is the value of that argument. Otherwise, it must have no
children. If the value argument is present, the new object must have a value
attribute set with the value of the argument as its value. If the defaultSelected argument is true, the new object must have a selected
attribute set with no value. If the selected argument is true, the new object must have
its selectedness set to true; otherwise the selectedness must be set to false, even if the defaultSelected argument is true. The element’s node document must be the active document of the browsing context of the Window
object on which the
interface object of the invoked constructor is found.
4.10.11. The textarea
element
- Categories:
- Flow content.
- Phrasing content.
- Interactive content.
- listed, labelable, submittable, resettable, and reassociateable form-associated element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Text.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
autocapitalize
- Hint for automatic capitalization by user agents.autocomplete
- Hint for form autofill featureautofocus
- Automatically focus the form control when the page is loadedcols
- Maximum number of characters per linedirname
- Name of form field to use for sending the element’s directionality in §4.10.21 Form submissiondisabled
- Whether the form control is disabledform
- Associates the control with aform
elementmaxlength
- Maximum length of valueminlength
- Minimum length of valuename
- Name of form control to use for §4.10.21 Form submission and in theform.elements
APIplaceholder
- User-visible label to be placed within the form controlreadonly
- Whether to allow the value to be edited by the userrequired
- Whether the control is required for §4.10.21 Form submissionrows
- Number of lines to showwrap
- How the value of the form control is to be wrapped for §4.10.21 Form submission - Allowed ARIA role attribute values:
-
textbox
with thearia-multiline
property set to "true" (default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLTextAreaElement
: HTMLElement { attribute DOMString autocapitalize; attribute DOMString autocomplete; attribute boolean autofocus; attribute unsigned long cols; attribute DOMString dirName; attribute boolean disabled; readonly attribute HTMLFormElement? form; attribute long maxLength; attribute long minLength; attribute DOMString name; attribute DOMString placeholder; attribute boolean readOnly; attribute boolean _required; attribute unsigned long rows; attribute DOMString wrap; readonly attribute DOMString type; attribute DOMString defaultValue; [TreatNullAs=EmptyString] attribute DOMString value; readonly attribute unsigned long textLength; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); boolean reportValidity(); void setCustomValidity(DOMStringerror
); [SameObject] readonly attribute NodeList labels; void select(); attribute unsigned long? selectionStart; attribute unsigned long? selectionEnd; attribute DOMString? selectionDirection; void setRangeText(DOMStringreplacement
); void setRangeText(DOMStringreplacement
, unsigned longstart
, unsigned longend
, optional SelectionModeselectionMode
= "preserve"); void setSelectionRange(unsigned longstart
, unsigned longend
, optional DOMStringdirection
); };
The textarea
element represents a multiline plain text edit
control for the element’s raw value.
The contents of the control represent the control’s default value.
The raw value of a textarea
control must be initially the empty string.
This element has rendering requirements involving the bidirectional algorithm.
The readonly
attribute is a boolean attribute used to control whether the text can be edited by the user or not.
<label for="buffer"> Filename: <code>/etc/bash.bashrc</code> </label> <textarea id="buffer" name="buffer" readonly> # System-wide .bashrc file for interactive bash(1) shells. # To enable the settings / commands in this file for login shells as well, # this file has to be sourced in /etc/profile. # If not running interactively, don’t do anything [ -z "$PS1" ] && return ...</textarea>
Constraint validation: If the readonly
attribute is specified on a textarea
element, the element is barred from constraint validation.
A textarea
element is mutable if it is
neither disabled nor has a readonly
attribute specified.
When a textarea
is mutable, its raw value should be editable by the user: the user agent
should allow the user to edit, insert, and remove text, and to insert and remove line breaks in
the form of U+000A LINE FEED (LF) characters. Any time the user causes the element’s raw value to change, the user agent must queue a
task to fire a simple event that bubbles named input
at the textarea
element. User agents may wait for a
suitable break in the user’s interaction before queuing the task; for example, a user agent could
wait for the user to have not hit a key for 100ms, so as to only fire the event when the user
pauses, instead of continuously for each keystroke.
A textarea
element has a dirty value flag, which must be initially
set to false, and must be set to true whenever the user interacts with the control in a way that
changes the raw value.
When the textarea
element’s textContent
IDL attribute changes value,
if the element’s dirty value flag is false, then the
element’s raw value must be set to the value of
the element’s textContent
IDL attribute.
The reset algorithm for textarea
elements is to set the dirty value flag back to false, and set the element’s raw value to
the value of the element’s textContent
IDL attribute.
When a textarea
element is popped off the stack of open elements of
an HTML parser or XML parser, then the user agent must invoke the
element’s reset algorithm.
If the element is mutable, the user agent should allow the user to change the writing direction of the element, setting it either to a left-to-right writing direction or a right-to-left writing direction. If the user does so, the user agent must then run the following steps:
-
Set the element’s
dir
attribute to "ltr
" if the user selected a left-to-right writing direction, and "rtl
" if the user selected a right-to-left writing direction. -
Queue a task to fire a simple event that bubbles named
input
at thetextarea
element.
The cols
attribute specifies the expected
maximum number of characters per line. If the cols
attribute is specified, its value must be a valid non-negative integer greater than
zero. If applying the rules for parsing non-negative integers to the attribute’s value
results in a number greater than zero, then the element’s character width is that value;
otherwise, it is 20.
The user agent may use the textarea
element’s character width as a hint to the user as to how many
characters the server prefers per line (e.g., for visual user agents by making the width of the
control be that many characters). In visual renderings, the user agent should wrap the user’s
input in the rendering so that each line is no wider than this number of characters.
The rows
attribute specifies the number of
lines to show. If the rows
attribute is specified, its
value must be a valid non-negative integer greater than zero.
If applying the rules for parsing non-negative integers to the attribute’s value
results in a number greater than zero, then the element’s character
height is that value; otherwise, it is 2.
Visual user agents should set the height of the control to the number of lines given by character height.
The wrap
attribute is an enumerated
attribute with two keywords and states: the soft
keyword which maps to the Soft state, and the hard
keyword which maps to the Hard state. The missing value default is the Soft state.
The Soft state indicates that the text in the textarea
is not to be wrapped when it is submitted (though it can still be wrapped in
the rendering).
The Hard state indicates that the text in the textarea
is to have newlines added by the user agent so that the text is wrapped when
it is submitted.
If the element’s wrap
attribute is in the Hard state, the cols
attribute must be specified.
For historical reasons, the element’s value is normalized in three different ways for three
different purposes. The raw value is the value as
it was originally set. It is not normalized. The API
value is the value used in the value
IDL
attribute. It is normalized so that line breaks use U+000A LINE FEED (LF) characters. Finally,
there is the value, as used in form submission and other
processing models in this specification. It is normalized so that line breaks use U+000D CARRIAGE
RETURN U+000A LINE FEED (CRLF) character pairs, and in addition, if necessary given the element’s wrap
attribute, additional line breaks are inserted to
wrap the text at the given width.
The element’s API value is defined to be the element’s raw value with the following transformation applied:
- Replace every U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair from the raw value with a single U+000A LINE FEED (LF) character.
- Replace every remaining U+000D CARRIAGE RETURN character from the raw value with a single U+000A LINE FEED (LF) character.
The element’s value is defined to be the element’s raw value with the textarea wrapping transformation applied. The textarea wrapping transformation is the following algorithm, as applied to a string:
- Replace every occurrence of a U+000D CARRIAGE RETURN (CR) character not followed by a U+000A LINE FEED (LF) character, and every occurrence of a U+000A LINE FEED (LF) character not preceded by a U+000D CARRIAGE RETURN (CR) character, by a two-character string consisting of a U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair.
- If the element’s
wrap
attribute is in the Hard state, insert U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pairs into the string using a user agent-defined algorithm so that each line has no more than character width characters. For the purposes of this requirement, lines are delimited by the start of the string, the end of the string, and U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pairs.
The maxlength
attribute is a form control maxlength
attribute controlled by the textarea
element’s dirty value flag.
If the textarea
element has a maximum allowed value length, then the
element’s children must be such that the code-unit length of the value of the
element’s textContent
IDL attribute with the textarea wrapping
transformation applied is equal to or less than the element’s maximum allowed value
length.
The minlength
attribute is a form control minlength
attribute controlled by the textarea
element’s dirty value flag.
The required
attribute is a boolean attribute. When specified, the user will be required to enter a value before
submitting the form.
Constraint validation: If the element has its required
attribute specified, and the element is mutable, and the element’s value is the empty string, then the element is suffering
from being missing.
The placeholder
attribute represents
a short hint (a word or short phrase) intended to aid the user with data entry when the
control has no value. A hint could be a sample value or a brief description of the expected
format.
The placeholder
attribute
should not be used as a replacement for a label
. For a
longer hint or other advisory text, place the text next to the control.
Use of the placeholder
attribute as a replacement for a label
can reduce the
accessibility and usability of the control for a range of users including older
users and users with cognitive, mobility, fine motor skill or vision impairments.
While the hint given by the control’s label
is shown at all times, the short
hint given in the placeholder
attribute is only shown before the user enters a value. Furthermore, placeholder
text may be mistaken for
a pre-filled value, and as commonly implemented the default color of the placeholder text
provides insufficient contrast and the lack of a separate visible label
reduces the size of the hit region available for setting focus on the control.
User agents should present this hint to the user when the element’s value is the empty string and the control is not focused (e.g., by displaying it inside a blank unfocused control). All U+000D CARRIAGE RETURN U+000A LINE FEED character pairs (CRLF) in the hint, as well as all other U+000D CARRIAGE RETURN (CR) and U+000A LINE FEED (LF) characters in the hint, must be treated as line breaks when rendering the hint.
The name
attribute represents the element’s name.
The dirname
attribute controls how the element’s directionality is submitted.
The disabled
attribute is used to make the control non-interactive and to prevent its
value from being submitted.
The form
attribute is used to explicitly associate the textarea
element with its form owner.
The autofocus
attribute controls focus.
The autocapitalize
attribute hints how the user agent should automatically capitalize text that the user enters.
The autocomplete
attribute controls how the user agent provides autofill behavior.
- textarea .
type
-
Returns the string "
textarea
". - textarea .
value
-
Returns the current value of the element.
Can be set, to change the value.
The cols
, placeholder
, required
, rows
,
and wrap
attributes must reflect the respective content attributes of the same name.
The cols
and rows
attributes are limited to only non-negative numbers
greater than zero. The cols
attribute’s default value is 20.
The rows
attribute’s default value is 2.
The dirName
IDL
attribute must reflect the dirname
content attribute.
The maxLength
IDL attribute must reflect the maxlength
content attribute, limited to only non-negative numbers.
The minLength
IDL attribute
must reflect the minlength
content attribute, limited to only non-negative numbers.
The readOnly
IDL attribute
must reflect the readonly
content attribute.
The autocapitalize
IDL attribute
must reflect the autocapitalize
content attribute, limited to only known values.
The type
IDL attribute must return the value"textarea
".
The defaultValue
IDL attribute must act like the element’s textContent
IDL attribute.
The value
attribute must, on getting, return the element’s API value; on setting, it must set the element’s raw value to the new value, set
the element’s dirty value flag to true, and should then move the text entry cursor
position to the end of the text field, unselecting any selected text and resetting the selection
direction to none.
The textLength
IDL attribute must return the code-unit length of
the element’s API value.
The willValidate
, validity
, and validationMessage
IDL attributes,
and the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of the constraint validation API.
The labels
IDL attribute provides a list of the element’s label
s.
The select()
, selectionStart
, selectionEnd
, selectionDirection
, setRangeText()
, and setSelectionRange()
methods and IDL
attributes expose the element’s text selection.
The autofocus
, disabled
, form
, and name
IDL attributes are part of the element’s forms API.
textarea
being used for unrestricted free-form text input in a form:
<div> <label> If you have any comments, please let us know: <textarea cols="80" name="comments"></textarea> </label> </div>
To specify a maximum length for the comments, one can use the maxlength
attribute:
<div> <label> If you have any short comments, please let us know: <textarea cols="80" name="comments" maxlength="200"></textarea> </label> </div>
To give a default value, text can be included inside the element:
<div> <label> If you have any comments, please let us know: <textarea cols="80" name="comments">You rock!</textarea> </label> </div>
You can also give a minimum length. Here, a letter needs to be filled out by the user; a template (which is shorter than the minimum length) is provided, but is insufficient to submit the form:
<textarea required minlength="500">Dear Madam Speaker, Regarding your letter dated ... ... Yours Sincerely, ...</textarea>
A placeholder can be given as well, to suggest the basic form to the user, without providing an explicit template:
<textarea placeholder="Dear Francine, They closed the parks this week, so we won’t be able to meet your there. Should we just have dinner? Love, Daddy"></textarea>
To have the browser submit the directionality of the element along with the
value, the dirname
attribute can be specified:
<div> <label> If you have any comments, please let us know (you may use either English or Hebrew for your comments): <textarea cols="80" name="comments" dirname="comments.dir"></textarea> </label> </div>
4.10.12. The output
element
- Categories:
- Flow content.
- Phrasing content.
- listed, labelable, resettable, and reassociateable form-associated element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content.
- Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
for
- Specifies controls from which the output was calculatedform
- Associates the control with aform
elementname
- Name of form control to use for §4.10.21 Form submission and in theform.elements
API - Allowed ARIA role attribute values:
-
status
(default - do not set) or any role value. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLOutputElement
: HTMLElement { [SameObject, PutForwards=value] readonly attribute DOMTokenList htmlFor; readonly attribute HTMLFormElement? form; attribute DOMString name; readonly attribute DOMString type; attribute DOMString defaultValue; attribute DOMString value; readonly attribute boolean willValidate; readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); boolean reportValidity(); void setCustomValidity(DOMStringerror
); [SameObject] readonly attribute NodeList labels; };
The output
element represents the result of a calculation performed
by the application, or the result of a user action.
This element can be contrasted with the samp
element, which is the
appropriate element for quoting the output of other programs run previously.
The for
content attribute allows an explicit
relationship to be made between the result of a calculation and the elements that represent the
values that went into the calculation or that otherwise influenced the calculation. The for
attribute, if specified, must contain a string consisting of
an unordered set of unique space-separated tokens that are case-sensitive, each of which must have the value of an ID of an element in the same Document
.
The form
attribute is used to explicitly associate the output
element with its form owner. The name
attribute represents the element’s name. The output
element is associated with a form so that it can be easily referenced from the event handlers of
form controls; the element’s value itself is not submitted when the form is submitted.
The element has a value mode flag which is either value or default. Initially, the value mode flag must be set to default.
The element also has a default value. Initially, the default value must be the empty string.
When the value mode flag is in mode default, the contents of the element represent both
the value of the element and its default value.
When the value mode flag is in mode value, the contents of the element represent the
value of the element only, and the default value is only accessible using the defaultValue
IDL
attribute.
Whenever the element’s descendants are changed in any way, if the value mode flag is in mode default, the element’s default value must be set to the value of the
element’s textContent
IDL attribute.
The reset algorithm for output
elements is to set the element’s value mode flag to default and then to set the element’s textContent
IDL attribute to the value of the element’s default value (thus replacing the element’s child nodes).
- output .
value
[ = value ] -
Returns the element’s current value.
Can be set, to change the value.
- output .
defaultValue
[ = value ] -
Returns the element’s current default value.
Can be set, to change the default value.
- output .
type
-
Returns the string "
output
".
The value
IDL attribute must act like the
element’s textContent
IDL attribute, except that on setting, in addition, before the
child nodes are changed, the element’s value mode flag must be set to value.
The defaultValue
IDL attribute, on
getting, must return the element’s default
value. On setting, the attribute must set the element’s default value, and, if the element’s value mode flag is in the mode default, set the element’s textContent
IDL
attribute as well.
The type
attribute must return the string
"output
".
The htmlFor
IDL attribute must reflect the for
content attribute.
The willValidate
, validity
, and validationMessage
IDL attributes, and
the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of
the constraint validation API.
The labels
IDL attribute provides a list of the element’s label
s.
The form
and name
IDL attributes are
part of the element’s forms API.
output
for its display of calculated results:
<form onsubmit="return false" oninput="o.value = a.valueAsNumber + b.valueAsNumber"> <input name="a" type="number" step="any"> + <input name="b" type="number" step="any"> = <output name="o" for="a b"></output> </form>
output
element is used to report the results of a calculation performed by a remote
server, as they come in:
<output id="result"></output> <script> var primeSource = new WebSocket('ws://primes.example.net/'); primeSource.onmessage = function (event) { document.getElementById('result').value = event.data; } </script>
4.10.13. The progress
element
- Categories:
- Flow content.
- Phrasing content.
- Labelable element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content, but there must be no
progress
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
value
- Current value of the elementmax
- Upper bound of range - Allowed ARIA role attribute values:
-
progressbar
(default - do not set). - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLProgressElement
: HTMLElement { attribute double value; attribute double max; readonly attribute double position; [SameObject] readonly attribute NodeList labels; };
The progress
element represents progress of a task, either as a fraction of the total that has been completed,
or merely that progress is occurring.
The progress
element is the wrong element to for a simple gauge, as opposed to task progress.
The meter
element is more appropriate for such use cases. It allows arbitrary minimum as well as maximum values.
The value
content attribute specifies how much of the
task has been completed. When the attribute is present the value must be a valid floating-point number in the range [0,maximum value].
If the attribute is missing, the element is an indeterminate progress bar, and should show something is happening
but that it is not clear how much more work remains to be done before the task is complete, for example
waiting for a response to a network request. If the attribute is present, the element is a determinate progress bar.
The max
content attribute specifies how much work the task requires.
When the attribuite is present, the value must be a valid floating-point number greater than zero.
The missing value default is 1.0.
The units are arbitrary and not specified.
The max
IDL attribute must reflect the content attribute of the same name, limited to numbers greater than
zero. The default value for max
is 1.0.
The value
IDL attribute provides the amount of the task complete
for a determinate progress bar or 0 for an indeterminate progress bar.
On setting, the given value must be converted to the best representation of the number as a floating-point number and then the value
content attribute must be set to that string.
The labels
IDL attribute provides a list of the element’s label
s.
The position
IDL attribute
gives the fraction of the task completed for a determinate progress bar or -1 for an indeterminate progress bar.
- progress .
position
-
For a determinate progress bar (one with known current and maximum values), returns the result of dividing the current value by the maximum value.
For an indeterminate progress bar, returns -1.
user agent requirements for showing the progress bar: When representing a progress
element to the user, the user agent should indicate whether it is a determinate or
indeterminate progress bar. For a determinate progress bar the user agent should indicate the current value relative to the maximum value,
e.g. by filling an appropriate fraction of the widget in a contrasting color.
4.10.13.1. Determinate progress bars
Authors are encouraged to include the current value and the maximum value inline as text inside the element, so that the progress is made available to users of legacy user agents.
<section> <h2>Task Progress</h2> <p> Progress: <progress id="pbar" max="100" value="0"> <span id="pVal">0</span>% </progress> </p> <script> var progressBar = document.getElementById('pbar'); function updateProgress(newValue) { progressBar.value = newValue; progressBar.querySelector('#pVal')[0].textContent = newValue; } </script> </section>
(The updateProgress()
method in this example would be called by some
other code on the page to update the actual progress bar as the task progressed.)
If the element has a max
attribute, the user agent must parse the attribute’s value according to the rules for parsing floating-point number values.
If this does not result in an error, and if the parsed value is greater than zero, then the maximum value of the progress bar is that value.
Otherwise the maximum value of the progress bar is 1.0.
User agents must parse the value
attribute’s value according to the rules for
parsing floating-point number values. If this results in an error, or if the
parsed value is less than zero, then the current value of the progress bar is zero.
Otherwise, the current value of the progress bar is the lesser of the parsed value and the maximum value of the progress bar.
The position
IDL attribute must return the
result of dividing the current value by the maximum value.
4.10.13.2. Indeterminate progress bars
<section> <h2>Task Progress</h2> <p> Progress: <progress id="pbar">Working...</progress> </p> <script> var progressBar = document.getElementById('pbar'); function finishedWorking() { progressBar.value = 1; progressBar.textContent = "Done"; } </script> </section>
The finishedWorking()
method in this example would be called by some
other code on the page to update the actual progress bar when the task is complete.
Setting the value
there changes the element to a determinate progress bar.
The position
IDL attribute must return -1.
The value
IDL attribute, on getting, must return 0.
Otherwise, it must return the current value.
Setting the value
IDL attribute to itself
when the corresponding content attribute is absent changes the progress bar from an
indeterminate progress bar to a determinate progress bar with no progress.
4.10.14. The meter
element
- Categories:
- Flow content.
- Phrasing content.
- Labelable element.
- Palpable content.
- Phrasing content.
- Contexts in which this element can be used:
- Where phrasing content is expected.
- Content model:
- Phrasing content, but there must be no
meter
element descendants. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
value
- Current value of the elementmin
- Lower bound of rangemax
- Upper bound of rangelow
- High limit of low rangehigh
- Low limit of high rangeoptimum
- Optimum value in gauge - Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- DOM interface:
-
interface
HTMLMeterElement
: HTMLElement { attribute double value; attribute double min; attribute double max; attribute double low; attribute double high; attribute double optimum; [SameObject] readonly attribute NodeList labels; };
The meter
element represents a scalar measurement within a known
range, or a fractional value; for example disk usage, the relevance of a query result, or the
fraction of a voting population to have selected a particular candidate.
This is also known as a gauge.
The meter
element should not be used to indicate progress (as in a
progress bar). For that role, HTML provides a separate progress
element.
The meter
element also does not represent a scalar value of arbitrary
range — for example, it would be wrong to use this to report a weight, or height, unless
there is a known maximum value.
There are six attributes that determine the semantics of the gauge represented by the element.
The min
attribute specifies the lower bound of
the range, and the max
attribute specifies the
upper bound. The value
attribute specifies the
value to have the gauge indicate as the "measured" value.
The other three attributes can be used to segment the gauge’s range into "low", "medium", and
"high" parts, and to indicate which part of the gauge is the "optimum" part. The low
attribute specifies the range that is considered to
be the "low" part, and the high
attribute
specifies the range that is considered to be the "high" part. The optimum
attribute gives the position that is
"optimum"; if that is higher than the "high" value then this indicates that the higher the value,
the better; if it’s lower than the "low" mark then it indicates that lower values are better, and
naturally if it is in between then it indicates that neither high nor low values are good.
Authoring requirements: The value
attribute must be specified.
The value
, min
, low
, high
, max
, and optimum
attributes, when present, must have values that are valid floating-point numbers.
In addition, the attributes' values are further constrained:
Let value be the value
attribute’s number.
If the min
attribute is specified, then let minimum be that attribute’s value;
otherwise, let it be zero.
If the max
attribute is specified, then let maximum be that attribute’s value;
otherwise, let it be 1.0.
The following inequalities must hold, as applicable:
- minimum ≤ value ≤ maximum
- minimum ≤
low
≤ maximum (iflow
is specified) - minimum ≤
high
≤ maximum (ifhigh
is specified) - minimum ≤
optimum
≤ maximum (ifoptimum
is specified) low
≤high
(if bothlow
andhigh
are specified)
If no minimum or maximum is specified, then the range is assumed to be 0..1, and the value thus has to be within that range.
Authors are encouraged to include a textual representation of the gauge’s state in the
element’s contents, for users of user agents that do not support the meter
element.
When used with microdata, the meter
element’s value
attribute provides the element’s machine-readable value.
Storage space usage: <meter value="6" max="8">6 blocks used (out of 8 total)</meter> Voter turnout: <meter value="0.75"><img alt="75%" src="graph75.png"></meter> Tickets sold: <meter min="0" max="100" value="75"></meter>
The following example is incorrect use of the element, because it doesn’t give a range (and since the default maximum is 1, both of the gauges would end up looking maxed out):
<p>The grapefruit pie had a radius of <meter value="12">12cm</meter> and a height of <meter value="2">2cm</meter>.</p> <!-- BAD! -->
Instead, one would either not include the meter element, or use the meter element with a defined range to give the dimensions in context compared to other pies:
<p>The grapefruit pie had a radius of 12cm and a height of 2cm.</p> <dl> <dt>Radius:</dt> <dd><meter min="0" max="20" value="12">12cm</meter></dd> <dt>Height:</dt> <dd><meter min="0" max="10" value="2">2cm</meter></dd> </dl>
There is no explicit way to specify units in the meter
element, but the units may
be specified in the title
attribute in free-form text.
<dl> <dt>Radius:</dt> <dd><meter min="0" max="20" value="12" title="centimeters">12cm</meter></dd> <dt>Height:</dt> <dd><meter min="0" max="10" value="2" title="centimeters">2cm</meter></dd> </dl>
User agent requirements: User agents must parse the min
, max
, value
, low
, high
, and optimum
attributes using the rules for parsing floating-point number values.
User agents must then use all these numbers to obtain values for six points on the gauge, as follows. (The order in which these are evaluated is important, as some of the values refer to earlier ones.)
- The minimum value
-
If the
min
attribute is specified and a value could be parsed out of it, then the minimum value is that value. Otherwise, the minimum value is zero. - The maximum value
-
If the
max
attribute is specified and a value could be parsed out of it, then the candidate maximum value is that value. Otherwise, the candidate maximum value is 1.0.If the candidate maximum value is greater than or equal to the minimum value, then the maximum value is the candidate maximum value. Otherwise, the maximum value is the same as the minimum value.
- The actual value
-
If the
value
attribute is specified and a value could be parsed out of it, then that value is the candidate actual value. Otherwise, the candidate actual value is zero.If the candidate actual value is less than the minimum value, then the actual value is the minimum value.
Otherwise, if the candidate actual value is greater than the maximum value, then the actual value is the maximum value.
Otherwise, the actual value is the candidate actual value.
- The low boundary
-
If the
low
attribute is specified and a value could be parsed out of it, then the candidate low boundary is that value. Otherwise, the candidate low boundary is the same as the minimum value.If the candidate low boundary is less than the minimum value, then the low boundary is the minimum value.
Otherwise, if the candidate low boundary is greater than the maximum value, then the low boundary is the maximum value.
Otherwise, the low boundary is the candidate low boundary.
- The high boundary
-
If the
high
attribute is specified and a value could be parsed out of it, then the candidate high boundary is that value. Otherwise, the candidate high boundary is the same as the maximum value.If the candidate high boundary is less than the low boundary, then the high boundary is the low boundary.
Otherwise, if the candidate high boundary is greater than the maximum value, then the high boundary is the maximum value.
Otherwise, the high boundary is the candidate high boundary.
- The optimum point
-
If the
optimum
attribute is specified and a value could be parsed out of it, then the candidate optimum point is that value. Otherwise, the candidate optimum point is the midpoint between the minimum value and the maximum value.If the candidate optimum point is less than the minimum value, then the optimum point is the minimum value.
Otherwise, if the candidate optimum point is greater than the maximum value, then the optimum point is the maximum value.
Otherwise, the optimum point is the candidate optimum point.
All of which will result in the following inequalities all being true:
- minimum value ≤ actual value ≤ maximum value
- minimum value ≤ low boundary ≤ high boundary ≤ maximum value
- minimum value ≤ optimum point ≤ maximum value
user agent requirements for regions of the gauge: If the optimum point is equal to the low boundary or the high boundary, or anywhere in between them, then the region between the low and high boundaries of the gauge must be treated as the optimum region, and the low and high parts, if any, must be treated as suboptimal. Otherwise, if the optimum point is less than the low boundary, then the region between the minimum value and the low boundary must be treated as the optimum region, the region from the low boundary up to the high boundary must be treated as a suboptimal region, and the remaining region must be treated as an even less good region. Finally, if the optimum point is higher than the high boundary, then the situation is reversed; the region between the high boundary and the maximum value must be treated as the optimum region, the region from the high boundary down to the low boundary must be treated as a suboptimal region, and the remaining region must be treated as an even less good region.
user agent requirements for showing the gauge: When representing a meter
element to the user, the user agent should indicate the relative position of the actual value to the
minimum and maximum values, and the relationship between the actual value and the three regions of
the gauge.
<section> <div> <h3>Suggested groups</h3> <button onclick="hideSuggestedGroups()">Hide suggested groups</button> </div> <ul> <li> <p> <a href="/group/comp.infosystems.www.authoring.stylesheets/view">comp.infosystems.www.authoring.stylesheets</a> - <a href="/group/comp.infosystems.www.authoring.stylesheets/subscribe">join</a> </p> <p> Group description: <strong>Layout/presentation on the WWW.</strong> </p> <p> <meter value="0.5">Moderate activity,</meter> Usenet, 618 subscribers </p> </li> <li> <p> <a href="/group/netscape.public.mozilla.xpinstall/view">netscape.public.mozilla.xpinstall</a> - <a href="/group/netscape.public.mozilla.xpinstall/subscribe">join</a> </p> <p> Group description: <strong>Mozilla XPInstall discussion.</strong> </p> <p> <meter value="0.25">Low activity,</meter> Usenet, 22 subscribers </p> </li> <li> <p> <a href="/group/mozilla.dev.general/view">mozilla.dev.general</a> - <a href="/group/mozilla.dev.general/subscribe">join</a> </p> <p> <meter value="0.25">Low activity,</meter> Usenet, 66 subscribers </p> </li> </ul> </section>
with some light CSS, might be rendered as follows:
User agents may combine the value of the title
attribute and the other attributes
to provide context-sensitive help or inline text detailing the actual values.
<meter min="0" max="60" value="23.2" title="seconds"></meter>
...might cause the user agent to display a gauge with a tooltip saying "Value: 23.2 out of 60." on one line and "seconds" on a second line.
The value
IDL attribute, on getting, must
return the actual value. On setting, the given value
must be converted to the best representation of the number as a floating-point number and then the value
content attribute must be set to that string.
The min
IDL attribute, on getting, must return
the minimum value. On setting, the given value must be
converted to the best representation of the number as a floating-point number and then the min
content attribute must be set to that string.
The max
IDL attribute, on getting, must return
the maximum value. On setting, the given value must be
converted to the best representation of the number as a floating-point number and then the max
content attribute must be set to that string.
The low
IDL attribute, on getting, must return
the low boundary. On setting, the given value must be
converted to the best representation of the number as a floating-point number and then the low
content attribute must be set to that string.
The high
IDL attribute, on getting, must return
the high boundary. On setting, the given value must be
converted to the best representation of the number as a floating-point number and then the high
content attribute must be set to that string.
The optimum
IDL attribute, on getting, must
return the optimum value. On setting, the given value
must be converted to the best representation of the number as a floating-point number and then the optimum
content attribute must be set to that string.
The labels
IDL attribute provides a list of the element’s label
s.
<p> Disk usage: <meter min="0" value="170261928" max="233257824"> 170 261 928 bytes used out of 233 257 824 bytes available </meter> </p>
4.10.15. The fieldset
element
- Categories:
- Flow content.
- Sectioning root.
- listed and reassociateable form-associated element.
- Palpable content.
- Sectioning root.
- Contexts in which this element can be used:
- Where flow content is expected.
- Content model:
- Optionally a
legend
element, followed by flow content. - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
disabled
- Whether the form control is disabledform
- Associates the control with aform
elementname
- Name of form control to use for §4.10.21 Form submission and in theform.elements
API - Allowed ARIA role attribute values:
-
group
(default - do not set),none
orpresentation
. - Allowed ARIA state and property attributes:
- Global aria-* attributes
- Any
aria-*
attributes applicable to the allowed roles. - Any
- DOM interface:
-
interface
HTMLFieldSetElement
: HTMLElement { attribute boolean disabled; readonly attribute HTMLFormElement? form; attribute DOMString name; readonly attribute DOMString type; [SameObject] readonly attribute HTMLCollection elements; readonly attribute boolean willValidate; [SameObject] readonly attribute ValidityState validity; readonly attribute DOMString validationMessage; boolean checkValidity(); boolean reportValidity(); void setCustomValidity(DOMStringerror
); };
The fieldset
element represents a set of form controls optionally
grouped under a common name.
The name of the group is given by the first legend
element that is a child of the fieldset
element, if any. The remainder of the descendants form the group.
The disabled
attribute, when specified,
causes all the form control descendants of the fieldset
element, excluding those that
are descendants of the fieldset
element’s first legend
element child, if
any, to be disabled.
A fieldset
element is a disabled fieldset if it matches any of the following conditions:
- Its
disabled
attribute is specified - It is a descendant of another
fieldset
element whosedisabled
attribute is specified, and is not a descendant of thatfieldset
element’s firstlegend
element child, if any.
The form
attribute is used to explicitly associate the fieldset
element with its form owner. The name
attribute represents the element’s name.
- fieldset .
type
-
Returns the string "fieldset".
- fieldset .
elements
-
Returns an
HTMLCollection
of the form controls in the element.
The disabled
IDL attribute must reflect the content attribute of the same name.
The type
IDL attribute must return the string
"fieldset
".
The elements
IDL attribute must return an HTMLCollection
rooted at the fieldset
element, whose filter
matches listed elements.
The willValidate
, validity
, and validationMessage
attributes, and the checkValidity()
, reportValidity()
, and setCustomValidity()
methods, are part of
the constraint validation API. The form
and name
IDL attributes are part of the
element’s forms API.
fieldset
element being used to group a set of related
controls:
<fieldset> <legend>Display</legend> <div> <label> <input type="radio" name="c" value="0" checked> Black on White </label> </div> <div> <label> <input type="radio" name="c" value="1"> White on Black </label> </div> <div> <label> <input type="checkbox" name="g"> Grayscale </label> </div> <div> <label> Enhance contrast <input type="range" name="e" list="contrast" min="0" max="100" value="0" step="1"> </label> </div> <datalist id="contrast"> <option label="Normal" value="0"> <option label="Maximum" value="100"> </datalist> </fieldset>
<fieldset name="clubfields" disabled> <legend> <label> <input type="checkbox" name="club" onchange="form.clubfields.disabled = !checked"> Use Club Card </label> </legend> <div> <label> Name on card: <input name="clubname" required> </label> </div> <div> <label> Card number: <input name="clubnum" required pattern="[-0-9]+"> </label> </div> <div> <label> Expiry date: <input name="clubexp" type="month"> </label> </div> </fieldset>
fieldset
elements. Here is an example expanding on the previous
one that does so:
<fieldset name="clubfields" disabled> <legend> <label> <input type="checkbox" name="club" onchange="form.clubfields.disabled = !checked"> Use Club Card </label> </legend> <div> <label> Name on card: <input name="clubname" required> </label> </div> <fieldset name="numfields"> <legend> <label> <input type="radio" checked name="clubtype" onchange="form.numfields.disabled = !checked"> My card has numbers on it </label> </legend> <div> <label> Card number: <input name="clubnum" required pattern="[-0-9]+"> </label> </div> </fieldset> <fieldset name="letfields" disabled> <legend> <label> <input type="radio" name="clubtype" onchange="form.letfields.disabled = !checked"> My card has letters on it </label> </legend> <div> <label> Card code: <input name="clublet" required pattern="[A-Za-z]+"> </label> </div> </fieldset> </fieldset>
In this example, if the outer "Use Club Card" checkbox is not checked, everything inside the
outer fieldset
, including the two radio buttons in the legends of the two nested fieldset
s, will be disabled. However, if the checkbox is checked, then the radio
buttons will both be enabled and will let you select which of the two inner fieldset
s is to be enabled.
4.10.16. The legend
element
- Categories:
- None.
- Contexts in which this element can be used:
- As the first child of a
fieldset
element. - Content model:
- Phrasing content and headings (
h1
-h6
elements). - Tag omission in text/html:
- Neither tag is omissible
- Content attributes:
- Global attributes
- Allowed ARIA role attribute values:
- None
- Allowed ARIA state and property attributes:
- Global aria-* attributes
- DOM interface:
-
interface
HTMLLegendElement
: HTMLElement { readonly attribute HTMLFormElement? form; };
The legend
element represents a caption for the rest of the contents
of the legend
element’s parent fieldset
element, if any.
- legend .
form
-
Returns the element’s
form
element, if any, or null otherwise.
The form
IDL attribute’s behavior depends on
whether the legend
element is in a fieldset
element or not. If the legend
has a fieldset
element as its parent, then the form
IDL attribute must return the same value as the form
IDL attribute on that fieldset
element.
Otherwise, it must return null.
4.10.17. Form control infrastructure
4.10.17.1. A form control value
Most form controls have a value and a checkedness. (The latter is only used by input
elements.) These are used to describe how the user interacts with the control.
A control’s value is its internal state. As such, it might not match the user’s current input.
For instance, if a user enters the word "three" into a numeric field that expects digits, the user’s input would
be the string "three" but the control’s value would remain
unchanged. Or, if a user enters the email address " awesome@example.com"
(with leading white space) into an email field
, the
user’s input would be the string " awesome@example.com" but the browser’s UI for
email fields might translate that into a value of "awesome@example.com
" (without the leading white space).
To define the behavior of constraint validation in the face of the input
element’s multiple
attribute, input
elements
can also have separately defined values.
The select
element does not have a value;
the selectedness of its option
elements is what is used instead.
4.10.17.2. Mutability
A form control can be designated as mutable.
This determines (by means of definitions and requirements in this specification that rely on whether an element is so designated) whether or not the user can modify the value or checkedness of a form control, or whether or not a control can be automatically prefilled.
4.10.17.3. Association of controls and forms
A form-associated element can have a relationship with a form
element, which is called the element’s form owner. If a form-associated
element is not associated with a form
element, its form owner is
said to be null.
A form-associated element is, by default, associated with its nearest ancestor form
element
(as described below), but, if it is reassociateable, may have a form
attribute specified to override this.
This feature allows authors to work around the lack of support for nested form
elements.
If a reassociateable form-associated
element has a form
attribute specified, then that
attribute’s value must be the ID of a form
element
in the element’s owner Document
.
The rules in this section are complicated by the fact that although conforming
documents will never contain nested form
elements, it is quite possible (e.g., using a
script that performs DOM manipulation) to generate documents that have such nested elements. They
are also complicated by rules in the HTML parser that, for historical reasons, can result in a form-associated element being associated with a form
element that is not
its ancestor.
When a form-associated element is created, its form owner must be initialized to null (no owner).
When a form-associated element is to be associated with a form, its form owner must be set to that form.
When a form-associated element or one of its ancestors is inserted into a Document
, then the user agent must reset the form owner of that form-associated element. The HTML parser overrides this requirement when inserting form
controls.
When an element changes its parent node resulting in a form-associated element and its form owner (if any) no longer being in the same tree, then the user agent must reset the form owner of that form-associated element.
When a reassociateable form-associated
element’s form
attribute is set, changed, or removed,
then the user agent must reset the form owner of that element.
When a reassociateable form-associated
element has a form
attribute and the ID of any of the elements in the Document
changes, then
the user agent must reset the form owner of that form-associated
element.
When a reassociateable form-associated
element has a form
attribute and an element with an ID is inserted into or removed from the Document
, then the user agent must reset the form owner of that form-associated element.
When the user agent is to reset the form owner of a form-associated element, it must run the following steps:
- If the element’s form owner is not null, and either the element is not reassociateable or its
form
content attribute is not present, and the element’s form owner is its nearestform
element ancestor after the change to the ancestor chain, then do nothing, and abort these steps. - Let the element’s form owner be null.
-
If the element is reassociateable, has a
form
content attribute, and is itself in aDocument
, then run these substeps:- If the first element in the
Document
to have an ID that is case-sensitively equal to the element’sform
content attribute’s value is aform
element, then associate the form-associated element with thatform
element. - Abort the "reset the form owner" steps.
- If the first element in the
- Otherwise, if the form-associated element in question has an ancestor
form
element, then associate the form-associated element with the nearest such ancestorform
element. - Otherwise, the element is left unassociated.
... <form id="a"> <div id="b"></div> </form> <script> document.getElementById('b').innerHTML = '<table><tr><td></form><form id="c"><input id="d"></table>' + '<input id="e">'; </script> ...
The form owner of "d" would be the inner nested form "c", while the form owner of "e" would be the outer form "a".
This happens as follows: First, the "e" node gets associated with "c" in the HTML
parser. Then, the innerHTML
algorithm moves the nodes
from the temporary document to the "b" element. At this point, the nodes see their ancestor chain
change, and thus all the "magic" associations done by the parser are reset to normal ancestor
associations.
This example is a non-conforming document, though, as it is a violation of the content models
to nest form
elements, and there is a parse error for the </form>
tag.
- element .
form
-
Returns the element’s form owner.
Returns null if there isn’t one.
Reassociateable form-associated elements have a form
IDL attribute, which, on getting, must return the element’s form owner, or null if there
isn’t one.
4.10.18. Attributes common to form controls
4.10.18.1. Naming form controls: the name
attribute
The name
content attribute gives the name of the form control, as used in §4.10.21 Form submission and
in the form
element’s elements
object. If the attribute is specified, its value
must not be the empty string.
Any non-empty value for name
is allowed, but the name
"_charset_
" is special:
_charset_
-
This value, if used as the name of a
control with no
value
attribute, is automatically given a value during submission consisting of the submission character encoding.
The name
IDL attribute must reflect the name
content attribute.
4.10.18.2. Submitting element directionality: the dirname
attribute
The dirname
attribute on a form control
element enables the submission of the directionality of the element, and gives the name of
the field that contains this value during §4.10.21 Form submission. If such an attribute is
specified, its value must not be the empty string.
<form action="/addcomment" method="post"> <div> <label for="add-comment">Comment:</label> <input type="text" id="add-comment" name="comment" dirname="comment.dir" required> </div> <div> <button name="mode" type="submit" value="add">Post Comment</button> </div> </form>
When the user submits the form, the user agent includes three fields, one called "comment", one called "comment.dir", and one called "mode"; so if the user types "Hello", the submission body might be something like:
comment=Hello&comment.dir=ltr&mode=add
If the user manually switches to a right-to-left writing direction and enters "مرحبا", the submission body might be something like:
comment=%D9%85%D8%B1%D8%AD%D8%A8%D8%A7&comment.dir=rtl&mode=add
4.10.18.3. Limiting user input length: the maxlength
attribute
A form control maxlength
attribute,
controlled by a dirty value flag, declares a limit on the number of characters
a user can input.
If an element has its form control maxlength
attribute specified, the attribute’s value must be a valid
non-negative integer. If the attribute is specified and applying the rules for
parsing non-negative integers to its value results in a number, then that number is the
element’s maximum allowed value length. If the attribute is omitted or parsing its
value results in an error, then there is no maximum allowed value length.
Constraint validation: If an element has a maximum allowed value length, its dirty value flag is true, its value was last changed by a user edit (as opposed to a change made by a script), and the code-unit length of the element’s value is greater than the element’s maximum allowed value length, then the element is suffering from being too long.
User agents may prevent the user from causing the element’s value to be set to a value whose code-unit length is greater than the element’s maximum allowed value length.
In the case of textarea
elements, this is the value, not the raw
value, so the textarea wrapping transformation is applied before the maximum allowed value length is checked.
4.10.18.4. Setting minimum input length requirements: the minlength
attribute
A form control minlength
attribute,
controlled by a dirty value flag, declares a lower bound on the number of
characters a user can input.
The minlength
attribute does not imply the required
attribute. If the form control has no required
attribute, then the value can still be omitted; the minlength
attribute only kicks in once the user has entered
a value at all. If the empty string is not allowed, then the required
attribute also needs to be set.
If an element has its form control minlength
attribute specified, the attribute’s value must be a valid
non-negative integer. If the attribute is specified and applying the rules for
parsing non-negative integers to its value results in a number, then that number is the
element’s minimum allowed value length. If the attribute is omitted or parsing its
value results in an error, then there is no minimum allowed value length.
If an element has both a maximum allowed value length and a minimum allowed value length, the minimum allowed value length must be smaller than or equal to the maximum allowed value length.
Constraint validation: If an element has a minimum allowed value length, its dirty value flag is true, its value was last changed by a user edit (as opposed to a change made by a script), its value is not the empty string, and the code-unit length of the element’s value is less than the element’s minimum allowed value length, then the element is suffering from being too short.
<form action="/events/menu" method="post"> <div> <label> Name of Event: <input required minlength="5" maxlength="50" name="event"> </label> </div> <div> <label> Describe what you would like for breakfast, if anything: <textarea name="breakfast" minlength="10"></textarea> </label> </div> <div> <label> Describe what you would like for lunch, if anything: <textarea name="lunch" minlength="10"></textarea> </label> </div> <div> <label> Describe what you would like for dinner, if anything: <textarea name="dinner" minlength="10"></textarea> </label> </div> <div> <input type="submit" value="Submit Request"> </div> </form>
4.10.18.5. Enabling and disabling form controls: the disabled
attribute
The disabled
content attribute is a boolean attribute.
A form control is disabled if any of the following conditions are met:
- The element is a
button
,input
,option
,select
, ortextarea
element, and thedisabled
attribute is specified on this element (regardless of its value). - The element is an
option
element that is a child of anoptgroup
element that has thedisabled
attribute specified. - The element is a descendant of a
fieldset
element whosedisabled
attribute is specified, and is not a descendant of thatfieldset
element’s firstlegend
element child, if any.
A form control that is disabled must prevent any click
events that are queued on the user interaction task source from being dispatched on the element.
Constraint validation: If an element is disabled, it is barred from constraint validation.
The disabled
IDL attribute must reflect the disabled
content attribute.
4.10.18.6. Form submission
Attributes for form submission can be specified both on form
elements
and on submit buttons (elements that represent buttons
that submit forms, e.g., an input
element whose type
attribute is in the Submit Button
state).
The attributes for form submission that may be specified on form
elements are action
, enctype
, method
, novalidate
, and target
.
The corresponding attributes for form submission that may be specified on submit buttons are formaction
, formenctype
, formmethod
, formnovalidate
, and formtarget
. When omitted, they default to the values given on
the corresponding attributes on the form
element.
The action
and formaction
content attributes, if specified, must
have a value that is a valid non-empty URL potentially surrounded by spaces.
The action of an element is the value of the element’s formaction
attribute, if the element is a Submit Button
and has such an attribute, or the value of its form owner’s action
attribute, if it has
one, or else the empty string.
The method
and formmethod
content attributes are enumerated attributes with the following keywords and
states:
- The keyword
get
, mapping to the state GET, indicating the HTTP GET method. - The keyword
post
, mapping to the state POST, indicating the HTTP POST method. - The keyword
dialog
, mapping to the state dialog, indicating that submitting theform
is intended to close thedialog
box in which the form finds itself, if any, and otherwise not submit.
The invalid value default for these attributes is the GET state. The missing value default for the method
attribute is also the GET state. (There is no missing value default for the formmethod
attribute.)
The method of an element is one of those states. If the element is a Submit Button
and has a formmethod
attribute, then the element’s method is that attribute’s state; otherwise, it
is the form owner’s method
attribute’s state.
method
attribute is used to explicitly specify
the default value, "get", so that the search
query is submitted in the URL:
<form method="get" action="/search"> <div> <label> Search terms: <input type="search" name="q"> </label> </div> <div><input type="submit"></div> </form>
method
attribute is used to
specify the value "post", so that the user’s
message is submitted in the HTTP request’s body:
<form method="post" action="/post-message"> <div> <label for="message">Message:</label> <input type="text" id="message" name="m"> </div> <div><input type="submit" value="Submit message"></div> </form>
form
is used within a dialog
. The method
attribute’s "dialog" keyword is used to have the dialog
automatically close when the form is submitted.
<dialog id="ship">
<form method="dialog">
<p>A ship has arrived in the harbour.</p>
<button type="submit" value="board">Board the ship</button>
<button type="submit" value="call">Call to the captain</button>
</form>
</dialog>
<script>
var ship = document.getElementById('ship');
ship.showModal();
ship.onclose = function(event) {
if (ship.returnValue == 'board') {
// ...
} else {
// ...
}
};
</script>
The enctype
and formenctype
content attributes are enumerated attributes with the following keywords and
states:
- The "
application/x-www-form-urlencoded
" keyword and corresponding state. - The "
multipart/form-data
" keyword and corresponding state. - The "
text/plain
" keyword and corresponding state.
The invalid value default for these attributes is the application/x-www-form-urlencoded
state. The missing value default for the enctype
attribute is also the application/x-www-form-urlencoded
state. (There is no missing value default for the formenctype
attribute.)
The enctype of an element is one of those three states.
If the element is a Submit Button
and has a formenctype
attribute, then the element’s enctype is that attribute’s state; otherwise, it is the form owner’s enctype
attribute’s state.
The target
and formtarget
content attributes, if specified, must
have values that are valid browsing context
names or keywords.
The target
of an element is the value of the element’s formtarget
attribute, if the element is a Submit Button
and has such an attribute; or the value of its form owner’s target
attribute, if it has
such an attribute; or, if the Document
contains a base
element with a target
attribute, then the value of the target
attribute of the first such base
element; or,
if there is no such element, the empty string.
The novalidate
and formnovalidate
content attributes are boolean attributes. If present, they indicate that the form is
not to be validated during submission.
The no-validate state of an element is true if the
element is a Submit Button
and the element’s formnovalidate
attribute is present, or if the element’s form owner’s novalidate
attribute is present,
and false otherwise.