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'

Example

dump(document.location); 
// Prints a string like
// "http://www.example.com/juicybits.html" to the console

Specifications

Specification Status Comment
WHATWG 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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes) (Yes) (Yes) (Yes) (Yes)
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) (Yes) (Yes)

See also

  • The interface of the returned value, Location.
  • A similar information, but attached to the browsing context, Window.location

 

Document Tags and Contributors

Last updated by: teoli,
Hide Sidebar