lb.core.plugins.url

Define methods in the ‘url’ property of given sandbox.

Parameters

Get the properties of the current URL location

Returns

an object with a copy of properties commonly found on window.location and document.location:

• href - string, the absolute URL of the current document
• protocol - string, the protocol part of the URL, e.g.  ‘http://’
• host - string, the host and port part of the url, e.g.  ‘example.com:8080’ or often just ‘example.com’
• hostname - the host name part of the URL, e.g.  ‘example:com’
• port - string, the port part of the URL, e.g.  ‘8080’ or often ‘’
• pathname - string, the relative path, e.g.  ‘/2010/10/31/index.php’
• search - string, the query part of the url, e.g.  ‘?param=value’
• hash - string, the local part of the url, e.g.  ‘#anchor’.  These properties are read-only here and not shared with other modules.

Jump to a new local location by replacing the hash part of the URL.

This method is used for local navigation, and ensures, in collaboration with the cross-browser history adapter module, that the back button of the browser works as expected.

Parameter

Set a listener to observe changes in local part of the URL.  Calling this method with a new callback will replace the listener previously set.  Calling onHashChange(null) will remove the current listener altogether.

Parameter