Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

The name of the function or
 the function expression to run when the location changes.

handler

LocationChangeHandler

Adds an event handler that runs when an application page's URL changes.

The event handler set by the `onChange()` function runs when the location is changed 
but the change doesn't trigger navigation. This situation occurs when navigating between 
subitems on a page that is managed by a full-page application.

For example, a store product page is a full-page application. When a product page's path 
changes because it is switching between items, no actual navigation is taking place. You 
can use the `onChange()` event handler to determine when a new product is displayed and 
perform any necessary partial updates on the current page.

The `onChange()` function can only be used when browser 
[rendering](https://support.wix.com/en/article/velo-about-the-page-rendering-process) happens, 
meaning you can only use it in frontend code after the page is ready.

To determine if a page is managed by a full-page application, use the `wix-site-frontend` 
[`currentPage`](https://dev.wix.com/docs/velo/api-reference/wix-site-frontend/current-page) property or [`getSiteStructure()`](https://dev.wix.com/docs/velo/api-reference/wix-site-frontend/get-site-structure)
function to retrieve a `StructurePage` object that
corresponds to the page. If the object contains an `applicationId` value, then the
page is managed by a full-page application.

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.onChange( (location) => {
  let newPath = location.path;
} );

Get the new location path

onChange

void

The URL of the page or website to navigate to.

string

Options to use when navigating to the specified URL, such as scrolling options.

options

NavOptions

Directs the browser to navigate to the specified URL.

The `to()` function navigates the browser to another web page.

 The `to()` function can only be used when browser 
 [rendering](https://support.wix.com/en/article/velo-about-the-page-rendering-process) happens, 
 meaning you can only use it in frontend code after the page is ready.

 The following link patterns are supported:

 + `/localPageURL`: Another page on your site.
 + `/localPageURL#`: Another page on your site scrolled to the
    element with the specified ID. The element must be an element that supports
    the `scrollTo` function.
 + `/localPageURL?queryParam=value`: Another page on your site with query parameters.
 + `/`: Your site's home page.
 + `http(s)://`: An external web address.
 + `wix:document://`: A document stored in the Media Manager.
 + `mailto:@?subject=`: An email.
 + `tel:`: A phone number.


 To find the local URL of a page on your site in the Editor:

 + Regular page: See the **SEO** tab of the **Page Settings** panel.
 + Dynamic page: See the **Page Info** tab of the **Page Settings** panel
   for the URL structure. The actual URL used for navigation needs to contain
   values where the placeholders are.

   For example, if the URL structure of your dynamic page looks like:

   ![Dynamic Page URL](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_dynamic_url.png "Dynamic Page URL")

   and you have an item with the title "Waffles", the local URL to that page
   is /Recipes/Waffles.
 + Router page: You cannot navigate directly to a specific router page. You
   can navigate to a URL with the router's prefix and the router code
   decides which page to route to.

 By default, when navigating to a new URL for a Wix page, the page scrolls to the top. Set
 the `disableScrollToTop` navigation parameter property to `true` if you want the 
 page to remain at the current Y-axis position as the previously-viewed page. 

 The `to()` function attempts to properly encode the URL parameter that
 is passed to it. For example, `.../some page` is encoded to
 `.../some%20page`. However, some URLs do not have one unambiguous encoding.
 In those cases it is up to you to encode the URL to reflect your intentions.
 Because of these situations, it is a best practice to always encode URLs
 before you pass them to the `to()` function.

 Note that Wix URLs do not contain spaces. A page which has spaces in its
 name has its spaces replaced with dashes (`-`). Similarly, a dynamic page
 whose URL contains the value of a field in your collection with spaces
 has its spaces replaced with dashes (`-`).

 > **Note:** The `to()` function does not work while previewing your site.

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.to("/about-me");

Navigate to a local link

import wixLocationFrontend from 'wix-location-frontend';

// ...

const options = {
  disableScrollToTop: true
};

wixLocationFrontend.to("/about-me", options);

Navigate to a local link, without automatically scrolling to the top

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.to("/long-page#downUnder");


This example assumes you have a page named **Long Page** that has an element
 with the ID `downUnder`.

Navigate to a local link and scroll to an element

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.to("http://wix.com");

Navigate to an external web link

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.to("mailto:a@b.com?subject=Something%20Intersting");

Open a new email window

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.to("wix:document://v1/9bec_52fb06ea/filename.xls");

Open a document

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.to("tel:+1-555-555-5555");

Make a phone call

# Introduction
To use the location module, import wixLocationFrontend from the wix-location-frontend module:

   ```javascript
   import wixLocationFrontend from 'wix-location-frontend';
   ```

 The setter functions in `wix-location-frontend` can only be used when browser 
 [rendering](https://support.wix.com/en/article/velo-about-the-page-rendering-process) happens,
 meaning you can only use them in frontend code after the page is ready. 
 You can use the getter functions for both server-side or browser rendering.


 The URL is broken into:
 + [`baseUrl`](https://dev.wix.com/docs/velo/api-reference/wix-location-frontend/base-url)
 + [`prefix`](wix-location-frontend/prefix), for routers and dynamic pages only.
 + [`path`](wix-location-frontend/path)
 + [`query`](wix-location-frontend/query)

#### Premium Sites

For premium sites, the URL of the incoming call has the following format:
**`https://www.domain.com/myPrefix/myPath?myQuery=myValue`**

+ **baseUrl**: &nbsp;&nbsp;&nbsp;&nbsp;`https://www.domain.com`
+ **prefix**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`myPrefix`
+ **path**:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; `myPath`
+ **query**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`myQuery=myValue`

**Example**: 
**`https://domain.com/animals/elephant?species=african-elephant`**
+ **baseUrl**: &nbsp;&nbsp;&nbsp;&nbsp;`https://domain.com/`
+ **prefix**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`animals`. Only for routers and dynamic pages. 
+ **path**:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; `elephant`
+ **query**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`species=african-elephant`

#### Free Sites

For free sites, the URL of the incoming call has the following format:
**`https://user_name.wixsite.com/mysite/myPrefix/myPath?myQuery=myValue`**

+ **baseUrl**: &nbsp;&nbsp;&nbsp;&nbsp;`https://user_name.wixsite.com/mysite`
+ **prefix**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`myPrefix`
+ **path**:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; `myPath`
+ **query**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`myQuery=myValue`

**Example**: 
**`https://user_name.wixsite.com/zoo/animals/elephant?species=african-elephant`**
+ **baseUrl**: &nbsp;&nbsp;&nbsp;&nbsp;`https://user.wixsite.com/zoo`
+ **prefix**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`animals`. Only for routers and dynamic pages. 
+ **path**:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; `elephant`
+ **query**: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`species=african-elephant`

 > Learn more about wix-location-frontend in [Getting Started](/getting-started/location-api) and on [Wix Learn](https://www.wix.com/learn/online-course/coding-with-velo/velo-frontend#use-wix-location-api).

velo_wix-location-frontend

Adds query parameters to the current page's URL.

Adds one or more query parameters to the current page's URL.
 
 The `add()` function can only be used when browser 
 [rendering](https://support.wix.com/en/article/velo-about-the-page-rendering-process) happens, 
 meaning you can only use it in frontend code after the page is ready.

 If a specified key already exists as a query parameter, the
 newly specified value will overwrite the key's previous value.

 Calling the `add()` function triggers the [`onChange()`](https://dev.wix.com/docs/velo/api-reference/wix-location-frontend/on-change)
 event handler if it has been registered.
 > **Note:** To retrieve the page's current query parameters, use the
 [`query`](wix-location-frontend.html#query) property.

Removes query parameters from the current page's URL.

Removes one or more query parameters to the current page's URL.

 The `remove()` function can only be used when browser 
 [rendering](https://support.wix.com/en/article/velo-about-the-page-rendering-process) happens, 
 meaning you can only use it in frontend code after the page is ready.

 If a specified key does not exist as a query parameter, it
 is ignored.

 Calling the `remove()` function triggers the [`onChange()`](https://dev.wix.com/docs/velo/api-reference/wix-location-frontend/on-change)
 event handler if it has been registered.
 > **Note:** To retrieve the page's current query parameters, use the
 [`query`](wix-location-frontend.html#query) property.

remove

QueryParams

Gets the base URL of the current page.

Premium sites:
 ![Premium site baseUrl](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_baseurl.png "Premium site baseUrl")

 Free sites:
 ![Free site baseUrl](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_baseurl.png "Free site baseUrl")

import wixLocationFrontend from 'wix-location-frontend';

// Premium site URL: "https://www.domain.com/elephant?species=african-elephant"
// Free site URL: "https://user_name.wixsite.com/zoo/elephant?species=african-elephant"

let baseUrl = wixLocationFrontend.baseUrl;
// Premium site: "https://domain.com/"
// Free site: "https://user_name.wixsite.com/zoo/"

Get the base URL of the current page

baseUrl

Gets the path of the current page's URL.

The path for a regular page is after the  [`baseUrl`](https://dev.wix.com/docs/velo/api-reference/wix-location-frontend/base-url)
If the page is a dynamic page or router page, the [`prefix`](wix-location-frontend/prefix) appears after the base URL, before the path.  


 Premium sites:  
 Path for a regular page, without a prefix: ![Premium site path](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_path.png "Premium site path")  
 Path for a dynamic or router page with a prefix: ![Premium site path](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_path_with_prefix.png "Premium site path with a prefix")

 Free sites:   
  Path for a regular page, without a prefix: ![Free site path](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_path.png "Free site path")  
  Path for a dynamic or router page with a prefix: ![Free site path](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_path_with_prefix.png "Free site path")

import wixLocationFrontend from 'wix-location-frontend';

// Premium site URL: "https://www.domain.com/elephant?species=african-elephant#desc"
// Free site URL: "https://user_name.wixsite.com/zoo/elephant?species=african-elephant#desc"

let path = wixLocationFrontend.path; // ["elephant"]

Get the path of the current page's URL

path

Gets the prefix of a dynamic page's or router page's URL.

Only dynamic pages and router pages have a prefix. The value of the
 `prefix` property for other page types is always `undefined`.
   
 Premium sites:
 ![Premium site prefix](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_prefix.png "Premium site prefix")

 Free sites:
 ![Free site prefix](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_prefix.png "Free site prefix")

 To learn more about dynamic page prefixes, see [About URL Prefixes and Page Grouping of Dynamic Pages](https://support.wix.com/en/article/about-url-prefixes-and-page-grouping-of-dynamic-pages).

 To learn more about router page prefixes, see [About Routers](https://support.wix.com/en/article/about-routers#url-prefix).

import wixLocationFrontend from 'wix-location-frontend';

// Premium site URL: "https://www.domain.com/mammals/elephant?species=african-elephant#desc"
// Free site URL: "https://user_name.wixsite.com/zoo/mammals/elephant?species=african-elephant#desc"

let prefix = wixLocationFrontend.prefix; // "mammals"

Get the prefix of the current page's URL

prefix

Gets the protocol of the current page's URL.

Premium sites:
 ![Premium site protocol](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_protocol.png "Premium site protocol")

 Free sites:
 ![Free site protocol](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_protocol.png "Free site protocol")

import wixLocationFrontend from 'wix-location-frontend';

// Premium site URL: "https://www.domain.com/animals/elephant?species=african-elephant#desc"
// Free site URL: "https://user_name.wixsite.com/zoo/animals/elephant?species=african-elephant#desc"


let protocol = wixLocationFrontend.protocol; // "https"

Get the protocol of the current page's URL

protocol

Gets an object that represents the query segment of the current page's URL.

Premium sites:
 ![Premium site query](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_query.png "Premium site query")

 Free sites:
 ![Free site query](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_query.png "Free site query")

import wixLocationFrontend from 'wix-location-frontend';

// Premium site URL: "https://www.domain.com/animals/elephant?species=african-elephant#desc"
// Free site URL: "https://user_name.wixsite.com/zoo/animals/elephant?species=african-elephant#desc"


let query = wixLocationFrontend.query; // {"species": "african-elephant"}

Get the query of the current page's URL

import wixLocationFrontend from 'wix-location-frontend';

$w.onReady(function () {
  $w("#addButton").onClick((event) => {
    const key = $w('#addKey').value;
    const value = $w('#addValue').value;
    if (key && value) {
      const toAdd = { [key]: value };
      wixLocationFrontend.queryParams.add(toAdd);
      $w('#addKey').value = undefined;
      $w('#addValue').value = undefined;
    }
  });

  $w("#removeButton").onClick((event) => {
    const paramToRemove = [$w('#removeKey').value];
    wixLocationFrontend.queryParams.remove(paramToRemove);
    $w('#removeKey').value = undefined;
  });

  $w("#getButton").onClick((event) => {
    const query = wixLocationFrontend.query;
    if (query) {
      $w('#getText').value = JSON.stringify(query, null, 2);
    }
  });
});

Note: It's easiest to test this example in a published version of your site. If you test using preview, you will see a lot of extra query parameters from the Editor URL.
 You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=a0d93d05-628d-47e1-9476-337899e39c10&templateId=4d236c8a-3fe4-4aa1-87fa-d5663d866420&autoDevMode=true).

Add, update, remove, and get URL query parameters

query

object

Gets an object used to manage the query segment of the current page's URL.

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.queryParams.add({
  "key2": "value2new",
  "key3": "value3"
});

// URL before addition:
// www.mysite.com/page?key1=value1&key2=value2

// URL will look like:
// www.mysite.com/page?key1=value1&key2=value2new&key3=value3

Add query parameters to the URL

import wixLocationFrontend from 'wix-location-frontend';

// ...

wixLocationFrontend.queryParams.remove(["key1"]);

// URL before removal:
// www.mysite.com/page?key1=value1&key2=value2

// URL after removal:
// www.mysite.com/page?key2=value2

Remove query parameters from the URL

queryParams

Gets the full URL of the current page.

Premium sites:
 ![Premium site URL](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_premium_url.png "Premium site URL")

 Free sites:
 ![Free site URL](https://wixmp-833713b177cebf373f611808.wixmp.com/images/velo-images/media_url_free_url.png "Free site URL")

import wixLocationFrontend from 'wix-location-frontend';

// ...

let url = wixLocationFrontend.url;
// Premium site: "https://www.domain.com/animals/elephant?species=african-elephant#desc"
// Free site: "https://user_name.wixsite.com/zoo/animals/elephant?species=african-elephant#desc"

Get the full URL of the current page

Location

event

Whether the page scrolls to the top when navigating to the specified URL for a Wix page. Defaults to `false`. When `true`, the page remains at the same Y-axis position as the previously-viewed page. This setting does not affect scrolling for external URLs.