| 1 | # [UI Router for Angular 1](https://ui-router.github.io/ng1/docs/latest)
|
| 2 |
|
| 3 | #### The de-facto solution to flexible routing in angular 1
|
| 4 |
|
| 5 | <div style="display: flex;">
|
| 6 |
|
| 7 | <iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=angular-ui&repo=ui-router&type=fork&count=true&size=medium" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
|
| 8 | <iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=angular-ui&repo=ui-router&type=star&count=true&size=medium" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
|
| 9 | [](https://travis-ci.org/angular-ui/ui-router)
|
| 10 |
|
| 11 | </div>
|
| 12 |
|
| 13 |
|
| 14 | Angular UI-Router is a client-side [Single Page Application](https://en.wikipedia.org/wiki/Single-page_application)
|
| 15 | routing framework for [AngularJS](http://angularjs.org).
|
| 16 |
|
| 17 | **[View on Github](http://github.com/angular-ui/ui-router) |**
|
| 18 | **[Tutorials](https://ui-router.github.io/ng1/tutorials/)** |
|
| 19 | **[Guides](https://ui-router.github.io/guide) |**
|
| 20 | **[Sample App](http://ui-router.github.io/resources/sampleapp/) |**
|
| 21 | **[Wiki](https://github.com/angular-ui/ui-router/wiki) |**
|
| 22 | **[FAQ](https://github.com/angular-ui/ui-router/wiki/Frequently-Asked-Questions)**
|
| 23 |
|
| 24 | #### API Documentation Organization
|
| 25 |
|
| 26 | The documentation is arranged according to API concern, such as `url`, `resolve`, and `core`.
|
| 27 | For a list of services and objects that can be injectable, see the [`injectables` section](./injectables.html).
|
| 28 |
|
| 29 | By default, only the public UI-Router API is shown.
|
| 30 | To view both public API and the internal APIs, check the "Internal UI-Router API" checkbox.
|
| 31 |
|
| 32 | #### Typescript
|
| 33 |
|
| 34 | UI-Router is written in Typescript.
|
| 35 | The API documentation is generated using [TypeDoc](https://github.com/TypeStrong/typedoc).
|
| 36 | The documentation reflects the Typescript classes, interfaces, and parameter types information embedded in the source code.
|
| 37 |
|
| 38 | #### Contributing
|
| 39 |
|
| 40 | Angular UI-Router depends on the framework agnostic `@uirouter/core`.
|
| 41 | To contribute to the documentation, please submit a PR to either
|
| 42 | [@uirouter/angularjs](http://github.com/angular-ui/ui-router)
|
| 43 | or
|
| 44 | [@uirouter/core](http://github.com/ui-router/core).
|
| 45 | To find where a specific piece of documentation is written, follow the links that say:
|
| 46 | > _Defined in ui-router/somedir/somefile.ts_
|
| 47 |
|
| 48 |
|