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
• Upgrading from 0.3.x to 0.4.x

Getting started

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

yarn add @uirouter/react

Import UIRouter into your project, define some states and you're good to go!

import React from 'react';
import ReactDOM from 'react-dom';
import {UIRouter, UIView, pushStateLocationPlugin} from '@uirouter/react';
import Home from './components/Home';

// define your states
const states = [{
  name: 'home',
  url: '/home',
  component: Home
}];

// select your plugins
const plugins = [
  pushStateLocationPlugin
];

ReactDOM.render(
  <UIRouter plugins={plugins} states={states}>
    <UIView/>
  </UIRouter>,
  document.getElementById('root')
);

0.5.0 (2017-05-24)

Bug Fixes

• UIRouter: Apply config before registering states (75f169a)
• rollup: Allow rollup to process 'import * as classNames' (8434883), closes #33

Features

• export everything from core alongside the react stuff (6d0b49b), closes #41
• UIView: add render prop API (1047b84), closes #35 #26 #13

BREAKING CHANGES

• UIView: Rename Resolves interface to UIViewResolves for consistency.
• UIView: Rename InjectedProps interface to UIViewResolves for consistency.

@uirouter/core changes

5.0.3 (2017-05-24)

Bug Fixes

• BrowserLocationConfig: fixed protocol + port value (#38) (5559382)
• TransitionHook: Transition hooks no longer expose the internal StateObject (2b0e48b)
• common: Fix implementation of 'pick' -- use hasOwnProperty (09848a4)
• common: Re-fix implementation of 'pick' using for .. in (f2da7f4)
• lazyLoad: Allow lazyLoad stateBuilder: Get lazyLoad fn from internal State object, not StateDeclaration (9313880)
• lazyLoad: Wait for future state to be replaced before registering lazy children (4bdce47)
• noImplicitAny: Fix noimplicitany compliance (1a6cdfc)
• pushStateLocation: call listeners in url() (#24) (7c90911), closes #23
• redirect: Do not update URL after redirect with { location: false } (652a760)
• resolve: Allow resolve's state context to be injected as $state$ (a06948b)
• tfs: Rename $q.ts and $injector.ts files, removing leading dollar signs (cb653ee)
• trace: Re-add transitionStart trace (b019036)
• transition: Do not ignore transitions which have states being entered or exited (175717e)
• transitionHook: Do not process transition hooks after router has been disposed. (666c6d7)
• typings: Allow strictNullChecks for HookMatchCriteria (d92d4d5)
• ui-sref: Improve performance of generating hrefs (c3967bd)
• view: Do not throw when uiView doesn't have a state context (f76ee2a)
• view: Update views in order of ui-view depth and also by state depth (46dea2b)

Features

• Globals: implement Disposable and delete global transition data (a794018)
• Rejection: Add $id to ease debugging of transition rejections (d456d54)
• State: Support registration of ES6 state classes (as opposed to object literals) (3a5d055)
• State: Switch Internal State Object to prototypally inherit from the State Declaration (027c995), closes #34
• StateObject: Rename internal State object to StateObject (feceaf9)
• StateRegistry: improve perf for: .register() and StateMatcher.find() misses (fdb3ab9)
• Transition: Normalize all transition errors to a Rejection. (a7464bb)
• Transition: deprecate Transition.is() which was never implemented (1edff4b)
• UIRouter: Add trace global to the UIRouter object (48c5af6)
• UrlService: (UrlRouter) improve perf of registering Url Rules and sorting Url Rules (64fbfff)
• UrlService: Add rules.initial("/home") to config initial state (like otherwise) (bbe4209)
• View: Allow targeting views on own state using viewname@. (normalizeUIViewTarget) (7078216), closes #25
• abort: Add API to manually abort/cancel a transition (39f8a53)
• build: Build and distribute UMD bundles (0a8da85)
• common: Perf improvements in hot functions: (4193244)
• core: Export all vanilla.* code from ui-router-core (f3392d1)
• core: Switch to @uirouter/core npm module (e3f389f)
• decorators: Add state, resolve and resolve data decorators (642df0b)
• defaultErrorHandler: Do not invoke default error handler for ABORTED transitions (b07a24b)
• globals: Removed UIRouterGlobals interface. Renamed Globals class to UIRouterGlobals (8719334)
• onBefore: Run onBefore hooks asynchronously. (30b82aa)
• onEnter/Exit/Retain: Use onExit/onEnter/onRetain from 56955state(), not state.self (bc1f554)
• transition: Ignore duplicate transitions (double clicks) (bd1bd0b)
• transition: Improve supersede logic: Do not supersede if the new trans is aborted before onStart (3141a8f)
• transition: Run hooks synchronously in current stack, when possible (953e618)

BREAKING CHANGES

TransitionHook: Transition hooks no longer expose the internal State object (now named StateObject)

Before:

import { State } from "ui-router-core";
const match = { to: (state: State) => state.data.auth };
transitionsvc.onEnter(match, (trans: Transition, state: State) => {
  // state is the internal State object
  if (state.includes["foo"]) { // internal ui-router API
    return false;
  }
}

Now:

import { StateDeclaration } from "@uirouter/react";
const match = { to: (state: StateDeclaration) => state.data.auth };
transitionsvc.onEnter(match, (trans: Transition, state: StateDeclaration) => {
  // state === the state object you registered
  // Access internal ui-router API using $$state()
  if (state.$$state().includes["foo"]) {
    return false;
  }
}

Motivation:

The State object (now named StateObject) is an internal API and should not be exposed via any public APIs. If you depend on the internal APIs, you can still access the internal object by calling state.$$state().

StateObject: Renamed internal API State object to StateObject

Before:

import {State} from "ui-router-core";

Now:

import {StateObject} from "@uirouter/react";

Motivation:

We'd like to use the State name/symbol as a public API. It will be an ES7/TS decorator for ES6/TS state definition classes, i.e:

@State("foo")
export class FooState implements StateDeclaration {
  url = "/foo";
  component = FooComponent;

  @Resolve({ deps: [FooService] })
  fooData(fooService) {
    return fooService.getFoos();
  }
}

Transition: All Transition errors are now wrapped in a Rejection object.

Before:

Previously, if a transition hook returned a rejected promise:

.onStart({}, () => Promise.reject('reject transition'));

In onError or transtion.promise.catch(), the raw rejection was returned:

.onError({}, (trans, err) => err === 'reject transition')

Now:

Now, the error is wrapped in a Rejection object.

• The detail (thrown error or rejected value) is still available as .detail.

.onError({}, (trans, err) =>
    err instanceof Rejection && err.detail === 'reject transition')

• The Rejection object indicates the .type of transition rejection (ABORTED, ERROR, SUPERSEDED and/or redirection).

  .onError({}, (trans, err) => {
  err.type === RejectType.ABORTED === 3
  });

Motivation:

Errors thrown from a hook and rejection values returned from a hook can now be processed in the same way.

onBefore: onBefore hooks are now run asynchronously like all the other hooks.

Old behavior

Previously, the onBefore hooks were run in the same stackframe as transitionTo. If they threw an error, it could be caught using try/catch.

transitionService.onBefore({ to: 'foo' }), () => { throw new Error('doh'); });
try {
  stateService.go('foo');
} catch (error) {
  // handle error
}

New behavior

Now, onBefore hooks are processed asynchronously. To handle errors, use any of the async error handling paradigms:

• Chain off the promise

  transitionService.onBefore({ to: 'foo' }), () => { throw new Error('doh'); });
  stateService.go('foo').catch(error => { //handle error });

• Define an error handler

  transitionService.onBefore({ to: 'foo' }), () => { throw new Error('doh'); });
  transitionService.onError({ to: 'foo' }), () => { // handle error });
  stateService.go('foo');

• Use the global defaultErrorHandler

  transitionService.onBefore({ to: 'foo' }), () => { throw new Error('doh'); });
  stateService.go('foo');
  stateService.defaultErrorHandler(error => { // global error handler });

Motivation

Why introduce a BC?

• No subtle behavior differences by hook type
• Simpler code and mental model
• Fewer edge cases to account for

defaultErrorHandler: ABORTED transitions do not invoke the defaultErrorHandler

Returning false from a transition hook will abort the transition.

Old behavior

Previously, this case was considered an error and was logged by defaultErrorHandler. After your feedback, we agree that this is not typically an error.

New behavior

Now, aborted transitions do not trigger the defaultErrorHandler

Motivation

Most users do not consider ABORT to be an error. The default error handler should match this assumption.

0.4.0 (2017-01-10)

Version 0.4.0 is based on ui-router-ore 3.1.0 and as such introduced a lot of new features/fixes alongside some breaking changes.

[full ui-router-core 3.0.0 changelog]

Breaking Changes

• html5Mode(): deprecated in favor of pushStateLocationPlugin.

Changed

• ui-router-core: Updated to version 3.1.0 (91661b1).

Add

• UIRouter: Add new UIRouter component for handling router instance and declarative bootstrapping (9b59d68).

Take a look at the guide for upgrading from 0.3.0 to 0.4.0

0.3.0 (2016-09-19)

Breaking Changes

1) State Glob patterns have been changed slightly.

Previously, a single wildcard `foo.*` could match "missing segments" on the end of a state name.
For example, `foo.*` would match the state `foo`.
Likewise, `foo.*.*.*` would also match the `foo` state.

Now, a single wildcard matches exactly one segment. 
`foo.*` will match `foo.bar` and `foo.baz`, but neither `foo` nor `foo.bar.baz`.

If you previously relied on the single wildcard to match missing segments, use a double wildcard, `foo.**`.

Double wildcards match 0 or more segments.

[Read more about Glob matching](https://ui-router.github.io/docs/latest/classes/common.glob.html)

2) (obscure) Renamed Transition.previous() to Transition.redirectedFrom() 3) (obscure) Location provider: remove url(url) and replace() in favor of setUrl(url, replace).

[full ui-router-core 1.0.0-beta.2 changelog].

Changed

• ui-router-core: Updated to version 1.0.0-beta.2 (9ad732e)
• UMD: The UMD build is exported as window.UIRouterReact instead of window.ui-router-react. (68ebd4c)

Fix

• uiCanExit: Remove uiCanExit hook setTimeout wrapper that prevents hook from being called when state is entered and exited synchronously (82bad02).
• UISref:
  • Fix right-click / meta+click behaviour (open in a new tab) on UISref tags (9a45de1).
  • Add call to deregister function when component is unmounted (0740825).
• UISrefActive: Fix state info deregister function (b6c93b5).
• UMD: The UMD build now looks react as window.React instead of window.react. (68ebd4c)

0.2.3 (2016-08-23)

Added

• UIView: Pass down to rendered element/component className and style props (if defined) (52e4132).

0.2.2 (2016-08-03)

Fix

• UISrefActive: register stateChange callback for proper rendering (634e9d1)
• UISref: doesn't need to be nested inside a UIView in order to work (3c00270)

0.2.0 (2016-08-02)

Changed

• Module default export is now the UIRouterReact class. It takes now care of setting up the viewConfigFactory and reactViewBuilder so user doesn't need to.
• Renamed all symbols to UI* from Ui* for consistency with ui-router-core.
• UISref only accepts a single valid element as child.
• UISrefActive properly track multiple descendants UISref component and track their specified states for applying the active class.

Added

• UISref and UISrefActive properly copy over all props and class names of thir children, adding more flexibility for the user.
• UIView rendered component exposes two props from the router: resolves and transition. They act as an injected dependecy of the state-component, and are used to interact with the router itself.
• UIView registers as onBefore hook the uiCanExit method of the component instance it renders.
• UISrefActive: by passing a extact={true} props it will only activate when the exact target state used in the UISref is active.
• html5Mode added to UIRouterReact class for using pushStateLocation instead of hashLocation as history strategy (WARNING: This is a temporary api and will likely change in the future)

0.1.2 (2016-07-18)

Fix

• Removed file extension preventing compiled code to work properly.

0.1.1 (2016-07-18)

Added

• Typings are specified by typings.json file and must be installed using typings CLI.
• Added es6-shim for Promises.

0.1.0 (2016-07-14)

First Release

• First alpha release of ui-router-react