The Router package adds Routing functionality to BetaJS.

This functionality is particularly useful in Single Page Web applications, as it creates an easy abstraction for navigating the internal structure of the application.

The Router in the BetaJS system is completely abstract.


### Setup

A router is created by creating an instance of the `Router` object.

```
  var router = new BetaJS.Router.Router();
```


### Binding Routes

The just created `router` object does nothing at this point, because it does not
know about any routes. So the next step is binding routes to `router`.

```
  /**
   * @param {string} name
   * @param {string} routeUrl
   */
  router.bind("test", "/test");
```


### Navigation

It is now possible to navigate to "test" by calling the `navigate` method.

```
  router.navigate("/test");
```


### Route Events

When the router navigates to "/test", it triggers an `event`. Learn more about events by looking at the `BetaJS.Events.Events` documentation. The name of the event is "dispatch:test". More generally, it is "dispatch:ROUTENAME".

Conducting an action based on the current route is as simple as listening for the proper event.

```
  var events = BetaJS.Events.Events();
  events.on("dispatch:test", function() {
    console.log("Navigated to test.");
  });
```


### Routes with Arguments

Now, suppose you want to navigate to the fourth post on a blog site. First, bind the route.

```
  /**
   * ...
   * @param {function} callback
   */
  router.bind("post", "/posts/(id:[0-9]*)", function(args) {
    console.log("You navigated to blog post #" + args.id);
  });
```

This route binding looks different because it contains a URL argument. It is possible to bind arguments from the url, which will be passed when the Event is omitted. Additionally, the previous example shows a new way to execute code during routing. The callback function will be called when the route is navigated to. It receives arguments from the url as the first argument to the callback.

Naturally, much more can be done with routers, but this is an introduction to the basic features.