Location
The Location
interface represents the location (URL) of the object it is linked to. Changes done on it are reflected on the object it relates to. Both the Document
and Window
interface have such a linked Location
, accessible via Document.location
and Window.location
respectively.
Location anatomy
Hover over the URL segments below to highlight their meaning:
Instance properties
Location.ancestorOrigins
-
A static
DOMStringList
containing, in reverse order, the origins of all ancestor browsing contexts of the document associated with the givenLocation
object. Location.href
-
A stringifier that returns a string containing the entire URL. If changed, the associated document navigates to the new page. It can be set from a different origin than the associated document.
Location.protocol
-
A string containing the protocol scheme of the URL, including the final
':'
. Location.host
-
A string containing the host, that is the hostname, a
':'
, and the port of the URL. Location.hostname
-
A string containing the domain of the URL.
Location.port
-
A string containing the port number of the URL.
Location.pathname
-
A string containing an initial
'/'
followed by the path of the URL, not including the query string or fragment. Location.search
-
A string containing a
'?'
followed by the parameters or "querystring" of the URL. Modern browsers provide URLSearchParams and URL.searchParams to make it easy to parse out the parameters from the querystring. Location.hash
-
A string containing a
'#'
followed by the fragment identifier of the URL. Location.origin
Read only-
Returns a string containing the canonical form of the origin of the specific location.
Instance methods
Location.assign()
-
Loads the resource at the URL provided in parameter.
Location.reload()
-
Reloads the current URL, like the Refresh button.
Location.replace()
-
Replaces the current resource with the one at the provided URL (redirects to the provided URL). The difference from the
assign()
method and setting thehref
property is that after usingreplace()
the current page will not be saved in sessionHistory
, meaning the user won't be able to use the back button to navigate to it. Location.toString()
-
Returns a string containing the whole URL. It is a synonym for
Location.href
, though it can't be used to modify the value.
Examples
js
// location: https://developer.mozilla.org:8080/en-US/search?q=URL#search-results-close-container
const loc = document.location;
console.log(loc.href); // https://developer.mozilla.org:8080/en-US/search?q=URL#search-results-close-container
console.log(loc.protocol); // https:
console.log(loc.host); // developer.mozilla.org:8080
console.log(loc.hostname); // developer.mozilla.org
console.log(loc.port); // 8080
console.log(loc.pathname); // /en-US/search
console.log(loc.search); // ?q=URL
console.log(loc.hash); // #search-results-close-container
console.log(loc.origin); // https://developer.mozilla.org:8080
location.assign("http://another.site"); // load another page
Specifications
Specification |
---|
HTML Standard # the-location-interface |
Browser compatibility
BCD tables only load in the browser
See also
- Two
Location
properties:Window.location
andDocument.location
. - URL manipulation interfaces:
URL
andURLSearchParams
.