UI-Router-React

UI-Router provides extremely flexible, state based routing to the React ecosystem.

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.

Docs & Resources

• Tutorials and Docs
• UI-Router website
• Changelog

Getting started

The UI-Router package is distributed using npm, the node package manager.

npm install --save ui-router-react

Import the UIRouterReact into your project, create a new instance and start the router!

import React from 'react';
import ReactDOM from 'react-dom';
import UIRouterReact, {UIView} from 'ui-router-react';
import Home from './components/Home';

// Create a new instance of the Router
const router = new UIRouterReact();

// Register state
router.stateRegistry.register({
	name: 'home',
	url: '/home',
	component: Home
});

// Setup html5Mode: There are two configuration modes which control the format
// of the URL in the browser address bar: hashLocation mode (the default)
// and the HTML5 mode which is based on using the HTML5 History API.
// WARNING: this is a temporary API and will likely change in the future versions!
router.html5Mode(true);

// Start the router
router.start();


ReactDOM.render(
	<UIView/>,
	document.getElementById('root')
);