@wordpress/dom 
Edit
DOM utilities module for WordPress.
Installation Installation
Install the module
npm install @wordpress/dom --save
API API
computeCaretRect computeCaretRect
Get the rectangle for the selection in a container.
Parameters
- win
Window: The window of the selection.
Returns
DOMRect | null: The rectangle.
documentHasSelection 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 documentHasTextSelection
Check whether the current document has selected text. This applies to ranges
of text in the document, and not selection inside <input> and <textarea>
elements.
See: https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection#Related_objects.
Parameters
- doc
Document: The document to check.
Returns
boolean: True if there is selection, false if not.
documentHasUncollapsedSelection documentHasUncollapsedSelection
Check whether the current document has any sort of selection. This includes
ranges of text across elements and any selection inside <input> and
<textarea> elements.
Parameters
- doc
Document: The document to check.
Returns
boolean: Whether there is any sort of “selection” in the document.
focus focus
Object grouping focusable and tabbable utils
under the keys with the same name.
getFilesFromDataTransfer getFilesFromDataTransfer
Gets all files from a DataTransfer object.
Parameters
- dataTransfer
DataTransfer: DataTransfer object to inspect.
Returns
File[]: An array containing all files.
getOffsetParent 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
Parameters
- node
Node: Node from which to find offset parent.
Returns
Node | null: Offset parent.
getPhrasingContentSchema getPhrasingContentSchema
Get schema of possible paths for phrasing content.
Related
Parameters
- context
[string]: Set to “paste” to exclude invisible elements and sensitive data.
Returns
Partial<ContentSchema>: Schema.
getRectangleFromRange getRectangleFromRange
Get the rectangle of a given Range.
Parameters
- range
Range: The range.
Returns
DOMRect: The rectangle.
getScrollContainer getScrollContainer
Given a DOM node, finds the closest scrollable container node.
Parameters
- node
Element | null: Node from which to start.
Returns
Element | undefined: Scrollable container node, if found.
insertAfter insertAfter
Given two DOM nodes, inserts the former in the DOM as the next sibling of
the latter.
Parameters
- newNode
Node: Node to be inserted. - referenceNode
Node: Node after which to perform the insertion.
Returns
void:
isEmpty 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.
isEntirelySelected isEntirelySelected
Check whether the contents of the element have been entirely selected.
Returns true if there is no possibility of selection.
Parameters
- element
HTMLElement: The element to check.
Returns
boolean: True if entirely selected, false if not.
isHorizontalEdge 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.
isNumberInput isNumberInput
Check whether the given element is an input field of type number
and has a valueAsNumber
Parameters
- node
Node: The HTML node.
Returns
node is HTMLInputElement: True if the node is input and holds a number.
isPhrasingContent isPhrasingContent
Find out whether or not the given node is phrasing content.
Related
Parameters
- node
Node: The node to test.
Returns
boolean: True if phrasing content, false if not.
isRTL isRTL
Whether the element’s text direction is right-to-left.
Parameters
- element
Element: The element to check.
Returns
boolean: True if rtl, false if ltr.
isTextContent isTextContent
Parameters
- node
Node:
Returns
boolean: Node is text content
isTextField 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
- node
Node: The HTML element.
Returns
node is HTMLElement: True if the element is an text field, false if not.
isVerticalEdge 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.
placeCaretAtHorizontalEdge placeCaretAtHorizontalEdge
Places the caret at start or end of a given element.
Parameters
- container
HTMLElement: Focusable element. - isReverse
boolean: True for end, false for start.
placeCaretAtVerticalEdge placeCaretAtVerticalEdge
Places the caret at the top or bottom of a given element.
Parameters
- container
HTMLElement: Focusable element. - isReverse
boolean: True for bottom, false for top. - rect
[DOMRect]: The rectangle to position the caret with.
remove remove
Given a DOM node, removes it from the DOM.
Parameters
- node
Node: Node to be removed.
Returns
void:
removeInvalidHTML removeInvalidHTML
Given a schema, unwraps or removes nodes, attributes and classes on HTML.
Parameters
- HTML
string: The HTML to clean up. - schema
import('./clean-node-list').Schema: Schema for the HTML. - inline
boolean: Whether to clean for inline mode.
Returns
string: The cleaned up HTML.
replace 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:
replaceTag 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.
safeHTML safeHTML
Strips scripts and on* attributes from HTML.
Parameters
- html
string: HTML to sanitize.
Returns
string: The sanitized HTML.
unwrap unwrap
Unwrap the given node. This means any child nodes are moved to the parent.
Parameters
- node
Node: The node to unwrap.
Returns
void:
wrap 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.
