[[#text-html|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 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|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.
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
[=xml/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]]
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 {{Event/isTrusted}} attribute is initialized to true. [[!DOM]]
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 <{iframe/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.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 aDOMString.
(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.
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.
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 the <{script}> 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 the {{HTMLScriptElement}} 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 [[#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 that <{blockquote}> 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.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 use <{address}> 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}>, and <{span}> and making liberal use of the <{global/style}> 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.This specification [=character encoding|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]]<?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 its transformToFragment() and
transformToDocument() methods. [[XSLTP]]
: URLs
:: The following terms are defined in the WHATWG URL specification: [[!URL]]
about: scheme [[!RFC6694]]
* The blob: scheme [[!FILEAPI]]
* 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
* Referercookie-string
* receives a set-cookie-string
* Cookie header
The following term is defined in the Web Linking specification: [[!RFC8288]]
* Link header
: Fetch
:: The following terms are defined in the WHATWG Fetch specification: [[!FETCH]]
* about:blank
* HTTPS state value
* referrer policy
* CORS protocol
* default User-Agent value
* extract a MIME type
* fetch
* ok status
* Origin header
* process response
* set
* terminate
* the RequestCredentials enumeration
* response and its associated:
* type
* url
* url list
* status
* [=response/header list=]
* [=response/body=]
* internal response
* [=response/CSP list=]
* [=response/HTTPS state=]
* request and its associated:
* url
* method
* header list
* body
* client
* target browsing context
* initiator
* type
* destination
* origin
* omit-Origin-header flag
* same-origin data-URL flag
* referrer
* synchronous flag
* mode
* credentials mode
* use-URL-credentials flag
* unsafe-request flag
* cache mode
* redirect mode
* cryptographic nonce metadata
* referrer policy
* parser metadata
:: The following terms are defined in Referrer Policy [[!REFERRERPOLICY]]
* referrer policy
* The `Referrer-Policy` HTTP header
* The parse a referrer policy from a `Referrer-Policy` header algorithm
* The "no-referrer",
"no-referrer-when-downgrade", and
"unsafe-url" referrer policies
: 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:
* array index property name
* supported property indices
* Determine the value of an indexed property
* Support named properties
* Supported property names
* Determine the value of a named property
* perform a security check
* Platform object
* Primary interface
* Global environment associated with a platform object
* Read only (when applied to arrays)
* Callback this value
* Converting between WebIDL types and JS types
* invoke the Web IDL callback function
The Web IDL specification also defines the following types that are used in Web IDL fragments
in this specification:
* ArrayBufferView
* boolean
* DOMString
* USVString
* double
* Error
* Function
* long
* object
* unrestricted double
* unsigned long
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:
* {{IndexSizeError}}
* {{HierarchyRequestError}}
* {{WrongDocumentError}}
* {{InvalidCharacterError}}
* {{NoModificationAllowedError}}
* {{NotFoundError}}
* {{NotSupportedError}}
* {{InvalidStateError}}
* {{SyntaxError}}
* {{InvalidModificationError}}
* {{NamespaceError}}
* {{InvalidAccessError}}
* {{SecurityError}}
* {{NetworkError}}
* {{AbortError}}
* {{URLMismatchError}}
* {{QuotaExceededError}}
* {{TimeoutError}}
* {{InvalidNodeTypeError}}
* {{DataCloneError}}
* {{NotAllowedError}}
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 created {{Date}} 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 a {{Date}} 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]]
EventTarget
* The concept of a target override
* 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 {{MouseEvent/relatedTarget}} attribute * The {{MouseEvent/button}} attribute * The {{MouseEvent/ctrlKey}} attribute * The {{MouseEvent/shiftKey}} attribute * The {{MouseEvent/altKey}} attribute * The {{MouseEvent/metaKey}} attribute * The {{MouseEvent/getModifierState()}} method * {{MouseEventInit}} dictionary type * The {{FocusEvent}} interface and its {{FocusEvent/relatedTarget}} attribute * The {{UIEvent}} interface's {{UIEvent/view}} and {{UIEvent/detail}} attributes * 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 named click" or "if the event name is
keypress". The terms "name" and "type" for events are synonymous.
The following features are defined in the DOM Parsing and Serialization specification:
[[!DOM-PARSING]]
* {{Element/innerHTML}}
* {{Element/outerHTML}}
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]]
ProgressEvent.lengthComputable attribute
* ProgressEvent.loaded attribute
* ProgressEvent.total attribute
* Fire a progress event named e
: 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]]
:: <
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.
resize event
* The scroll event
* The features argument of window.open
The following features and terms are defined in the CSS Syntax specifications:
[[!CSS-SYNTAX-3]]
* Parse a comma-separated list of component values
* component value
* environment encoding
* <CanvasRenderingContext2D object's use of fonts depends on the features
described in the CSS Fonts and Font Loading specifications,
including in particular FontFace 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 particular FontFace objects and the
font source concept. [[!CSS-FONTS-3]] [[CSS-FONT-LOADING-3]]
The following interface is defined in the SVG specification: [[!SVG11]]
* {{SVGMatrix}}
: WebGL
:: The following interface is defined in the WebGL specification: [[!WEBGL-1]]
* {{WebGLRenderingContext}}
: WebGL2
:: The following interface is defined in the WebGL2 specification: [[!webgl-2]]
* {{WebGL2RenderingContext}}
: 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:
* WebVTT file
* WebVTT file using cue text
* WebVTT file using chapter title text
* WebVTT file using only nested cues
* WebVTT parser
* The rules for updating the display of WebVTT text tracks
* The rules for interpreting WebVTT cue text
* The WebVTT text track cue writing direction
: The WebSocket protocol
:: The following terms are defined in the WebSocket protocol specification: [[!RFC6455]]
* establish a WebSocket connection
* the WebSocket connection is established
* validate the server's response
* extensions in use
* subprotocol in use
* headers to send appropriate cookies
* cookies set during the server's opening handshake
* a WebSocket message has been received
* send a WebSocket Message
* fail the WebSocket connection
* close the WebSocket connection
* start the WebSocket closing handshake
* the WebSocket closing handshake is started
* the WebSocket connection is closed (possibly cleanly)
* the WebSocket connection close code
* the WebSocket connection close reason
* Sec-WebSocket-Protocol field
: 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
aria-* content
attributes are defined in the ARIA specification: [[!wai-aria-1.1]]
report-uri, frame-ancestors, and
sandbox 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
* The frame-ancestors directive
* The sandbox directive
: Service Workers
:: The following terms are defined in Service Workers: [[!SERVICE-WORKERS]]
* client message queue
* match service worker registration
* ServiceWorkerContainer
: Secure Contexts
:: The following term is defined in Secure Contexts: [[!SECURE-CONTEXTS]]
* Is environment settings object a secure context?
: 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:
* MathML annotation-xml element
* MathML math element
* MathML merror element
* MathML mi element
* MathML mn element
* MathML mo element
* MathML ms element
* MathML mtext element
: 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's cursor property instead)
* The font-defining SVG elements: font, glyph,
missing-glyph, hkern, vkern,
font-face, font-face-src, font-face-uri,
font-face-format, and font-face-name (use CSS's
@font-face instead)
* The externalResourcesRequired attribute
* The enable-background property
* The contentScriptType and contentStyleType attributes (use the
type attribute on the SVG script and
<{global/style}> elements instead)
User agents that implement SVG must implement the following features from SVG Tiny 1.2:
* The non-scaling-stroke value for the vector-effect property
* The <{global/class}> attribute is allowed on all SVG elements
* The <{global/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:
* <filter-function-list>
This specification might have certain additional requirements on character encodings, image formats, audio formats, and video formats in the respective sections.
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.
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".
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.
x-vendor-feature", the IDL attribute should be named
"vendorFeature" (i.e., the "x" is dropped from
the IDL attribute's name).
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.)
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/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: 1. If the context node is from an HTML DOM, the default element namespace is "http://www.w3.org/1999/xhtml". 2. 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]]
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]]
interactive" and then to "complete" if they are aborted.
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.
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.
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.
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:
1. Let input and position be the same variables as those of the same name in
the algorithm that invoked these steps.
2. Let result be the empty string.
3. 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.
4. 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:
1. Let input be the string being parsed.
2. Let position be a pointer into input, initially
pointing at the start of the string.
3. Let tokens be an ordered list of tokens, initially empty.
4. While position is not past the end of input:
1. Collect a sequence of characters that are not the delimiter character.
2. Append the string collected in the previous step to tokens.
3. Advance position to the next character in input.
5. 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).
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:
The empty string can be a valid keyword.
+" is ignored, but
it is not conforming.)
2. If position is past the end of input, return an error.
7. If the character indicated by position is not an ASCII digit, then return
an error.
8. Collect a sequence of characters that are ASCII digits, and interpret the
resulting sequence as a base-ten integer. Let value be that integer.
9. If sign is "positive", return value, otherwise return the result of
subtracting value from 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. 1. Let input be the string being parsed. 2. Let position be a pointer into input, initially pointing at the start of the string. 3. Let value have the value 1. 4. Let divisor have the value 1. 5. Let exponent have the value 1. 6. Skip white space. 7. If position is past the end of input, return an error. 8. If the character indicated by position is a U+002D HYPHEN-MINUS character (-): 1. Change value and divisor to -1. 2. Advance position to the next character. 3. 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 (+): 1. Advance position to the next character. (The "+" is ignored, but
it is not conforming.)
2. If position is past the end of input, return an error.
9. 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.
10. If the character indicated by position is not an ASCII digit, then return
an error.
11. Collect a sequence of characters that are ASCII digits, and interpret the
resulting sequence as a base-ten integer. Multiply value by that integer.
12. If position is past the end of input, jump to the step labeled
conversion.
13. Fraction: If the character indicated by position is a U+002E FULL STOP
(.), run these substeps:
1. Advance position to the next character.
2. 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.
3. 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.
4. Fraction loop: Multiply divisor by ten.
5. Add the value of the character indicated by position, interpreted as a
base-ten digit (0..9) and divided by divisor, to value.
6. Advance position to the next character.
7. If position is past the end of input, then jump to the step labeled
conversion.
8. If the character indicated by position is an ASCII digit, jump back to
the step labeled fraction loop in these substeps.
14. 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:
1. Advance position to the next character.
2. If position is past the end of input, then jump to the step labeled
conversion.
3. If the character indicated by position is a U+002D HYPHEN-MINUS character (-):
1. Change exponent to -1.
2. Advance position to the next character.
3. 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
(+):
1. Advance position to the next character.
2. If position is past the end of input, then jump to the step
labeled conversion.
4. If the character indicated by position is not an ASCII digit, then jump
to the step labeled conversion.
5. Collect a sequence of characters that are ASCII digits, and interpret the
resulting sequence as a base-ten integer. Multiply exponent by that integer.
6. Multiply value by ten raised to the exponentth power.
15. 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.
16. 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.)
17. If rounded-value is 21024 or -21024, return an error.
18. Return rounded-value.
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]]
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.
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.
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 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.
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. 1. Let input be the string being parsed. 2. Let position be a pointer into input, initially pointing at the start of the string. 3. Parse a time-zone offset component to obtain timezonehours and timezoneminutes. If this returns nothing, then fail. 4. If position is not beyond the end of input, then fail. 5. 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. 1. If the character at position is a U+005A LATIN CAPITAL LETTER Z character (Z), then: 1. Let timezonehours be 0. 2. Let timezoneminutes be 0. 3. 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: 1. 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". 2. Advance position to the next character in input. 3. Collect a sequence of characters that are ASCII digits. Let s be the collected sequence. 4. If s is exactly two characters long, then run these substeps: 1. Interpret s as a base-ten integer. Let that number be the timezonehours. 2. 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. 3. 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: 1. Interpret the first two characters of s as a base-ten integer. Let that number be the timezonehours. 2. Interpret the last two characters of s as a base-ten integer. Let that number be the timezoneminutes. Otherwise, fail. 5. If timezonehours is not a number in the range 0 ≤ timezonehours ≤ 23, then fail. 6. If sign is "negative", then negate timezonehours. 7. If timezoneminutes is not a number in the range 0 ≤ timezoneminutes ≤ 59, then fail. 8. If sign is "negative", then negate timezoneminutes. Otherwise, fail. 2. Return timezonehours and timezoneminutes.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: 1. A valid date string representing the date converted to the UTC time zone 2. A U+0054 LATIN CAPITAL LETTER T character (T) 3. 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) 4. 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. 1. Let input be the string being parsed. 2. Let position be a pointer into input, initially pointing at the start of the string. 3. Parse a date component to obtain year, month, and day. If this returns nothing, then fail. 4. 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. 5. Parse a time component to obtain hour, minute, and second. If this returns nothing, then fail. 6. If position is beyond the end of input, then fail. 7. Parse a time-zone offset component to obtain timezonehours and timezoneminutes. If this returns nothing, then fail. 8. If position is not beyond the end of input, then fail. 9. 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. 10. Let timezone be timezonehours hours and timezoneminutes minutes from UTC. 11. Return time and timezone.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:
1. Four ASCII digits, representing year, where year >= 1 2. A U+002D HYPHEN-MINUS character (-) 3. A U+0057 LATIN CAPITAL LETTER W character (W) 4. 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. 1. Let input be the string being parsed. 2. Let position be a pointer into input, initially pointing at the start of the string. 3. 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. 4. If year is not a number greater than zero, then fail. 5. 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. 6. 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. 7. 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. 8. Let maxweek be the week number of the last day of year year. 9. If week is not a number in the range 1 ≤ week ≤ maxweek, then fail. 10. If position is not beyond the end of input, then fail. 11. Return the week-year number year and the week number week.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: 1. One or more ASCII digits followed by a U+0044 LATIN CAPITAL LETTER D character, representing a number of days. 2. A U+0054 LATIN CAPITAL LETTER T character followed by one or more of the following subcomponents, in the order given: 1. One or more ASCII digits followed by a U+0048 LATIN CAPITAL LETTER H character, representing a number of hours. 2. One or more ASCII digits followed by a U+004D LATIN CAPITAL LETTER M character, representing a number of minutes. 3. The following components: 1. One or more ASCII digits, representing a number of seconds. 2. Optionally, a U+002E FULL STOP character (.) followed by one, two, or three ASCII digits, representing a fraction of a second. 3. 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: 1. Zero or more [=space characters=]. 2. 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. 3. 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. 4. Zero or more [=space characters=]. 5. 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. 6. 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. 1. Let input be the string being parsed. 2. Let position be a pointer into input, initially pointing at the start of the string. 3. Let months, seconds, and component count all be zero. 4. 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.
5. Skip white space. 6. If position is past the end of input, then fail. 7. 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. 8. Run the following substeps in a loop, until a step requiring the loop to be broken or the entire algorithm to fail is reached: 1. Let units be undefined. It will be assigned one of the following values: years, months, weeks, days, hours, minutes, and seconds. 2. Let next character be undefined. It is used to process characters from the input. 3. If position is past the end of input, then break the loop. 4. 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. 5. Set next character to the character in input pointed to by position. 6. 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. 7. If position is past the end of input, then fail. 8. 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.) 9. If next character is a U+002E FULL STOP character (.), then run these substeps: 1. Collect a sequence of characters that are ASCII digits. Let s be the resulting sequence. 2. If s is the empty string, then fail. 3. Let length be the number of characters in s. 4. Let fraction be the result of interpreting s as a base-ten integer, and then dividing that number by 10length. 5. Increment N by fraction. 6. Skip white space. 7. If position is past the end of input, then fail. 8. Set next character to the character in input pointed to by position, and advance position to the next character. 9. If next character is neither a U+0053 LATIN CAPITAL LETTER S character nor a U+0073 LATIN SMALL LETTER S character, then fail. 10. Set units to seconds. Otherwise, run these substeps: 1. 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. 2. 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. 10. Increment component count. 11. Let multiplier be 1. 12. If units is years, multiply multiplier by 12 and set units to months. 13. If units is months, add the product of N and multiplier to months. Otherwise, run these substeps: 1. If units is weeks, multiply multiplier by 7 and set units to days. 2. If units is days, multiply multiplier by 24 and set units to hours. 3. If units is hours, multiply multiplier by 60 and set units to minutes. 4. If units is minutes, multiply multiplier by 60 and set units to seconds. 5. Forcibly, units is now seconds. Add the product of N and multiplier to seconds. 14. Skip white space. 9. If component count is zero, fail. 10. If months is not zero, fail. 11. Return the duration consisting of seconds seconds.transparent", then return an error.
5. 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.
6. 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: 1. Let result be a simple color. 2. Interpret the second character of input as a hexadecimal digit; let the red component of result be the resulting number multiplied by 17. 3. Interpret the third character of input as a hexadecimal digit; let the green component of result be the resulting number multiplied by 17. 4. Interpret the fourth character of input as a hexadecimal digit; let the blue component of result be the resulting number multiplied by 17. 5. Return result. 7. 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".
8. If input is longer than 128 characters, truncate input, leaving only
the first 128 characters.
9. If the first character in input is a U+0023 NUMBER SIGN character (#), remove it.
10. Replace any character in input that is not an ASCII hex digit with the
character U+0030 DIGIT ZERO (0).
11. While input's length is zero or not a multiple of three, append a U+0030 DIGIT
ZERO (0) character to input.
12. 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).
13. If length is greater than 8, then remove the leading length-8
characters in each component, and let length be 8.
14. 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.
15. If length is still greater than two, truncate each component, leaving
only the first two characters in each.
16. Let result be a simple color.
17. Interpret the first component as a hexadecimal number; let the red component of
result be the resulting number.
18. Interpret the second component as a hexadecimal number; let the green component of
result be the resulting number.
19. Interpret the third component as a hexadecimal number; let the blue component of
result be the resulting number.
20. Return result.
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: 1. Let input be the string being parsed. 2. Let position be a pointer into input, initially pointing at the start of the string. 3. Let tokens be an ordered list of tokens, initially empty. 4. Skip white space 5. While position is not past the end of input: 1. Collect a sequence of characters that are not [=space characters=]. 2. Append the string collected in the previous step to tokens. 3. Skip white space 6. Return tokens.
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.
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:
1. 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.
2. 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.
3. Return the first element of type type in tree order that has an
<{global/id}> attribute or a name attribute whose value is s.
<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]]
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:
about:legacy-compat as a
reserved, though unresolvable,
about: URL, for use in [=DOCTYPE=]s 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
[=Document/URL=] of `iframe` `srcdoc` documents.
[[!RFC6694]]
The fallback base URL of a {{Document}} object is the absolute URL
obtained by running these substeps:
1. 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.
2. If document's [=url/URL=] is about:blank, and the
Document's browsing context has a creator browsing context, then
return the creator base URL.
3. Return document's [=url/URL=].
The document base URL of a {{Document}} object is the absolute URL
obtained by running these substeps:
1. If there is no <{base}> element that has an <{base/href}> attribute in the
{{Document}}, then the document base URL is the {{Document}}'s
fallback base URL; abort these steps.
2. Otherwise, the document base URL is the frozen base URL of the first
<{base}> element in the {{Document}} that has an <{base/href}>
attribute, in tree order.
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. 1. Let encoding be document's character encoding, if document was given, and environment settings object's API URL character encoding otherwise. 2. Let baseURL be document's base URL, if document was given, and environment settings object's API base URL otherwise. 3. Let urlRecord be the result of applying the URL parser to url, with baseURL and encoding. 4. If urlRecord is failure, then abort these steps with an error. 5. Let urlString be the result of applying the URL serializer to urlRecord. 6. Return urlString as the resulting URL string and urlRecord as the resulting URL record.For example, the CSS '':link''/'':visited'' pseudo-classes might have been affected.
cite attribute
cite attribute is being shown to
the user, or if any data derived from that [=url/URL=] is affecting the display, then
the [=url/URL=] should be reparsed relative to the element's
node document and the UI updated appropriately.
For instance, changing the base URL doesn't affect the image displayed by img
elements, although subsequent accesses of the src IDL attribute from script
will return a new absolute URL that might no longer correspond to the image being
shown.
no-cors" if corsAttributeState is
No CORS, and "cors" otherwise.
2. If same-origin fallback flag is set and mode is "no-cors", set
mode to "same-origin".
3. Let credentialsMode be "include".
4. If corsAttributeState is Anonymous, set credentialsMode to
"same-origin".
5. Let request be a new request whose [=url/URL=] is url,
destination is "subresource", mode is mode,
credentials mode is credentialsMode, and whose
use-URL-credentials flag is set.
data: URL, and
is not the [=url/URL=] "about:blank", then generate the address of the
resource from which Request-URIs are obtained as required by HTTP for the
Referer (sic) header from referrer. [[!HTTP]]
Otherwise, the Referer (sic) header must be omitted, regardless of its value.
9. If the algorithm was not invoked with the synchronous flag, perform the remaining
steps in parallel.
10. 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.
11. 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 and
Origin 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/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]]
12. If the algorithm was not invoked with the block cookies flag, and there are cookies
to be set, update the cookies. [[!COOKIES]]
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]]
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.
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.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]]
charset". If no such
match is found, return nothing and abort these steps.
3. Skip any [=space characters=] that immediately follow the word "charset"
(there might not be any).
4. 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.
5. Skip any [=space characters=] that immediately follow the equals sign (there might not be
any).
6. Process the next character as follows:
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]]
| 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".
|
anonymous keyword. The
missing value default, used when the attribute is omitted, is the
No CORS state.
name attribute set to referrer.`Referrer-Policy` HTTP
header.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.
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 [=response/CSP list=] be element's shadow-including root's [=response/CSP list=].
If [=response/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 [=response/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.
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): 1. If the corresponding content attribute is absent, then the IDL attribute must return null. 2. Let candidate be the element that thedocument.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.
3. If candidate is null, or if it is not type-compatible with the IDL attribute, then
the IDL attribute must return null.
4. Otherwise, it must return candidate.
On setting, if the given element has an <{global/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 <{global/id}>
attribute, then the content attribute must be set to the value of that <{global/id}>
attribute. Otherwise, the content attribute must be set to the empty string.
HTMLAllCollection interfaceHTMLAllCollection 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]
interface HTMLAllCollection {
readonly attribute unsigned long length;
getter Element (unsigned long index);
getter (HTMLCollection or Element)? namedItem(DOMString name);
legacycaller (HTMLCollection or Element)? item(optional DOMString nameOrItem);
};
HTMLCollection
objects.
The supported property names consist of the non-empty values of all the
<{global/id}> and name attributes of all the elements
represented by the collection, in tree order, ignoring later duplicates, with the
<{global/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:
1. If nameOrIndex was not provided, return null.
2. 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:
1. If name is the empty string, return null.
2. Let subCollection be an HTMLCollection object rooted at the same
{{Document}} 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.
3. If there is exactly one element in subCollection, then return that element.
4. Otherwise, if subCollection is empty, return null.
5. Otherwise, return subCollection.
HTMLFormControlsCollection interfaceHTMLFormControlsCollection interface is used for collections of
listed elements in <{form}> elements.
interface HTMLFormControlsCollection : HTMLCollection {
// inherits length and item()
getter (RadioNodeList or Element)? namedItem(DOMString name); // shadows inherited namedItem()
};
interface RadioNodeList : NodeList {
attribute DOMString value;
};
lengthitem(index)namedItem(name)namedItem(name)
name name from the collection.
If there are multiple matching items, then a RadioNodeList object containing all
those elements is returned.
HTMLCollection
objects.
The supported property names consist of the non-empty values of all the <{global/id}>
and name attributes of all the elements represented by the collection, in
tree order, ignoring later duplicates, with the <{global/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:
1. If name is the empty string, return null and stop the algorithm.
2. If, at the time the method is called, there is exactly one node in the collection that has
either an <{global/id}> attribute or a name attribute equal to
name, then return that node and stop the algorithm.
3. Otherwise, if there are no nodes in the collection that have either an <{global/id}>
attribute or a name attribute equal to name, then return null and
stop the algorithm.
4. Otherwise, create a new RadioNodeList object representing a live view of
the HTMLFormControlsCollection object, further filtered so that the only nodes
in the RadioNodeList object are those that have either an <{global/id}>
attribute or a name attribute equal to name. The nodes in the
RadioNodeList object must be sorted in tree order.
5. Return that RadioNodeList object.
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:
1. Let element be the first element in tree order represented by the
RadioNodeList object that is an <{input}> element whose
type attribute is in the <{input/Radio|Radio Button}> state and whose checkedness
is true. Otherwise, let it be null.
2. If element is null, return the empty string.
3. If element is an element with no value attribute, return the string
"on".
4. Otherwise, return the value of element's value attribute.
On setting, the value IDL attribute must run the following steps:
1. If the new value is the string "on": let element be the first element
in tree order represented by the RadioNodeList object that is an
<{input}> element whose type attribute is in the <{input/Radio|Radio Button}>
state and whose value 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 an <{input}> element
whose type attribute is in the <{input/Radio|Radio Button}> state and whose
value content attribute is present and equal to the new value, if any. If no
such element exists, then instead let element be null.
2. If element is not null, then set its checkedness to true.
HTMLOptionsCollection interfaceHTMLOptionsCollection 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.
interface HTMLOptionsCollection : HTMLCollection {
// inherits item(), namedItem()
attribute unsigned long length; // shadows inherited length
setter void (unsigned long index, HTMLOptionElement? option);
void add((HTMLOptionElement or HTMLOptGroupElement) element, optional (HTMLElement or long)? before = null);
void remove(long index);
attribute long selectedIndex;
};
length [ = value ]item(index)namedItem(name)name name from the collection.
If there are multiple matching items, then the first is returned.
add(element [, before ] )remove(index)selectedIndex [ = value ]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 {{HTMLOptionsCollection/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 <{global/id}> andname attributes of all the elements represented by the collection, in
tree order, ignoring later duplicates, with the <{global/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:
1. If value is null, invoke the steps for the remove method with
index as the argument, and abort these steps.
2. Let length be the number of nodes represented by the collection.
3. Let n be index minus length.
4. If n is greater than zero, then append a DocumentFragment
consisting of n-1 new <{option}> elements with no attributes and no
child nodes to the <{select}> element on which the HTMLOptionsCollection
is rooted.
5. 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:
1. If element is an ancestor of the <{select}> element on which the
HTMLOptionsCollection is rooted, then throw a {{HierarchyRequestError}}
exception and abort these steps.
2. If before is an element, but that element isn't a descendant of the
<{select}> element on which the HTMLOptionsCollection is rooted, then
throw a {{NotFoundError}} exception and abort these steps.
3. If element and before are the same element, then return and abort these
steps.
4. 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.
5. If reference is not null, let parent be the parent node of
reference. Otherwise, let parent be the <{select}> element on
which the HTMLOptionsCollection is rooted.
6. Pre-insert element into parent node before reference.
The remove(index) method
must act according to the following algorithm:
1. If the number of nodes represented by the collection is zero, abort these steps.
2. 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.
3. Let element be the indexth element in the collection.
4. 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
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 long index);
boolean contains(DOMString string);
};
New APIs must use `sequence
length attribute's getter must this
{{DOMStringList}} object's associated list's [=size=].
The item(index) method,
when invoked, must return the |index|th 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.
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/
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.
[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:
Person instance or null
Person instances to be serializable objects by
annotating the Person interface with the [Serializable]
extended attribute, and defining the following accompanying algorithms:
: serialization steps
::
1. Set serialized.[[Name]] to value's associated name value.
2. Let serializedBestFriend be the sub-serialization of
value's associated best friend value.
3. Set serialized.[[BestFriend]] to serializedBestFriend.
: deserialization steps
::
1. Set value's associated name value to serialized.[[Name]].
2. Let deserializedBestFriend be the sub-deserialization
of serialized.[[BestFriend]].
3. Set value's associated best friend value to deserializedBestFriend.
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.
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.
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.
2. If memory[value] exists, then return memory[value]. 3. Let deep be false. 4. If Type(value) is Undefined, Null, Boolean, String, or Number, then return { \[[Type]]: "primitive", \[[Value]]: value }. 5. If Type(value) is Symbol, then throw a "{{DataCloneError}}"DOMException.
6. Let serialized be an uninitialized value.
7. If value has a \[[BooleanData]] internal slot, then set serialized to
{ \[[Type]]: "Boolean", \[[BooleanData]]: value.\[[BooleanData]] }.
8. Otherwise, if value has a \[[NumberData]] internal slot, then set
serialized to { \[[Type]]: "Number", \[[NumberData]]: value.\[[NumberData]] }.
9. Otherwise, if value has a \[[StringData]] internal slot, then set
serialized to { \[[Type]]: "String", \[[StringData]]: value.\[[StringData]] }.
10. Otherwise, if value has a \[[DateValue]] internal slot, then set
serialized to { \[[Type]]: "Date", \[[DateValue]]: value.\[[DateValue]] }.
11. Otherwise, if value has a \[[RegExpMatcher]] internal slot, then set
serialized to { \[[Type]]: "RegExp", \[[RegExpMatcher]]:
value.\[[RegExpMatcher]], \[[OriginalSource]]: value.\[[OriginalSource]],
\[[OriginalFlags]]: value.\[[OriginalFlags]] }.
12. Otherwise, if value has an \[[ArrayBufferData]] internal slot, then:
1. Let size be value.\[[ArrayBufferByteLength]].
2. If ! IsSharedArrayBuffer(value) is true, then:
1. If forStorage is true, then throw a
"{{DataCloneError}}" DOMException.
2. Set serialized to { \[[Type]]: "SharedArrayBuffer", \[[ArrayBufferData]]:
value.\[[ArrayBufferData]], \[[ArrayBufferByteLength]]: size,
\[[AgentCluster]]: the current Realm Record's corresponding agent cluster }.
3. Otherwise:
1. If ! IsDetachedBuffer(value) is true, then throw a
"{{DataCloneError}}" DOMException.
2. Let dataCopy be ? CreateByteDataBlock(size).
This can throw a RangeError exception
upon allocation failure.
length").
2. Let valueLen be valueLenDescriptor.\[[Value]].
3. Set serialized to { \[[Type]]: "Array", \[[Length]]: valueLen,
\[[Properties]]: a new empty List }.
4. Set deep to true.
17. Otherwise, if value is a platform object that is a serializable object:
1. If value has a [[Detached]] internal slot whose value is true,
then throw a "{{DataCloneError}}" DOMException.
2. Let typeString be the identifier of the primary interface of
value.
3. Set serialized to { \[[Type]]: typeString }.
4. Set deep to true.
18. Otherwise, if value is a platform object, then throw a
"{{DataCloneError}}" DOMException.
19. Otherwise, if IsCallable(value) is true, then throw a
"{{DataCloneError}}" DOMException.
20. 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.
21. Otherwise, if value is an exotic object, then throw a "{{DataCloneError}}"DOMException.
For instance, a proxy object.
22. Otherwise: 1. Set serialized to { \[[Type]]: "Object", \[[Properties]]: a new empty List }. 2. Set deep to true. 23. Set memory[value] to serialized. 24. If deep is true, then: 1. If value has a \[[MapData]] internal slot, then: 1. Let copiedList be a new empty List. 2. For each Record { \[[Key]], \[[Value]] } entry of value.\[[MapData]]: 1. Let copiedEntry be a new Record { \[[Key]]: entry.\[[Key]], \[[Value]]: entry.\[[Value]] }. 2. If copiedEntry.\[[Key]] is not the special value empty, append copiedEntry to copiedList. 3. For each Record { \[[Key]], \[[Value]] } entry of copiedList: 1. Let serializedKey be ? StructuredSerializeInternal(entry.\[[Key]], forStorage, memory). 2. Let serializedValue be ? StructuredSerializeInternal(entry.\[[Value]], forStorage, memory). 3. Append { \[[Key]]: serializedKey, \[[Value]]: serializedValue } to serialized.\[[MapData]]. 2. Otherwise, if value has a \[[SetData]] internal slot, then: 1. Let copiedList be a new empty List. 2. For each entry of value.\[[SetData]]: 1. If entry is not the special value empty, append entry to copiedList. 3. For each entry of copiedList: 1. Let serializedEntry be ? StructuredSerializeInternal(entry, forStorage, memory). 2. Append serializedEntry to serialized.\[[SetData]]. 3. 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.) 4. Otherwise: 1. Let enumerableKeys be a new empty List. 2. For each key in ! value.\[[OwnPropertyKeys]](): 1. If Type(key) is String, then: 1. Let valueDesc be ! value.\[[GetOwnProperty]](key). 2. If valueDesc.\[[Enumerable]] is true, then append key to enumerableKeys. 3. For each key in enumerableKeys: 1. If ! HasOwnProperty(value, key) is true, then: 1. Let inputValue be ? value.\[[Get]](key, value). 2. Let outputValue be ? StructuredSerializeInternal(inputValue, forStorage, memory). 3. 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]] 25. Return serialized.
const o = {};
o.myself = o;
it produces the following result:
{
\[[Type]]: "Object",
\[[Properties]]: «
{
\[[Key]]: "myself",
\[[Value]]: <a pointer to this whole structure>
}
»
}
ArrayBuffer objects).
1. 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.
2. If memory[serialized] exists, then return memory[serialized]. 3. Let deep be false. 4. Let value be an uninitialized value. 5. If serialized contains a \[[TransferConsumed]] field, then: 1. 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.) 2. Set serialized.\[[TransferConsumed]] to true. 3. 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.
4. Otherwise: 1. Let interfaceName be serialized.\[[Type]]. 2. If the interface identified by interfaceName is not exposed in targetRealm, then throw a "{{DataCloneError}}"DOMException.
3. Set value to a new instance of the interface identified by
interfaceName, created in targetRealm.
4. Perform the appropriate transfer-receiving steps for the interface
identified by interfaceName given serialized and
value.
6. Otherwise, if serialized.\[[Type]] is "primitive", then set value to
serialized.\[[Value]].
7. Otherwise, if serialized.\[[Type]] is "Boolean", then set value to a new Boolean object in
targetRealm whose \[[BooleanData]] internal slot value is
serialized.\[[BooleanData]].
8. Otherwise, if serialized.\[[Type]] is "Number", then set value to a new Number object in
targetRealm whose \[[NumberData]] internal slot value is
serialized.\[[NumberData]].
9. Otherwise, if serialized.\[[Type]] is "String", then set value to a new String object in
targetRealm whose \[[StringData]] internal slot value is
serialized.\[[StringData]].
10. Otherwise, if serialized.\[[Type]] is "Date", then set value to a new Date object in
targetRealm whose \[[DateValue]] internal slot value is
serialized.\[[DateValue]].
11. 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]].
12. Otherwise, if serialized.\[[Type]] is "SharedArrayBuffer", then:
1. If targetRealm's corresponding agent cluster is not
serialized.\[[AgentCluster]], then throw a
"{{DataCloneError}}" DOMException.
2. 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]].
13. 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.
14. Otherwise, if serialized.\[[Type]] is "ArrayBufferView", then: 1. Let deserializedArrayBuffer be ? StructuredDeserialize(serialized.\[[ArrayBufferSerialized]], targetRealm, memory). 2. 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]]. 3. 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]]. 15. Otherwise, if serialized.\[[Type]] is "Map", then: 1. Set value to a new Map object in targetRealm whose \[[MapData]] internal slot value is a new empty List. 2. Set deep to true. 16. Otherwise, if serialized.\[[Type]] is "Set", then: 1. Set value to a new Set object in targetRealm whose \[[SetData]] internal slot value is a new empty List. 2. Set deep to true. 17. Otherwise, if serialized.\[[Type]] is "Array", then: 1. Let outputProto be the %ArrayPrototype% intrinsic object in targetRealm. 2. Set value to ! ArrayCreate(serialized.\[[Length]], outputProto). 3. Set deep to true. 18. Otherwise, if serialized.\[[Type]] is "Object", then: 1. Set value to a new Object in targetRealm. 2. Set deep to true. 19. Otherwise: 1. Let interfaceName be serialized.\[[Type]]. 2. If the interface identified by interfaceName is not exposed in targetRealm, then throw a "{{DataCloneError}}"DOMException.
3. Set value to a new instance of the interface identified by
interfaceName, created in targetRealm.
4. Set deep to true.
20. Set memory[serialized] to value.
21. If deep is true, then:
1. If serialized.\[[Type]] is "Map", then:
1. For each Record { \[[Key]], \[[Value]] }
entry of serialized.\[[MapData]]:
1. Let deserializedKey be ?
StructuredDeserialize(entry.\[[Key]], targetRealm,
memory).
2. Let deserializedValue be ?
StructuredDeserialize(entry.\[[Value]], targetRealm,
memory).
3. Append { \[[Key]]: deserializedKey,
[Value]]: deserializedValue } to value.\[[MapData]].
2. Otherwise, if serialized.\[[Type]] is "Set", then:
1. For each entry of
serialized.\[[SetData]]:
1. Let deserializedEntry be ?
StructuredDeserialize(entry, targetRealm,
memory).
2. Append deserializedEntry to value.\[[SetData]].
3. Otherwise, if serialized.\[[Type]] is "Array" or "Object", then:
1. For each Record { \[[Key]], \[[Value]] }
entry of serialized.\[[Properties]]:
1. Let deserializedValue be ?
StructuredDeserialize(entry.\[[Value]], targetRealm,
memory).
2. Let result be ! CreateDataProperty(value,
entry.\[[Key]], deserializedValue).
3. Assert: result is true.
4. Otherwise:
1. 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.)
22. Return value.
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.
2. For each transferable of transferList: 1. If transferable has neither an \[[ArrayBufferData]] internal slot nor a [[Detached]] internal slot, then throw a "{{DataCloneError}}"DOMException.
2. If transferable has an \[[ArrayBufferData]] internal slot and either !
IsSharedArrayBuffer(transferable) is true or !
IsDetachedBuffer(transferable) is true, then throw a
"{{DataCloneError}}" DOMException.
3. If transferable has a [[Detached]] internal slot and
transferable.[[Detached]] is true, then throw a
"{{DataCloneError}}" DOMException.
4. Let placeholder be a user-agent-defined placeholder object.
5. Set memory[transferable] to placeholder.
3. Let serialized be ? StructuredSerializeInternal(value,
false, memory).
4. Let transferDataHolders be a new empty List.
5. For each transferable of transferList:
1. Let placeholder be memory[transferable].
2. Let dataHolder be an uninitialized value.
3. If transferable has an \[[ArrayBufferData]] internal slot, then:
1. Set dataHolder to { \[[TransferConsumed]]: false, \[[Type]]: "ArrayBuffer",
\[[ArrayBufferData]]: transferable.\[[ArrayBufferData]], \[[ArrayBufferByteLength]]:
transferable.\[[ArrayBufferByteLength]] }.
2. Perform ! DetachArrayBuffer(transferable).
4. Otherwise:
1. Assert: transferable is a platform object that is
a transferable object.
2. Let interfaceName be the identifier of the primary interface
of transferable.
3. Set dataHolder to { \[[TransferConsumed]]: false, \[[Type]]:
interfaceName }.
4. Perform the appropriate transfer steps for the interface identified by
interfaceName, given transferable and dataHolder.
5. Set transferable.[[Detached]] to true.
5. Within serialized, replace all instances of placeholder with
dataHolder.
6. Append dataHolder to transferDataHolders.
6. Return { \[[Serialized]]: serialized, \[[TransferDataHolders]]:
transferDataHolders }.
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.
2. Let deserialized be ? StructuredDeserialize(serializeWithTransferResult.\[[Serialized]], targetRealm, memory). 3. Let transferredValues be a new empty List. 4. For each transferDataHolder of serializeWithTransferResult.\[[TransferDataHolders]]: 1. Append memory[transferDataHolder] to transferredValues. 5. Return { \[[Deserialized]]: deserialized, \[[TransferredValues]]: transferredValues }.messagePort.postMessage()
uses this pair of abstract operations, as the destination Realm is not known until the
MessagePort has been shipped.
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() and history.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 the history.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.
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.