State-based routing for Javascript
npm install ui-router**Note: this is the Angular 1.x source for UI-Router version 1.0 alpha. If you are looking for the source for UI-Router
version 0.2.x, it can be found here**
---
#### The de-facto solution to flexible routing in angular
---
Docs 1.0.0-alpha.3 |
Download stable (or Minified) |
Guide |
API |
Sample (Src) |
FAQ |
Resources |
Report an Issue |
Contribute |
Help! |
---
Angular UI-Router is a client-side Single Page Application
routing framework for AngularJS.
Routing frameworks for SPAs update the browser's URL as the user nagivates through the app. Conversely, this allows
changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a
location deep within the SPA.
UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a
state machine to manage the transitions between those
application states in a transaction-like manner.
(1) Get UI-Router in one of the following ways:
- clone & build this repository
- download the release (or minified)
- link to cdn
- via jspm: by running $ jspm install angular-ui-router from your console
- or via npm: by running $ npm install angular-ui-router from your console
- or via Bower: by running $ bower install angular-ui-router from your console
- or via Component: by running $ component install angular-ui/ui-router from your console
(2) Include angular-ui-router.js (or angular-ui-router.min.js) in your index.html, after including Angular itself (For Component users: ignore this step)
(3) Add 'ui.router' to your main module's list of dependencies (For Component users: replace 'ui.router' with require('angular-ui-router'))
When you're done, your setup should look similar to the following:
>
``html`
...
...
The majority of UI-Router's power is in its ability to nest states & views.
(1) First, follow the setup instructions detailed above.
(2) Then, add a ui-view directive to the
of your app.>
`html
State 1
State 2
`ui-sref directives. In addition to managing state transitions, this directive auto-generates the href attribute of the element it's attached to, if the corresponding state has a URL. Next we'll add some templates. These will plug into the ui-view within index.html. Notice that they have their own ui-view as well! That is the key to nesting states and views.>
`html
State 1
Show List
`
`html
State 2
Show List
`(4) Next, we'll add some child templates. These will get plugged into the
ui-view of their parent state templates.>
`html
List of State 1 Items
- {{ item }}
`>
`html
List of State 2 Things
- {{ thing }}
`(5) Finally, we'll wire it all up with
$stateProvider. Set up your states in the module config, as in the following:
>
`javascript
myApp.config(function($stateProvider, $urlRouterProvider) {
//
// For any unmatched url, redirect to /state1
$urlRouterProvider.otherwise("/state1");
//
// Now set up the states
$stateProvider
.state('state1', {
url: "/state1",
templateUrl: "partials/state1.html"
})
.state('state1.list', {
url: "/list",
templateUrl: "partials/state1.list.html",
controller: function($scope) {
$scope.items = ["A", "List", "Of", "Items"];
}
})
.state('state2', {
url: "/state2",
templateUrl: "partials/state2.html"
})
.state('state2.list', {
url: "/list",
templateUrl: "partials/state2.list.html",
controller: function($scope) {
$scope.things = ["A", "Set", "Of", "Things"];
}
});
});
`(6) See this quick start example in action.
>Go to Quick Start Plunker for Nested States & Views
(7) This only scratches the surface
>Dive Deeper!
$3
Another great feature is the ability to have multiple
ui-views view per template.Pro Tip: *While multiple parallel views are a powerful feature, you'll often be able to manage your
interfaces more effectively by nesting your views, and pairing those views with nested states.*
(1) Follow the setup instructions detailed above.
(2) Add one or more
ui-view to your app, give them names.
>
`html
Route 1
Route 2
`(3) Set up your states in the module config:
>
`javascript
myApp.config(function($stateProvider) {
$stateProvider
.state('index', {
url: "",
views: {
"viewA": { template: "index.viewA" },
"viewB": { template: "index.viewB" }
}
})
.state('route1', {
url: "/route1",
views: {
"viewA": { template: "route1.viewA" },
"viewB": { template: "route1.viewB" }
}
})
.state('route2', {
url: "/route2",
views: {
"viewA": { template: "route2.viewA" },
"viewB": { template: "route2.viewB" }
}
})
});
``(4) See this quick start example in action.
>Go to Quick Start Plunker for Multiple & Named Views
* In-Depth Guide
* API Reference
* Sample App (Source)
* FAQ
* Slides comparing ngRoute to ui-router
* UI-Router Extras / Addons (@christopherthielen)
* Introduction Video (egghead.io)
* Tim Kindberg on Angular UI-Router
* Activating States (egghead.io)
* Learn Angular.js using UI-Router (LearnCode.academy)
Please read our Contributor guidelines before reporting an issue or creating a pull request.