Node plugin that provides seamless, gracefully degrading pjax functionality.
_addAttrscfgs
values
lazy
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).
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 addAttr.
_addLazyAttrname
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrdername
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});_afterHistoryChangee
Handles history:change and hashchange events.
_aggregateAttrsallAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_cloneDefaultValuecfg
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.
cfg
Object
_decodestring
Wrapper around decodeURIComponent that also converts + chars into
spaces.
string
String
String to decode.
Decoded string.
_defAttrChangeFne
eventFastPath
Default function for attribute change events.
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
_defaultRoutereq
res
next
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.
_defCompleteFne
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.
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_dequeueShifts the topmost _save() call off the queue and executes it. Does
nothing if the queue is empty.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_dispatchreq
res
Dispatches to the first route handler that matches the specified path.
If called before the ready event has fired, the dispatch will be aborted.
This ensures normalized behavior between Chrome (which fires a popstate
event on every pageview) and other browsers (which do not).
_filterAdHocAttrsallAttrs
userVals
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.
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
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.
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfgname
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.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
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.
_getAttrInitValattr
cfg
initValues
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.
The initial value of the attribute.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
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.
_getFullTypetype
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.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getHashPath[hash]
Returns the resolved path from the hash fragment, or an empty string if the hash is not path-like.
[hash]
String
optional
Hash fragment to resolve into a path. By default this will be the hash from the current URL.
Current hash path, or an empty string if the hash is empty.
_getInstanceAttrCfgsallCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getOriginGets the location origin (i.e., protocol, host, and port) as a URL.
Location origin (i.e., protocol, host, and port).
http://example.com_getParamsGetter for the params attribute.
Mapping of param handlers: name -> RegExp | Function.
_getParamValuesroute
path
Gets the param values for the specified route and path, suitable to use
form req.params.
Note: This method will return false if a named param handler rejects a
param value.
_getPathRootReturns 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 '/'.
The URL's path root.
_getQueryGets the current route query string.
Current route query string.
_getRegexpath
keys
Creates a regular expression from the given route specification. If path is already a regex, it will be returned unmodified.
Route regex.
_getRequestsrc
Gets a request object that can be passed to a route handler.
src
String
What initiated the URL change and need for the request.
Request object.
_getResponsereq
Gets a response object that can be passed to a route handler.
req
Object
Request object.
Response Object.
_getRoutesGetter for the routes attribute.
Array of route objects.
_getStateValname
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_hasSameOriginurl
Returns true when the specified url 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.
url
String
URL to compare origin with the current URL.
Whether the URL has the same origin of the current URL.
_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
attrs
Object
The attributes to add during construction (passed through to addAttrs). 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 addAttrs). 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 addAttrs).
_initAttributeInitializes AttributeCore
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
attrs
Object
The attributes to add during construction (passed through to addAttrs). 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 addAttrs). 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 addAttrs).
_initBaseconfig
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initHierarchyuserVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA 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.
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_isLinkSameOriginlink
Utility method to test whether a specified link/anchor node's href is of
the same origin as the page's current location.
This normalize browser inconsistencies with how the port is reported for
anchor elements (IE reports a value for the default port, e.g. "80").
link
Node
The anchor element to test whether its href is of the
same origin as the page's current location.
Whether or not the link's href is of the same origin as
the page's current location.
_joinURLurl
Joins the root URL to the specified url, normalizing leading/trailing
/ characters.
url
String
URL to append to the root URL.
Joined URL.
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'_monitorwhat
eventType
o
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.
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
_normalizePathpath
Returns a normalized path, ridding it of any '..' segments and properly handling leading and trailing slashes.
path
String
URL path to normalize.
Normalized path.
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
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.
_onLinkClicke
Handler for delegated link-click events which match the linkSelector.
This will attempt to enhance the navigation to the link element's href by
passing the URL to the _navigate() 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.
_onPjaxIOCompleteid
ioResponse
details
Handles IO complete events.
This parses the content from the Y.io() response and puts it on the
route's response object.
_onPjaxIOEndid
details
Handles IO end events.
_parseQueryquery
Parses a URL query string into a key/value hash. If Y.QueryString.parse is
available, this method will be an alias to that.
query
String
Query string to parse.
Hash of key/value pairs for query parameters.
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_pathHasRootroot
path
Returns true when the specified path is semantically within the
specified root path.
If the root does not end with a trailing slash ("/"), one will be added
before the path is evaluated against the root path.
Whether or not the path is semantically within the
root path.
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_pjaxBindUIBinds the delegation of link-click events that match the linkSelector to
the _onLinkClick() handler.
By default this method will only be called if the browser is capable of using HTML5 history.
_preInitEventCfgconfig
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.
config
Object
The user configuration object
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publishfullType
etOpts
ceOpts
The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the type to fullType conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_queueQueues up a _save() call to run after all previously-queued calls have
finished.
This is necessary because if we make multiple _save() calls before the
first call gets dispatched, then both calls will dispatch to the last call's
URL.
All arguments passed to _queue() will be passed on to _save() when the
queued function is executed.
_resolvePathpath
Returns the normalized result of resolving the path against the current
path. Falsy values for path will return just the current path.
path
String
URL path to resolve.
Resolved path.
_resolveURLurl
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.
url
String
URL to resolve.
Resolved URL.
_save[url]
[replace=false]
Saves a history entry using either pushState() or the location hash.
This method enforces the same-origin security constraint; attempting to save
a url that is not from the same origin as the current URL will result in
an error.
_setname
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAttrname
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrsattrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrValattrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
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.
true if the new attribute value was stored, false if not.
_setParamsparams
Setter for the params attribute.
params
Object
Map in the form: name -> RegExp | Function.
The map of params: name -> RegExp | Function.
_setRoutesroutes
Setter for the routes attribute.
routes
Object[]
Array of route objects.
Array of route objects.
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_upgradeURLurl
Upgrades a hash-based URL to a full-path URL, if necessary.
The specified url 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.
url
String
The URL to upgrade from hash-based to full-path.
The upgraded URL, or the specified URL untouched.
app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/';addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
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.
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)
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 Attribute.INVALID_VALUE, 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.
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.
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.
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.
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).
A reference to the host object.
addAttrscfgs
values
lazy
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.
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 addAttr.
A reference to the host object.
addTargeto
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.
o
EventTarget
the target to add
aftertype
fn
[context]
[arg*]
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.
A subscription handle capable of detaching the subscription
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
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.
beforeExecutes 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
detach handle
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
destroyDestroy lifecycle method. Invokes destructors for the class hierarchy.
A reference to this object
detachtype
fn
context
Detach one or more listeners the from the specified event
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)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
dispatchDispatches to the first route handler that matches the current URL, if any.
If dispatch() is called before the ready event has fired, it will
automatically wait for the ready event before dispatching. Otherwise it
will dispatch immediately.
firetype
arguments
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.
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.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
getname
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.
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. get("x.y.z"))
The value of the attribute
getAttrsattrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getContentresponseText
Extracts and returns the relevant HTML content from an Ajax response. The
content is extracted using the contentSelector attribute as a CSS
selector. If contentSelector is null, the entire response will be
returned.
The return value is an object containing two properties:
node: A Y.Node instance for a document fragment containing the
extracted HTML content.
title: The title of the HTML page, if any, extracted using the
titleSelector attribute (which defaults to looking for a <title>
element). If titleSelector is not set or if a title could not be
found, this property will be undefined.
responseText
String
Raw Ajax response text.
Content object with the properties described above.
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
hasRouteurl
Returns true if this router has at least one route that matches the
specified URL, false otherwise. This also checks that any named param
handlers also accept app param values in the url.
This method enforces the same-origin security constraint on the specified
url; any URL which is not from the same origin as the current URL will
always return false.
url
String
URL to match.
true if there's at least one matching route, false
otherwise.
initcfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
loadContentreq
res
next
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:
req.ioURL: The full URL that was used to make the Y.io() XHR. This
may contain "pjax=1" if the addPjaxParam option is set.
res.content: An object containing node and title properties for
the content extracted from the server's response. See getContent() for
more details.
res.ioResponse: The full Y.io() response object. This is useful if
you need access to the XHR's response status or HTTP headers.
router.route('/foo/', 'loadContent', function (req, res, next) {
Y.one('container').setHTML(res.content.node);
Y.config.doc.title = res.content.title;
});matchpath
Returns an array of route objects that match the specified URL path.
If this router has a root, then the specified path must be
semantically within the root 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:
callback: A function or a string representing the name of a function
this router that should be executed when the route is triggered.
keys: An array of strings representing the named parameters defined in
the route's path specification, if any.
path: The route's path specification, which may be either a string or
a regex.
regex: A regular expression version of the route's path specification.
This regex is used to determine whether the route matches a given path.
path
String
URL path to match. This should be an absolute path that starts with a slash: "/".
Array of route objects that match the specified path.
router.route('/foo', function () {});
router.match('/foo');
// => [{callback: ..., keys: [], path: '/foo', regex: ...}]modifyAttrname
config
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:
Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
ontype
fn
[context]
[arg*]
Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.
Callback functions for events published with emitFacade = true will
receive an EventFacade as the first argument (typically named "e").
These callbacks can then call e.preventDefault() to disable the
behavior published to that event's defaultFn. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade events will receive the arguments passed to fire()
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, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.
Returning false from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();. However, it is
recommended to use the event methods whenever possible.
A subscription handle capable of detaching that subscription
oncetype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to on except the
listener is immediatelly detached when it is executed.
A subscription handle capable of detaching the subscription
onceAftertype
fn
[context]
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to after except the
listener is immediatelly detached when it is executed.
A subscription handle capable of detaching that subscription
paramname
handler
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 req.params 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 false, null,
undefined, or NaN, 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.
name
String
Name of the param used in route paths.
handler
Function | RegExp
Function to invoke or regular expression to
exec() during route dispatching whose return value is used as the new
param value. Values of false, null, undefined, or NaN 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:
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) {
// req.params.username is an array because the result of calling
// exec() 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!"parseTypetype
[pre]
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.
an array containing:
publishtype
opts
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.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
the custom event
removeAttrname
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
removeQueryurl
Removes a query string from the end of the url (if one exists) and returns the result.
url
String
URL.
Queryless path.
removeRooturl
Removes the root URL from the front of url (if it's there) and returns
the result. The returned path will always have a leading /.
url
String
URL.
Rootless path.
replace[url]
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 pushState() 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.
[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 root
attribute. If no URL is specified, the page's current URL will be used.
// 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/resetname
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
name
String
Optional. The name of the attribute to reset. If omitted, all attributes are reset.
A reference to the host object.
routeroute
callbacks
Adds a route handler for the specified route.
The route 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: :param will match any single part of a URL path
(not including / characters), and param will match any number of parts
of a URL path (including / characters). These named parameters will be
made available as keys on the req.params object that's passed to route
handlers.
If the route parameter is a regex, all pattern matches will be made
available as numbered keys on req.params, starting with 0 for the full
match, then 1 for the first subpattern match, and so on.
Alternatively, an object can be provided to represent the route and it may
contain a path 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 regex or regexp property, the route will be
considered fully-processed and will be associated with any callacks
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:
Route: /photos/:tag/:page
/photos/kittens/1, params: {tag: 'kittens', page: '1'}/photos/puppies/2, params: {tag: 'puppies', page: '2'}Route: /file/path
/file/foo/bar/baz.txt, params: {path: 'foo/bar/baz.txt'}/file/foo, params: {path: 'foo'}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 callbacks, 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 next() 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 next(), it's assumed to be an error,
therefore stopping the dispatch chain, unless that value is: "route",
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.
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
path
String
pendingCallbacks
Number
pendingRoutes
Number
query
Object
route
Object
router
Object
src
String
dispath() method is
called, the src will be "dispatch".
url
String
res
Object
Response object containing methods and information that relate to responding to a request. It contains the following properties.
req
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 req and res 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
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.
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 findUser middleware puts the user object on the req.
Y.log('Current user:' req.user.get('name'));
});save[url]
Saves a new browser history entry and dispatches to the first matching route handler, if any.
Behind the scenes, this method uses HTML5 pushState() 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.
[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 root
attribute. If no URL is specified, the page's current URL will be used.
// 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/setname
value
[opts]
Sets the value of an attribute.
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. set("x.y.z", 5)).
value
Any
The value to set the attribute to.
[opts]
Object
optional
Optional data providing the circumstances for the change.
A reference to the host object.
setAttrsattrs
[opts]
Sets multiple attribute values.
A reference to the host object.
subscribesubscribe to an event
toStringDefault toString implementation. Provides the constructor NAME and the instance guid, if set.
String representation for this object
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrsThis 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)
_dispatchedWhether or not _dispatch() has been called since this router was
instantiated.
Default: undefined
_dispatchingWhether or not we're currently in the process of dispatching to routes.
Default: undefined
_historyEventsHistory event handle for the history:change or hashchange event
subscription.
_paramsMap which holds the registered param handlers in the form:
name -> RegExp | Function.
_regexPathParamRegex used to match parameter placeholders in route paths.
Subpattern captures:
Parameter prefix character. Either a : for subpath parameters that
should only match a single level of a path, or * for splat parameters
that should match any number of path levels.
Parameter name, if specified, otherwise it is a wildcard match.
_regexURLRegex used to break up a URL string around the URL's path.
Subpattern captures:
_regexUrlOriginRegex 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.
_regexUrlQueryRegex that matches and captures the query portion of a URL, minus the
preceding ? character, and discarding the hash portion of the URL if any.
addPjaxParamIf true, 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
addPjaxParamChange
Fires when the value for the configuration attribute addPjaxParam is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
containerNode 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
containerChange
Fires when the value for the configuration attribute container is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
contentSelectorCSS 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 example.html but only use
the content within an element with the id "pjax-content", you'd set
contentSelector to "#pjax-content".
If not set, the entire page will be used.
Default: null
contentSelectorChange
Fires when the value for the configuration attribute contentSelector is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
destroyedFlag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
destroyedChange
Fires when the value for the configuration attribute destroyed is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
html5Whether or not this browser is capable of using HTML5 history.
Setting this to false will force the use of hash-based history even on
HTML5 browsers, but please don't do this unless you understand the
consequences.
html5Change
Fires when the value for the configuration attribute html5 is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
initializedFlag indicating whether or not this object has been through the init lifecycle phase.
Default: false
initializedChange
Fires when the value for the configuration attribute initialized is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
linkSelectorCSS 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 href 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"
linkSelectorChange
Fires when the value for the configuration attribute linkSelector is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
paramsMap of params handlers in the form: name -> RegExp | Function.
If a param handler regex or function returns a value of false, null,
undefined, or NaN, 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 param() method.
Default: `{}`
paramsChange
Fires when the value for the configuration attribute params is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
rootAbsolute root path from which all routes should be evaluated.
For example, if your router is running on a page at
http://example.com/myapp/ and you add a route with the path /, your
route will never execute, because the path will always be preceded by
/myapp. Setting root to /myapp would cause all routes to be
evaluated relative to that root URL, so the / route would then execute
when the user browses to http://example.com/myapp/.
Default: `''`
rootChange
Fires when the value for the configuration attribute root is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
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');routesArray of route objects.
Each item in the array must be an object with the following properties in order to be processed by the router:
path: String or regex representing the path to match. See the docs
for the route() method for more details.
callbacks: 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 route() method for more details.
If a route object contains a regex or regexp property, or if its
path is a regular express, then the route will be considered to be
fully-processed. Any fully-processed routes may contain the following
properties:
regex: The regular expression representing the path to match, this
property may also be named regexp for greater compatibility.
keys: Array of named path parameters used to populate req.params
objects when dispatching to route handlers.
Any additional data contained on these route objects will be retained.
This is useful to store extra metadata about a route; e.g., a name 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 route() method.
Default: `[]`
routesChange
Fires when the value for the configuration attribute routes is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
scrollToTopWhether 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
scrollToTopChange
Fires when the value for the configuration attribute scrollToTop is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
timeoutTime in milliseconds after which an Ajax request should time out.
Default: 30000
timeoutChange
Fires when the value for the configuration attribute timeout is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
titleSelectorCSS 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 <title> element,
but you could customize it to extract the title from an <h1>, or from
any other element, if that's more appropriate for the content you're
loading.
Default: "title"
titleSelectorChange
Fires when the value for the configuration attribute titleSelector is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
e
EventFacade
destroyLifecycle 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).
e
EventFacade
Event object
errorFired when an error occurs while attempting to load a URL via Ajax.
initLifecycle 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).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
loadFired when a URL is successfully loaded via Ajax.
readyFired 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.
dispatched
Boolean
true if routes have already been dispatched
(most likely due to a history change).