AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    HistoryHash Class

    Defined in: yui3/src/history/js/history-hash.js:1
    Module: history-hash
    Parent Module: history

    Available since 3.2.0

    Provides browser history management backed by <code>window.location.hash</code>, as well as convenience methods for working with the location hash and a synthetic <code>hashchange</code> event that normalizes differences across browsers.

    Index

    Methods

    Properties

    Methods

    _afterHashChange

    (
    • e
    )
    protected

    Defined in yui3/src/history/js/history-hash.js:87

    Handler for hashchange events.

    Parameters:

    _updateIframe

    (
    • hash
    • replace
    )
    protected static

    Provided by the history-hash-ie module.

    Defined in yui3/src/history/js/history-hash-ie.js:42

    Updates the history iframe with the specified hash.

    Parameters:

    • hash String

      location hash

    • replace Boolean

      (optional) if <code>true</code>, the current history state will be replaced without adding a new history entry

    createHash

    (
    • params
    )
    String static

    Defined in yui3/src/history/js/history-hash.js:150

    Creates a location hash string from the specified object of key/value pairs.

    Parameters:

    • params Object

      object of key/value parameter pairs

    Returns:

    String:

    location hash string

    decode

    (
    • string
    )
    String static

    Defined in yui3/src/history/js/history-hash.js:172

    Wrapper around <code>decodeURIComponent()</code> that also converts + chars into spaces.

    Parameters:

    • string String

      string to decode

    Returns:

    String:

    decoded string

    encode

    (
    • string
    )
    String static

    Defined in yui3/src/history/js/history-hash.js:185

    Wrapper around <code>encodeURIComponent()</code> that converts spaces to

    • chars.

    Parameters:

    • string String

      string to encode

    Returns:

    String:

    encoded string

    getHash

    () String static

    Defined in yui3/src/history/js/history-hash.js:198

    Gets the raw (not decoded) current location hash, minus the preceding '#' character and the hashPrefix (if one is set).

    Returns:

    String:

    current location hash

    getIframeHash

    () String static

    Provided by the history-hash-ie module.

    Defined in yui3/src/history/js/history-hash-ie.js:22

    Gets the raw (not decoded) current location hash from the IE iframe, minus the preceding '#' character and the hashPrefix (if one is set).

    Returns:

    String:

    current iframe hash

    getUrl

    () String static

    Defined in yui3/src/history/js/history-hash.js:232

    Gets the current bookmarkable URL.

    Returns:

    String:

    current bookmarkable URL

    parseHash

    (
    • hash
    )
    Object static

    Defined in yui3/src/history/js/history-hash.js:243

    Parses a location hash string into an object of key/value parameter pairs. If <i>hash</i> is not specified, the current location hash will be used.

    Parameters:

    • hash String

      (optional) location hash string

    Returns:

    Object:

    object of parsed key/value parameter pairs

    replaceHash

    (
    • hash
    )
    static

    Defined in yui3/src/history/js/history-hash.js:291

    Replaces the browser's current location hash with the specified hash and removes all forward navigation states, without creating a new browser history entry. Automatically prepends the <code>hashPrefix</code> if one is set.

    Parameters:

    • hash String

      new location hash

    setHash

    (
    • hash
    )
    static

    Defined in yui3/src/history/js/history-hash.js:312

    Sets the browser's location hash to the specified string. Automatically prepends the <code>hashPrefix</code> if one is set.

    Parameters:

    • hash String

      new location hash

    Properties

    _REGEX_HASH

    RegExp protected final static

    Defined in yui3/src/history/js/history-hash.js:137

    Regular expression used to parse location hash/query strings.

    hashPrefix

    String static

    Defined in yui3/src/history/js/history-hash.js:112

    <p> Prefix to prepend when setting the hash fragment. For example, if the prefix is <code>!</code> and the hash fragment is set to <code>#foo=bar&baz=quux</code>, the final hash fragment in the URL will become <code>#!foo=bar&baz=quux</code>. This can be used to help make an Ajax application crawlable in accordance with Google's guidelines at <a href="http://code.google.com/web/ajaxcrawling/">http://code.google.com/web/ajaxcrawling/</a>. </p>

    <p> Note that this prefix applies to all HistoryHash instances. It's not possible for individual instances to use their own prefixes since they all operate on the same URL. </p>

    Default: ''

    SRC_HASH

    String final static

    Defined in yui3/src/history/js/history-hash.js:101

    Constant used to identify state changes originating from <code>hashchange</code> events.