Introduction

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

Copy

The setter functions in wix-location-frontend can only be used when browser rendering 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:

Premium Sites

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

  • baseUrl:     https://www.domain.com
  • prefix:        myPrefix
  • path:          myPath
  • query:        myQuery=myValue

Example: https://domain.com/animals/elephant?species=african-elephant

  • baseUrl:     https://domain.com/
  • prefix:        animals. Only for routers and dynamic pages.
  • path:          elephant
  • query:        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:     https://user_name.wixsite.com/mysite
  • prefix:        myPrefix
  • path:          myPath
  • query:        myQuery=myValue

Example: https://user_name.wixsite.com/zoo/animals/elephant?species=african-elephant

  • baseUrl:     https://user.wixsite.com/zoo
  • prefix:        animals. Only for routers and dynamic pages.
  • path:          elephant
  • query:        species=african-elephant

Learn more about wix-location-frontend in Getting Started and on Wix Learn.

Did this help?

baseUrl

baseUrlstringRead-only

Gets the base URL of the current page.

Premium sites: Premium site baseUrl

Free sites: Free site baseUrl

Get the base URL of the current page
JavaScript
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/"
Did this help?

path

pathArray<string>Read-only

Gets the path of the current page's URL.

The path for a regular page is after the baseUrl If the page is a dynamic page or router page, the prefix appears after the base URL, before the path.

Premium sites:
Path for a regular page, without a prefix: Premium site path
Path for a dynamic or router page with a prefix: Premium site path

Free sites:
Path for a regular page, without a prefix: Free site path
Path for a dynamic or router page with a prefix: Free site path

Get the path of the current page's URL
JavaScript
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"]
Did this help?

prefix

prefixstringRead-only

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

Free sites: Free site prefix

To learn more about dynamic page prefixes, see About URL Prefixes and Page Grouping of Dynamic Pages.

To learn more about router page prefixes, see About Routers.

Get the prefix of the current page's URL
JavaScript
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"
Did this help?

protocol

protocolstringRead-only

Gets the protocol of the current page's URL.

Premium sites: Premium site protocol

Free sites: Free site protocol

Get the protocol of the current page's URL
JavaScript
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"
Did this help?

query

queryQueryRead-only

Gets an object that represents the query segment of the current page's URL.

Premium sites: Premium site query

Free sites: Free site query

JavaScript
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"}
Did this help?

queryParams

queryParamsQueryParamsRead-only

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

JavaScript
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
Did this help?

url

urlstringRead-only

Gets the full URL of the current page.

Premium sites: Premium site URL

Free sites: Free site URL

Get the full URL of the current page
JavaScript
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"
Did this help?