DOCS.md

UI Router for React

State based routing for React

<iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=ui-router&repo=react&type=fork&count=true&size=medium" frameborder="0" scrolling="0" width="110px" height="20px"></iframe> <iframe style="display: inline-block;" src="https://ghbtns.com/github-btn.html?user=ui-router&repo=react&type=star&count=true&size=medium" frameborder="0" scrolling="0" width="110px" height="20px"></iframe> [](https://travis-ci.org/ui-router/react)

UI-Router React is a client-side Single Page Application routing framework for React.

View on Github | View ui-router-core on Github | Tutorials | Guides | Sample App

API Documentation Organization

The documentation is arranged according to API concern, such as components, url, resolve, and core. By default, only the public API is shown. To view both public API and the internal APIs, check the "Internal UI-Router API" checkbox.

Typescript

UI-Router is written in Typescript. The API documentation is generated using TypeDoc. The documentation reflects the Typescript classes, interfaces, and parameter types information embedded in the source code.

Contributing

UI-Router React depends on the framework agnostic ui-router-core. To contribute to the documentation, please submit a PR to either @uirouter/react or @uirouter/core. To find where a specific piece of API documentation is written, follow the links that say:

Defined in ui-router/somedir/somefile.ts