Router Class
Provides URL-based routing using HTML5 pushState() or the location hash.
This makes it easy to wire up route handlers for different application states while providing full back/forward navigation support and bookmarkable, shareable URLs.
Constructor
Item Index
Methods
- addAttr
- addAttrs
- addTarget
- after
- attrAdded
- before
- bubble
- destroy
- detach
- detachAll
- dispatch static
- dispatch
- fire
- get
- getAttrs
- getEvent
- getPath
- getTargets
- hasRoute
- init
- match
- modifyAttr
- on
- once
- onceAfter
- param
- parseType
- publish
- removeAttr
- removeQuery
- removeRoot
- removeTarget
- replace
- reset
- route
- save
- set
- setAttrs
- subscribe deprecated
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
- upgrade
Properties
- name deprecated
Methods
addAttr
-
name -
config -
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
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.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
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)
- setter <Function | String>
-
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.
- getter <Function | String>
-
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.
- validator <Function | String>
-
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.
- lazyAdd <boolean>
- 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 addAttrs method.
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:
-
nameStringThe name of the attribute.
-
configObjectAn 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.
-
lazyBoolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
A reference to the host object.
addAttrs
-
cfgs -
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.
Parameters:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn 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.
-
lazyBooleanWhether 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.
Returns:
A reference to the host object.
addTarget
-
o
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:
-
oEventTargetthe target to add
after
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching the subscription
attrAdded
-
name
Checks if the given attribute has been added to the host
Parameters:
-
nameStringThe name of the attribute to check.
Returns:
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
()
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
Propagate an event. Requires the event-custom-complex module.
Parameters:
-
evtCustomEventthe custom event to propagate
Returns:
the aggregated return value from Event.Custom.fire
destroy
()
BaseCore
chainable
Destroy lifecycle method. Invokes destructors for the class hierarchy.
Returns:
A reference to this object
detach
-
type -
fn -
context
Detach one or more listeners the from the specified event
Parameters:
-
typeString | ObjectEither 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.
-
fnFunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
-
contextObjectThe 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:
the host
detachAll
-
type
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:
-
typeStringThe type, or name of the event
dispatch
()
static
Dispatches to the first route handler that matches the specified path for
all active router instances.
This provides a mechanism to cause all active router instances to dispatch
to their route handlers without needing to change the URL or fire the
history:change or hashchange event.
dispatch
()
chainable
Dispatches 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.
fire
-
type -
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.
Parameters:
-
typeString | ObjectThe type of the event, or an object that contains a 'type' property.
-
argumentsObject*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:
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
get
-
name
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:
-
nameStringThe 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"))
Returns:
The value of the attribute
getAttrs
-
attrs
Gets multiple attribute values.
Parameters:
Returns:
An object with attribute name/value pairs.
getEvent
-
type -
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
Parameters:
Returns:
the custom event or null
getTargets
()
Returns an array of bubble targets for this object.
Returns:
EventTarget[]
hasRoute
-
url
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.
Parameters:
-
urlStringURL to match.
Returns:
true if there's at least one matching route, false
otherwise.
init
-
cfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
Parameters:
-
cfgObjectObject with configuration property name/value pairs
Returns:
A reference to this object
match
-
path
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.
Parameters:
-
pathStringURL path to match. This should be an absolute path that starts with a slash: "/".
Returns:
Array of route objects that match the specified path.
Example:
router.route('/foo', function () {});
router.match('/foo');
// => [{callback: ..., keys: [], path: '/foo', regex: ...}]modifyAttr
-
name -
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:
- readOnly;
- writeOnce;
- broadcast; and
- getter.
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).
on
-
type -
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.
this.on("change", this._onChange, this);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.
this.on({
"attrChange" : this._onAttrChange,
"change" : this._onChange
});You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback.
this.on([ "change", "attrChange" ], this._onChange);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.
Parameters:
Returns:
A subscription handle capable of detaching that subscription
once
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching the subscription
onceAfter
-
type -
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.
Parameters:
Returns:
A subscription handle capable of detaching that subscription
param
-
name -
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.
Parameters:
-
nameStringName of the param used in route paths.
-
handlerFunction | RegExpFunction to invoke or regular expression to
exec()during route dispatching whose return value is used as the new param value. Values offalse,null,undefined, orNaNwill 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:
Example:
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!"parseType
-
type -
[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.
Parameters:
Returns:
an array containing:
- the detach category, if supplied,
- the prefixed event type,
- whether or not this is an after listener,
- the supplied event type
publish
-
type -
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.
Parameters:
-
typeStringthe type, or name of the event
-
optsObjectoptional config params. Valid properties are:
-
[broadcast=false]Boolean optionalwhether or not the YUI instance and YUI global are notified when the event is fired.
-
[bubbles=true]Boolean optionalWhether or not this event bubbles. Events can only bubble if
emitFacadeis true. -
[context=this]Object optionalthe default execution context for the listeners.
-
[defaultFn]Function optionalthe default function to execute when this event fires if preventDefault was not called.
-
[emitFacade=false]Boolean optionalwhether or not this event emits a facade.
-
[prefix]String optionalthe prefix for this targets events, e.g., 'menu' in 'menu:click'.
-
[fireOnce=false]Boolean optionalif an event is configured to fire once, new subscribers after the fire will be notified immediately.
-
[async=false]Boolean optionalfireOnce event listeners will fire synchronously if the event has already fired unless
asyncistrue. -
[preventable=true]Boolean optionalwhether or not
preventDefault()has an effect. -
[preventedFn]Function optionala function that is executed when
preventDefault()is called. -
[queuable=false]Boolean optionalwhether or not this event can be queued during bubbling.
-
[silent]Boolean optionalif silent is true, debug messages are not provided for this event.
-
[stoppedFn]Function optionala function that is executed when stopPropagation is called.
-
[monitored]Boolean optionalspecifies whether or not this event should send notifications about when the event has been attached, detached, or published.
-
[type]String optionalthe event type (valid option if not provided as the first parameter to publish).
-
Returns:
the custom event
removeAttr
-
name
Removes an attribute from the host object
Parameters:
-
nameStringThe name of the attribute to be removed.
removeQuery
-
url
Removes a query string from the end of the url (if one exists) and returns the result.
Parameters:
-
urlStringURL.
Returns:
Queryless path.
removeRoot
-
url
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 /.
Parameters:
-
urlStringURL.
Returns:
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.
Parameters:
-
[url]String optionalURL 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
rootattribute. If no URL is specified, the page's current URL will be used.
Example:
// 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/reset
-
name
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
Parameters:
-
nameStringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
A reference to the host object.
route
-
route -
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- URL:
/photos/kittens/1, params:{tag: 'kittens', page: '1'} - URL:
/photos/puppies/2, params:{tag: 'puppies', page: '2'}
- URL:
-
Route:
/file/*path- URL:
/file/foo/bar/baz.txt, params:{path: 'foo/bar/baz.txt'} - URL:
/file/foo, params:{path: 'foo'}
- URL:
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.
Parameters:
-
routeString | RegExp | ObjectRoute to match. May be a string or a regular expression, or a route object.
-
callbacksArray | Function | String multipleCallback 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.
-
reqObjectRequest object containing information about the request. It contains the following properties.
-
paramsArray | ObjectCaptured 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. -
pathStringThe current URL path. -
pendingCallbacksNumberNumber of remaining callbacks the route handler has after this one in the dispatch chain. -
pendingRoutesNumberNumber of matching routes after this one in the dispatch chain. -
queryObjectQuery hash representing the URL query string, if any. Parameter names are keys, and are mapped to parameter values. -
routeObjectReference to the current route object whose callbacks are being dispatched. -
routerObjectReference to this router instance. -
srcStringWhat initiated the dispatch. In an HTML5 browser, when the back/forward buttons are used, this property will have a value of "popstate". When thedispath()method is called, thesrcwill be"dispatch". -
urlStringThe full URL.
-
-
resObjectResponse object containing methods and information that relate to responding to a request. It contains the following properties.
-
reqObjectReference to the request object.
-
-
nextFunctionFunction 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
reqandresobjects that were passed to this route (so you can use these objects to pass data along to subsequent callbacks and routes).-
[err]String optionalOptional error which will stop the dispatch chaining for thisreq, 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:
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.
Parameters:
-
[url]String optionalURL 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
rootattribute. If no URL is specified, the page's current URL will be used.
Example:
// 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/set
-
name -
value -
[opts]
Sets the value of an attribute.
Parameters:
-
nameStringThe 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)). -
valueAnyThe value to set the attribute to.
-
[opts]Object optionalOptional data providing the circumstances for the change.
Returns:
A reference to the host object.
setAttrs
-
attrs -
[opts]
Sets multiple attribute values.
Parameters:
Returns:
A reference to the host object.
subscribe
()
deprecated
subscribe to an event
toString
()
String
Default toString implementation. Provides the constructor NAME and the instance guid, if set.
Returns:
String representation for this object
unsubscribe
()
deprecated
detach a listener
unsubscribeAll
-
type
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:
-
typeStringThe type, or name of the event
Properties
Attributes
destroyed
Boolean
readonly
Flag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
Fires event 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.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
html5
Boolean
Whether 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.
Fires event 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.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
initialized
Boolean
readonly
Flag indicating whether or not this object has been through the init lifecycle phase.
Default: false
Fires event 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.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
params
Object
Map 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: `{}`
Fires event 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.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
root
String
Absolute 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: `''`
Fires event 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.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
Example:
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');routes
Object[]
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:
-
path: String or regex representing the path to match. See the docs for theroute()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 theroute()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 namedregexpfor greater compatibility. -
keys: Array of named path parameters used to populatereq.paramsobjects 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: `[]`
Fires event 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.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
Events
destroy
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:
-
eEventFacadeEvent object
init
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:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
ready
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:
-
dispatchedBooleantrueif routes have already been dispatched (most likely due to a history change).