The Window.getSelection()
method returns a Selection
object representing the range of text selected by the user or the current position of the caret.
Syntax
selection = window.getSelection();
Return value
A Selection
object.
When cast to string, either by appending an empty string (""
) or using Selection.toString()
, this object returns the text selected.
When called on an <iframe>
that is not displayed (eg. where display: none
is set) Firefox will return null
, whereas other browsers will return a Selection
object with Selection.type
set to None
.
Examples
function foo() { var selObj = window.getSelection(); alert(selObj); var selRange = selObj.getRangeAt(0); // do stuff with the range }
Notes
String representation of the Selection object
In JavaScript, when an object is passed to a function expecting a string (like window.alert()
or document.write()
), the object's toString()
method is called and the returned value is passed to the function. This can make the object appear to be a string when used with other functions when it is really an object with properties and methods.
In the above example, selObj.toString()
is automatically called when it is passed to window.alert()
. However, attempting to use a JavaScript String property or method such as length
or substr
directly on a Selection
object will result in an error if it does not have that property or method and may return unexpected results if it does. To use a Selection
object as a string, call its toString()
method directly:
var selectedText = selObj.toString();
selObj
is aSelection
object.selectedText
is a string (Selected text).
Related objects
You can call Document.getSelection()
, which works identically to Window.getSelection()
.
It is worth noting that currently getSelection()
doesn't work on the content of <textarea>
and <input>
elements in Firefox, Edge (Legacy) and Internet Explorer. HTMLInputElement.setSelectionRange()
or the selectionStart
and selectionEnd
properties could be used to work around this.
Notice also the difference between selection and focus. Document.activeElement
returns the focused element.
Specifications
Specification | Status | Comment |
---|---|---|
Selection APIThe definition of 'Window.getSelection()' in that specification. | Working Draft | New spec. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getSelection
|
Chrome
Full support 1 |
Edge
Full support 12 |
Firefox
Full support 1 |
IE
Full support 9 |
Opera
Full support 9 |
Safari
Full support 1 |
WebView Android
Full support 1 |
Chrome Android
Full support 18 |
Firefox Android
Full support 4 |
Opera Android
Full support 10.1 |
Safari iOS
Full support 1 |
Samsung Internet Android
Full support 1.0 |
Legend
- Full support
- Full support
See also
Window.getSelection() by Mozilla Contributors is licensed under CC-BY-SA 2.5.