web api interface

Document

The Document interface represents any web page loaded in the browser and serves as an entry point into the web page’s content, which is the DOM tree.

The DOM tree includes elements such as <body> and <table>, among many others. It provides functionality globally to the document, like how to obtain the page’s URL and create new elements in the document.

The Document interface describes the common properties and methods for any kind of document. Depending on the document’s type (e.g., HTML, XML, SVG, …), a larger API is available: HTML documents, served with the "text/html" content type, also implement the HTMLDocument interface, whereas XML and SVG documents implement the XMLDocument interface.

Constructor

Document()
- : Creates a new Document object.

Instance properties

This interface also inherits from the Node and EventTarget interfaces.

activeElement Read only
- : Returns the Element that currently has focus.
activeViewTransition Read only
- : Returns a ViewTransition instance representing the view transition currently active on the document, or null if there is no active view transition.
adoptedStyleSheets
- : Add an array of constructed stylesheets to be used by the document. These stylesheets may also be shared with shadow DOM subtrees of the same document.
body
- : Returns the <body> or <frameset> node of the current document.
characterSet Read only
- : Returns the character set being used by the document.
childElementCount Read only
- : Returns the number of child elements of the current document.
children Read only
- : Returns the child elements of the current document.
compatMode Read only
- : Indicates whether the document is rendered in quirks or strict mode.
contentType Read only
- : Returns the Content-Type from the MIME Header of the current document.
currentScript Read only
- : Returns the <script> element whose script is currently being processed and isn’t a JavaScript module.
customElementRegistry Read only
- : The CustomElementRegistry object associated with this document, or null if one has not been set.
doctype Read only
- : Returns the Document Type Definition (DTD) of the current document.
documentElement Read only
- : Returns the Element that is a direct child of the document. For HTML documents, this is normally the HTMLHtmlElement object representing the document’s <html> element.
documentURI Read only
- : Returns the document location as a string.
embeds Read only
- : Returns an HTMLCollection of the embedded <embed> elements in the document.
featurePolicy Experimental Read only
- : Returns the FeaturePolicy interface with the feature policies applied to the document.
firstElementChild Read only
- : Returns the first child element of the current document.
fonts
- : Returns the FontFaceSet interface of the current document.
forms Read only
- : Returns an HTMLCollection of the <form> elements in the document.
fragmentDirective Read only
- : Returns the FragmentDirective for the current document.
fullscreenElement Read only
- : The element that’s currently in full screen mode for this document.
head Read only
- : Returns the <head> element of the current document.
hidden Read only
- : Returns a Boolean value indicating if the page is considered hidden or not.
images Read only
- : Returns an HTMLCollection of the images in the document.
implementation Read only
- : Returns the DOM implementation associated with the current document.
lastElementChild Read only
- : Returns the last child element of the current document.
links Read only
- : Returns an HTMLCollection of the hyperlinks in the document.
pictureInPictureElement Read only
- : Returns the Element currently being presented in picture-in-picture mode in this document.
pictureInPictureEnabled Read only
- : Returns true if the picture-in-picture feature is enabled.
plugins Read only
- : Returns an HTMLCollection of the available plugins.
pointerLockElement Read only
- : Returns the element set as the target for mouse events while the pointer is locked. null if lock is pending, pointer is unlocked, or if the target is in another document.
prerendering Read only Experimental
- : Returns a boolean that indicates whether the document is currently in the process of prerendering, as initiated via the Speculation Rules API.
scripts Read only
- : Returns an HTMLCollection of the <script> elements in the document.
scrollingElement Read only
- : Returns a reference to the Element that scrolls the document.
styleSheets Read only
- : Returns a StyleSheetList of CSSStyleSheet objects for stylesheets explicitly linked into, or embedded in a document.
timeline Read only
- : Returns timeline as a special instance of DocumentTimeline that is automatically created on page load.
visibilityState Read only
- : Returns a string denoting the visibility state of the document. Possible values are visible, hidden, and unloaded.

Extensions for HTMLDocument

The Document interface for HTML documents inherits from the HTMLDocument interface or is extended for such documents.

cookie
- : Returns a semicolon-separated list of the cookies for that document or sets a single cookie.
defaultView Read only
- : Returns a reference to the window object.
designMode
- : Gets/sets the ability to edit the whole document.
dir
- : Gets/sets directionality (rtl/ltr) of the document.
fullscreenEnabled Read only
- : Indicates whether fullscreen mode is available.
lastModified Read only
- : Returns the date on which the document was last modified.
location Read only
- : Returns the URI of the current document.
readyState Read only
- : Returns loading status of the document.
referrer Read only
- : Returns the URI of the page that linked to this page.
title
- : Sets or gets the title of the current document.
URL Read only
- : Returns the document location as a string.
Named properties
- : Some elements in the document are also exposed as properties:
  - For each <embed>, <form>, <iframe>, <img>, and <object> element, its name (if non-empty) is exposed. For example, if the document contains <form name="my_form">, then document["my_form"] (and its equivalent document.my_form) returns a reference to that element.
  - For each <object> element, its id (if non-empty) is exposed.
  - For each <img> element with non-empty name, its id (if non-empty) is exposed.
  If a property corresponds to a single element, that element is directly returned. If that single element is an iframe, then its contentWindow is returned instead. If the property corresponds to multiple elements, then an HTMLCollection is returned containing all of them.

Deprecated properties

alinkColor Deprecated
- : Returns or sets the color of active links in the document body.
all Deprecated
- : Provides access to all elements in the document — it returns an HTMLAllCollection rooted at the document node. This is a legacy, non-standard property and should not be used.
anchors Deprecated Read only
- : Returns a list of all of the anchors in the document.
applets Deprecated Read only
- : Returns an empty HTMLCollection. Legacy property that used to return the list of applets within a document.
bgColor Deprecated
- : Gets/sets the background color of the current document.
Document.charset Deprecated Read only
- : Alias of characterSet. Use this property instead.
domain Deprecated
- : Gets/sets the domain of the current document.
fgColor Deprecated
- : Gets/sets the foreground color, or text color, of the current document.
fullscreen Deprecated
- : Returns true when the document is in fullscreen mode.
Document.inputEncoding Deprecated Read only
- : Alias of characterSet. Use this property instead.
lastStyleSheetSet Deprecated Read only
- : Returns the name of the style sheet set that was last enabled. Has the value null until the style sheet is changed by setting the value of selectedStyleSheetSet.
linkColor Deprecated
- : Gets/sets the color of hyperlinks in the document.
preferredStyleSheetSet Deprecated Read only
- : Returns the preferred style sheet set as specified by the page author.
rootElement Deprecated
- : Like documentElement, but only for <svg> root elements. Use this property instead.
selectedStyleSheetSet Deprecated
- : Returns which style sheet set is currently in use.
styleSheetSets Deprecated Read only
- : Returns a list of the style sheet sets available on the document.
vlinkColor Deprecated
- : Gets/sets the color of visited hyperlinks.
xmlEncoding Deprecated
- : Returns the encoding as determined by the XML declaration.
Document.xmlStandalone Deprecated
- : Returns true if the XML declaration specifies the document to be standalone (e.g., An external part of the DTD affects the document’s content), else false.
xmlVersion Deprecated
- : Returns the version number as specified in the XML declaration or "1.0" if the declaration is absent.

Instance methods

This interface also inherits from the Node and EventTarget interfaces.

adoptNode()
- : Adopt node from an external document.
append()
- : Inserts a set of Node objects or strings after the last child of the document.
ariaNotify()
- : Specifies that a given string of text should be announced by a screen reader.
browsingTopics() Deprecated
- : Returns a promise that fulfills with an array of objects representing the top topics for the user, one from each of the last three epochs. By default, the method also causes the browser to record the current page visit as observed by the caller, so the page’s hostname can later be used in topics calculation. See the Topics API for more details.
Document.captureEvents() Deprecated
- : See captureEvents.
caretPositionFromPoint()
- : Returns a CaretPosition object containing the DOM node containing the caret, and caret’s character offset within that node.
caretRangeFromPoint()
- : Gets a Range object for the document fragment under the specified coordinates.
createAttribute()
- : Creates a new Attr object and returns it.
createAttributeNS()
- : Creates a new attribute node in a given namespace and returns it.
createCDATASection()
- : Creates a new CDATA node and returns it.
createComment()
- : Creates a new comment node and returns it.
createDocumentFragment()
- : Creates a new document fragment.
createElement()
- : Creates a new element with the given tag name.
createElementNS()
- : Creates a new element with the given tag name and namespace URI.
createEvent() Deprecated
- : Creates an event object.
createNodeIterator()
- : Creates a NodeIterator object.
createProcessingInstruction()
- : Creates a new ProcessingInstruction object.
createRange()
- : Creates a Range object.
createTextNode()
- : Creates a text node.
createTouch() Deprecated
- : Creates a Touch object.
createTouchList() Deprecated
- : Creates a TouchList object.
createTreeWalker()
- : Creates a TreeWalker object.
elementFromPoint()
- : Returns the topmost element at the specified coordinates.
elementsFromPoint()
- : Returns an array of all elements at the specified coordinates.
enableStyleSheetsForSet() Deprecated
- : Enables the style sheets for the specified style sheet set.
exitFullscreen()
- : Stops document’s fullscreen element from being displayed fullscreen.
exitPictureInPicture()
- : Remove the video from the floating picture-in-picture window back to its original container.
exitPointerLock()
- : Release the pointer lock.
getAnimations()
- : Returns an array of all Animation objects currently in effect, whose target elements are descendants of the document.
Document.getBoxQuads() Experimental
- : Returns a list of DOMQuad objects representing the CSS fragments of the node.
Document.getElementById()
- : Returns an object reference to the identified element.
getElementsByClassName()
- : Returns a list of elements with the given class name.
getElementsByTagName()
- : Returns a list of elements with the given tag name.
getElementsByTagNameNS()
- : Returns a list of elements with the given tag name and namespace.
getSelection()
- : Returns a Selection object representing the range of text selected by the user, or the current position of the caret.
hasPrivateToken() Experimental
- : Returns a promise that fulfills with a boolean indicating whether the browser has a private state token stored from a particular issuer.
hasRedemptionRecord() Experimental
- : Returns a promise that fulfills with a boolean indicating whether the browser has a redemption record originating from a particular issuer.
hasStorageAccess()
- : Returns a Promise that resolves with a boolean value indicating whether the document has access to unpartitioned cookies.
hasUnpartitionedCookieAccess()
- : New name for hasStorageAccess().
importNode()
- : Returns a clone of a node from an external document.
moveBefore()
- : Moves a given Node inside the Document DOM node as a direct child, before a given reference node, without removing and then inserting the node.
mozSetImageElement()
- : Allows you to change the element being used as the background image for a specified element ID.
prepend()
- : Inserts a set of Node objects or strings before the first child of the document.
querySelector()
- : Returns the first Element node within the document, in document order, that matches the specified selectors.
querySelectorAll()
- : Returns a list of all the Element nodes within the document that match the specified selectors.
releaseCapture()
- : Releases the current mouse capture if it’s on an element in this document.
Document.releaseEvents() Deprecated
- : See releaseEvents().
replaceChildren()
- : Replaces the existing children of a document with a specified new set of children.
requestStorageAccess()
- : Allows a document loaded in a third-party context (i.e., embedded in an <iframe>) to request access to unpartitioned cookies, in cases where user agents by default block access to unpartitioned cookies by sites loaded in a third-party context to improve privacy.
requestStorageAccessFor() Deprecated
- : Allows top-level sites to request third-party cookie access on behalf of embedded content originating from another site in the same related website set.
startViewTransition()
- : Starts a new view transition and returns a ViewTransition object to represent it.

The Document interface is extended with the XPathEvaluator interface:

createExpression()
- : Compiles an XPathExpression which can then be used for (repeated) evaluations.
createNSResolver() Deprecated
- : Returns the input node as-is.
evaluate()
- : Evaluates an XPath expression.

Extension for HTML documents

The Document interface for HTML documents inherit from the HTMLDocument interface or is extended for such documents:

clear() Deprecated
- : This method does nothing.
close()
- : Closes a document stream for writing.
execCommand() Deprecated
- : On an editable document, executes a formatting command.
getElementsByName()
- : Returns a list of elements with the given name.
hasFocus()
- : Returns true if the focus is currently located anywhere inside the specified document.
open()
- : Opens a document stream for writing.
queryCommandEnabled() Deprecated
- : Returns true if the formatting command can be executed on the current range.
Document.queryCommandIndeterm() Deprecated
- : Returns true if the formatting command is in an indeterminate state on the current range.
queryCommandState() Deprecated
- : Returns true if the formatting command has been executed on the current range.
queryCommandSupported() Deprecated
- : Returns true if the formatting command is supported on the current range.
Document.queryCommandValue() Deprecated
- : Returns the current value of the current range for a formatting command.
write() Deprecated
- : Writes text in a document.
writeln() Deprecated
- : Writes a line of text in a document.

Static methods

This interface also inherits from the Node and EventTarget interfaces.

Document.parseHTML()
- : Creates a new Document object from a string of HTML in an XSS-safe manner with sanitization.
Document.parseHTMLUnsafe()
- : Creates a new Document object from a string of HTML without performing sanitization. The string may contain declarative shadow roots.

Events

Listen to these events using addEventListener() or by assigning an event listener to the oneventname property of this interface. In addition to the events listed below, many events can bubble from nodes contained in the document tree.

afterscriptexecute Deprecated
- : Fired when a static <script> element finishes executing its script
beforescriptexecute Deprecated
- : Fired when a static <script> is about to start executing.
prerenderingchange Experimental
- : Fired on a prerendered document when it is activated (i.e., the user views the page).
securitypolicyviolation
- : Fired when a content security policy is violated.
visibilitychange
- : Fired when the content of a tab has become visible or has been hidden.

Fullscreen events

fullscreenchange
- : Fired when the Document transitions into or out of fullscreen mode.
fullscreenerror
- : Fired if an error occurs while attempting to switch into or out of fullscreen mode.

Load & unload events

DOMContentLoaded
- : Fired when the document has been completely loaded and parsed, without waiting for stylesheets, images, and subframes to finish loading.
readystatechange
- : Fired when the readyState attribute of a document has changed.

Pointer lock events

pointerlockchange
- : Fired when the pointer is locked/unlocked.
pointerlockerror
- : Fired when locking the pointer failed.

Scroll events

scroll
- : Fired when the document view or an element has been scrolled.
scrollend
- : Fired when the document view or an element has completed scrolling.
scrollsnapchange Experimental
- : Fired on the scroll container at the end of a scrolling operation when a new scroll snap target has been selected.
scrollsnapchanging Experimental
- : Fired on the scroll container when the browser determines a new scroll snap target is pending, i.e., it will be selected when the current scroll gesture ends.

Selection events

selectionchange
- : Fired when the current text selection on a document is changed.

Bubbled events

Not all events that bubble can reach the Document object. Only the following do and can be listened for on the Document object:

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.