aciFragment API v1.1.0

.click - Process the HREF attribute of a link and set the key/value pairs found...
.destroy - Destroys the aciFragment instance. Under normal use - it...
.get - Returns the value assigned to a key (or a default value)...
.getAnchor - Returns the current anchor value (or a default value)...
.hasAnchor - Returns TRUE if pairs has the anchor property defined...
.init - Init the aciFragment plugin. In normal use - aciFragment...
.parse - Parse the fragment section of an URL to create a list of key/value pairs...
.parseHash - Parse the current fragment section of the URL to create a list of key/value...
.replace - Replace the fragment portion with the variables defined by the key/value...
.scroll - Scrolls the document to the current anchor. A test is made...
.set - Sets a new value for the key. If...
.setAnchor - Sets a new value for the anchor. The...
.update - Change the variables defined by the key/value pairs...
.wasInit - Returns TRUE if the plugin has been initialized.
.click (link, scroll) Process the HREF attribute of a link and set the key/value pairs found. where: link jQuery object object of type A scroll (boolean) if TRUE, a scroll of the contents to the current anchor will be made A test is made to see if the fragment portion of current URL contain the variable named options.anchor before a scroll to the anchor defined by the value of the variable is made. .click calls .scroll to do the document scroll to the anchor.
.destroy () Destroys the aciFragment instance. Under normal use - it should not be necessary to call .destroy.
.get (key, defaultValue) Returns the value assigned to a key (or a default value). where: key (string) key name defaultValue (string) the default value (if the key does not exists) .get calls .parseHash to determine the current value of the variables in the fragment section of the current URL.
.getAnchor (defaultValue) Returns the current anchor value (or a default value). where: defaultValue (string) the default value (if the anchor does not exists) A test will be made to see if the fragment portion of current URL contains the variable named options.anchor. .getAnchor calls .get to determine the current value of the anchor.
.hasAnchor (pairs) Returns TRUE if pairs has the anchor property defined. where: pairs (obiect) key/value pairs A test is made to see if the pairs object contains the property named options.anchor. An example of use is processing a URL with .parse to find if there was an anchor in URL.
.init () Init the aciFragment plugin. In normal use - aciFragment should need to be initialized only once, bound on the document object (to benefit from the internal cache implementation).
.parse (url) Parse the fragment section of an URL to create a list of key/value pairs. where: url (string) URL that may contain a fragment portion Returns an object where each property is a key/value pair.
.parseHash () Parse the current fragment section of the URL to create a list of key/value pairs. Returns an object where each property is a key/value pair. .parseHash calls .parse for the current URL.
.replace (pairs) Replace the fragment portion with the variables defined by the key/value pairs. where: pairs (obiect) key/value pairs .replace trigger the acifragment event by changing the fragment section of the current URL.
.scroll () Scrolls the document to the current anchor. A test is made to see if the fragment portion of the current URL contains the variable named options.anchor to produce the scroll at the anchor defined by the value of the variable.
.set (key, value) Sets a new value for the key. where: key (string) key name value (string) the new value If value is an empty string or NULL or not set, the variable with the key name will be removed. .set calls .replace to change the current value of the fragment section.
.setAnchor (anchor) Sets a new value for the anchor. where: anchor (string) the new value The anchor is defined by the variable named options.anchor. If anchor is an empty string or NULL or not set, the anchor will be removed. .setAnchor calls .set to change the current value of the fragment section.
.update (pairs) Change the variables defined by the key/value pairs. where: pairs (obiect) key/value pairs .update calls .replace to change the current value of the fragment section.
.wasInit () Returns TRUE if the plugin has been initialized.

aciFragment jQuery Plugin v1.1.0

http://acoderinsights.ro

Copyright (c) 2013 Dragos Ursu

Dual licensed under the MIT or GPL Version 2 licenses.

Require jQuery Library >= v1.7.1 http://jquery.com

+ aciPlugin >= v1.1.1 https://github.com/dragosu/jquery-aciPlugin

Date: Apr Fri 26 18:00 2013 +0200