components | @uirouter/react
Options
Menu

Module components

Components

UI-Router React Components and their APIs:

  • UIRouter: Main router component
  • UIView: A viewport for routed components
  • UISref: A state ref to a target state; navigates when clicked
  • UISrefActive: Adds a css class when a UISref's target state (or a child state) is active

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

RenderPropCallback: function

Function type for UIViewProps.render

Function type for UIViewProps.render

If the render function prop is provided, the UIView will use it instead of rendering the component by itself.

Type declaration

    • (Component: StatelessComponent<any> | ComponentClass<any> | ClassicComponentClass<any>, Props: any): Element | null

    • Parameters

      • Component StatelessComponent<any> | ComponentClass<any> | ClassicComponentClass<any>
      • Props any

      Returns Element | null

Variables

StateNameMustBeAStringError: Error = new Error('State name provided to <UISref {to}> must be a string.',)
TransitionPropCollisionError: Error = new Error('`transition` cannot be used as resolve token. ' +'Please rename your resolve to avoid conflicts with the router transition.',)
classNames: function = _classNames

Type declaration

    • (...classes: ClassValue[]): string

    • Parameters

      • ...classes: Rest  ClassValue[]

      Returns string

classNames: function = _classNames

Type declaration

    • (...classes: ClassValue[]): string

    • Parameters

      • ...classes: Rest  ClassValue[]

      Returns string

id: number = 0

Generated using TypeDoc