UIRouter | @uirouter/react
Options
Menu

Class UIRouter<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

  • new UIRouter(props: any, context: any): UIRouter

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props: Readonly<object> | Readonly<UIRouterProps>
refs: object

Type declaration

  • [key: string]: ReactInstance
state: Readonly<UIRouterState>
contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

  • UNSAFE_componentWillMount(): void
  • Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<UIRouterProps>, nextContext: any): void
  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

  • UNSAFE_componentWillUpdate(nextProps: Readonly<UIRouterProps>, nextState: Readonly<UIRouterState>, nextContext: any): void
  • Called immediately before rendering when new props or state is received. Not called for the initial render.

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error Error
    • errorInfo ErrorInfo

    Returns void


  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void


  • componentDidUpdate(prevProps: Readonly<UIRouterProps>, prevState: Readonly<UIRouterState>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void


  • componentWillMount(): void
  • Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

  • componentWillReceiveProps(nextProps: Readonly<UIRouterProps>, nextContext: any): void
  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void


  • componentWillUpdate(nextProps: Readonly<UIRouterProps>, nextState: Readonly<UIRouterState>, nextContext: any): void
  • Called immediately before rendering when new props or state is received. Not called for the initial render.

  • forceUpdate(callBack?: function): void
  • Parameters

    • callBack: Optional  function
        • (): void
        • Returns void

    Returns void


  • getSnapshotBeforeUpdate(prevProps: Readonly<UIRouterProps>, prevState: Readonly<UIRouterState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null


  • render(): Element
  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof UIRouterState

    Parameters

    • state function | S | object
    • callback: Optional  function
        • (): void
        • Returns void

    Returns void


  • shouldComponentUpdate(nextProps: Readonly<UIRouterProps>, nextState: Readonly<UIRouterState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean


Object literals

propTypes: object
children: Validator<ReactElementLike> = PropTypes.element.isRequired
config: Requireable<function> = PropTypes.func
plugins: Requireable<function[]> = PropTypes.arrayOf(PropTypes.func)
router: Requireable<object> = PropTypes.object
states: Requireable<object[]> = PropTypes.arrayOf(PropTypes.object)

Generated using TypeDoc