Interface HookMatchCriteria

This object is used to configure whether or not a Transition Hook is invoked for a particular transition, based on the Transition's "to state" and "from state".

Each property (to, from, exiting, retained, and entering) can be a state name string, a boolean, or a function that takes a state and returns a boolean (see [[HookMatchCriterion]])

All properties are optional. If any property is omitted, it is replaced with the value true, and always matches. To match any transition, use an empty criteria object {}.

Example:

// This matches a transition coming from the `parent` state and going to the `parent.child` state.
var match = {
  to: 'parent',
  from: 'parent.child'
}
Copy

Example:

// This matches a transition coming from any state and going to any state that has `data.authRequired`
// set to a truthy value.
var match = {
  to: function(state) {
    return state.data != null && state.data.authRequired === true;
  }
}
Copy

Example:

// This will match when route is just entered (initial load) or when the state is hard-refreshed
// by specifying `{refresh: true}` as transition options.
var match = {
  from: (state, transition) => state.self.name === '' || transition._options.reload
}
Copy

Example:

// This matches a transition that is exiting `parent.child`
var match = {
  exiting: 'parent.child'
}
Copy