HistoryHash Class
Provides browser history management backed by
window.location.hash, as well as convenience methods for working
with the location hash and a synthetic hashchange event that
normalizes differences across browsers.
Item Index
Methods
- _afterHashChange
- _updateIframe static
- createHash static
- decode static
- encode static
- getHash static
- getIframeHash static
- getUrl static
- parseHash static
- replaceHash static
- setHash static
Properties
- _REGEX_HASH static
- hashPrefix static
- SRC_HASH static
Methods
_updateIframe
    
        - 
                    
                        hash
- 
                    
                        replace
Updates the history iframe with the specified hash.
createHash
    
        - 
                    
                        params
Creates a location hash string from the specified object of key/value pairs.
Parameters:
- 
                    
                        paramsObjectobject of key/value parameter pairs 
Returns:
decode
    
        - 
                    
                        string
Wrapper around decodeURIComponent() that also converts +
chars into spaces.
Parameters:
- 
                    
                        stringStringstring to decode 
Returns:
encode
    
        - 
                    
                        string
Wrapper around encodeURIComponent() that converts spaces to
+ chars.
Parameters:
- 
                    
                        stringStringstring to encode 
Returns:
getHash
    
        ()
    
    
        
            String
        
    
    
    
    
    
        static
    
    
    
    Gets the raw (not decoded) current location hash, minus the preceding '#' character and the hashPrefix (if one is set).
Returns:
getIframeHash
    
        ()
    
    
        
            String
        
    
    
    
    
    
        static
    
    
    
    Gets the raw (not decoded) current location hash from the IE iframe, minus the preceding '#' character and the hashPrefix (if one is set).
Returns:
getUrl
    
        ()
    
    
        
            String
        
    
    
    
    
    
        static
    
    
    
    Gets the current bookmarkable URL.
Returns:
parseHash
    
        - 
                    
                        hash
Parses a location hash string into an object of key/value parameter pairs. If hash is not specified, the current location hash will be used.
Parameters:
- 
                    
                        hashString(optional) location hash string 
Returns:
replaceHash
    
        - 
                    
                        hash
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 hashPrefix if one
is set.
Parameters:
- 
                    
                        hashStringnew location hash 
setHash
    
        - 
                    
                        hash
Sets the browser's location hash to the specified string. Automatically
prepends the hashPrefix if one is set.
Parameters:
- 
                    
                        hashStringnew location hash 
Properties
_REGEX_HASH
    RegExp
    
    
        protected
    
    
        final
    
    
        static
    
    
    Regular expression used to parse location hash/query strings.
hashPrefix
    String
    
    
    
    
        static
    
    
    
Prefix to prepend when setting the hash fragment. For example, if the
prefix is ! and the hash fragment is set to
#foo=bar&baz=quux, the final hash fragment in the URL will
become #!foo=bar&baz=quux. This can be used to help make an
Ajax application crawlable in accordance with Google's guidelines at
http://code.google.com/web/ajaxcrawling/.
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.
Default: ''
SRC_HASH
    String
    
    
    
        final
    
    
        static
    
    
    Constant used to identify state changes originating from
hashchange events.
