react | @uirouter/react
Options
Menu

Module react

React Specific API

UI-Router for React relies heavily on @uirouter/core. The following APIs are extensions to the core ui-router APIs, specific to ui-router-react.

Index

Classes

Interfaces

Variables

Functions

Variables

id: number = 0

Functions

  • reactViewsBuilder(state: StateObject): object

  • This is a StateBuilder.builder function for react views.

  • This is a StateBuilder.builder function for react views.

    When the StateBuilder builds a [[State]] object from a raw StateDeclaration, this builder handles the views property with logic specific to ui-router-react.

    If no views: {} property exists on the StateDeclaration, then it creates the views object and applies the state-level configuration to a view named $default.

    Parameters

    • state StateObject

    Returns object

  • React View Config Factory

    Given a path and a ReactViewDeclaration (the view declaration object found on the state declaration), returns a ReactViewConfig

    The ReactViewConfig is an instance of a view, which will be provided to the matching UIView Component's [[UIView.viewConfigUpdated]] function.

    Parameters

    Returns ReactViewConfig

Generated using TypeDoc