MDN self-hosted library · e01.org

Location

HTML DOM

no runnable cells web-api-interface upstream source

HTML DOM

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:

```html hidden <span id="href" title="href"

https://example.org:8080</span /foo/bar</span ?q=baz</span #bang</span


```css hidden
html {
  display: table;
  width: 100%;
}

body {
  display: table-cell;
  text-align: center;
  vertical-align: middle;
  font-family: "Georgia";
  font-size: 200%;
  line-height: 1em;
  white-space: nowrap;
}

[title] {
  position: relative;
  display: inline-block;
  box-sizing: border-box;
  line-height: 2em;
  cursor: pointer;
  color: gray;
}

[title]::before {
  content: attr(title);
  font-family: monospace;
  position: absolute;
  top: 100%;
  width: 100%;
  left: 50%;
  margin-left: -50%;
  font-size: 50%;
  line-height: 1.5;
  background: black;
}

[title]:hover::before,
:target::before {
  background: black;
  color: yellow;
}

[title] [title]::before {
  margin-top: 1.5em;
}

[title] [title] [title]::before {
  margin-top: 3em;
}

[title] [title] [title] [title]::before {
  margin-top: 4.5em;
}

[title]:hover,
:target {
  position: relative;
  z-index: 1;
  outline: 50em solid rgb(255 255 255 / 80%);
}

```js hidden document.body.addEventListener("click", (event) => { event.preventDefault();

window.location.hash = event.target.hasAttribute("id") ? #${event.target.getAttribute("id")} : ""; });


85ch

## Instance properties

- Location.ancestorOrigins 
  - : A static DOMStringList containing, in reverse order, the origins of all ancestor browsing contexts of the document associated with the given `Location` 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 "query string" of the URL. Modern browsers provide [`URLSearchParams`](/docs/Web/API/URLSearchParams/get) and [`URL.searchParams`](/docs/Web/API/URL/searchParams) to make it easy to parse out the parameters from the query string.
- Location.hash
  - : A string containing a `'#'` followed by the fragment identifier of the URL.
- Location.origin 
  - : 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 the `href` property is that after using `replace()` the current page will not be saved in session History, 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

Browser compatibility

See also

  • Two Location properties: Window.location and Document.location.
  • URL manipulation interfaces: URL and URLSearchParams.