Selection.containsNode()

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The Selection.containsNode() method indicates if the node is part of the selection.

Syntax

sel.containsNode(node, partialContainment)

Parameters

node
The node that is being looked for in the selection.
partialContainment Optional
When true, containsNode() returns true when a part of the node is part of the selection. When false, containsNode() only returns true when the entire node is part of the selection. If not specified, the default value false is used.

Examples

 /* Check to see if anything inside the body element is selected */
 console.log(window.getSelection().containsNode(document.body, true));

Specifications

Specification Status Comment
HTML Editing APIs
The definition of 'Selection.containsNode' in that specification.		 Editor's Draft Initial definition
Selection API
The definition of 'Selection.containsNode()' in that specification.		 Working Draft Current

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) (Yes) 4.0 (2)[1] No support (Yes) (Yes)
partialContainment parameter is optional (Yes) ? 55 (55) No support (Yes) (Yes)
Feature Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? (Yes) 4.0 (2)[1] No support ? (Yes)
partialContainment parameter is optional ? ? 55.0 (55) No support ? (Yes)

[1] Before Firefox 35, the method didn't throw if node was null.

See also

Document Tags and Contributors

Tags: 
 Contributors to this page: chrisdavidmills, realappie, abbycar, fscholz, BenjamP, teoli, MHasan, kscarfone, Kartik_Chadha, Sheppy, Federico, DR, Rev, Mw22
 Last updated by: chrisdavidmills,