ui-router README

The project's README from github.com/angular-ui/ui-router. As one markdown file: README.md.

AngularUI Router  Build Status

Note: this is the Angular 1.x source for UI-Router version 1.x. If you are looking for the source for UI-Router version 0.x, it can be found here


The de-facto solution to flexible routing in angular


Tutorials | API Docs | Download stable (or Minified) | Guide | Sample App | FAQ | 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 navigates 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.

Get Started

Resources

Videos

Reporting issues and Contributing

Please read our Contributor guidelines before reporting an issue or creating a pull request.

ui-router (angular-ui/ui-router)

Searching Database…

13.4K ·GitHub
What is this?UI-Router is a client-side routing framework for Single Page Applications, originally built for AngularJS, that models an app as a hierarchical tree of states instead of flat URL-to-view mappings.
Is it a replacement for Angular's built-in router, or something else?Yes, it's an alternative routing framework: instead of mapping URLs directly to views, it uses a state machine where states can be nested, and each state manages its own view, data, and transitions.
How do I add it to my project?Grab the stable build (or minified version) and follow the framework-specific getting-started guide, since there are separate packages for Angular 1, Angular 2+, and React.
Does this work with modern Angular, or only AngularJS?There are separate editions: this repo is the Angular 1.x (AngularJS) source, with distinct versions/packages available for Angular 2+ and for React.
Is this still actively evolving, or mostly legacy at this point?The README points to an older 0.x legacy line with its own 'Extras/Addons' package, suggesting long-standing versioning history; it's a mature, long-running project rather than a fast-moving new tool.
Why use nested states instead of plain routes?Nested states let each level of the UI (e.g. a layout, a tab, a sub-tab) own its own view, data, and URL segment, so navigating deep into the app updates only the relevant nested views instead of re-rendering everything.
Can I bookmark a deep location inside the app?Yes, because state transitions drive the browser URL (and vice versa), users can bookmark or share a link to any specific state deep within the single-page app.
Creator
angular-ui
Size
13.1 MB
Stars
13.4K
Age
13y
Commits · 90 Days