Skip to content

Latest commit

 

History

History
976 lines (641 loc) · 44.7 KB

CHANGELOG.md

File metadata and controls

976 lines (641 loc) · 44.7 KB
Raw

1.0.3 (2020-04-29)

Compare @uirouter/react versions 1.0.2 and 1.0.3

Bug Fixes

  • examples: update animating-transitions example (3520596)

Features

Updated @uirouter/core from 6.0.4 to 6.0.5

Changelog for @uirouter/core:

Compare @uirouter/core versions 6.0.4 and 6.0.5

Bug Fixes

  • TargetState: make isDef check more thorough (e657cfe)

Features

  • urlRuleFactory: Add support for StateDeclarations in UrlRuleFactory.fromState() (539d33a)

1.0.2 (2020-02-24)

Compare @uirouter/react versions 1.0.1 and 1.0.2

Bug Fixes

  • Only run initialization effect on first render (7788a98)

1.0.1 (2020-02-04)

Compare @uirouter/react versions 1.0.0 and 1.0.1

Bug Fixes

  • Refactor UIView for compatibility with @uirouter/react-hybrid. (55d4c98)
  • Restore UIRouterConsumer and UIViewConsumer context consumer components. (3ed8ce1)
  • uiCanExit: fix uiCanExit logic and use refs so hook de/registration happens outside any render (e73daa7)

Features

  • hooks: Add useCanExit hook to block transitions from exiting a state (29d080c)
  • hooks: export useParentView for use in uirouter/react-hybrid (b5a2e80)

BREAKING CHANGES

  • UIRouterConsumer now is of type import { UIRouter } from '@uirouter/core' instead of import { UIRouterReact } from '@uirouter/react'

Updated @uirouter/core from 6.0.1 to 6.0.4

Changelog for @uirouter/core:

Compare @uirouter/core versions 6.0.1 and 6.0.4

Bug Fixes

  • hof: Rewrite curry from scratch (fc324c6), closes #350
  • IE9: Add safeConsole so IE9 doesn't break (9c8579d)
  • safeConsole: check if document is defined to avoid issues in node environments (da29d88)

Features

  • stateService: add transition option 'supercede' so transition can be ignored if one is pending (6e5a56f)

1.0.0 (2020-01-07)

Compare @uirouter/react versions 0.8.10 and 1.0.0

This is a long overdue release of UI-Router for React version 1.0. This release adds a react hooks API.

Bug Fixes

  • errors: Always throw a new Error() so stacktraces are usable (26f6989)
  • typescript: Type onClick as MouseEventHandler. (7512f14)
  • UISrefActive: Avoid reusing the same array reference during setState() call (b9064cd)

Features

Add hooks:

useRouter

function GoHome() {
  const { stateService } = useRouter();
  return <button onClick={() => stateService.go('home')}>Home</a>
}

useSref

function LinkHome() {
  const sref = useSref('home')
  return <a {...sref}>Home</a>
}

<a href="/home" onClick=...>Home</a>

useSrefActive and uiSrefActiveExact

function LinkHome() {
  const sref = useSrefActive('home', {}, 'active')
  return <a {...sref}>Home</a>
}

<a href="/home" onClick=... className="active">Home</a>

useTransitionHook

function CanExit() {
  const isDirty = useIsFormDirty();
  useTransitionHook("onBefore", { exiting: 'forms' }, () => isDirty ? false : true)
}

useCurrentStateAndParams

function CurrentState() {
  const { state, params } = useCurrentStateAndParams();
  return <div>{state.name} {JSON.stringify(params)}</div>
}

useOnStateChanged

This is a callback style hook that useCurrentStateAndParams and isActive is built on top of, used to avoid excessive renders in isActive

function CurrentState() {
  const [stateName, setStateName] = useState();
  useOnStateChanged((state, params) => setStateName(state.name));
  return <div>{stateName}</div>
}

useIsActive

function CurrentState() {
  const isHomeActive = useIsActive('home');
  return <div>{isHomeActive ? 'You are home!' : 'try to find your way back'}</div>
}

0.8.10 (2019-10-10)

Compare @uirouter/react versions 0.8.9 and 0.8.10

Bug Fixes

  • travis: use service: xvfb instead of launching it manually. install libgconf debian package (07e6fb6)

Features

  • package: fixes to support React.StrictMode (#512) (cd8777a)

Updated @uirouter/core from 5.0.23 to 6.0.1

Changelog for @uirouter/core:

Compare @uirouter/core versions 5.0.23 and 6.0.1

Bug Fixes

  • resolve: remove unnecessary generics from CustomAsyncPolicy (#452) (61f4ee9)
  • travis: use service: xvfb instead of launching it manually (1271fcd)
  • travis: use service: xvfb instead of launching it manually. install libgconf debian package (ac1ef4b)

Features

  • resolve: Remove RXWAIT async policy in favour of allowing user defined async policy function (#366) (0ad87f6)

BREAKING CHANGES

  • resolve: RXWAIT async policy has been removed, but it never worked in the first place

0.8.9 (2019-01-29)

Compare @uirouter/react versions 0.8.8 and 0.8.9

Updated @uirouter/core from 5.0.22 to 5.0.23

Compare @uirouter/core versions 5.0.22 and 5.0.23

Bug Fixes

  • test_downstream_projects: don't double build core while testing downstreams (148b16b)
  • typescript: Fix typing of onChange callback in UrlService (961ed0f), closes #229
  • typescript: Mark params as optional in StateService.href (614bfb4), closes #287
  • vanilla: Fix baseHref parsing with chrome-extension:// urls (f11be4d), closes #304

0.8.8 (2019-01-10)

Compare @uirouter/react versions 0.8.7 and 0.8.8

Updated @uirouter/core from 5.0.21 to 5.0.22

Compare @uirouter/core versions 5.0.21 and 5.0.22

Bug Fixes

Features

  • TransitionHook: Pass in transition to HookMatchCriteria (#255) (926705e)

0.8.7 (2018-08-11)

Compare @uirouter/react versions 0.8.5 and 0.8.7

Updated @uirouter/core from 5.0.20 to 5.0.21

Compare @uirouter/core versions 5.0.20 and 5.0.21

Bug Fixes

  • dynamic: Use 'find' from common.ts instead of Array.prototype.find (66a3244), closes #215
  • url: When using html5Mode and no tag is present, default to '/' (23742e3), closes #223

0.8.5 (2018-08-09)

Compare @uirouter/react versions 0.8.4 and 0.8.5

Features

  • UISref: Call child element's onClick prop first, if it exists (095a90d), closes #240

0.8.4 (2018-08-07)

Compare @uirouter/react versions 0.8.3 and 0.8.4

Bug Fixes

  • uiview: Fix uiCanExit when routing to a React.forwardRef() (cf5c668)

Features

  • UISrefActive: pass down className (fbb8152)
  • UISrefActive: support for nested UISrefActive (49e32e6)

0.8.3 (2018-07-20)

Compare @uirouter/react versions 0.8.2 and 0.8.3

Updated @uirouter/core from 5.0.19 to 5.0.20

Compare @uirouter/core versions 5.0.19 and 5.0.20

Bug Fixes

  • params: When creating an array parameter from a custom type, copy the raw property (b6dd738), closes #178

Features

  • dynamic: Support dynamic flag on a state declaration (3cd5a2a)
  • transition: Added transition.paramsChanged() to get added/deleted/changed parameter values for a transition (10b7fde)
  • view: Add _pluginapi._registeredUIView() to get a ui-view by id (6533b51)

0.8.2 (2018-05-25)

Compare @uirouter/react versions 0.8.1 and 0.8.2

Bug Fixes

  • enzyme: fix enzyme patch leaving a file called '-' (4c2157c)

Features

  • internal: Change UIView from arrow to Component Class (ce2bc1e)

0.8.1 (2018-05-25)

Compare @uirouter/react versions 0.8.0 and 0.8.1

Features

  • internal: exposed the internal View component for use by @uirouter/react-hybrid (9c07226)

0.8.0 (2018-05-19)

Compare @uirouter/react versions 0.7.0 and 0.8.0

Bug Fixes

  • UISref/UISrefActive: make proptypes non-required: parentUIView, addStateInfoToParentActive (c7aa299), closes #173

Features

  • UIView: force component re-mount on reload() (d01162a), closes #172

BREAKING CHANGES

  • UIView: when a state is entered/exited the State Component is remounted, re-running its lifecycle methods.

Updated @uirouter/core from 5.0.18 to 5.0.19

Compare @uirouter/core versions 5.0.18 and 5.0.19

Bug Fixes

0.7.0 (2018-05-05)

Compare @uirouter/react versions 0.6.2 and 0.7.0

Bug Fixes

  • package: update prop-types to version 15.6.1 (1d0ee26)

Features

  • use new React 16.3 context API (580700f), closes #54
  • react: update minimum react version supported (4acb7a7)

BREAKING CHANGES

  • react: from version 0.7.0 @uirouter/react only supports react from version 16.3.x because of the new Context API. If you need to use it with previous versions of React you should check the 0.6.x, but bear in mind that it’s no longer supported and it’s advised to update React instead.
  • @uirouter/react now uses the new React 16.3 Context API. If you were accessing the router instance via the legacy context api (which was never explecitly supported) you need to update your code accordingly:

before:

class SomeComponent extends React.Component {
  static contextTypes = {
    router: PropTypes.object
  }

  render () {
    // access context via this.context
    const router = this.context.router;
    // do whatever needed with the router
  }
}

after:

class SomeComponent extends React.Component {
  render () {
    // access router via props
    const router = this.props.router;
    // do whatever needed with the router
  }
}

// when rendering the component wrap it with the `<UIRouterConsumer>` component
<UIRouterConsumer>
  {router => <SomeComponent router={router} />}
</UIRouterConsumer>

Updated @uirouter/core from 5.0.17 to 5.0.18

Compare @uirouter/core versions 5.0.17 and 5.0.18

Bug Fixes

  • angular: A hack to force the Angular compiler to import from module index (d56a2be)
  • StateRegistry: Notify listeners of added states when there are orphans in the state queue (5a9bac9)
  • transition: Fix typing of Transition.params() (ebea30e)
  • transition: Normalize error() to always return Rejection (9bcc5db)

0.6.3 (2018-05-03)

Compare @uirouter/react versions 0.6.2 and 0.6.3

Bug Fixes

  • package: update prop-types to version 15.6.1 (1d0ee26)

Features

  • use new React 16.3 context API (580700f), closes #54
  • react: update minimum react version supported (4acb7a7)

BREAKING CHANGES

  • react: from version 0.7.0 @uirouter/react only supports react from version 16.3.x because of the new Context API. If you need to use it with previous versions of React you should check the 0.6.x, but bear in mind that it’s no longer supported and it’s advised to update React instead.
  • @uirouter/react now uses the new React 16.3 Context API. If you were accessing the router instance via the legacy context api (which was never explecitly supported) you need to update your code accordingly:

before:

class SomeComponent extends React.Component {
  static contextTypes = {
    router: PropTypes.object
  }

  render () {
    // access context via this.context
    const router = this.context.router;
    // do whatever needed with the router
  }
}

after:

class SomeComponent extends React.Component {
  render () {
    // access router via props
    const router = this.props.router;
    // do whatever needed with the router
  }
}

// when rendering the component wrap it with the `<UIRouterConsumer>` component
<UIRouterConsumer>
  {router => <SomeComponent router={router} />}
</UIRouterConsumer>

Updated @uirouter/core from 5.0.17 to 5.0.18

Compare @uirouter/core versions 5.0.17 and 5.0.18

Bug Fixes

  • angular: A hack to force the Angular compiler to import from module index (d56a2be)
  • StateRegistry: Notify listeners of added states when there are orphans in the state queue (5a9bac9)
  • transition: Fix typing of Transition.params() (ebea30e)
  • transition: Normalize error() to always return Rejection (9bcc5db)

0.6.2 (2018-02-12)

Compare @uirouter/react versions 0.6.1 and 0.6.2

Bug Fixes

  • package: update @uirouter/core to version 5.0.17 (b0109ee)
  • UIView: Do not reload view if the new viewConfig is identical to the old one (07a03bf)
  • UIView: Pass style prop through even if no className is specified (cc3d80d)
  • UIView: Provide only resolve props that should be accessible to each view (a4ee9e9)

Updated @uirouter/core from 5.0.16 to 5.0.17

Compare @uirouter/core versions 5.0.16 and 5.0.17

Bug Fixes

  • core: Fix leak of old transitions by mutating pathnode*.resolvables*.data (0a1f518)

0.6.1 (2018-01-31)

Compare @uirouter/react versions 0.6.0 and 0.6.1

Updated @uirouter/core from 5.0.15 to 5.0.16

Compare @uirouter/core versions 5.0.15 and 5.0.16

Bug Fixes

  • common: Fix signature of for objects (make target optional) (61d0afc)

0.6.0 (2018-01-30)

Compare @uirouter/react versions 0.5.5 and 0.6.0

Bug Fixes

Features

  • UIView: resolves are now injected as root props (ff67239)
  • UIView: warn user when using transition as resolve token (10b247b)

BREAKING CHANGES

  • UIView: Previously resolves were accessible as properties of a resolves props injected in the routed component. They are now each injected as a prop. This way components don't need to be aware of the router and can be more reusable.

before:

render () {
  const { foo } = this.props.resolves;
  return <div>{foo}</div>;
}

after:

render () {
  const { foo } = this.props;
  return <div>{foo}</div>
}

Updated @uirouter/core from 5.0.11 to 5.0.15

Compare @uirouter/core versions 5.0.11 and 5.0.15

Bug Fixes

  • browserLocation: Use location.pathname (not href) or '/' when no base tag found (db461d6)
  • browserLocationConfig: If no base href found, use location.href (not empty string) (0251424)
  • core: Fix memory leak of resolve data from ALL transitions ever (7f2aed1)
  • pathNode: add backwards compat for PathNode.clone(). Add retainedWithToParams to treeChanges interface. (4833a32)
  • pushStateLocation: Fix URLs: add slash between base and path when necessary (bfa5755)
  • pushStateLocation: When url is "" or "/", use baseHref for pushState (042a950)
  • resolve: Add onFinish hook to resolve any dynamicly added resolvables (7d1ca54)
  • trace: Fix null reference in uiview name sort function (59cb067)
  • treeChanges: apply toParams to 'retained' path (#72) (cf63d11)
  • urlRouter: Update query params when resetting url via .update() (7664cd0)

Features

  • common: Add map-in-place support to map() (12bc7d8)
  • common: Add onEvict() callback registry for queues with max length (c19d007)
  • view: Add onSync callback API to plugin API (9544ae5)

0.5.5 (2017-12-09)

Compare @uirouter/react versions 0.5.4 and 0.5.5

Bug Fixes

  • UIView: apply exit hook only on class components (660e317), closes #71

Features

  • move prop-types from peerDependencies to dependecies (5c6b2dd), closes #70
  • UIRouterReact: throw if start is called more than once (d48c9fb), closes #65

0.5.4 (2017-10-17)

Compare @uirouter/react versions 0.5.3 and 0.5.4

Updated @uirouter/core from 5.0.10 to 5.0.11

Compare @uirouter/core versions 5.0.10 and 5.0.11

Bug Fixes

  • ie9: make console.bind work in ie9 (#85) (318214b)

0.5.3 (2017-10-07)

Compare @uirouter/react versions 0.5.2 and 0.5.3

Updates @uirouter/core from 5.0.7 to 5.0.10 (2017-10-07)

Compare @uirouter/core versions 5.0.7 and 5.0.10

Bug Fixes

  • angular/cli: Use package.json fields: 'typings', 'main', 'jsnext:main' (74143d9)
  • bundle: Rollup: Do not warn on THIS_IS_UNDEFINED (a4581b1)
  • isomorphic: Remove use of CustomEvent. Detect root scope (global/window/self) for nodejs, browser, or web-worker. (2d206ba)
  • redirectTo: Fix typings for redirectTo. Allow a function that returns a target state or a promise for one. (3904487)
  • typings: Use StateObject for parameter to hook criteria functions (5b58566)

Features

  • TargetState: Add builder methods .withState, .withParams, and .withOptions (6b93142)
  • TransitionHook: Add hook registration option invokeLimit to limit the number of times a hook is invoked before being auto-deregistered. (2cb17ef)

@uirouter/react 0.5.2 (2017-09-23)

Compare @uirouter/react versions 0.5.1 and 0.5.2

Bug Fixes

  • sourcemaps: Embed sources in sourcemaps (62d84ea)

Changes to @uirouter/core: Compare @uirouter/core versions 5.0.5 and 5.0.7

Bug Fixes

  • globals: Use shallow copy to update the globals.params / $state.params object (e883afc)
  • Injector: When getting tokens from native injector, only throw on undefined (not on falsey values) (ada9ca2)
  • sourceMaps: Embed typescript sources in sourcemaps (10558a3)
  • trace: Fall back to console.log if .table is unavailable (IE) (c8110fc)
  • trace: Support tracing of object-parameters with circular references (2f1ae9a)
  • typescript: Fix strictNullCheck type error (0ae585e)
  • url: Add CustomEvent polyfill for IE (a50db21)
  • urlRouter: Fix absolute 'href' generation by using location.hostname (not location.host) (a28b68a)
  • urlService: Fix priority sorting of URL rules (73a1fe0)
  • vanilla: fix base path handling for vanilla push state (ad61d74)
  • vanilla: Use self instead of window for webworker compat (a4629ee)

0.5.1 (2017-07-03)

This release updates @uirouter/core from 5.0.3 to 5.0.5

Changes in @uirouter/core between versions 5.0.3 and 5.0.5 (2017-07-03)

Bug Fixes

  • future: Allow future states to specify a parent: (828fe1b)
  • typescript: Update to typescript 2.4 (ce1669b)
  • view: only sync views which are of the same name and type (c48da4a)

Features

  • invalidTransition: Better error messaging when param values are invalid (2a15d1a)
  • Resolvable: Add .value(): returns value (WAIT) or promise (NOWAIT) (8769449)
  • trace: Trace view synchronization. Allow trace.enable(...string) (284392d)
  • urlMatcher: add support for multiline urls (5b11ce0)

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

  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