kafe.url

Class

Version 1.2.0

Manipulation tools for route-based urls.

Source: dist/url.js

Methods

followLinkWhen

Delay link until promises are resolved.

followLinkWhen
  • event
  • promises

Parameters:

  • event Event

    Original click event

  • promises Array

    Array of promises

Example:

kafe.url.followLinkWhen(event, [
					    kafe.ext.googletagmanager.track('checkout-type', { type: 'guest' }),
					    kafe.ext.googletagmanager.track('checkout-step', { number: 2 })
					]);

parseAjaxParams

Parses a hashbang (#!) as a key/value list and creates a javascript object.

parseAjaxParams
  • hashbang = CURRENT_LOCATION_HASH
Object

Parameters:

  • [hashbang = CURRENT_LOCATION_HASH] String Optional

Returns:

Object

An object represention of the hashbang.

Example:

kafe.url.parseAjaxParams('#!color=blue&size=large&extras=false');
					// returns Object {color: "blue", size: "large", extras: "false"}

parseAjaxPath

Parses a hashbang (#!) as a path and creates an ordered array.

parseAjaxPath
  • hashbang = CURRENT_LOCATION_HASH
Array(String)

Parameters:

  • [hashbang = CURRENT_LOCATION_HASH] String Optional

Returns:

Array(String)

An array represention of the hashbang path.

Example:

kafe.url.parseAjaxPath('#!/clothing/man/shirts');
					// returns ["clothing", "man", "shirts"]

parseHashParams

Parses a hash string as a key/value list and creates a javascript object.

parseHashParams
  • hash = CURRENT_LOCATION_HASH
Object

Parameters:

  • [hash = CURRENT_LOCATION_HASH] String Optional

Returns:

Object

An object represention of the hash string.

Example:

kafe.url.parseHashParams('#color=blue&size=large&extras=false');
					// returns Object {color: "blue", size: "large", extras: "false"}

parseHashPath

Parses a hash string as a path and creates an ordered array.

parseHashPath
  • hash = CURRENT_LOCATION_HASH
Array(String)

Parameters:

  • [hash = CURRENT_LOCATION_HASH] String Optional

Returns:

Array(String)

An array represention of the hash path.

Example:

kafe.url.parseHashPath('#/clothing/man/shirts');
					// returns ["clothing", "man", "shirts"]

parseSearchParams

Parses a querystring as a key/value list and creates a javascript object.

parseSearchParams
  • querystring = CURRENT_LOCATION_SEARCH
Object

Parameters:

  • [querystring = CURRENT_LOCATION_SEARCH] String Optional

Returns:

Object

An object represention of the querystring.

Example:

kafe.url.parseSearchParams('?group=players&team=blue&ranking=3');
					// returns Object {group: "players", team: "blue", ranking: "3"}

parseSearchPath

Parses a querystring as a path and creates an ordered array.

parseSearchPath
  • querystring = CURRENT_LOCATION_SEARCH
Array(String)

Parameters:

  • [querystring = CURRENT_LOCATION_SEARCH] String Optional

Returns:

Array(String)

An array represention of the querystring path.

Example:

kafe.url.parseSearchPath('?/Players/Teams/Blue');
					// returns ["Players", "Teams", "Blue"]