Router type

Client-side routing (aka hash-routing) allows you to specify some information about the state of the application using the URL. So that when the user visits a specific URL, the application can be transformed accordingly.

Example

HTML

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>A Gentle Introduction</title>
    <script src="https://raw.github.com/flatiron/director/master/build/director.min.js"></script>
    <script>

      var author = function () { console.log("author"); },
          books = function () { console.log("books"); },
          viewBook = function(bookId) { console.log("viewBook: bookId is populated: " + bookId); };

      var routes = {
        '/author': author,
        '/books': [books, function() { console.log("An inline route handler."); }],
        '/books/view/:bookId': viewBook
      };

      var router = Router(routes);
      router.init();

    </script>
  </head>
  <body>
    <ul>
      <li><a href="#/author">#/author</a></li>
      <li><a href="#/books">#/books</a></li>
      <li><a href="#/books/view/1">#/books/view/1</a></li>
    </ul>
  </body>
</html>

Inheritance Hierarchy

Object
Router

Browser Compatibility

Fields

	Name	Description
	async
	delimiter
	every
	history
	historySupport
	methods
	notfound
	params
	recurse
	resource
	routes
	run_in_init
	scope
	strict

Top

Methods

	Name	Description
	configure	Given the flexible nature of director there are several options available for both the Client-side and Server-side. These options can be set using the .configure() method
	dispatch	Dispatches the route handlers matched within the Routing Table for this instance for the specified method and path.
	getRoute	Returns the entire route or just a section of it.
	init	Initialize the router, start listening for changes to the URL.
	insertEx	insert a callback that will only occur once per the matched route.
	mount	Inserts the partial Routing Table, routes, into the Routing Table for this Router instance at the specified path.
	on	Adds the route handler for the specified method and path within the Routing Table.
	param	Adds a route fragment for the given string token to the specified regex matcher to this Router instance. See URL Parameters for more documentation.
	setRoute	Remove a segment from the current route.

Top

Reference

(Global) Namespace