hooks | @uirouter/core
Options
Menu

Module hooks

Index

Variables

RESOLVE_HOOK_PRIORITY: 1000 = 1000
TRANSITION_TOKENS: (string | Transition)[] = ['$transition$', Transition]
isTransition: function = inArray(TRANSITION_TOKENS)

Type declaration

    • (obj: any): boolean
    • Parameters

      • obj any

      Returns boolean

onEnterHook: TransitionStateHookFn = makeEnterExitRetainHook('onEnter')

The TransitionStateHookFn for onEnter

The TransitionStateHookFn for onEnter

When the state is being entered, the state's .onEnter function is invoked.

Registered using transitionService.onEnter({ entering: (state) => !!state.onEnter }, onEnterHook);

See: IHookRegistry.onEnter

onExitHook: TransitionStateHookFn = makeEnterExitRetainHook('onExit')

The TransitionStateHookFn for onExit

The TransitionStateHookFn for onExit

When the state is being exited, the state's .onExit function is invoked.

Registered using transitionService.onExit({ exiting: (state) => !!state.onExit }, onExitHook);

See: IHookRegistry.onExit

onRetainHook: TransitionStateHookFn = makeEnterExitRetainHook('onRetain')

The TransitionStateHookFn for onRetain

The TransitionStateHookFn for onRetain

When the state was already entered, and is not being exited or re-entered, the state's .onRetain function is invoked.

Registered using transitionService.onRetain({ retained: (state) => !!state.onRetain }, onRetainHook);

See: IHookRegistry.onRetain

Functions

  • A TransitionHookFn which activates the new views when a transition is successful.

    Registered using transitionService.onSuccess({}, activateViews);

    After a transition is complete, this hook deactivates the old views from the previous state, and activates the new views from the destination state.

    See ViewService

    Parameters

    Returns void


  • Parameters

    Returns void


  • A TransitionHookFn which resolves all EAGER Resolvables in the To Path

    Registered using transitionService.onStart({}, eagerResolvePath, { priority: 1000 });

    When a Transition starts, this hook resolves all the EAGER Resolvables, which the transition then waits for.

    See StateDeclaration.resolve

    Parameters

    Returns Promise<any>


  • A TransitionHookFn that skips a transition if it should be ignored

    This hook is invoked at the end of the onBefore phase.

    If the transition should be ignored (because no parameter or states changed) then the transition is ignored and not processed.

    Parameters

    Returns Promise<any>


  • A TransitionHookFn that rejects the Transition if it is invalid

    This hook is invoked at the end of the onBefore phase. If the transition is invalid (for example, param values do not validate) then the transition is rejected.

    Parameters

    Returns void


  • A TransitionHookFn that performs lazy loading

    When entering a state "abc" which has a lazyLoad function defined:

    • Invoke the lazyLoad function (unless it is already in process)
      • Flag the hook function as "in process"
      • The function should return a promise (that resolves when lazy loading is complete)
    • Wait for the promise to settle
      • If the promise resolves to a LazyLoadResult, then register those states
      • Flag the hook function as "not in process"
    • If the hook was successful
      • Remove the lazyLoad function from the state declaration
    • If all the hooks were successful
      • Retry the transition (by returning a TargetState)
    .state('abc', {
      component: 'fooComponent',
      lazyLoad: () => System.import('./fooComponent')
      });

    See StateDeclaration.lazyLoad

    Parameters

    Returns Promise<false | true | void | TargetState>


  • Invokes a state's lazy load function

    Parameters

    Returns Promise<LazyLoadResult>

    :

    A promise for the lazy load result


  • A TransitionHookFn which resolves all LAZY Resolvables for the state (and all its ancestors) in the To Path

    Registered using transitionService.onEnter({ entering: () => true }, lazyResolveState, { priority: 1000 });

    When a State is being entered, this hook resolves all the Resolvables for this state, which the transition then waits for.

    See StateDeclaration.resolve

    Parameters

    Returns Promise<any>


  • A TransitionHookFn which waits for the views to load

    Registered using transitionService.onStart({}, loadEnteringViews);

    Allows the views to do async work in ViewConfig.load before the transition continues. In angular 1, this includes loading the templates.

    Parameters

    Returns Promise<any>


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • Parameters

    Returns Function


  • resolveRemaining(trans: Transition): Promise<any>
  • A TransitionHookFn which resolves any dynamically added (LAZY or EAGER) Resolvables.

  • A TransitionHookFn which resolves any dynamically added (LAZY or EAGER) Resolvables.

    Registered using transitionService.onFinish({}, eagerResolvePath, { priority: 1000 });

    After all entering states have been entered, this hook resolves any remaining Resolvables. These are typically dynamic resolves which were added by some Transition Hook using Transition.addResolvable.

    See StateDeclaration.resolve

    Parameters

    Returns Promise<any>


  • Parameters

    Returns void


  • A TransitionHookFn which updates global UI-Router state

    Registered using transitionService.onBefore({}, updateGlobalState);

    Before a Transition starts, updates the global value of "the current transition" ([[Globals.transition]]). After a successful Transition, updates the global values of "the current state" ([[Globals.current]] and [[Globals.$current]]) and "the current param values" ([[Globals.params]]).

    See also the deprecated properties: StateService.transition, StateService.current, StateService.params

    Parameters

    Returns void


  • A TransitionHookFn which updates the URL after a successful transition

    Registered using transitionService.onSuccess({}, updateUrl);

    Parameters

    Returns void


Generated using TypeDoc