The Document.location
read-only property returns a Location
object, which contains information about the URL of the document and provides methods for changing that URL and loading another URL.
Though Document.location
is a read-only Location
object, you can also assign a DOMString
to it. This means that you can work with document.location as if it were a string in most cases: document.location = 'http://www.example.com'
is a synonym of document.location.href = 'http://www.example.com'
.
To retrieve just the URL as a string, the read-only document.URL
property can also be used.
If the current document is not in a browsing context, the returned value is null
.
Syntax
locationObj = document.location document.location = 'http://www.mozilla.org' // Equivalent to document.location.href = 'http://www.mozilla.org'
Examples
console.log(document.location); // Prints a Location object to the console
Specifications
Specification | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'Document.location' in that specification. |
Living Standard | No change from HTML5. |
HTML5 The definition of 'Document.location' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
The compatibility table on 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
location | Chrome Full support 1 | Edge Full support 12 | Firefox Full support 1 | IE Full support 4 | Opera Full support 3 | 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
- The interface of the returned value,
Location
. - A similar information, but attached to the browsing context,
Window.location
.