Plugin.Pjax - AlloyUI

Extends: Pjax

Defined in: yui3/src/pjax/js/pjax-plugin.js:9

Module: pjax-plugin
Parent Module: pjax

Available since 3.5.0

Node plugin that provides seamless, gracefully degrading pjax functionality.

Index

Methods

`_addAttrs`

(

cfgs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:877

Implementation behind the public addAttrs method. This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

Parameters:

cfgs Object

An object with attribute name/configuration pairs.
values Object

An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy Boolean

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See <a href="#method_addAttr">addAttr</a>.

`_addLazyAttr`

(

name
[lazyCfg]

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:360

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute
[lazyCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

`_addOutOfOrder`

(

name
cfg

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:550

Utility method used by get/set to add attributes encountered out of order when calling addAttrs(). For example, if: <pre><code>this.addAttrs({ foo: { setter: function() { // make sure this bar is available when foo is added this.get("bar"); } }, bar: { value: ... } });</code></pre>

Parameters:

name String

attribute name
cfg Object

attribute configuration

`_afterHistoryChange`

(

)

protected

Inherited from Router: yui3/src/app/js/router.js:1600

Handles <code>history:change</code> and <code>hashchange</code> events.

Parameters:

e EventFacade

`_aggregateAttrs`

(

allAttrs

)

Object private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:618

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy. The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).

Parameters:

allAttrs Array

An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object:

The aggregate set of ATTRS definitions for the instance

`_attrCfgHash`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:581

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

`_baseDestroy`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:364

Internal destroy implementation for BaseCore

`_baseInit`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:336

Internal initialization implementation for BaseCore

`_cloneDefaultValue`

(

cfg

)

private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:592

This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.

Parameters:

cfg Object

`_decode`

(

string

)

String protected

Inherited from Router: yui3/src/app/js/router.js:765

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

Parameters:

string String

String to decode.

Returns:

String:

Decoded string.

`_defAttrChangeFn`

(

e
eventFastPath

)

private

Inherited from AttributeObservable: yui3/src/attribute/js/AttributeObservable.js:185

Default function for attribute change events.

Parameters:

e EventFacade

The event object for attribute change events.
eventFastPath Boolean

Whether or not we're using this as a fast path in the case of no listeners or not

`_defaultRoute`

(

req
res
next

)

protected

Inherited from Pjax: yui3/src/pjax/js/pjax.js:81

Available since 3.5.0

Default Pjax route callback. Fires either the load or error event based on the status of the Y.io request made by the loadContent() middleware.

Note: This route callback assumes that it's called after the loadContent() middleware.

Parameters:

req Object

Request object.
res Object

Response Object.
next Function

Function to pass control to the next route callback.

`_defCompleteFn`

(

)

protected

Inherited from Pjax: yui3/src/pjax/js/pjax.js:113

Available since 3.5.0

Default event handler for both the error and load events. Attempts to insert the loaded content into the container node and update the page's title.

Parameters:

e EventFacade

`_defDestroyFn`

(

)

protected

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:202

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defInitFn`

(

)

protected

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:190

Default init event handler

Parameters:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`_defNavigateFn`

(

)

protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:291

Available since 3.5.0

Default handler for the <code>navigate</code> event. Adds a new history entry or replaces the current entry for the specified URL and will scroll the page to the top if configured to do so.

Parameters:

e EventFacade

`_defReadyFn`

(

)

protected

Inherited from Router: yui3/src/app/js/router.js:1635

Default handler for the <code>ready</code> event.

Parameters:

e EventFacade

`_dequeue`

() protected chainable

Inherited from Router: yui3/src/app/js/router.js:778

Shifts the topmost <code>_save()</code> call off the queue and executes it. Does nothing if the queue is empty.

`_destroyHierarchy`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:782

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

`_dispatch`

(

req
res

)

protected chainable

Inherited from Router: yui3/src/app/js/router.js:806

Dispatches to the first route handler that matches the specified path. If called before the <code>ready</code> event has fired, the dispatch will be aborted. This ensures normalized behavior between Chrome (which fires a <code>popstate</code> event on every pageview) and other browsers (which do not).

Parameters:

req Object

Request object.
res String

Response object.

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:470

Parameters:

allAttrs Object

The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
userVals Object

The config object passed in by the user, from which adhoc attrs are to be filtered.

Returns:

Object:

The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

`_fireAttrChange`

(

attrName
subAttrName
currVal
newVal
opts
[cfg]

)

private

Inherited from AttributeObservable: yui3/src/attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

attrName String

The name of the attribute
subAttrName String

The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
currVal Any

The current value of the attribute
newVal Any

The new value of the attribute
opts Object

Any additional event data to mix into the attribute change event's event facade.
[cfg] Object optional

The attribute config stored in State, if already available.

`_getAttr`

(

name

)

Any protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:587

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method. See <a href="#method_get">get</a> for argument details.

Parameters:

name String

The name of the attribute.

Returns:

Any:

The value of the attribute.

`_getAttrCfg`

(

name

)

Object protected

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:125

Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.

Parameters:

name String

Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object:

The configuration properties for the given attribute, or all attributes.

`_getAttrCfgs`

() Object protected

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:394

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object:

The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

`_getAttrInitVal`

(

attr
cfg
initValues

)

Any private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:986

Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.

Parameters:

attr String

The name of the attribute
cfg Object

The attribute configuration object
initValues Object

The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any:

The initial value of the attribute.

`_getAttrs`

(

attrs

)

Object protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:815

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

attrs String | Boolean

Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object:

An object with attribute name/value pairs.

`_getClasses`

() Function protected

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:378

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function:

An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

`_getFullType`

(

type

)

String private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:564

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix. NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.

Parameters:

type String

The short type to prefix

Returns:

String:

The prefixed type, if a prefix is set, otherwise the type passed in

`_getHashPath`

(

[hash]

)

String protected

Inherited from Router: yui3/src/app/js/router.js:896

Returns the resolved path from the hash fragment, or an empty string if the hash is not path-like.

Parameters:

[hash] String optional

Hash fragment to resolve into a path. By default this will be the hash from the current URL.

Returns:

String:

Current hash path, or an empty string if the hash is empty.

`_getInstanceAttrCfgs`

(

allCfgs

)

Object private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:411

A helper method used to isolate the attrs config for this instance to pass to <code>addAttrs</code>, from the static cached ATTRS for the class.

Parameters:

allCfgs Object

The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

Returns:

Object:

The set of attributes to be added for this instance, suitable for passing through to <code>addAttrs</code>.

`_getOrigin`

() String protected

Inherited from Router: yui3/src/app/js/router.js:917

Gets the location origin (i.e., protocol, host, and port) as a URL.

Returns:

String:

Location origin (i.e., protocol, host, and port).

Example:

<pre class="code prettyprint"><code>http://example.com</code></pre>

`_getParams`

() Object protected

Inherited from Router: yui3/src/app/js/router.js:932

Available since 3.12.0

Getter for the <code>params</code> attribute.

Returns:

Object:

Mapping of param handlers: <code>name</code> -> RegExp | Function.

`_getParamValues`

(

route
path

)

Boolean | Array | Object protected

Inherited from Router: yui3/src/app/js/router.js:944

Available since 3.16.0

Gets the param values for the specified <code>route</code> and <code>path</code>, suitable to use form <code>req.params</code>. Note: This method will return <code>false</code> if a named param handler rejects a param value.

Parameters:

route Object

The route to get param values for.
path String

The route path (root removed) that provides the param values.

Returns:

Boolean | Array | Object:

The collection of processed param values. Either a hash of <code>name</code> -> <code>value</code> for named params processed by this router's param handlers, or an array of matches for a route with unnamed params. If a named param handler rejects a value, then <code>false</code> will be returned.

`_getPath`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1024

Gets the current route path.

Returns:

String:

Current route path.

`_getPathRoot`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1038

Available since 3.5.0

Returns the current path root after popping off the last path segment, making it useful for resolving other URL paths against. The path root will always begin and end with a '/'.

Returns:

String:

The URL's path root.

`_getQuery`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1064

Gets the current route query string.

Returns:

String:

Current route query string.

`_getRegex`

(

path
keys

)

RegExp protected

Inherited from Router: yui3/src/app/js/router.js:1085

Creates a regular expression from the given route specification. If path is already a regex, it will be returned unmodified.

Parameters:

path String | RegExp

Route path specification.
keys Array

Array reference to which route parameter names will be added.

Returns:

RegExp:

Route regex.

`_getRequest`

(

src

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1120

Gets a request object that can be passed to a route handler.

Parameters:

src String

What initiated the URL change and need for the request.

Returns:

Object:

Request object.

`_getResponse`

(

req

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1138

Gets a response object that can be passed to a route handler.

Parameters:

req Object

Request object.

Returns:

Object:

Response Object.

`_getRoutes`

() Object protected

Inherited from Router: yui3/src/app/js/router.js:1150

Getter for the <code>routes</code> attribute.

Returns:

Object:

Array of route objects.

`_getStateVal`

(

name
[cfg]

)

Any private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:641

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
[cfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Any:

The stored value of the attribute

`_getType`

() private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:36

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

`_getURL`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1161

Gets the current full URL.

Returns:

String:

URL.

`_hasPotentialSubscribers`

(

fullType

)

Boolean private

Inherited from EventTarget: yui3/src/event-custom/js/event-facade.js:643

Parameters:

fullType String

The fully prefixed type name

Returns:

Boolean:

Whether the event has potential subscribers or not

`_hasSameOrigin`

(

url

)

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:1178

Returns <code>true</code> when the specified <code>url</code> is from the same origin as the current URL; i.e., the protocol, host, and port of the URLs are the same. All host or path relative URLs are of the same origin. A scheme-relative URL is first prefixed with the current scheme before being evaluated.

Parameters:

url String

URL to compare origin with the current URL.

Returns:

Boolean:

Whether the URL has the same origin of the current URL.

`_initAttrHost`

(

attrs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

attrs Object

The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

`_initAttribute`

() private

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:309

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:1052

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

attrs Object

The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).

`_initBase`

(

config

)

private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:274

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:702

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

userVals Object

Object with configuration property name/value pairs

`_initHierarchyData`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:500

A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.

`_isLazyAttr`

(

name

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:347

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

name String

The name of the attribute

Returns:

Boolean:

true if it's a lazily added attribute, false otherwise.

`_isLinkSameOrigin`

(

link

)

Boolean protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:152

Available since 3.6.0

Utility method to test whether a specified link/anchor node's <code>href</code> is of the same origin as the page's current location. This normalize browser inconsistencies with how the <code>port</code> is reported for anchor elements (IE reports a value for the default port, e.g. "80").

Parameters:

link Node

The anchor element to test whether its <code>href</code> is of the same origin as the page's current location.

Returns:

Boolean:

Whether or not the link's <code>href</code> is of the same origin as the page's current location.

`_joinURL`

(

url

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1201

Joins the <code>root</code> URL to the specified url, normalizing leading/trailing <code>/</code> characters.

Parameters:

url String

URL to append to the <code>root</code> URL.

Returns:

String:

Joined URL.

Example:

<pre class="code prettyprint"><code>router.set('root', '/foo'); router._joinURL('bar'); // => '/foo/bar' router._joinURL('/bar'); // => '/foo/bar' router.set('root', '/foo/'); router._joinURL('bar'); // => '/foo/bar' router._joinURL('/bar'); // => '/foo/bar'</code></pre>

`_monitor`

(

what
eventType
o

)

private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:636

This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> click_attach, click_detach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.

Parameters:

what String

'attach', 'detach', 'fire', or 'publish'
eventType String | CustomEvent

The prefixed name of the event being monitored, or the CustomEvent object.
o Object

Information about the event interaction, such as fire() args, subscription category, publish config

`_navigate`

(

url
[options]

)

Boolean protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:201

Available since 3.5.0

Underlying implementation for <code>navigate()</code>.

Parameters:

url String

The fully-resolved URL that the router should dispatch to its route handlers to fulfill the enhanced navigation "request", or use to update <code>window.location</code> in non-HTML5 history capable browsers.
[options] Object optional

Additional options to configure the navigation. These are mixed into the <code>navigate</code> event facade.
- [replace] Boolean optional
 
 Whether or not the current history entry will be replaced, or a new entry will be created. Will default to <code>true</code> if the specified <code>url</code> is the same as the current URL.
- [force=false] Boolean optional
 
 Whether the enhanced navigation should occur even in browsers without HTML5 history.

Returns:

Boolean:

<code>true</code> if the URL was navigated to, <code>false</code> otherwise.

`_normalizePath`

(

path

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1234

Available since 3.5.0

Returns a normalized path, ridding it of any '..' segments and properly handling leading and trailing slashes.

Parameters:

path String

URL path to normalize.

Returns:

String:

Normalized path.

`_normAttrVals`

(

valueHash

)

Object private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:938

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

valueHash Object

An object with attribute name/value pairs

Returns:

Object:

An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

`_onLinkClick`

(

)

protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:316

Available since 3.5.0

Handler for delegated link-click events which match the <code>linkSelector</code>. This will attempt to enhance the navigation to the link element's <code>href</code> by passing the URL to the <code>_navigate()</code> method. When the navigation is being enhanced, the default action is prevented. If the user clicks a link with the middle/right mouse buttons, or is holding down the Ctrl or Command keys, this method's behavior is not applied and allows the native behavior to occur. Similarly, if the router is not capable or handling the URL because no route-handlers match, the link click will behave natively.

Parameters:

e EventFacade

`_onPjaxIOComplete`

(

id
ioResponse
details

)

protected

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:159

Available since 3.7.0

Handles IO complete events. This parses the content from the <code>Y.io()</code> response and puts it on the route's response object.

Parameters:

id String

The <code>Y.io</code> transaction id.
ioResponse Object

The <code>Y.io</code> response object.
details Object

Extra details carried through from <code>loadContent()</code>.

`_onPjaxIOEnd`

(

id
details

)

protected

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:189

Available since 3.5.0

Handles IO end events.

Parameters:

id String

The <code>Y.io</code> transaction id.
details Object

Extra details carried through from <code>loadContent()</code>.

`_parseQuery`

(

query

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1276

Parses a URL query string into a key/value hash. If <code>Y.QueryString.parse</code> is available, this method will be an alias to that.

Parameters:

query String

Query string to parse.

Returns:

Object:

Hash of key/value pairs for query parameters.

`_parseType`

() private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

`_pathHasRoot`

(

root
path

)

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:1304

Available since 3.13.0

Returns <code>true</code> when the specified <code>path</code> is semantically within the specified <code>root</code> path. If the <code>root</code> does not end with a trailing slash ("/"), one will be added before the <code>path</code> is evaluated against the root path.

Parameters:

root String

Root path used to evaluate whether the specificed <code>path</code> is semantically within. A trailing slash ("/") will be added if it does not already end with one.
path String

Path to evaluate for containing the specified <code>root</code>.

Returns:

Boolean:

Whether or not the <code>path</code> is semantically within the <code>root</code> path.

Example:

<pre class="code prettyprint"><code>this._pathHasRoot('/app', '/app/foo'); // => true this._pathHasRoot('/app/', '/app/foo'); // => true this._pathHasRoot('/app/', '/app/'); // => true this._pathHasRoot('/app', '/foo/bar'); // => false this._pathHasRoot('/app/', '/foo/bar'); // => false this._pathHasRoot('/app/', '/app'); // => false this._pathHasRoot('/app', '/app'); // => false</code></pre>

`_pjaxBindUI`

() protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:270

Available since 3.5.0

Binds the delegation of link-click events that match the <code>linkSelector</code> to the <code>_onLinkClick()</code> handler. By default this method will only be called if the browser is capable of using HTML5 history.

`_preInitEventCfg`

(

config

)

private

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:110

Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.

Parameters:

config Object

The user configuration object

`_protectAttrs`

(

attrs

)

Object deprecated protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:924

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

attrs Object

A hash of attribute to configuration object pairs.

Returns:

Object:

A protected version of the attrs argument.

`_publish`

(

fullType
etOpts
ceOpts

)

CustomEvent private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:588

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

Parameters:

fullType String

The prefixed type of the event to publish.
etOpts Object

The EventTarget specific configuration to mix into the published event.
ceOpts Object

The publish specific configuration to mix into the published event.

Returns:

CustomEvent:

The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will be the default <code>CustomEvent</code> instance, and can be configured independently.

`_queue`

() protected chainable

Inherited from Router: yui3/src/app/js/router.js:1336

Queues up a <code>_save()</code> call to run after all previously-queued calls have finished. This is necessary because if we make multiple <code>_save()</code> calls before the first call gets dispatched, then both calls will dispatch to the last call's URL. All arguments passed to <code>_queue()</code> will be passed on to <code>_save()</code> when the queued function is executed.

`_resolvePath`

(

path

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1381

Available since 3.5.0

Returns the normalized result of resolving the <code>path</code> against the current path. Falsy values for <code>path</code> will return just the current path.

Parameters:

path String

URL path to resolve.

Returns:

String:

Resolved path.

`_resolveURL`

(

url

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1403

Available since 3.5.0

Resolves the specified URL against the current URL. This method resolves URLs like a browser does and will always return an absolute URL. When the specified URL is already absolute, it is assumed to be fully resolved and is simply returned as is. Scheme-relative URLs are prefixed with the current protocol. Relative URLs are giving the current URL's origin and are resolved and normalized against the current path root.

Parameters:

url String

URL to resolve.

Returns:

String:

Resolved URL.

`_save`

(

[url]
[replace=false]

)

protected chainable

Inherited from Router: yui3/src/app/js/router.js:1454

Saves a history entry using either <code>pushState()</code> or the location hash. This method enforces the same-origin security constraint; attempting to save a <code>url</code> that is not from the same origin as the current URL will result in an error.

Parameters:

[url] String optional

URL for the history entry.
[replace=false] Boolean optional

If <code>true</code>, the current history entry will be replaced instead of a new one being added.

`_set`

(

name
val
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:405

Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.

Parameters:

name String

The name of the attribute.
val Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_setAttr`

(

name
value
[opts]
force

)

Object protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:421

Provides the common implementation for the public set and protected _set methods. See <a href="#method_set">set</a> for argument details.

Parameters:

name String

The name of the attribute.
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.
force Boolean

If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object:

A reference to the host object.

`_setAttrs`

(

attrs
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:783

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change

Returns:

Object:

A reference to the host object.

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:681

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

attrName String

The attribute name.
subAttrName String

The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal Any

The currently stored value of the attribute.
newVal Any

The value which is going to be stored.
[opts] Object optional

Optional data providing the circumstances for the change.
[attrCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Boolean:

true if the new attribute value was stored, false if not.

`_setParams`

(

params

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1518

Available since 3.12.0

Setter for the <code>params</code> attribute.

Parameters:

params Object

Map in the form: <code>name</code> -> RegExp | Function.

Returns:

Object:

The map of params: <code>name</code> -> RegExp | Function.

`_setRoutes`

(

routes

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1537

Setter for the <code>routes</code> attribute.

Parameters:

routes Object

Array of route objects.

Returns:

Object:

Array of route objects.

`_setStateVal`

(

name
value

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:663

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
value Any

The value of the attribute

`_upgradeURL`

(

url

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1555

Available since 3.5.0

Upgrades a hash-based URL to a full-path URL, if necessary. The specified <code>url</code> will be upgraded if its of the same origin as the current URL and has a path-like hash. URLs that don't need upgrading will be returned as-is.

Parameters:

url String

The URL to upgrade from hash-based to full-path.

Returns:

String:

The upgraded URL, or the specified URL untouched.

Example:

<pre class="code prettyprint"><code>app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/';</code></pre>

`addAttr`

(

name
config
lazy

)

Object chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:157

Adds an attribute with the provided configuration to the host object. The config argument object supports the following properties: <dl> <dt>value <Any></dt> <dd>The initial value to set on the attribute</dd> <dt>valueFn <Function | String></dt> <dd> A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used. valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value. </dd> <dt>readOnly <boolean></dt> <dd>Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.</dd> <dt>writeOnce <boolean> or <string></dt> <dd> Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set. The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction) </dd> <dt>setter <Function | String></dt> <dd> The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent the value from being stored. setter can also be set to a string, representing the name of the instance method to be used as the setter function. </dd> <dt>getter <Function | String></dt> <dd> The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get. getter can also be set to a string, representing the name of the instance method to be used as the getter function. </dd> <dt>validator <Function | String></dt> <dd> The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored. validator can also be set to a string, representing the name of the instance method to be used as the validator function. </dd> <dt>lazyAdd <boolean></dt> <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the <a href="#method_addAttrs">addAttrs</a> method.</dd> </dl> The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object. Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

name String

The name of the attribute.
config Object

An object with attribute configuration property/value pairs, specifying the configuration for the attribute. NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
lazy Boolean

(optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object:

A reference to the host object.

`addAttrs`

(

cfgs
values
lazy

)

Object chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:846

Configures a group of attributes, and sets initial values. NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

cfgs Object

An object with attribute name/configuration pairs.
values Object

An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
lazy Boolean

Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See <a href="#method_addAttr">addAttr</a>.

Returns:

Object:

A reference to the host object.

`addTarget`

(

)

chainable

Inherited from EventTarget: yui3/src/event-custom/js/event-facade.js:496

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified. Events can only bubble if emitFacade is true. Included in the event-custom-complex submodule.

Parameters:

o EventTarget

the target to add

`after`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:812

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override <code>this</code> object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

`attrAdded`

(

name

)

Boolean

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:319

Checks if the given attribute has been added to the host

Parameters:

name String

The name of the attribute to check.

Returns:

Boolean:

true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

`before`

()

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:849

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on. For DOM and custom events: type, callback, context, 0-n arguments For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

detach handle

`bubble`

(

evt

)

Boolean

Inherited from EventTarget: yui3/src/event-custom/js/event-facade.js:554

Propagate an event. Requires the event-custom-complex module.

Parameters:

evt CustomEvent

the custom event to propagate

Returns:

Boolean:

the aggregated return value from Event.Custom.fire

`destroy`

() BaseCore chainable

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:352

Destroy lifecycle method. Invokes destructors for the class hierarchy.

Returns:

BaseCore:

A reference to this object

`detach`

(

type
fn
context

)

EventTarget

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:356

Detach one or more listeners the from the specified event

Parameters:

type String | Object

Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
fn Function

The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context Object

The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)

Returns:

EventTarget:

the host

`detachAll`

(

type

)

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:479

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

type String

The type, or name of the event

`dispatch`

() chainable

Inherited from Router: yui3/src/app/js/router.js:244

Dispatches to the first route handler that matches the current URL, if any. If <code>dispatch()</code> is called before the <code>ready</code> event has fired, it will automatically wait for the <code>ready</code> event before dispatching. Otherwise it will dispatch immediately.

`fire`

(

type
arguments

)

Boolean

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:673

Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters. The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object. If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

Parameters:

type String | Object

The type of the event, or an object that contains a 'type' property.
arguments Object

an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.

Returns:

Boolean:

True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

`get`

(

name

)

Any

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:331

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

name String

The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)

Returns:

Any:

The value of the attribute

`getAttrs`

(

attrs

)

Object

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:803

Gets multiple attribute values.

Parameters:

attrs String | Boolean

Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object:

An object with attribute name/value pairs.

`getContent`

(

responseText

)

Object

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:38

Available since 3.5.0

Extracts and returns the relevant HTML content from an Ajax response. The content is extracted using the <code>contentSelector</code> attribute as a CSS selector. If <code>contentSelector</code> is <code>null</code>, the entire response will be returned. The return value is an object containing two properties: <ul> <li> <code>node</code>: A <code>Y.Node</code> instance for a document fragment containing the extracted HTML content. </li> <li> <code>title</code>: The title of the HTML page, if any, extracted using the <code>titleSelector</code> attribute (which defaults to looking for a <code><title></code> element). If <code>titleSelector</code> is not set or if a title could not be found, this property will be <code>undefined</code>. </li> </ul>

Parameters:

responseText String

Raw Ajax response text.

Returns:

Object:

Content object with the properties described above.

`getEvent`

(

type
prefixed

)

CustomEvent

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:793

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

type String

the type, or name of the event
prefixed String

if true, the type is prefixed already

Returns:

CustomEvent:

the custom event or null

`getPath`

() String

Inherited from Router: yui3/src/app/js/router.js:271

Gets the current route path.

Returns:

String:

Current route path.

`getTargets`

()

Inherited from EventTarget: yui3/src/event-custom/js/event-facade.js:523

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

`hasRoute`

(

url

)

Boolean

Inherited from Router: yui3/src/app/js/router.js:281

Returns <code>true</code> if this router has at least one route that matches the specified URL, <code>false</code> otherwise. This also checks that any named <code>param</code> handlers also accept app param values in the <code>url</code>. This method enforces the same-origin security constraint on the specified <code>url</code>; any URL which is not from the same origin as the current URL will always return <code>false</code>.

Parameters:

url String

URL to match.

Returns:

Boolean:

<code>true</code> if there's at least one matching route, <code>false</code> otherwise.

`init`

(

cfg

)

BaseCore chainable

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:319

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

cfg Object

Object with configuration property name/value pairs

Returns:

BaseCore:

A reference to this object

`loadContent`

(

req
res
next

)

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:83

Available since 3.7.0

Pjax route middleware to load content from a server. This makes an Ajax request for the requested URL, parses the returned content and puts it on the route's response object. This is route middleware and not intended to be the final callback for a route. This will add the following information to the route's request and response objects: <ul> <li> <code>req.ioURL</code>: The full URL that was used to make the <code>Y.io()</code> XHR. This may contain <code>"pjax=1"</code> if the <code>addPjaxParam</code> option is set. </li> <li> <code>res.content</code>: An object containing <code>node</code> and <code>title</code> properties for the content extracted from the server's response. See <code>getContent()</code> for more details. </li> <li> <code>res.ioResponse</code>: The full <code>Y.io()</code> response object. This is useful if you need access to the XHR's response <code>status</code> or HTTP headers. </li> </ul>

Parameters:

req Object

Request object.
res Object

Response Object.
next Function

Function to pass control to the next route callback.

Example:

<pre class="code prettyprint"><code>router.route('/foo/', 'loadContent', function (req, res, next) { Y.one('container').setHTML(res.content.node); Y.config.doc.title = res.content.title; });</code></pre>

`match`

(

path

)

Object

Inherited from Router: yui3/src/app/js/router.js:328

Returns an array of route objects that match the specified URL path. If this router has a <code>root</code>, then the specified <code>path</code> must be semantically within the <code>root</code> path to match any routes. This method is called internally to determine which routes match the current path whenever the URL changes. You may override it if you want to customize the route matching logic, although this usually shouldn't be necessary. Each returned route object has the following properties: <ul> <li> <code>callback</code>: A function or a string representing the name of a function this router that should be executed when the route is triggered. </li> <li> <code>keys</code>: An array of strings representing the named parameters defined in the route's path specification, if any. </li> <li> <code>path</code>: The route's path specification, which may be either a string or a regex. </li> <li> <code>regex</code>: A regular expression version of the route's path specification. This regex is used to determine whether the route matches a given path. </li> </ul>

Parameters:

path String

URL path to match. This should be an absolute path that starts with a slash: "/".

Returns:

Object:

Array of route objects that match the specified path.

Example:

<pre class="code prettyprint"><code>router.route('/foo', function () {}); router.match('/foo'); // => [{callback: ..., keys: [], path: '/foo', regex: ...}]</code></pre>

`modifyAttr`

(

name
config

)

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:40

Updates the configuration of an attribute which has already been added. The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: <dl> <dt>readOnly;</dt> <dt>writeOnce;</dt> <dt>broadcast; and</dt> <dt>getter.</dt> </dl> Note: New attributes cannot be added using this interface. New attributes must be added using <a href="../classes/AttributeCore.html#method_addAttr" class="crosslink">addAttr</a>, or an appropriate manner for a class which utilises Attributes (e.g. the <a href="../classes/Base.html#property_ATTRS" class="crosslink">ATTRS</a> property in <a href="../classes/Base.html" class="crosslink">Base</a>).

Parameters:

name String

The name of the attribute whose configuration is to be updated.
config Object

An object with configuration property/value pairs, specifying the configuration properties to modify.

`navigate`

(

url
[options]

)

Boolean

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:98

Available since 3.5.0

Navigates to the specified URL if there is a route handler that matches. In browsers capable of using HTML5 history, the navigation will be enhanced by firing the <code>navigate</code> event and having the router handle the "request". Non-HTML5 browsers will navigate to the new URL via manipulation of <code>window.location</code>. When there is a route handler for the specified URL and it is being navigated to, this method will return <code>true</code>, otherwise it will return <code>false</code>. Note: The specified URL must be of the same origin as the current URL, otherwise an error will be logged and navigation will not occur. This is intended as both a security constraint and a purposely imposed limitation as it does not make sense to tell the router to navigate to a URL on a different scheme, host, or port.

Parameters:

url String

The URL to navigate to. This must be of the same origin as the current URL.
[options] Object optional

Additional options to configure the navigation. These are mixed into the <code>navigate</code> event facade.
- [replace] Boolean optional
 
 Whether or not the current history entry will be replaced, or a new entry will be created. Will default to <code>true</code> if the specified <code>url</code> is the same as the current URL.
- [force=false] Boolean optional
 
 Whether the enhanced navigation should occur even in browsers without HTML5 history.

Returns:

Boolean:

<code>true</code> if the URL was navigated to, <code>false</code> otherwise.

`on`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:188

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object. <pre><code> this.on("change", this._onChange, this); </code></pre> Callback functions for events published with <code>emitFacade = true</code> will receive an <code>EventFacade</code> as the first argument (typically named "e"). These callbacks can then call <code>e.preventDefault()</code> to disable the behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code> API for all available properties and methods. Subscribers to non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code> after the event name. To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback. <pre><code> this.on({ "attrChange" : this._onAttrChange, "change" : this._onChange }); </code></pre> You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback. <pre><code> this.on([ "change", "attrChange" ], this._onChange); </code></pre> Returning <code>false</code> from a callback is supported as an alternative to calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is recommended to use the event methods whenever possible.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override <code>this</code> object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

`once`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:124

Listen to a custom event hosted by this object one time. This is the equivalent to <code>on</code> except the listener is immediatelly detached when it is executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override <code>this</code> object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

`onceAfter`

(

type
fn
[context]
[arg*]

)

EventHandle

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:146

Listen to a custom event hosted by this object one time. This is the equivalent to <code>after</code> except the listener is immediatelly detached when it is executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override <code>this</code> object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

`param`

(

name
handler

)

chainable

Inherited from Router: yui3/src/app/js/router.js:383

Available since 3.12.0

Adds a handler for a route param specified by name. Param handlers can be registered via this method and are used to validate/format values of named params in routes before dispatching to the route's handler functions. Using param handlers allows routes to defined using string paths which allows for <code>req.params</code> to use named params, but still applying extra validation or formatting to the param values parsed from the URL. If a param handler regex or function returns a value of <code>false</code>, <code>null</code>, <code>undefined</code>, or <code>NaN</code>, the current route will not match and be skipped. All other return values will be used in place of the original param value parsed from the URL.

Parameters:

name String

Name of the param used in route paths.
handler Function | RegExp

Function to invoke or regular expression to <code>exec()</code> during route dispatching whose return value is used as the new param value. Values of <code>false</code>, <code>null</code>, <code>undefined</code>, or <code>NaN</code> will cause the current route to not match and be skipped. When a function is specified, it will be invoked in the context of this instance with the following parameters:
- value String
 
 The current param value parsed from the URL.
- name String
 
 The name of the param.

Example:

<pre class="code prettyprint"><code>router.param('postId', function (value) { return parseInt(value, 10); }); router.param('username', /^\w+$/); router.route('/posts/:postId', function (req) { Y.log('Post: ' + req.params.id); }); router.route('/users/:username', function (req) { // <code>req.params.username</code> is an array because the result of calling // <code>exec()</code> on the regex is assigned as the param's value. Y.log('User: ' + req.params.username[0]); }); router.route('*', function () { Y.log('Catch-all no routes matched!'); }); // URLs which match routes: router.save('/posts/1'); // => "Post: 1" router.save('/users/ericf'); // => "User: ericf" // URLs which do not match routes because params fail validation: router.save('/posts/a'); // => "Catch-all no routes matched!" router.save('/users/ericf,rgrove'); // => "Catch-all no routes matched!"</code></pre>

`parseType`

(

type
[pre]

)

Array

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:168

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

type String

the type
[pre] String optional

The prefix. Defaults to this._yuievt.config.prefix

Returns:

Array:

an array containing: <ul> <li>the detach category, if supplied,</li> <li>the prefixed event type,</li> <li>whether or not this is an after listener,</li> <li>the supplied event type</li> </ul>

`publish`

(

type
opts

)

CustomEvent

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:503

Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.

Parameters:

type String

the type, or name of the event
opts Object

optional config params. Valid properties are:
- [broadcast=false] Boolean optional
 
 whether or not the YUI instance and YUI global are notified when the event is fired.
- [bubbles=true] Boolean optional
 
 Whether or not this event bubbles. Events can only bubble if <code>emitFacade</code> is true.
- [context=this] Object optional
 
 the default execution context for the listeners.
- [defaultFn] Function optional
 
 the default function to execute when this event fires if preventDefault was not called.
- [emitFacade=false] Boolean optional
 
 whether or not this event emits a facade.
- [prefix] String optional
 
 the prefix for this targets events, e.g., 'menu' in 'menu:click'.
- [fireOnce=false] Boolean optional
 
 if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- [async=false] Boolean optional
 
 fireOnce event listeners will fire synchronously if the event has already fired unless <code>async</code> is <code>true</code>.
- [preventable=true] Boolean optional
 
 whether or not <code>preventDefault()</code> has an effect.
- [preventedFn] Function optional
 
 a function that is executed when <code>preventDefault()</code> is called.
- [queuable=false] Boolean optional
 
 whether or not this event can be queued during bubbling.
- [silent] Boolean optional
 
 if silent is true, debug messages are not provided for this event.
- [stoppedFn] Function optional
 
 a function that is executed when stopPropagation is called.
- [monitored] Boolean optional
 
 specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- [type] String optional
 
 the event type (valid option if not provided as the first parameter to publish).

Returns:

CustomEvent:

the custom event

`removeAttr`

(

name

)

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:90

Removes an attribute from the host object

Parameters:

name String

The name of the attribute to be removed.

`removeQuery`

(

url

)

String

Inherited from Router: yui3/src/app/js/router.js:477

Removes a query string from the end of the url (if one exists) and returns the result.

Parameters:

url String

URL.

Returns:

String:

Queryless path.

`removeRoot`

(

url

)

String

Inherited from Router: yui3/src/app/js/router.js:445

Removes the <code>root</code> URL from the front of url (if it's there) and returns the result. The returned path will always have a leading <code>/</code>.

Parameters:

url String

URL.

Returns:

String:

Rootless path.

`removeTarget`

(

)

chainable

Inherited from EventTarget: yui3/src/event-custom/js/event-facade.js:533

Removes a bubble target

Parameters:

o EventTarget

the target to remove

`replace`

(

[url]

)

chainable

Inherited from Router: yui3/src/app/js/router.js:489

Replaces the current browser history entry with a new one, and dispatches to the first matching route handler, if any. Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that support it (or the location hash in older browsers and IE) to change the URL. The specified URL must share the same origin (i.e., protocol, host, and port) as the current page, or an error will occur.

Parameters:

[url] String optional

URL to set. This URL needs to be of the same origin as the current URL. This can be a URL relative to the router's <code>root</code> attribute. If no URL is specified, the page's current URL will be used.

Example:

<pre class="code prettyprint"><code>// Starting URL: http://example.com/ router.replace('/path/'); // New URL: http://example.com/path/ router.replace('/path?foo=bar'); // New URL: http://example.com/path?foo=bar router.replace('/'); // New URL: http://example.com/</code></pre>

`reset`

(

name

)

Object chainable

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:100

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

name String

Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object:

A reference to the host object.

`route`

(

route
callbacks

)

chainable

Inherited from Router: yui3/src/app/js/router.js:523

Adds a route handler for the specified <code>route</code>. The <code>route</code> parameter may be a string or regular expression to represent a URL path, or a route object. If it's a string (which is most common), it may contain named parameters: <code>:param</code> will match any single part of a URL path (not including <code>/</code> characters), and <code>*param</code> will match any number of parts of a URL path (including <code>/</code> characters). These named parameters will be made available as keys on the <code>req.params</code> object that's passed to route handlers. If the <code>route</code> parameter is a regex, all pattern matches will be made available as numbered keys on <code>req.params</code>, starting with <code>0</code> for the full match, then <code>1</code> for the first subpattern match, and so on. Alternatively, an object can be provided to represent the route and it may contain a <code>path</code> property which is a string or regular expression which causes the route to be process as described above. If the route object already contains a <code>regex</code> or <code>regexp</code> property, the route will be considered fully-processed and will be associated with any <code>callacks</code> specified on the object and those specified as parameters to this method. Note: Any additional data contained on the route object will be preserved. Here's a set of sample routes along with URL paths that they match: <ul> <li> Route: <code>/photos/:tag/:page</code> <ul> <li>URL: <code>/photos/kittens/1</code>, params: <code>{tag: 'kittens', page: '1'}</code></li> <li>URL: <code>/photos/puppies/2</code>, params: <code>{tag: 'puppies', page: '2'}</code></li> </ul> </li> <li> Route: <code>/file/*path</code> <ul> <li>URL: <code>/file/foo/bar/baz.txt</code>, params: <code>{path: 'foo/bar/baz.txt'}</code></li> <li>URL: <code>/file/foo</code>, params: <code>{path: 'foo'}</code></li> </ul> </li> </ul> Middleware: Routes also support an arbitrary number of callback functions. This allows you to easily reuse parts of your route-handling code with different route. This method is liberal in how it processes the specified <code>callbacks</code>, you can specify them as separate arguments, or as arrays, or both. If multiple route match a given URL, they will be executed in the order they were added. The first route that was added will be the first to be executed. Passing Control: Invoking the <code>next()</code> function within a route callback will pass control to the next callback function (if any) or route handler (if any). If a value is passed to <code>next()</code>, it's assumed to be an error, therefore stopping the dispatch chain, unless that value is: <code>"route"</code>, which is special case and dispatching will skip to the next route handler. This allows middleware to skip any remaining middleware for a particular route.

Parameters:

route String | RegExp | Object

Route to match. May be a string or a regular expression, or a route object.
callbacks Array | Function | String multiple

Callback functions to call whenever this route is triggered. These can be specified as separate arguments, or in arrays, or both. If a callback is specified as a string, the named function will be called on this router instance.
- req Object
 
 Request object containing information about the request. It contains the following properties.
 - params Array | Object
 Captured parameters matched by the route path specification. If a string path was used and contained named parameters, then this will be a key/value hash mapping parameter names to their matched values. If a regex path was used, this will be an array of subpattern matches starting at index 0 for the full match, then 1 for the first subpattern match, and so on.
 - path String
 The current URL path.
 - pendingCallbacks Number
 Number of remaining callbacks the route handler has after this one in the dispatch chain.
 - pendingRoutes Number
 Number of matching routes after this one in the dispatch chain.
 - query Object
 Query hash representing the URL query string, if any. Parameter names are keys, and are mapped to parameter values.
 - route Object
 Reference to the current route object whose callbacks are being dispatched.
 - router Object
 Reference to this router instance.
 - src String
 What initiated the dispatch. In an HTML5 browser, when the back/forward buttons are used, this property will have a value of "popstate". When the dispath() method is called, the src will be "dispatch".
 - url String
 The full URL.
- res Object
 
 Response object containing methods and information that relate to responding to a request. It contains the following properties.
 - req Object
 Reference to the request object.
- next Function
 
 Function to pass control to the next callback or the next matching route if no more callbacks (middleware) exist for the current route handler. If you don't call this function, then no further callbacks or route handlers will be executed, even if there are more that match. If you do call this function, then the next callback (if any) or matching route handler (if any) will be called. All of these functions will receive the same <code>req</code> and <code>res</code> objects that were passed to this route (so you can use these objects to pass data along to subsequent callbacks and routes).
 - [err] String optional
 Optional error which will stop the dispatch chaining for this req, unless the value is "route", which is special cased to jump skip past any callbacks for the current route and pass control the next route handler.

Example:

<pre class="code prettyprint"><code>router.route('/photos/:tag/:page', function (req, res, next) { Y.log('Current tag: ' + req.params.tag); Y.log('Current page number: ' + req.params.page); }); // Using middleware. router.findUser = function (req, res, next) { req.user = this.get('users').findById(req.params.user); next(); }; router.route('/users/:user', 'findUser', function (req, res, next) { // The <code>findUser</code> middleware puts the <code>user</code> object on the <code>req</code>. Y.log('Current user:' req.user.get('name')); });</code></pre>

`save`

(

[url]

)

chainable

Inherited from Router: yui3/src/app/js/router.js:699

Saves a new browser history entry and dispatches to the first matching route handler, if any. Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that support it (or the location hash in older browsers and IE) to change the URL and create a history entry. The specified URL must share the same origin (i.e., protocol, host, and port) as the current page, or an error will occur.

Parameters:

[url] String optional

URL to set. This URL needs to be of the same origin as the current URL. This can be a URL relative to the router's <code>root</code> attribute. If no URL is specified, the page's current URL will be used.

Example:

<pre class="code prettyprint"><code>// Starting URL: http://example.com/ router.save('/path/'); // New URL: http://example.com/path/ router.save('/path?foo=bar'); // New URL: http://example.com/path?foo=bar router.save('/'); // New URL: http://example.com/</code></pre>

`set`

(

name
value
[opts]

)

Object chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:388

Sets the value of an attribute.

Parameters:

name String

The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`setAttrs`

(

attrs
[opts]

)

Object chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:770

Sets multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`subscribe`

() deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:346

Deprecated: use on

subscribe to an event

`toString`

() String

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:815

Default toString implementation. Provides the constructor NAME and the instance guid, if set.

Returns:

String:

String representation for this object

`unsubscribe`

() deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:469

Deprecated: use detach

detach a listener

`unsubscribeAll`

(

type

)

deprecated

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:490

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

type String

The type, or name of the event

`upgrade`

() Boolean

Inherited from Router: yui3/src/app/js/router.js:733

Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5 browsers, this method is a noop.

Returns:

Boolean:

<code>true</code> if the URL was upgraded, <code>false</code> otherwise.

Properties

`_allowAdHocAttrs`

Boolean protected

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:155

This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash. AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass._NON_ATTRS_CFG

Default: undefined (false)

`_dispatched`

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:66

Whether or not <code>_dispatch()</code> has been called since this router was instantiated.

Default: undefined

`_dispatching`

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:76

Whether or not we're currently in the process of dispatching to routes.

Default: undefined

`_historyEvents`

EventHandle protected

Inherited from Router: yui3/src/app/js/router.js:85

History event handle for the <code>history:change</code> or <code>hashchange</code> event subscription.

`_html5`

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:94

Cached copy of the <code>html5</code> attribute for internal use.

`_params`

Object protected

Inherited from Router: yui3/src/app/js/router.js:102

Available since 3.12.0

Map which holds the registered param handlers in the form: <code>name</code> -> RegExp | Function.

`_pjaxEvents`

EventHandle protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:69

Available since 3.5.0

Holds the delegated pjax-link click handler.

`_ready`

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:112

Whether or not the <code>ready</code> event has fired yet.

Default: undefined

`_regexPathParam`

RegExp protected

Inherited from Router: yui3/src/app/js/router.js:138

Regex used to match parameter placeholders in route paths. Subpattern captures: <ol> <li> Parameter prefix character. Either a <code>:</code> for subpath parameters that should only match a single level of a path, or <code>*</code> for splat parameters that should match any number of path levels. </li> <li> Parameter name, if specified, otherwise it is a wildcard match. </li> </ol>

`_regexURL`

RegExp protected

Inherited from Router: yui3/src/app/js/router.js:121

Available since 3.5.0

Regex used to break up a URL string around the URL's path. Subpattern captures: <ol> <li>Origin, everything before the URL's path-part.</li> <li>The URL's path-part.</li> <li>The URL's query.</li> <li>The URL's hash fragment.</li> </ol>

`_regexUrlOrigin`

RegExp protected

Inherited from Router: yui3/src/app/js/router.js:165

Regex that matches everything before the path portion of a URL (the origin). This will be used to strip this part of the URL from a string when we only want the path.

`_regexUrlQuery`

RegExp protected

Inherited from Router: yui3/src/app/js/router.js:155

Regex that matches and captures the query portion of a URL, minus the preceding <code>?</code> character, and discarding the hash portion of the URL if any.

`_routes`

Array protected

Inherited from Router: yui3/src/app/js/router.js:176

Collection of registered routes.

`name`

String deprecated

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:297

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

Attributes

`addPjaxParam`

Boolean

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:204

Available since 3.5.0

If <code>true</code>, a "pjax=1" query parameter will be appended to all URLs requested via Pjax. Browsers ignore HTTP request headers when caching content, so if the same URL is used to request a partial Pjax page and a full page, the browser will cache them under the same key and may later load the cached partial page when the user actually requests a full page (or vice versa). To prevent this, we can add a bogus query parameter to the URL so that Pjax URLs will always be cached separately from non-Pjax URLs.

Default: true

`allowFallThrough`

Boolean

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:425

Available since 3.18.0

Whether to set <code>window.location</code> when calling <code>navigate()</code> if no routes match the specified URL.

Default: true

`container`

Node

Inherited from Pjax: yui3/src/pjax/js/pjax.js:137

Available since 3.5.0

Node into which content should be inserted when a page is loaded via Pjax. This node's existing contents will be removed to make way for the new content.

If not set, loaded content will not be automatically inserted into the page.

Default: null

`contentSelector`

String

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:226

Available since 3.5.0

CSS selector used to extract a specific portion of the content of a page loaded via Pjax. For example, if you wanted to load the page <code>example.html</code> but only use the content within an element with the id "pjax-content", you'd set <code>contentSelector</code> to "#pjax-content". If not set, the entire page will be used.

Default: null

`destroyed`

Boolean readonly

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:212

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

`html5`

Boolean

Inherited from Router: yui3/src/app/js/router.js:1650

Whether or not this browser is capable of using HTML5 history. Setting this to <code>false</code> will force the use of hash-based history even on HTML5 browsers, but please don't do this unless you understand the consequences.

`initialized`

Boolean readonly

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:198

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

`linkSelector`

String | Function

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:372

Available since 3.5.0

CSS selector string used to filter link click events so that only the links which match it will have the enhanced navigation behavior of Pjax applied. When a link is clicked and that link matches this selector, Pjax will attempt to dispatch to any route handlers matching the link's <code>href</code> URL. If HTML5 history is not supported or if no route handlers match, the link click will be handled by the browser just like any old link.

Default: "a.yui3-pjax"

`navigateOnHash`

Boolean

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:392

Available since 3.5.0

Whether navigating to a hash-fragment identifier on the current page should be enhanced and cause the <code>navigate</code> event to fire. By default Pjax allows the browser to perform its default action when a user is navigating within a page by clicking in-page links (e.g. <code><a href="#top">Top of page</a></code>) and does not attempt to interfere or enhance in-page navigation.

Default: false

`params`

Object

Inherited from Router: yui3/src/app/js/router.js:1671

Available since 3.12.0

Map of params handlers in the form: <code>name</code> -> RegExp | Function. If a param handler regex or function returns a value of <code>false</code>, <code>null</code>, <code>undefined</code>, or <code>NaN</code>, the current route will not match and be skipped. All other return values will be used in place of the original param value parsed from the URL. This attribute is intended to be used to set params at init time, or to completely reset all params after init. To add params after init without resetting all existing params, use the <code>param()</code> method.

Default: `{}`

`root`

String

Inherited from Router: yui3/src/app/js/router.js:1695

Absolute root path from which all routes should be evaluated. For example, if your router is running on a page at <code>http://example.com/myapp/</code> and you add a route with the path <code>/</code>, your route will never execute, because the path will always be preceded by <code>/myapp</code>. Setting <code>root</code> to <code>/myapp</code> would cause all routes to be evaluated relative to that root URL, so the <code>/</code> route would then execute when the user browses to <code>http://example.com/myapp/</code>.

Default: `''`

Example:

<pre class="code prettyprint"><code>router.set('root', '/myapp'); router.route('/foo', function () { ... }); Y.log(router.hasRoute('/foo')); // => false Y.log(router.hasRoute('/myapp/foo')); // => true // Updates the URL to: "/myapp/foo" router.save('/foo');</code></pre>

`routes`

Object

Inherited from Router: yui3/src/app/js/router.js:1723

Array of route objects. Each item in the array must be an object with the following properties in order to be processed by the router: <ul> <li> <code>path</code>: String or regex representing the path to match. See the docs for the <code>route()</code> method for more details. </li> <li> <code>callbacks</code>: Function or a string representing the name of a function on this router instance that should be called when the route is triggered. An array of functions and/or strings may also be provided. See the docs for the <code>route()</code> method for more details. </li> </ul> If a route object contains a <code>regex</code> or <code>regexp</code> property, or if its <code>path</code> is a regular express, then the route will be considered to be fully-processed. Any fully-processed routes may contain the following properties: <ul> <li> <code>regex</code>: The regular expression representing the path to match, this property may also be named <code>regexp</code> for greater compatibility. </li> <li> <code>keys</code>: Array of named path parameters used to populate <code>req.params</code> objects when dispatching to route handlers. </li> </ul> Any additional data contained on these route objects will be retained. This is useful to store extra metadata about a route; e.g., a <code>name</code> to give routes logical names. This attribute is intended to be used to set routes at init time, or to completely reset all routes after init. To add routes after init without resetting all existing routes, use the <code>route()</code> method.

Default: `[]`

`scrollToTop`

Boolean

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:410

Available since 3.5.0

Whether the page should be scrolled to the top after navigating to a URL. When the user clicks the browser's back button, the previous scroll position will be maintained.

Default: true

`timeout`

Number

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:263

Available since 3.5.0

Time in milliseconds after which an Ajax request should time out.

Default: 30000

`titleSelector`

String

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:245

Available since 3.5.0

CSS selector used to extract a page title from the content of a page loaded via Pjax. By default this is set to extract the title from the <code><title></code> element, but you could customize it to extract the title from an <code><h1></code>, or from any other element, if that's more appropriate for the content you're loading.

Default: "title"

Events

`destroy`

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:163

Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding. Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).

Event Payload:

e EventFacade

Event object

`error`

Inherited from Pjax: yui3/src/pjax/js/pjax.js:22

Available since 3.5.0

Fired when an error occurs while attempting to load a URL via Ajax.

Event Payload:

content Object

Content extracted from the response, if any.
- node Node
  
  A Y.Node instance for a document fragment containing the extracted HTML content.
- [title] String optional
  
  The title of the HTML page, if any, extracted using the titleSelector attribute. If titleSelector is not set or if a title could not be found, this property will be undefined.
responseText String

Raw Ajax response text.
status Number

HTTP status code for the Ajax response.
url String

The absolute URL that failed to load.

`init`

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:62

Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring. Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

Event Payload:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`load`

Inherited from Pjax: yui3/src/pjax/js/pjax.js:40

Available since 3.5.0

Fired when a URL is successfully loaded via Ajax.

Event Payload:

content Object

Content extracted from the response, if any.
- node Node
  
  A Y.Node instance for a document fragment containing the extracted HTML content.
- [title] String optional
  
  The title of the HTML page, if any, extracted using the titleSelector attribute. If titleSelector is not set or if a title could not be found, this property will be undefined.
responseText String

Raw Ajax response text.
status Number

HTTP status code for the Ajax response.
url String

The absolute URL that was loaded.

`navigate`

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:16

Available since 3.5.0

Fired when navigating to a URL via Pjax. When the <code>navigate()</code> method is called or a pjax link is clicked, this event will be fired if the browser supports HTML5 history and the router has a route handler for the specified URL. This is a useful event to listen to for adding a visual loading indicator while the route handlers are busy handling the URL change.

Event Payload:

url String

The URL that the router will dispatch to its route handlers in order to fulfill the enhanced navigation "request".
[force=false] Boolean optional

Whether the enhanced navigation should occur even in browsers without HTML5 history.
[hash] String optional

The hash-fragment (including "#") of the <code>url</code>. This will be present when the <code>url</code> differs from the current URL only by its hash and <code>navigateOnHash</code> has been set to <code>true</code>.
[originEvent] Event optional

The event that caused the navigation. Usually this would be a click event from a "pjax" anchor element.
[replace] Boolean optional

Whether or not the current history entry will be replaced, or a new entry will be created. Will default to <code>true</code> if the specified <code>url</code> is the same as the current URL.

`ready`

Inherited from Router: yui3/src/app/js/router.js:26

Fired when the router is ready to begin dispatching to route handlers. You shouldn't need to wait for this event unless you plan to implement some kind of custom dispatching logic. It's used internally in order to avoid dispatching to an initial route if a browser history change occurs first.

Event Payload:

dispatched Boolean

<code>true</code> if routes have already been dispatched (most likely due to a history change).

APIs

Plugin.Pjax Class

Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_afterHistoryChange

Parameters:

_aggregateAttrs

Parameters:

Returns:

_attrCfgHash

_baseDestroy

_baseInit

_cloneDefaultValue

Parameters:

_decode

Parameters:

Returns:

_defAttrChangeFn

Parameters:

_defaultRoute

Parameters:

_defCompleteFn

Parameters:

_defDestroyFn

Parameters:

_defInitFn

Parameters:

_defNavigateFn

Parameters:

_defReadyFn

Parameters:

_dequeue

_destroyHierarchy

_dispatch

Parameters:

_filterAdHocAttrs

Parameters:

Returns:

_fireAttrChange

Parameters:

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

_getAttrs

Parameters:

Returns:

_getClasses

Returns:

_getFullType

Parameters:

Returns:

_getHashPath

Parameters:

Returns:

_getInstanceAttrCfgs

Parameters:

Returns:

_getOrigin

Returns:

Example:

_getParams

Returns:

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_afterHistoryChange`

`_aggregateAttrs`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_cloneDefaultValue`

`_decode`

`_defAttrChangeFn`

`_defaultRoute`

`_defCompleteFn`

`_defDestroyFn`

`_defInitFn`

`_defNavigateFn`

`_defReadyFn`

`_dequeue`

`_destroyHierarchy`

`_dispatch`

`_filterAdHocAttrs`

`_fireAttrChange`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getFullType`

`_getHashPath`

`_getInstanceAttrCfgs`

`_getOrigin`

`_getParams`

`_getParamValues`

`_getPath`

`_getPathRoot`

`_getQuery`

`_getRegex`

`_getRequest`

`_getResponse`

`_getRoutes`

`_getStateVal`

`_getType`

`_getURL`

`_hasPotentialSubscribers`

`_hasSameOrigin`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_isLazyAttr`

`_isLinkSameOrigin`

`_joinURL`

`_monitor`

`_navigate`

`_normalizePath`

`_normAttrVals`

`_onLinkClick`

`_onPjaxIOComplete`

`_onPjaxIOEnd`