SrefActive | @uirouter/react
Options
Menu

Class SrefActive<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

Properties

activeClasses: object

Type declaration

  • [key: string]: string
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
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

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

deregister: Function
props: Readonly<UISrefActiveProps> | Readonly<object>
refs: object

Type declaration

  • [key: string]: ReactInstance
states: Array<UISrefActiveState> = []
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<UISrefActiveProps>, 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<UISrefActiveProps>, nextState: Readonly<any>, nextContext: any): void
  • Called immediately before rendering when new props or state is received. Not called for the initial render.

  • addState(stateName: any, stateParams: any, activeClass: any): (Anonymous function)
  • Parameters

    • stateName any
    • stateParams any
    • activeClass any

    Returns (Anonymous function)


  • addStateInfo(stateName: any, stateParams: any): (Anonymous function)
  • Parameters

    • stateName any
    • stateParams any

    Returns (Anonymous function)


  • 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
  • Returns void


  • componentDidUpdate(prevProps: Readonly<UISrefActiveProps>, prevState: Readonly<any>, 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

    • prevProps Readonly<UISrefActiveProps>
    • prevState Readonly<any>
    • snapshot: Optional  SS

    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<UISrefActiveProps>, 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
  • Returns void


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

  • createStateHash(state: string, params: Object): string
  • Parameters

    • state string
    • params Object

    Returns string


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

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

    Returns void


  • getActiveClasses(): string
  • Returns string


  • getSnapshotBeforeUpdate(prevProps: Readonly<UISrefActiveProps>, prevState: Readonly<any>): 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
  • Returns Element


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

    • K: keyof any

    Parameters

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

    Returns void


  • shouldComponentUpdate(nextProps: Readonly<UISrefActiveProps>, nextState: Readonly<any>, 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


  • updateActiveClasses(): void
  • Returns void


Object literals

state: object
activeClasses: string = ""
propTypes: object
addStateInfoToParentActive: Requireable<function> = PropTypes.func
children: Validator<ReactElementLike> = PropTypes.element.isRequired
class: Validator<string> = PropTypes.string.isRequired
className: Requireable<string> = PropTypes.string
parentUIView: Requireable<object> = PropTypes.object
router: Validator<object> = PropTypes.object.isRequired

Generated using TypeDoc