| 1 | # AngularUI Router [](https://github.com/angular-ui/ui-router/actions?query=workflow%3A%22CI%3A+UIRouter+for+AngularJS%22)
|
| 2 |
|
| 3 | **Note: this is the Angular 1.x source for UI-Router version 1.x. If you are looking for the source for UI-Router
|
| 4 | version 0.x, it can be found [here](https://github.com/angular-ui/ui-router/tree/legacy)**
|
| 5 |
|
| 6 | ---
|
| 7 |
|
| 8 |
|
| 9 | #### The de-facto solution to flexible routing in angular
|
| 10 | ---
|
| 11 | **[Tutorials](https://ui-router.github.io/tutorials/)** |
|
| 12 | **[API Docs](https://ui-router.github.io/docs/latest/)** |
|
| 13 | **[Download stable](http://unpkg.com/@uirouter/angularjs@latest/release/angular-ui-router.js)** (or **[Minified](http://unpkg.com/@uirouter/angularjs@latest/release/angular-ui-router.min.js)**) **|**
|
| 14 | **[Guide](https://ui-router.github.io/guide/) |**
|
| 15 | **[Sample App](http://ui-router.github.io/resources/sampleapp/) |**
|
| 16 | **[FAQ](https://github.com/angular-ui/ui-router/wiki/Frequently-Asked-Questions) |**
|
| 17 | **[Report an Issue](https://github.com/angular-ui/ui-router/blob/master/CONTRIBUTING.md#report-an-issue) |**
|
| 18 | **[Contribute](https://github.com/angular-ui/ui-router/blob/master/CONTRIBUTING.md#contribute) |**
|
| 19 | **[Help!](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) |**
|
| 20 |
|
| 21 | ---
|
| 22 |
|
| 23 | Angular UI-Router is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application)
|
| 24 | routing framework for [AngularJS](http://angularjs.org).
|
| 25 |
|
| 26 | Routing frameworks for SPAs update the browser's URL as the user navigates through the app. Conversely, this allows
|
| 27 | changes to the browser's URL to drive navigation through the app, thus allowing the user to create a bookmark to a
|
| 28 | location deep within the SPA.
|
| 29 |
|
| 30 | UI-Router applications are modeled as a hierarchical tree of states. UI-Router provides a
|
| 31 | [*state machine*](https://en.wikipedia.org/wiki/Finite-state_machine) to manage the transitions between those
|
| 32 | application states in a transaction-like manner.
|
| 33 |
|
| 34 | ## Get Started
|
| 35 |
|
| 36 |
|
| 37 | - [UI-Router for Angular 1](https://ui-router.github.io/ng1)
|
| 38 | - [UI-Router for Angular 2](https://ui-router.github.io/ng2)
|
| 39 | - [UI-Router for React](https://ui-router.github.io/react)
|
| 40 |
|
| 41 | ## Resources
|
| 42 |
|
| 43 | * [In-Depth Guide](https://github.com/angular-ui/ui-router/wiki)
|
| 44 | * [Slides comparing ngRoute to ui-router](http://slid.es/timkindberg/ui-router#/)
|
| 45 | * [UI-Router Extras / Addons for legacy (0.x)](http://christopherthielen.github.io/ui-router-extras/#/home) (@christopherthielen)
|
| 46 |
|
| 47 | ### Videos
|
| 48 |
|
| 49 | * [Introduction Video](https://egghead.io/lessons/angularjs-introduction-ui-router) (egghead.io)
|
| 50 | * [Tim Kindberg on Angular UI-Router](https://www.youtube.com/watch?v=lBqiZSemrqg)
|
| 51 | * [Activating States](https://egghead.io/lessons/angularjs-ui-router-activating-states) (egghead.io)
|
| 52 | * [Learn Angular.js using UI-Router](http://youtu.be/QETUuZ27N0w) (LearnCode.academy)
|
| 53 |
|
| 54 | ## Reporting issues and Contributing
|
| 55 |
|
| 56 | Please read our [Contributor guidelines](CONTRIBUTING.md) before reporting an issue or creating a pull request.
|