DOM

DOM utilities module for WordPress.

Installation

Install the module

npm install @wordpress/dom --save

API

# computeCaretRect

Get the rectangle for the selection in a container.

Parameters

• win Window: The window of the selection.

Returns

• ?DOMRect: The rectangle.

# documentHasSelection

Check whether the current document has a selection. This checks for both focus in an input field and general text selection.

Parameters

• doc Document: The document to check.

Returns

• boolean: True if there is selection, false if not.

# documentHasTextSelection

Check whether the current document has selected text. This applies to ranges of text in the document, and not selection inside and elements.</p> <p>See: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection#Related_objects" title="undefined" rel="noopener noreferrer">https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection#Related_objects</a>.</p> <p><em>Parameters</em></p> <ul> <li><em>doc</em> <code>Document</code>: The document to check.</li> </ul> <p><em>Returns</em></p> <ul> <li><code>boolean</code>: True if there is selection, false if not.</li> </ul> <p><a name="documentHasUncollapsedSelection" href="#documentHasUncollapsedSelection">#</a> <strong>documentHasUncollapsedSelection</strong></p> <p>Check whether the current document has any sort of selection. This includes ranges of text across elements and any selection inside <input> and</p> <textarea> elements. _Parameters_ - _doc_ `Document`: The document to check. _Returns_ - `boolean`: Whether there is any sort of "selection" in the document. <a name="focus" href="#focus">#</a> **focus** Object grouping `focusable` and `tabbable` utils under the keys with the same name. <a name="getFilesFromDataTransfer" href="#getFilesFromDataTransfer">#</a> **getFilesFromDataTransfer** Gets all files from a DataTransfer object. _Parameters_ - _dataTransfer_ `DataTransfer`: DataTransfer object to inspect. _Returns_ - `Array<Object>`: An array containing all files. <a name="getOffsetParent" href="#getOffsetParent">#</a> **getOffsetParent** Returns the closest positioned element, or null under any of the conditions of the offsetParent specification. Unlike offsetParent, this function is not limited to HTMLElement and accepts any Node (e.g. Node.TEXT_NODE). _Related_ - <https://drafts.csswg.org/cssom-view/#dom-htmlelement-offsetparent> _Parameters_ - _node_ `Node`: Node from which to find offset parent. _Returns_ - `?Node`: Offset parent. <a name="getPhrasingContentSchema" href="#getPhrasingContentSchema">#</a> **getPhrasingContentSchema** Get schema of possible paths for phrasing content. _Related_ - <https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content> _Parameters_ - _context_ `string`: Set to "paste" to exclude invisible elements and sensitive data. _Returns_ - `Object`: Schema. <a name="getRectangleFromRange" href="#getRectangleFromRange">#</a> **getRectangleFromRange** Get the rectangle of a given Range. _Parameters_ - _range_ `Range`: The range. _Returns_ - `DOMRect`: The rectangle. <a name="getScrollContainer" href="#getScrollContainer">#</a> **getScrollContainer** Given a DOM node, finds the closest scrollable container node. _Parameters_ - _node_ `Element`: Node from which to start. _Returns_ - `?Element`: Scrollable container node, if found. <a name="insertAfter" href="#insertAfter">#</a> **insertAfter** Given two DOM nodes, inserts the former in the DOM as the next sibling of the latter. _Parameters_ - _newNode_ `Element`: Node to be inserted. - _referenceNode_ `Element`: Node after which to perform the insertion. _Returns_ - `void`: <a name="isEmpty" href="#isEmpty">#</a> **isEmpty** Recursively checks if an element is empty. An element is not empty if it contains text or contains elements with attributes such as images. _Parameters_ - _element_ `Element`: The element to check. _Returns_ - `boolean`: Whether or not the element is empty. <a name="isEntirelySelected" href="#isEntirelySelected">#</a> **isEntirelySelected** Check whether the contents of the element have been entirely selected. Returns true if there is no possibility of selection. _Parameters_ - _element_ `Element`: The element to check. _Returns_ - `boolean`: True if entirely selected, false if not. <a name="isHorizontalEdge" href="#isHorizontalEdge">#</a> **isHorizontalEdge** Check whether the selection is horizontally at the edge of the container. _Parameters_ - _container_ `Element`: Focusable element. - _isReverse_ `boolean`: Set to true to check left, false for right. _Returns_ - `boolean`: True if at the horizontal edge, false if not. <a name="isNumberInput" href="#isNumberInput">#</a> **isNumberInput** Check whether the given element is an input field of type number and has a valueAsNumber _Parameters_ - _element_ `HTMLElement`: The HTML element. _Returns_ - `boolean`: True if the element is input and holds a number. <a name="isPhrasingContent" href="#isPhrasingContent">#</a> **isPhrasingContent** Find out whether or not the given node is phrasing content. _Related_ - <https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_categories#Phrasing_content> _Parameters_ - _node_ `Element`: The node to test. _Returns_ - `boolean`: True if phrasing content, false if not. <a name="isTextContent" href="#isTextContent">#</a> **isTextContent** Undocumented declaration. <a name="isTextField" href="#isTextField">#</a> **isTextField** Check whether the given element is a text field, where text field is defined by the ability to select within the input, or that it is contenteditable. See: <https://html.spec.whatwg.org/#textFieldSelection> _Parameters_ - _element_ `HTMLElement`: The HTML element. _Returns_ - `boolean`: True if the element is an text field, false if not. <a name="isVerticalEdge" href="#isVerticalEdge">#</a> **isVerticalEdge** Check whether the selection is vertically at the edge of the container. _Parameters_ - _container_ `Element`: Focusable element. - _isReverse_ `boolean`: Set to true to check top, false for bottom. _Returns_ - `boolean`: True if at the vertical edge, false if not. <a name="placeCaretAtHorizontalEdge" href="#placeCaretAtHorizontalEdge">#</a> **placeCaretAtHorizontalEdge** Places the caret at start or end of a given element. _Parameters_ - _container_ `Element`: Focusable element. - _isReverse_ `boolean`: True for end, false for start. <a name="placeCaretAtVerticalEdge" href="#placeCaretAtVerticalEdge">#</a> **placeCaretAtVerticalEdge** Places the caret at the top or bottom of a given element. _Parameters_ - _container_ `Element`: Focusable element. - _isReverse_ `boolean`: True for bottom, false for top. - _rect_ `[DOMRect]`: The rectangle to position the caret with. - _mayUseScroll_ `[boolean]`: True to allow scrolling, false to disallow. <a name="remove" href="#remove">#</a> **remove** Given a DOM node, removes it from the DOM. _Parameters_ - _node_ `Element`: Node to be removed. _Returns_ - `void`: <a name="removeInvalidHTML" href="#removeInvalidHTML">#</a> **removeInvalidHTML** Given a schema, unwraps or removes nodes, attributes and classes on HTML. _Parameters_ - _HTML_ `string`: The HTML to clean up. - _schema_ `Object`: Schema for the HTML. - _inline_ `Object`: Whether to clean for inline mode. _Returns_ - `string`: The cleaned up HTML. <a name="replace" href="#replace">#</a> **replace** Given two DOM nodes, replaces the former with the latter in the DOM. _Parameters_ - _processedNode_ `Element`: Node to be removed. - _newNode_ `Element`: Node to be inserted in its place. _Returns_ - `void`: <a name="replaceTag" href="#replaceTag">#</a> **replaceTag** Replaces the given node with a new node with the given tag name. _Parameters_ - _node_ `Element`: The node to replace - _tagName_ `string`: The new tag name. _Returns_ - `Element`: The new node. <a name="safeHTML" href="#safeHTML">#</a> **safeHTML** Strips scripts and on\* attributes from HTML. _Parameters_ - _html_ `string`: HTML to sanitize. _Returns_ - `string`: The sanitized HTML. <a name="unwrap" href="#unwrap">#</a> **unwrap** Unwrap the given node. This means any child nodes are moved to the parent. _Parameters_ - _node_ `Node`: The node to unwrap. _Returns_ - `void`: <a name="wrap" href="#wrap">#</a> **wrap** Wraps the given node with a new node with the given tag name. _Parameters_ - _newNode_ `Element`: The node to insert. - _referenceNode_ `Element`: The node to wrap. <!-- END TOKEN(Autogenerated API docs) --> <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p> </section></jspm-packages-readme></details></main></section><footer><section class="maintainers"><h3>Collaborators</h3><ul><li><a href="https://www.github.com/garypendergast"><figure><img loading="lazy" alt="garypendergast" src="https://unavatar.io/gary@pento.net" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/adamsilverstein"><figure><img loading="lazy" alt="adamsilverstein" src="https://unavatar.io/adam@10up.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/gziolo"><figure><img loading="lazy" alt="gziolo" src="https://unavatar.io/grzegorz@gziolo.pl" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/ntwb"><figure><img loading="lazy" alt="ntwb" src="https://unavatar.io/stephen@netweb.com.au" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/riad"><figure><img loading="lazy" alt="riad" src="https://unavatar.io/benguella@gmail.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/noisysocks"><figure><img loading="lazy" alt="noisysocks" src="https://unavatar.io/robert@noisysocks.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/kadamwhite"><figure><img loading="lazy" alt="kadamwhite" src="https://unavatar.io/adam@kadamwhite.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/gutenbergplugin"><figure><img loading="lazy" alt="gutenbergplugin" src="https://unavatar.io/gutenberg@wordpress.org" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/jorgefilipecosta"><figure><img loading="lazy" alt="jorgefilipecosta" src="https://unavatar.io/jorge.costa@developer.pt" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/ellatrix"><figure><img loading="lazy" alt="ellatrix" src="https://unavatar.io/ella@vandurpe.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/iandunn206"><figure><img loading="lazy" alt="iandunn206" src="https://unavatar.io/ian@iandunn.name" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/whyisjake"><figure><img loading="lazy" alt="whyisjake" src="https://unavatar.io/whyisjake@gmail.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/ockham"><figure><img loading="lazy" alt="ockham" src="https://unavatar.io/ockham@raz.or.at" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/sirreal"><figure><img loading="lazy" alt="sirreal" src="https://unavatar.io/jon.surrell@gmail.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/nosolosw"><figure><img loading="lazy" alt="nosolosw" src="https://unavatar.io/andres.maneiro@gmail.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/wpisabel"><figure><img loading="lazy" alt="wpisabel" src="https://unavatar.io/isabel.brison@automattic.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/ntsekouras"><figure><img loading="lazy" alt="ntsekouras" src="https://unavatar.io/ntsekouras@outlook.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/nerrad"><figure><img loading="lazy" alt="nerrad" src="https://unavatar.io/darren@roughsmootheng.in" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/desrosj"><figure><img loading="lazy" alt="desrosj" src="https://unavatar.io/desrosjaccounts@gmail.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/talldanwp"><figure><img loading="lazy" alt="talldanwp" src="https://unavatar.io/daniel.richards@automattic.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/peterwilsoncc"><figure><img loading="lazy" alt="peterwilsoncc" src="https://unavatar.io/wilson@peterwilson.cc" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/ryanwelcher"><figure><img loading="lazy" alt="ryanwelcher" src="https://unavatar.io/me@ryanwelcher.com" width="75" height="75" /></figure></a></li><li><a href="https://www.github.com/mamaduka"><figure><img loading="lazy" alt="mamaduka" src="https://unavatar.io/georgemamadashvili@gmail.com" width="75" height="75" /></figure></a></li></ul></section><section class="keywords"><h3>Keywords</h3><ul><li><a href="/search?keyword=wordpress">#wordpress</a></li><li><a href="/search?keyword=gutenberg">#gutenberg</a></li><li><a href="/search?keyword=dom">#dom</a></li><li><a href="/search?keyword=utils">#utils</a></li></ul></section><section><h3>Dependencies</h3><ul><li><a href="/package/@babel/runtime">@babel/runtime</a></li><li><a href="/package/lodash">lodash</a></li></ul></section></footer></section></jspm-packages-package> </jspm-packages> <script type="module"> import '@jspm/packages/package-dom'; </script> </body> </html>