url.js

A lightweight JavaScript library to manipulate the page url.

Demo

Browse the demos on http://jillix.github.io/url.js/

CDN

The library is available on CDNJS as well. To use it, just do:

<script src="https://cdnjs.cloudflare.com/ajax/libs/urljs/1.2.0/url.min.js"></script>

Usage

<script src="path/to/url.js"></script>
<!-- or use the cdn
<script src="https://cdnjs.cloudflare.com/ajax/libs/urljs/1.2.0/url.min.js"></script>
-->
<script>
    Url.updateSearchParam("answer", 42);
</script>

CommonJS-compatible

The library is CommonJS-compatible. You can require("url.js") in your files.

Installation

Check out the src directory to download the needed files and include them on your page.

Documentation

queryString(name, notDecoded)

Finds the value of parameter passed in first argument.

Params

• String name: The parameter name.
• Boolean notDecoded: If true, the result will be encoded.

Return

• String|Boolean|Undefined The parameter value (as string), true if the parameter is there, but doesn't have a value, or undefined if it is missing.

parseQuery(search)

Parses a string as querystring. Like the queryString method does, if the parameter is there, but it doesn't have a value, the value will be true.

Params

• String search: An optional string that should be parsed (default: window.location.search).

Return

• Object The parsed querystring. Note this will contain empty strings for

stringify(queryObj)

Stringifies a query object.

Params

• Object queryObj: The object that should be stringified.

Return

• String The stringified value of queryObj object.

updateSearchParam(param, value, push)

Adds, updates or deletes a parameter (without page refresh).

Params

• String param: The parameter name.
• String value: The parameter value. If undefined, the parameter will be removed.
• Boolean push: If true, the page will be kept in the history, otherwise the location will be changed but by pressing the back button will not bring you to the old location.

Return

• Url The Url object.

getLocation()

Returns the page url, but not including the domain name.

Return

• String The page url (without domain).

hash(newHash)

Sets/gets the hash value.

Params

• String newHash: The hash to set.

Return

• String The location hash.

_updateAll(newHash)

Update the full url (pathname, search, hash).

Params

• String newHash: The hash to set.

Return

• String The set url.

getLocation(pathname, push)

pathname Sets/gets the pathname.

Params

• String pathname: The pathname to set.
• Boolean push: If true, the page will be kept in the history, otherwise the location will be changed but by pressing the back button will not bring you to the old location.

Return

• String The set url.

How to contribute

Have an idea? Found a bug? See how to contribute.

Where is this library used?

If you are using this library in one of your projects, add it in this list.

License

MIT © jillix