CHANGELOG.md

1.0.0-beta.7 (2017-06-19)

Bug Fixes

• lazyLoad: fixed getting parent injector in angular 4.2 (dcd1cda)
• Ng2LocationServices: Do not fireAfterUpdate when on server. (543afcd)
• UISrefStatus: Fix memory leak -- take only one inner subscription at a time. (#120) (5a65d3c), closes #21

Features

• view: Support shorthand for named views, views: { viewName: Component } (84aec02)

Changes in @uirouter/core from 5.0.0 to 5.0.4

Bug Fixes

• common: Fix implementation of 'pick' -- use hasOwnProperty (09848a4)
• common: Re-fix implementation of 'pick' using for .. in (f2da7f4)
• future: Allow future states to specify a parent: (828fe1b)
• transition: Do not ignore transitions which have states being entered or exited (175717e)
• view: only sync views which are of the same name and type (c48da4a)

Features

• build: Build and distribute UMD bundles (0a8da85)
• 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)

1.0.0-beta.6 (2017-04-28)

Adds supports for Angular 4.x, removes support for Angular 2.x

Bug Fixes

• uiSref: open new tab when a tag has target="_blank" (d13ed47)

Features

• resolve: auto-map resolve values to matching component inputs in AoT (f6c552d)

1.0.0-beta.5 (2017-04-22)

NOTICE: The npm package changed to @uirouter/angular

Bug Fixes

• bindings: Make bindings: work on a state declaration (as well as a view declaration) (a21c479)
• bundle: Only bundle ui-router-ng2 code (do not bundle ui-router-core) (a285218)
• bundle: work around rollup bug rollup/rollup#1322 (89884b9)
• lazyLoad: Supply native injector to lazy loaded states (ebce639)
• Ng2LocationServices: Ignore duplicated 'hashchange' event in favor of 'popstate' event (82a3e2e)
• NgModule: De-dupe states loaded from NgModule (ffe85cb)
• package.json: Fix engines in package.json (b2d828a)
• rxjs: Fix missing RxJS operators in tree-shaked apps (5f03719)
• rxjs: import rxjs operators. (26a74ef)
• uiSref: avoid empty links (#26) (5f6870d)

Features

• bindings: Apply explicit bindings even when no [@Input](https://github.com/Input)() found. (4351c53)
• config: Pass the module object to the module config function (e9705b0)
• Ng2LocationConfig: use BrowserLocationConfig. (7e0aef6)
• uiCanExit: Add uiCanExit hook for routed components (633573e)

Reverts

• ResolveData: Remove @ResolveData decorator (0c8226d)

BREAKING CHANGES

bundle: We no longer bundle the core nor rx code in the UMD bundle.

Previously, the ui-router-ng2 bundle included the code from ui-router-core and ui-router-rx. Now, each UMD bundle must be included separately.

This change is most likely to affect:

• SystemJS projects
• projects that do not bundle (but ship pre-built UMD bundles)
• Users of ui-router plugins that import ui-router-core, such as sticky-states.

@ui-router/core changes

5.0.0 (2017-04-22)

This release of @uirouter/angular updates @uirouter/core from 4.0.0 to 5.0.0. Here are the changes from core:

Bug Fixes

• BrowserLocationConfig: fixed protocol + port value (#38) (5559382)
• lazyLoad: Wait for future state to be replaced before registering lazy children (4bdce47)
• noImplicitAny: Fix noimplicitany compliance (1a6cdfc)
• redirect: Do not update URL after redirect with { location: false } (652a760)
• tfs: Rename $q.ts and $injector.ts files, removing leading dollar signs (cb653ee)
• trace: Re-add transitionStart trace (b019036)
• TransitionHook: Do not process transition hooks after router has been disposed. (666c6d7)
• TransitionHook: Transition hooks no longer expose the internal StateObject (2b0e48b)
• 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

• abort: Add API to manually abort/cancel a transition (39f8a53)
• common: Perf improvements in hot functions: (4193244)
• core: Switch to @uirouter/core npm module (e3f389f)
• defaultErrorHandler: Do not invoke default error handler for ABORTED transitions (b07a24b)
• Globals: implement Disposable and delete global transition data (a794018)
• onBefore: Run onBefore hooks asynchronously. (30b82aa)
• onEnter/Exit/Retain: Use onExit/onEnter/onRetain from StateObject, not state.self (bc1f554)
• Rejection: Add $id to ease debugging of transition rejections (d456d54)
• 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: 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)
• Transition: Normalize all transition errors to a Rejection. (a7464bb)
• 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)

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 "ui-router-core";
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().

BC Likelihood

How likely is this BC to affect me?

Medium: You will likely be affected you 1) have transition hooks, 2) are using typescript and/or 3) use the internal ui-router State API.

BC Severity

How severe is this BC?

Low: Access to the internal api is still available using $$state().

StateObject: Renamed internal API State object to StateObject

Before:

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

Now:

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

Motivation:

We'd like to use the State name/symbol as a public API. Some day (not today) it will likely 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();
  }
}

BC Likelihood

How likely is this to affect me?

Low: This only affects code that imports the internal API symbol State. You will likely be affected you 1) import that symbol, 2) are using typescript and 3) explicitly typed a variable such as let internalStateObject = state.$$state();

BC Severity

How severe is this change?

Low: Find all places where State is imported and rename to StateObject

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.

BC Likelihood

How likely is this to affect me?

Medium: apps which have onError handlers for rejected values

BC Severity

How severe is this change?

Low: Find all error handlers (or .catch/.then chains) that do not understand Rejection. Add err.detail processing.

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

BC Liklihood

How likely is this to affect my app?

Very Low: Apps that registered onBefore hooks and depend on synchronous execution are affected.

BC Severity

How severe is this BC?

Low: Switch to asynchronous handling, such as chaining off the transition promise

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:

Why introduce a BC?

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

BC liklihood

How likely am I to be affected?

Low: Most users do not consider ABORT to be an error. For most users this will not be a BC.

BC severity

How severe is this BC?

Low: Users who want to handle all transition rejections can register a .onError handler and filter/process accordingly.

1.0.0-beta.4 (2017-01-22)

This is a major release of ui-router-ng2 with many new features, including support for the angular-cli. We now support AoT compilation with NgModule lazy loading (via Future States). We also enabled code splitting support from the []@ngtools/webpack project](https://www.npmjs.com/package/@ngtools/webpack).

There are numerous BREAKING CHANGES including those from the ui-router-core dependency. Please read through them carefully.

AoT support + lazy loading + Angular-CLI

Commits eb5d599, 2a4b174, and 8088ef9 enable AoT compilation support and better Lazy Loading support. When @ngtools/webpack is being used, this also enables automatic code splitting + lazy loading.  Because angular-cli uses @ngtools/webpack, this change also enables angular-cli support.

To use these new features, define a Future State (by appending .** to the state name).  Give the state a loadChildren property which points to a nested NgModule that will be lazy loaded.  Use the same syntax that @ngtools/webpack expects: <pathToModule>#<name of export>.

export var futureFooState = {
  name: 'foo.**',
  url: '/foo',
  loadChildren: './foo/foo.module#FooModule'
};

...

  imports: [
    UIRouterModule.forRoot({ states: [ futureFooState  ] }),
...

In your nested module, add a state named foo (without the .**). This nested module's foo state will replace the foo.** Future State (placeholder).

export var fooState = {
  name: 'foo',
  url: '/foo',
  resolve: {
    fooData: fooResolveFn
  },
  onEnter: onEnterFooFn,
  data: {
    requiresAuth: true
  }
};

...

  imports: [
    UIRouterModule.forChild({ states: [ fooState ] }),
...

This change works by providing the same DI token as the @angular/router which is then analyzed for lazy loading by @ngtools/webpack. The ROUTES token is deep imported from @angular/router/src/router_config_loader. The module's states are provided on the ROUTES token, which enables the webpack tooling to analyze the states, looking for loadChildren.

When the UMD bundle is built, the ROUTES token is pulled in from @angular/router (and duplicated), but should not be used by anything.

Because we pull in the token from the @angular/router package, we have a temporary dependency on the angular router.  This is a temporary hack until the @ngtools/webpack project makes itself router-agnostic.

Bug Fixes

• #3087: deep rxjs imports (964c99f)
• build: bump ng2 deps and remove prepublish step (c6628fa)
• lazyLoad: Update lazyLoad for ui-router-core 3.1 (2a4b174)
• loadNgModule: Better error message when lazy loaded NgModule contains no state defs (7d4ac6d)
• location: Do not deep import vanilla.* from ui-router-core (19113ee)
• location: make initial otherwise('/') activate state (perform url sync) (33ae6a8)
• uiSrefActive: Allow ng-if on nested uiSrefs (e3051f5), closes #3046
• params: Fix typed parameters by auto-flushing the param type queue (6241bca), closes #14
• ui-router-rx: Fix ui-router-rx plugin name (a1855ab)

Features

• BC: We no longer ship commonjs in the npm package. We now ship esm+es5 (individual files) and UMD bundles only. (34ea6ad)
• BC: You no longer configure a module using an Injectable UIRouterConfig class. Now you use a function that receives the UIRouter and the Injector (9aae71a)
• UIRouterConfig: Use a simple function to configure module instead of an injectable class (9aae71a)
• AoT: Enable AoT with Lazy Loading. Enable Angular CLI support. (eb5d599)
• build: Generate bundle using rollup instead of webpack (42b0f16)
• bundles: Point package.json main: to the umd bundle. Stop shipping commonjs. (34ea6ad)
• lazyLoad: Allow loadChildren: sugar on a state definition (2a4b174)
• lazyLoad: automatically unwrap default export (__esModule) (allows easier default export of NgModule) (2a4b174)
• lazyLoad: Support passing callback to lazyLoad for loading ng2 module (#3037) (a0688ae)
• UrlService: Add UrlService injectable (33ae6a8), closes #17
• rx: Move reactive extension to its own project at http://github.com/ui-router/rx (b0a672f)

BREAKING CHANGES

BREAKING CHANGE: We no longer ship commonjs in the npm package. We now ship esm+es5 (individual files) and UMD bundles only.

This brings ui-router-ng2 npm package in line with how the core Angular 2 packages are packaged.

We compile and distribute esm+es5 + typescript typings in lib/ (formerly in lib-esm/) We no longer include the commonjs+es5 (formerly in lib/) We now point the main: entry to the UMD bundle for commonjs users.

BREAKING CHANGE: You no longer configure a module using an Injectable UIRouterConfig class. Now you use a function that receives the UIRouter and the Injector

In 1.0.0-beta.3 you might have a config class like this:

export class MyUIRouterConfig {
  constructor(@Inject(UIRouter) router: UIRouter, @Inject(SomeService) myService: SomeService) {
    // do something with router and injected service
  }
}

which was wired into the root module like this:
```js
@NgModule({
  imports: [
    UIRouterModule.forRoot({ configClass: MyUIRouterConfig })
  ]
})
export class AppModule {}

In 1.0.0-beta.4 you should switch to a simple function. The function receives the router: UIRouter and injector: Injector

export function configureModule(router: UIRouter, injector: Injector) {
  // do something with router
  router.urlService.rules.type('slug', slugParamType);
  // inject other services
  const myService: SomeService = injector.get(SomeService);
  // do something injected service
  myService.init();
}

which is now wired using config: configureModule instead of configClass: ...

@NgModule({
  imports: [
    UIRouterModule.forRoot({ configClass: MyUIRouterConfig })
  ]
})
export class AppModule {}

ui-router-core changes

This 1.0.0-beta.4 release of ui-router-ng2 updates ui-router-core from 1.0.0-beta.3 to 4.0.0

4.0.0 (2017-01-22)

Bug Fixes

• lazyLoad: Allow lazyLoad stateBuilder: Get lazyLoad fn from internal State object, not StateDeclaration (9313880)
• lazyLoad: Fix State.lazyLoad type def (9313880)
• lazyLoad: Sync by URL after nested lazy load triggered by URL (1c6220c)
• lazyLoad: Use UrlService.match() to retry url sync after successful lazy load triggered by url (8c2461d), closes #19
• onBefore: Skip remaining hooks after the (#2) (8a45d04)
• param: params: { foo: { raw: true } } overrides ParamType.raw (aefeabf)
• Param: Mark all query parameters as optional (7334d98)
• params: Check for null in int param type is() check (aa551e4), closes #3197
• pushStateLocation: call listeners in url() (#24) (7c90911), closes #23
• redirect: Do not allow onBefore hooks to cause infinite redirect loops (5c5f7eb), closes #6
• redirectTo: Do not puke when redirectTo returns undefined (bde9c0f)
• redirectTo: fix TS type signature of redirectTo (2c059c4)
• resolve: Allow resolve's state context to be injected as $state$ (a06948b)
• StateQueueManager: Compare parsed url parameters using typed parameters (beca1f5)
• StateRegistry: Fix error message: State '' is already defined (f5bd96b)
• StateService: Compare typed parameters in .is() and .includes() (b1a5155)
• TargetState: Narrow name() return type to String (a02f4a7)
• Transition: Use { location: replace } when redirecting a transtition in response to a URL sync (23e2b78)
• typescript: Emit TS 1.8 compatible .d.ts files (65badf4)
• typings: Allow urlRouter.rule to return void (0b78bdf)
• UrlRouter: Use { location: 'replace' } whenever a url redirect happens (6cf9b8f)
• UrlService: Wire urlMatcherFactory and urlRouter functions (a7b58d6)
• vanilla: vanilla locations: do not parse "empty string" query key parameter (f949480)
• view: Load view prerequisites in onFinish (cc85e76)
• view.load: Allow view.load to return synchronously (8619cf9)

Features

• BC: (CoreServices) Move location and locationConfig from services to UIRouter.locationService and UIRouter.locationConfig. (029fb00)
• BC: Built-in string parameter type no longer encodes slashes as ~2F nor tildes as ~~ (72bb2d8)
• BC: Path/Query parameters no longer default to string param type (72bb2d8)
• BC: Hook errors are all normalized to a "Rejection" type. To access the detail of the error thrown (throw "Error 123"), use .detail, i.e.: (f486ced)
• BC: Move html5Mode and hashPrefix from LocationServices to LocationConfig interface (9d316a7)
• BC: move ViewService.viewConfigFactory and rootContext to _pluginapi.* (65badf4)
• BC: Move html5Mode and hashPrefix to LocationServices from LocationConfig (f7ac2bb)
• BC: Order URL Matching Rules by priority, not registration order (eb2f5d7)
• BC: Previously, a state with a lazyLoad function was considered a future state. (ec50da4)
• BC: Remove getResolveValue and getResolvable methods from Transition in favor of injector().get() and injector().getAsync() (111d259)
• BC: Replace LocationServices.setUrl with LocationServices.url (4c39dcb)
• BC: Replace UrlRouterProvider/UrlRouter with just UrlRouter (fddd1e2)
• Create router.dispose() to dispose a router instance and resources. (0690917)
• assertMap: Add a [].map() helper that asserts that each element is truthy (f044f53)
• core: Export all vanilla.* code from ui-router-core (f3392d1)
• futureState: States with a .** name suffix (i.e., foo.**) are considered future states (ec50da4)
• globals: Removed UIRouterGlobals interface. Renamed Globals class to UIRouterGlobals (8719334)
• hash: Change the hash parameter type ('#') to inherit: false so it is cleared out when another transition occurs. (849f84f), closes #3245 #3218 #3017
• HookBuilder: Allow custom hook types (to be defined by a plugin) (3f146e6)
• lazyLoad: Created StateService.lazyLoad method to imperatively lazy load a state (ec50da4), closes #8
• lazyLoad: Exported/exposed the lazyLoadState function (ec50da4)
• lazyLoad: the lazyLoad hook can be used to lazy load anything (component code, etc) (ec50da4), closes #4
• LocationServices: Add a parts() method which returns the URL parts as an object (32e64f0)
• onCreate: Add onCreate transition hook (f486ced)
• Params: Add path and query param types (72bb2d8)
• Params: add option to use generic type for Transition.params (#17) (eb12ec8), closes #16
• Params: Allow inherit: false specified per parameter or type (849f84f)
• Plugin: Allow all plugins to be gotted. (e324973)
• Plugin: Allow registration by ES6 class, JS constructor fn, JS factory fn (b9f4541)
• Plugin: Create plugin API (36a5215), closes #7
• Resolve: implement NOWAIT policy: Do not wait for resolves before completing a transition. (05d4c73), closes #3243 #2691
• State: add .parameters() option for filtering to matching keys (beca1f5)
• Transition: Allow plugins to define own transition events like onEnter (0dc2c19)
• Transition: Add Transition.originalTransition() to return the initial transition in a chain of redirects (4fe39e3)
• Transition: Allow injector() to retrieve resolves for the exiting states/path (df502e8)
• Transition: Allow a plain object ResolvableLiteral in Transition.addResolvable (ad9ae81)
• Transition: Make Transition.params() immutable to avoid confusion about mutability (0162212)
• Transition: Support treechange paths in API for Resolve+transition (beedc82)
• UIRouter: Add trace global to the UIRouter object (48c5af6)
• UrlMatcher: Add comparison function by UrlMatcher specificity (eb2f5d7)
• UrlRouter: sort url rules by specificity, not by registration order. (eb2f5d7)
• UrlService: allow eager or lazy binding of location objects during construction (7e0a8af)
• UrlServices: Add match(): given a URL, return the best matching Url Rule (32e64f0)
• vanilla: Implement in-memory-only location api (f64aace)
• View: Allow targeting views on own state using viewname@. (normalizeUIViewTarget) (7078216), closes #25

BREAKING CHANGES

BREAKING CHANGE: Renamed Globals class to UIRouterGlobals (removed UIRouterGlobals interface)

This change will likely only affect a small subset of typescript users and probably only those using ui-router-ng2. If you're injecting the Globals class somewhere, e.g.:

@Injectable()
class MyService {
  _globals: UIRouterGlobals;
  constructor(globals: Globals) {
    this._globals = <UIRouterGlobals> globals;
  }
}

you should now inject UIRouterGlobals, e.g.:

@Injectable()
class MyService {
  constructor(public globals: UIRouterGlobals) { }
}

Likewise, if you were casting the UIRouter.globals object as a UIRouterGlobals, it is no longer necessary:

function myHook(trans: Transition) {
  let globals: UIRouterGlobals = trans.router.globals; // cast is no longer necessary
}

Closes ui-router/core#31

BREAKING CHANGE: Hook errors are all normalized to a "Rejection" type. To access the detail of the error thrown (throw "Error 123"), use .detail, i.e.:

Before

$state.go('foo').catch(err => { if (err === "Error 123") .. });

New way

$state.go('foo').catch(err => { if (err.detail === "Error 123") .. });

BREAKING CHANGE: Order URL Matching Rules by priority, not registration order

URL Rules can come from registered states' .urls, calling .when(), or calling .rule(). It's possible that two or more URL Rules could match the URL.

Previously

Previously, url rules were matched in the order in which they were registered. The rule which was registered first would handle the URL change.

Now

Now, the URL rules are sorted according to a sort function. More specific rules are preferred over less specific rules

Why

It's possible to have multiple url rules that match a given URL. Consider the following states:

• { name: 'books', url: '/books/index' }''
• { name: 'book', url: '/books/:bookId' }''

Both states match when the url is /books/index. Additionally, you might have some custom url rewrite rules such as:

.when('/books/list', '/books/index').

The book state also matches when the rewrite rule is matched.

Previously, we simply used the first rule that matched. However, now that lazy loading is officially supported, it can be difficult for developers to ensure the rules are registered in the right order.

Instead, we now prioritize url rules by how specific they are. More specific rules are matched earlier than less specific rules. We split the path on /. A static segment (such as index in the example) is more specific than a parameter (such as:bookId).

More Details

The built-in rule sorting function (see UrlRouter.defaultRuleSortFn) sorts rules in this order:

• Explicit priority: .when('/foo', '/bar', { priority: 1 }) (default priority is 0)
• Rule Type:
  • UrlMatchers first (registered states and .when(string, ...))
  • then regular Expressions (.when(regexp, ...))
  • finally, everything else (.rule())
• UrlMatcher specificity: static path segments are more specific than variables (see UrlMatcher.compare)
• Registration order (except for UrlMatcher based rules)

For complete control, a custom sort function can be registered with UrlService.rules.sort(sortFn)

Query params

Because query parameters are optional, they are not considered during sorting. For example, both these rules will match when the url is '/foo/bar':

.when('/foo/bar', doSomething);
.when('/foo/bar?queryparam', doSomethingElse);

To choose the most specific rule, we match both rules, then choose the rule with the "best ratio" of matched optional parameters (see UrlRuleFactory.fromUrlMatcher)

This allows child states to be defined with only query params for a URL. The state only activates when the query parameter is present.

.state('parent', { url: '/parent' });
.state('parent.child', { url: '?queryParam' });

Restoring the previous behavior

For backwards compatibility, register a sort function which sorts by the registration order:

myApp.config(function ($urlServiceProvider) {

  function sortByRegistrationOrder(a, b) {
   return a.$id - b.$id;
  }

  $urlServiceProvider.rules.sort(sortByRegistrationOrder);

});

BREAKING CHANGE: Replace LocationServices.setUrl with LocationServices.url

This makes url() a getter/setter. It also adds the optional state parameter to pass through to the browser history when using pushstate. End users should not notice this change, but plugin authors may.

BREAKING CHANGE: Replace UrlRouterProvider/UrlRouter with just UrlRouter

The configuration functions from the provider object have been integrated into the normal UrlRouter object. The UIRouter object no longer has a uriRouterProvider, but the equivalent functions can be found on uiRouter

One difference between the old functions on urlRouterProvider and the new ones on uriRouter is that new functions do not accept injectable functions.

BREAKING CHANGE: Built-in string parameter type no longer encodes slashes as ~2F nor tildes as ~~

Previously, the string parameter type pre-encoded tilde chars (~) as two tilde chars (~~) and slashes (/) as ~2F.

Now, the string parameter type does not pre-encode slashes nor tildes. If you rely on the previous encoding, create a custom parameter type that implements the behavior:

urlMatcherFactory.type('tildes', {
  encode: (val: any) =>
      val != null ? val.toString().replace(/(~|\/)/g, m => ({ '~': '~~', '/': '~2F' }[m])) : val;
  decode: (val: string) =>
      val != null ? val.toString().replace(/(~~|~2F)/g, m => ({ '~~': '~', '~2F': '/' }[m])) : val;
  pattern: /[^/]*/
});

BREAKING CHANGE: Remove getResolveValue and getResolvable methods from Transition in favor of injector().get() and injector().getAsync()

In beta.3, the Transition APIs: injector(), getResolvable, and getResolveValue duplicated functionality.

Instead of:

trans.getResolveValue('myResolve');

use:

trans.injector().get('myResolve')

BREAKING CHANGE: (CoreServices) Move location and locationConfig from services to UIRouter.locationService and UIRouter.locationConfig.

The core services object is a mutable object which each framework was monkey patching. This change removes the requirement to monkey patch a global mutable object. Instead, framework implementors should pass the LocationServices and LocationConfig implementations into the UIRouter constructor.

End Users

End users who were accessing services.location or services.locationConfig should access these off the UIRouter instance instead.

BREAKING CHANGE: Move html5Mode and hashPrefix from LocationServices to LocationConfig interface

End users should not notice

BREAKING CHANGE: move ViewService.viewConfigFactory and rootContext to _pluginapi.*

This BC happened in commit 6c42285

BREAKING CHANGE: Move html5Mode and hashPrefix to LocationServices from LocationConfig

BREAKING CHANGE: Future States names must end with .**, i.e., foo.bar.**

Previously, a state with a lazyLoad function was considered a future state. Now, a state whose name ends with .** (i.e., a glob pattern which matches all children) is a future state.

All future states should be given a name that ends in .**.

Change your future states from:

{ name: 'future', url: '/future', lazyLoad: () => ... }

to:

{ name: 'future.**', url: '/future', lazyLoad: () => ... }

BREAKING CHANGE: Path/Query parameters no longer default to string param type

Previously, if a url parameter's type was not specified (in either the path or query), it defaulted to the string type.

Now, path parameters default to the new path type and query parameters default to the new query type.

1.0.0-beta.3 commits (2016-09-23)

Read more on the blog

This release adds Angular 2.0.0 final support. It changes the NgModule mechanism to use UIRouterModule.forRoot() and UIRouterModule.forChild(). See the blog and the breaking changes section.

Bug Fixes

This release fixes bugs for both ng1 and ng2

• common: Remove url() from LocationService interface (#2990) (d6c2580)
• lazyLoad: Always delete the lazy load promise after it settles. (dd2f101)
• ng1.StateProvider: Export StateProvider class so type can be used (167770d)
• ng1.uiView: Remove deprecated jquery functions bind/unbind in favor of on/off (60ebd44)
• ng2: Angular 2.0.0 final compatibility (7c54b75), closes #2991
• ng2.NgModule: Allow apps with no forChild modules (d3bd332), closes #3009
• ng2.uiView: Use ReflectorReader to get component inputs
• resolve: Don't re-resolve data when redirected to same state, but only dynamic params changed. (98cd2d2), closes #3033
• trace: Show function definition during logging of trace.enable('HOOK') (190d122)
• transition: Fail a transition if a new one has started while resolves are loading (bc87d9e), closes #2972
• urlMatcherFactory: fix tilde edge case with "string" encoding (#3018) (a201906)
• viewService: Allow root ui-view to be wrapped in ng-if (32f718a), closes #3004

Features

• StateBuilder: Calculate parent state name when ends in two wildcards ** (b4621f3)

BREAKING CHANGES

BC in Core

• Remove UIInjector.native infavor of UIInjector.getNative() (d11b7dc)
• Remove stateProvider from ui-router-core. Use stateRegistry and stateService in 88c6494
• We now enforce states with an explicit parent: may NOT ALSO specify a parent state in their name (i.e., parent.child)

BC in Angular 2

Major breaking changes for Angular 2 bootstrap between beta.2 and beta.3

• Removed @UIRouterModule decorator.
• Added UIRouterModule.forRoot() and UIRouterModule.forChild() factory methods
• See https://ui-router.github.io/docs/latest/classes/ng2.uiroutermodule.html

@NgModule({ imports: [ UIRouterModule.forRoot({ states: INITIAL_STATES, useHash: true, configClass: MyUIRouterConfig }), BrowserModule, FeatureModule, ], declarations: INITIAL_COMPONENTS }) class RootAppModule {}

@NgModule({ imports: [ UIRouterModule.forChild({ states: FEATURE_STATES, configClass: FeatureConfig }), CommonModule, ], declarations: FEATURE_COMPONENTS })

1.0.0-beta.2 commits (2016-09-09)

Read more on the blog

Features

Core

• lazyLoad: Add state.lazyLoad hook to lazy load a tree of states (bef5257) (8ecb6c6), closes #146 #2739
• StateRegistry: Add deregister method. (44579ec), closes #1095 #2711
• redirectTo: Process redirectTo property of a state as a redirect string/object/hook function (6becb12), closes #27 #948
• redirect: Error after 20+ redirected transitions (88052bf)
• rejectFactory: separate transition aborted and transition errored reject types (55995fd)
• Resolve: support ng2-like provide object literals (a7e5ea6)
• Resolve: Switch state.resolve to be an array of Resolvables (6743a60)
• Transition: Add the transition source (url/sref) to TransitionOptions (5d42d79)
• Transition: Added getResolvable(token) method (3aee2b7)
• Transition: expose the current UiRouter object as a public property (52f1308)
• Transition: expose the transition rejection reason as Transition.error() (7a9e383), closes #2866
• Transition: Expose the transition's TargetState as targetState() (f06f6b6)
• urlRouter: Allow a rule to be deleted. (55f3d3d)

ng2

• ng2.rx: Added RxJS Observables for transitions and states: (2a2f381)
• ng2: Add @UIRouterModule decorator (e7bedc2), closes #2922
• ng2: Improve ng2 bootstrap flexibility with provideUIRouter() provider factory function (bc17066), closes #2958
• ng2.UrlRouter: Implement { location: replace } (b8c6146), closes #2850
• ng2.NgModule: Add module's states to DI using UIROUTER_STATES_TOKEN (0cb628e)
• ng2.stateRegistry: Automatically register states defined on a UIRouterModule (58a3c84)
• ng2.UIView: Use merged NgModule/ParentComp to inject routed component (37241e7)
• ng2.upgrade: Enable ng1-to-ng2 (0bf4eb4)
• uiView: Support Components loaded via AppModule (696148f)

Bug Fixes

Core

• defaultErrorHandler: Invoke handler when a transition is Canceled. (4fcccd8), closes #2924
• defaultErrorHandler: log Error and Error.stack by default (e102a85)
• defaultErrorHandler: Reduce console.error noise when redirected (8c0344f)
• common: Add concrete import to interface.ts to fix unit tests (2d16740)
• redirect: fix bug where redirected transitions with reload: true got wrong resolve values copied (bd0e3a3)
• redirectTo: fix redirectTo definition (interface) (eff7195), closes #2871
• Rejection: Silence "Error: Uncaught (in Exception)" (38432f4), closes #2676
• Resolve: prevent RXWAIT from waiting for the observable to complete (a02caf3)
• ResolvePolicy: Fix resolve policy config loading (4440811), closes #2945
• stateService: change reloadState parameter in reload function is optional (#2973) (839dc4a)
• StateService: remove jQuery deprecated feature (fa40acc)
• trace: make TRANSITION trace less noisy when a transition is redirected (a65c58f)
• Trace: Fix error in console after $trace.enable() (013c77a), closes #2752
• transitionHook: Prevent queued hookFn to be called if deregistered (#2939) (39e1ba7), closes #2928
• typescript: Make UI-Router noImplicitAny safe. (0769bc2), closes #2693
• typescript: Remove angular1 specific types from ui-router-core methods (30124bd), closes #2693

ng1

• ng1.stateService: Coerce 'null' params value to empty object (f674151), closes #2952
• ng1.uiSref: Allow nested UISrefs by stopping event propagation on-click (b4a2499), closes #2962
• ng1.uiSrefActive: update sref-active after existing transition-in-progress completes (0994c71), closes #2908
• uiSref, uiState: added click unbind to prevent memory leaks (79d501e)
• uiView: separate $uiView and $uiViewAnim element.data() (a94117d), closes #2763

ng2

• ng2.pushState: Properly match urls when base path set (b9be2dc), closes #2745
• ng2.UIRouterConfig: Allow new UIRouter() to finish before configuring it (a151f71)
• ng2.uiSrefActive: Allow uiSrefActive on ancestor element. (874fc07), closes #2950
• ng2.uiSrefActive: don't puke on sref to invalid target state (c9b6570)
• ng2.UISrefActive: Use @ContentChildren to query for the nested UISref (999c42a), closes #2950
• ng2.UiView: fix input resolve binding (4f53f81)
• ng2.UIView: Make routed to component appear inside UIView, not next to it. (558fc80)

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) Angular 1 DI token ng1UIRouter renamed to $uiRouter

3. (obscure) Renamed Transition.previous() to Transition.redirectedFrom()

1.0.0-beta.1 commits (2016-06-30)

UI-Router 1.0 is in beta

UI-Router has a new home!

https://ui-router.github.io/new-ui-router-site/

BREAKING CHANGES

These breaking changes are for users upgrading from a previous alpha, not from 0.x legacy series. This list is extensive, but typical users won't be affected by most of these changes.

The most common breaks will be #1 and #2

1. BC-BREAK: renamed all Ui* (lowercase 'i') symbols to UI* (uppercase 'I') for more consistent naming.

   • UiView -> UIView
   • UiSref -> UISref (and related directives)
   • UiInjector -> UIInjector

2. BC-BREAK: Transition Hooks are no longer injected (onBefore/onStart/onExit/onRetain/onEnter/onFinish/onSuccess/onError)

   Previously, a hook like ['$state', ($state) => $state.target('foo')] would get $state injected. Now, all hooks receive two parameters:

   • transition: the current Transition, which has an injector() function
   • state: for onEnter/onRetain/onExit hooks only, the State which the hook is being run for. This value will be null for onBefore/onStart/onFinish/onSuccess/onError hooks.

   Refactor your hooks from: ['$state', 'mySvc', ($state, mySvc) => mySvc.foo() ? $state.target('foo')] : true to: (trans) => trans.injector().get('mySvc').foo() ? trans.router.stateService.target('foo') : true

   Note: for backwards compatiblity, angular 1 onEnter/onExit/onRetain hooks are still injected

3. BC-BREAK: - The (internal API) State object's .resolve property is now an array of Resolvables, built from your state definitions by the StateBuilder

4. BC-BREAK: - Removed the default resolve called $resolve$, which was added in a previous alpha

5. BC-BREAK: - Transition.addResolves()  replaced with Transition.addResolvable()

6. BC-BREAK: remove ResolveContext.getResolvables() in favor of .getToken()`` and .getResolvable()`

7. BC-BREAK: remove ResolveContext.invokeLater() and .invokeNow()

8. BC-BREAK: remove support for JIT resolves. This also eliminated the need for the loadAllControllerLocals hook which was also removed

9. BC-BREAK: Replaced ViewConfig.node with ViewConfig.path. Angular 1's $(element).data('$uiView') is affected. Previously the .node was the node for the view. Now the last element in the path is the node for the view.

10. BC-BREAK: Nodes no longer have (stateful) .resolveContext properties. Instead, a new ResolveContext is wrapped over a Path of Nodes.  Removed PathFactory.bindResolveContexts().

11. BC-BREAK: ResolveContext.resolvePath returns a promise for resolved data as an array of tuples, instead of a promise for an object of resolved data.  Removed ResolveContext.resolvePathElement().

12. BC-BREAK: Removed ResolvePolicy enum in favor of the ResolvePolicy interface { when: "", async: "" }

13. BC-BREAK: renamed ResolveContext.isolateRootTo to subContext

14. BC-BREAK: rename UIRouterGlobals class to Globals; add UIRouterGlobals back as an interface

15. BC-BREAK: Moved defaultErrorHandler from TransitionService to StateService

Features

• Resolve: Switch state.resolve to be an array of Resolvables (6743a60)
• Resolve: support ng2-like provide object literals. Support injection of arbitrary tokens, not just strings. (a7e5ea6)
• Resolve: support ng2-like provide object literals (a7e5ea6)
• Transition: expose the current UiRouter object as a public property (52f1308)
• redirectTo: Process redirectTo property of a state as a redirect string/object/hook function (6becb12), closes #27 #948
• rejectFactory: separate transition aborted and transition errored reject types (55995fd)
• ParamType: allow a custom parameter Type to specify a default value for a parameter's dynamic property
• Resolvable: Added a new Resolve Policy 'RXWAIT'. If an Observable is returned, pass the observable as the value, but also wait for it to emit its first value

Bug Fixes

• ng2.pushState: Properly match urls when base path set (b9be2dc), closes #2745
• ng2.UIRouterConfig: Allow new UIRouter() to finish before configuring it (a151f71)
• ng2.UiView: fix input resolve binding (4f53f81)
• ng2.UIView: Make routed to component appear inside UIView, not next to it. (558fc80)
• redirect: fix bug where redirected transitions with reload: true got wrong resolve values copied (bd0e3a3)
• Rejection: Silence "Error: Uncaught (in Exception)" (38432f4), closes #2676
• Trace: Fix error in console after $trace.enable() (013c77a), closes #2752
• ng2.UIView: Trigger change detection once for routed components

1.0.0-alpha.5 commits (2016-05-13)

Bug Fixes

Core

• attachRoute: Do not update URL after syncing from url(8742511), closes #2730
• common: only use window if available(32ff988)
• coreservices: Use Promise.reject()/resolve()/all()(62b2ebc), closes #2683
• paramTypes.hash: Update hash for each transition(79d4fd7), closes #2742
• Rejection: Dont log an ignored trans as console.error(7522c26), closes #2676
• resolve: Fix regression; Allow resolve values to be service names(a34fd3b), closes #2588
• StateQueueManager: Do not throw on orphan states.(95ae0cf), closes #2546
• TransitionManager: Update url even when the Transition is ignored.(f9c3e3c), closes #2723

ng1

• ng1.component: Allow route-to-component "@" and optional bindings(71b3393), closes #2708
• view: only run ng1 route-to-component code if component: is a string(ec1c534)

ng2

• ng2.uiSrefStatus: Avoid "dehydrated detector" error(9111727), closes #2684
• ng2.uiView: Fix "Invalid left-hand in assignment"(3f711a1)
• build: declare external dep on angular/core in webpack bundle(adfbde3), closes #2687

Features

ng2

• ng2.uiView: bind resolve data to input[] and @Input(), process bindings:(f6dae28)
• ng2.urlRouter: HTML5 PushState support(9842fb7), closes #2688
• ng2.UIRouter: update to ng2 beta.17(45c0758)
• ng2.UIRouter: Update ui-router for ng2 rc.1(3219406), closes #2722

1.0.0-alpha.4 commits (2016-04-06)

Bug Fixes

• ng2.uiView: Fix "Invalid left-hand in assignment" (3f711a1)
• view: only run ng1 route-to-component code if component: is a string (ec1c534)

Features

• uiView: add support for hybrid ng1/ng2 ui-router apps via ng-upgrade and http://github.com/ui-router/ng1-to-ng2
• ng2.uiView: bind resolve data to input[] and @Input(), process bindings: (f6dae28)

1.0.0-alpha.2 (2016-04-03)

Changes between 1.0.0-alpha.1 and 1.0.0-alpha.2

Angular 2

This is the first release with angular 2 support. See http://github.com/ui-router/quickstart-ng2 for a small ui-router-ng2 app

Bug Fixes

• ViewHooks: Avoid calling $onInit if angular 1.5 will call it for us (d42b617), closes #2660
• ViewHooks: Fix problem with injecting uiCanExit (76ab22d), closes #2661
• view: temporary sanity check that a node exists (1c0edeb), closes #2657
• justjs.$q: Fix $q.all([..]) and $q.all({...}) (b1624c6)
• ng2.uiSref: Fix anchor href generation (98b5b42)
• ng2.uiSrefStatus: calculate target state parameters (46cdf4c)
• ng2.uiView: Dispose prev comp on empty viewconfig (f28e0c3)

Features

• UIRouterConfig: Define UIRouterConfig class for router bootstrap (c16b9e6)
• UIRouterGlobals: Create UIRouterGlobals (0eb7406), closes #2525
• ui-router-ng2: Update providers and viewsBuilder to match new 1.0 API (ff54d61)
• ng2.uiSrefActive: Implement uiSrefStatus, uiSrefActive, uiSrefActiveEq (fcb15c5)

1.0.0-alpha.1 commits (2016-03-27)

We will maintain a list of Known BC from 0.2.x to 1.0 final to help people upgrade to the 1.0 release.

Bug fixes and features since 1.0.0alpha0

Bug Fixes

• date: Compare dates only using year, month, date (7a68ade), closes #2484
• params: Clone all properties of a Node. Introduce applyRawParams() (88c624d)
• RejectFactory: stringify rejections with circular dependency-aware stringify (199db79), closes #2538
• src/resolve: use injector's strictDi value in calls to .annotate (4c5b5d8)
• stateQueueManager: Use location: true for url-matched transitions (25e0c04), closes #2455
• stateService: Process reload: in the StateService.target() (081da32), closes #2537
• Transition: Do not reuse resolves for reloaded state during redirect (0c123c3), closes #2539
• Transition: Reject Transition promise when onBefore error (4b6d56f), closes #2561
• Transition: Reset URL to current state after aborted transition (3a1308b), closes #2611
• transition/transitionService: uses console.error to log error in default error handler (43a8fc5)
• ui-sref: update ui-sref-active/eq info when params change (dcbaebf), closes #2554
• ui-state: update ui-sref-active/eq info (025ebc8), closes #2488
• UrlMatcher: Format parent/child UrlMatchers properly (86e07ef), closes ##2504
• UrlMatcher: isOptional always false for empty parameter (4e85db4)

Features

• params: Add uiOnParamsChanged controller callback (961c96d), closes #2608 #2470 #2391 #1967
• resolve: Allow all resolved data for a node to be injected as $resolve$ (e432c27)
• state: Expose the internal state API via $$state() (92053f1), closes #13
• ui-router-ng2: Initial angular2 support (217de70)
• uiCanExit: Add controller lifecycle hook "uiCanExit" (afcfe95)
• uiView: Expose the resolved data for a state as $scope.$resolve (0f6aea6), closes #2175 #2547
• uiView: Fire the $onInit hook (c8afc38), closes #2559
• uiView: Put $animate promises on element.data('$uiView') (a5578de), closes #2562 #2579
• view: Route a view to a directive using component: (1552032), closes #2627

Other commits

Many of these commits are merged from 0.2.x legacy branch

• uiSrefActive: allow multiple classes (120d7ad), closes #2481 #2482
• justjs: provide naive implementation of most of the coreservices api (426f134)
• resolve: add $resolve service back to 1.0 (70c6659)
• uiSrefActive: allow active & active-eq on same element (d9a676b), closes #1997
• uiSrefActive: provide a ng-{class,style} like interface (a9ff6fe), closes #1431
• uiSrefActive: Added support for multiple nested uiSref directives (b184494)
• uiState: add ui-state directive (3831af1), closes #395 #900 #1932
• urlMatcher: add support for optional spaces (4b7f304)
• urlMatcher: Add param only type names (6a371f9)
• $IncludedByStateFilter: add parameters to $IncludedByStateFilter (963f6e7), closes #1735
• $state: make state data inheritance prototypical (c4fec8c)
• $state: Inject templateProvider with resolved values (afa20f2)
• $state: added 'state' to state reload method (feat no.1612) (b8f0457)
• $state: broadcast $stateChangeCancel event when event.preventDefault() is called in $sta (ecefb75)
• $state: inject resolve params into controllerProvider (b380c22), closes #1131
• $state: support URLs with #fragments (3da0a17)
• $uiViewScroll: change function to return promise (c2a9a31), closes #1702

0.2.18 (2016-02-07)

This is a maintenance release which fixes a few known bugs introduced in 0.2.16.

Bug Fixes

• $urlRouter: revert BC: resolve clashing of routes This reverts commit b5c57c8ec2e14e17e75104 (2f1ebefc, closes #2501)
• uiState: Corrected typo for 'ref' variable (#2488, #2508) (b8f3c144)
• $urlMatcherFactory: Fix to make the YUI Javascript compressor work (ad9c41d2)
• stateBuilder: fix non-url params on a state without a url. The parameters are now applied when (d6d8c332, closes #2025)
• ui-view: (ui-view) use static renderer when no animation is present for a ui-view (2523bbdb, closes #2485). This allows a ui-view scope to be destroyed when switching states, before the next view is initialized.

Features

• ui-view: Add noanimation attribute to specify static renderer. (2523bbdb, closes #2485). This allows a ui-view scope to be destroyed before the next ui-view is initialized, when ui-view animation is not present.

0.2.17 (2016-01-25)

Bug Fixes

• uiSrefActive: allow multiple classes (a89114a0, closes #2481, #2482)

0.2.16 (2016-01-24)

Bug Fixes

• $state:
  • statechangeCancel: Avoid infinite digest in .otherwise/redirect case. Don't clobber url if a new transition has started. Closes #222 (e00aa695, closes #2238)
  • transitionTo: Allow hash (#) value to be read as toParams['#'] in events. Re-add the saved hash before broadcasting $stateChangeStart event. (8c1bf30d)
• $stateParams: Fix for testing: reset service instance between tests (2aeb0c4b)
• $urlRouter:
  • Sort URL rules by specificity. Potential minor BC if apps were relying on rule registration order. (b5c57c8e)
  • Use $sniffer for pushstate compat check (c219e801)
• UrlMatcher:
  • Properly encode/decode slashes in parameters Closes #2172 Closes #2250 Closes #1 (02e98660, closes #2339)
  • Array types: Fix default value for array query parameters. Pass empty arrays through in handler. (20d6e243, closes #2222)
  • Remove trailing slash, if parameter is optional and was squashed from URL (77fa11bf, closes #1902)
  • Allow a parameter declaration to configure the parameter type by name. closes #2294 (e4010249)
  • include the slash when recognizing squashed params in url (b5130bb1, closes #2064)
  • Allow url query param names to contain periods (d31b3337)
• reloadOnSearch: Update locals.globals.$stateParams when reloadOnSearch=false (350d3e87, closes #2356)
• ui-view:
  • fix $animate usage for ng 1.4+ (9b6d9a2d)
  • change $viewContentLoading to pair with $viewContentLoaded (f9b43d66, closes #685)
  • $destroy event is triggered before animation ends (1be13795)
• uiSref:
  • Ensure URL once param checks pass (9dc31c54, closes #2091)
  • uiSrefActive: update the active classes after linking directive (7c914030)

Features

• $IncludedByStateFilter: add parameters to $IncludedByStateFilter (963f6e71, closes #1735)
• isStateFilter: Include optional state params. (71d74699)
• $state: make state data inheritance prototypical (c4fec8c7)
• $stateChangeStart: Add options to event (a1f07559)
• UrlMatcher: Add param only type names (6a371f9b)
• uiSrefActive:
  • provide a ng-{class,style} like interface (a9ff6feb)
  • allow active & active-eq on same element (d9a676ba)
• uiState: add ui-state directive (3831af1d, closes #395, #900, #1932)
• urlMatcher: add support for optional spaces in params (4b7f3046)

0.2.15 (2015-05-19)

Bug Fixes

• $state: reloadOnSearch should not affect non-search param changes. (6ca0d770, closes #1079)
• urlMatcherFactory: Revert to 0.2.13 behavior where all string parameters are considered optional fi (495a02c3, closes #1963)
• urlRouter: allow .when() to redirect, even after a successful $state.go() - This partially (48aeaff6, closes #1584)

Features

• $state: Inject templateProvider with resolved values (afa20f22)

0.2.14 (2015-04-23)

Bug Fixes

• $StateRefDirective: resolve missing support for svg anchor elements #1667 (0149a7bb)
• $urlMatcherFactory:
  • regex params should respect case-sensitivity (1e10519f, closes #1671)
  • unquote all dashes from array params (06664d33)
  • add Type.$normalize function (b0c6aa23)
  • make optional params regex grouping optional (06f73794, closes #1576)
• $state: allow about.*.** glob patterns (e39b27a2)
• uiSref:
  • use Object's toString instead of Window's toString (2aa7f4d1)
  • add absolute to allowed transition options (ae1b3c4e)
• uiSrefActive: Apply active classes on lazy loaded states (f0ddbe7b)
• uiView: add $element to locals for view controller (db68914c)

Features

• $state:
  • support URLs with #fragments (3da0a170)
  • inject resolve params into controllerProvider (b380c223, closes #1131)
  • added 'state' to state reload method (feat no.1612) - modiefied options.reload (b8f04575)
  • broadcast $stateChangeCancel event when event.preventDefault() is called in $sta (ecefb758)
• $uiViewScroll: change function to return promise (c2a9a311, closes #1702)
• uiSrefActive: Added support for multiple nested uiSref directives (b1844948)

0.2.13 (2014-11-20)

This release primarily fixes issues reported against 0.2.12

Bug Fixes

• $state: fix $state.includes/.is to apply param types before comparisions fix(uiSref): ma (19715d15, closes #1513)
  • Avoid re-synchronizing from url after .transitionTo (b267ecd3, closes #1573)
• $urlMatcherFactory:
  • Built-in date type uses local time zone (d726bedc)
  • make date type fn check .is before running (aa94ce3b, closes #1564)
  • early binding of array handler bypasses type resolution (ada4bc27)
  • add 'any' Type for non-encoding non-url params (3bfd75ab, closes #1562)
  • fix encoding slashes in params (0c983a08, closes #1119)
  • fix mixed path/query params ordering problem (a479fbd0, closes #1543)
• ArrayType:
  • specify empty array mapping corner case (74aa6091, closes #1511)
  • fix .equals for array types (5e6783b7, closes #1538)
• Param: fix default value shorthand declaration (831d812a, closes #1554)
• common: fixed the _.filter clone to not create sparse arrays (750f5cf5, closes #1563)
• ie8: fix calls to indexOf and filter (dcb31b84, closes #1556)

Features

• add json parameter Type (027f1fcf)

0.2.12 (2014-11-13)

Bug Fixes

• $resolve: use resolve fn result, not parent resolved value of same name (67f5e00c, closes [#1317], [#1353])
• $state:
  • populate default params in .transitionTo. (3f60fbe6, closes [#1396])
  • reload() now reinvokes controllers (73443420, closes [#582])
  • do not emit $viewContentLoading if notify: false (74255feb, closes #1387)
  • register states at config-time (4533fe36)
  • handle parent.name when parent is obj (4533fe36)
• $urlMatcherFactory:
  • register types at config (4533fe36, closes [#1476])
  • made path params default value "" for backwards compat (8f998e71)
  • Pre-replace certain param values for better mapping (6374a3e2)
  • fixed ParamSet.$$keys() ordering (9136fecb)
  • empty string policy now respected in Param.value() (db12c85c)
  • "string" type now encodes/decodes slashes (3045e415, closes [#1119])
  • allow arrays in both path and query params (fdd2f2c1, closes [#1073], [#1045], [#1486], [#1394])
  • typed params in search (8d4cab69, closes #1488)
  • no longer generate unroutable urls (cb9fd9d8, closes #1487)
  • handle optional parameter followed by required parameter in url format. (efc72106)
  • default to parameter string coersion. (13a468a7, closes #1414)
  • concat respects strictMode/caseInsensitive (dd72e103, closes [#1395])
• ui-sref:
  • Allow sref state options to take a scope object (b5f7b596)
  • replace raw href modification with attrs. (08c96782)
  • nagivate to state when url is "" fix($state.href): generate href for state with (656b5aab, closes #1363)
  • Check that state is defined in isMatch() (92aebc75, closes #1314, #1332)
• uiView:
  • allow inteprolated ui-view names (81f6a19a, closes #1324)
  • Made anim work with angular 1.3 (c3bb7ad9, closes #1367, #1345)
• urlRouter: html5Mode accepts an object from angular v1.3.0-rc.3 (7fea1e9d)
• stateFilters: mark state filters as stateful. (a00b353e, closes [#1479])
• ui-router: re-add IE8 compatibility for map/filter/keys (8ce69d9f, closes [#1518], [#1383])
• package: point 'main' to a valid filename (ac903350)
• travis: make CI build faster (0531de05)

Features

Default and Typed params

This release includes a lot of bug fixes around default/optional and typed parameters. As such, 0.2.12 is the first release where we recommend those features be used.

• $state:
  • add state params validation (b1379e6a, closes #1433)
  • is/includes/get work on relative stateOrName (232e94b3)
  • .reload() returns state transition promise (639e0565)
• $templateFactory: request templateURL as text/html (ccd60769, closes [#1287])
• $urlMatcherFactory: Made a Params and ParamSet class (0cc1e6cc)

0.2.11 (2014-08-26)

Bug Fixes

• $resolve: Resolves only inherit from immediate parent fixes #702 (df34e20c)
• $state:
  • change $state.href default options.inherit to true (deea695f)
  • sanity-check state lookups (456fd5ae, closes #980)
  • didn't comply to inherit parameter (09836781)
  • allow view content loading broadcast (7b78edee)
• $urlMatcherFactory:
  • detect injected functions (91f75ae6)
  • syntax (1ebed370)
• UrlMatcher:
  • query param function defaults (f9c20530)
  • don't decode default values (63607bdb)
• travis: update Node version to fix build (d6b95ef2)
• uiSref:
  • Generate an href for states with a blank url. closes #1293 (691745b1)
  • should inherit params by default (b973dad1)
  • cancel transition if preventDefault() has been called (2e6d9167)
• uiView: Fixed infinite loop when is called .go() from a controller. (e13988b8, closes #1194)
• docs:
  • Fixed link to milestones (6c0ae500)
  • fix bug in decorator example (4bd00af5)
  • Removed an incorrect semi-colon (af97cef8)
  • Explain return value of rule as function (5e887890)

Features

• $state:
  • allow parameters to pass unharmed (8939d057)
    • BREAKING CHANGE: state parameters are no longer automatically coerced to strings, and unspecified parameter values are now set to undefined rather than null.
  • allow prevent syncUrl on failure (753060b9)
• typescript: Add typescript definitions for component builds (521ceb3f)
• uiSref: extend syntax for ui-sref (71cad3d6)
• uiSrefActive:

  • Also activate for child states. (bf163ad6, closes #818)

    • BREAKING CHANGE Since ui-sref-active now activates even when child states are active you may need to swap out your ui-sref-active with ui-sref-active-eq, thought typically we think devs want the auto inheritance.

  • uiSrefActiveEq: new directive with old ui-sref-active behavior

• $urlRouter:
  • defer URL change interception (c72d8ce1)
  • force URLs to have valid params (d48505cd)
  • abstract $location handling (08b4636b)
• $urlMatcherFactory:
  • fail on bad parameters (d8f124c1)
  • date type support (b7f074ff)
  • implement type support (450b1f0e)
• UrlMatcher:
  • handle query string arrays (9cf764ef, closes #373)
  • injectable functions as defaults (00966ecd)
  • default values & type decoding for query params (a472b301)
  • allow shorthand definitions (5b724304)
  • validates whole interface (32b27db1)
  • implement non-strict matching (a3e21366)
  • add per-param config support (07b3029f)
    • BREAKING CHANGE: the params option in state configurations must now be an object keyed by parameter name.

0.2.10 (2014-03-12)

Bug Fixes

• $state: use $browser.baseHref() when generating urls with .href() (cbcc8488)
• bower.json: JS files should not be ignored (ccdab193)
• dev: karma:background task is missing, can't run grunt:dev. (d9f7b898)
• sample: Contacts menu button not staying active when navigating to detail states. Need t (2fcb8443)
• uiSref: support mock-clicks/events with no data (717d3ff7)
• uiView:
  • Do NOT autoscroll when autoscroll attr is missing (affe5bd7, closes #807)
  • Refactoring uiView directive to copy ngView logic (548fab6a, closes #857, #552)

Features

• $state: includes() allows glob patterns for state matching. (2d5f6b37)
• UrlMatcher: Add support for case insensitive url matching (642d5247)
• uiSref: add support for transition options (2ed7a728)
• uiView: add controllerAs config with function (1ee7334a)

0.2.9 (2014-01-17)

This release is identical to 0.2.8. 0.2.8 was re-tagged in git to fix a problem with bower.

0.2.8 (2014-01-16)

Bug Fixes

• $state: allow null to be passed as 'params' param (094dc30e)
• $state.go: param inheritance shouldn't inherit from siblings (aea872e0)
• bower.json: fixes bower.json (eed3cc4d)
• uiSrefActive: annotate controller injection (85921422, closes #671)
• uiView:
  • autoscroll tests pass on 1.2.4 & 1.1.5 (86eacac0)
  • don't animate initial load (83b6634d)
  • test pass against 1.0.8 and 1.2.4 (a402415a)
  • it should autoscroll when expr is missing. (8bb9e27a)

Features

• uiSref: add target attribute behaviour (c12bf9a5)
• uiView:
  • merge autoscroll expression test. (b89e0f87)
  • cache and test autoscroll expression (ee262282)