Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseComponent<Props, State>

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BaseComponent<Props, State>(props?: Props, context?: any): BaseComponent<Props, State>

  • Type parameters

    Parameters

    • Optional props: Props
    • Optional context: any

    Returns BaseComponent<Props, State>

Properties

Optional base

base?: Element | Text

context

context: ViewContext

debug

debug: boolean

propEquality

propEquality: EqualityFuncs<Props>

props

props: RenderableProps<Props, any>

state

state: Readonly<State>

stateEquality

stateEquality: EqualityFuncs<State>

Static addPropsEquality

addPropsEquality: (propEquality: any) => void

Type declaration

    • (propEquality: any): void

    • Parameters

      • propEquality: any

      Returns void

Static addStateEquality

addStateEquality: (stateEquality: any) => void

Type declaration

    • (stateEquality: any): void

    • Parameters

      • stateEquality: any

      Returns void

Static contextType

contextType: any

Static Optional defaultProps

defaultProps?: any

Static Optional displayName

displayName?: string

Methods

Optional componentDidCatch

  • componentDidCatch(error: any, errorInfo: any): void

  • Parameters

    • error: any
    • errorInfo: any

    Returns void

Optional componentDidMount

  • componentDidMount(): void

  • Returns void

Optional componentDidUpdate

  • componentDidUpdate(previousProps: Readonly<Props>, previousState: Readonly<State>, snapshot: any): void

  • Parameters

    • previousProps: Readonly<Props>
    • previousState: Readonly<State>
    • snapshot: any

    Returns void

Optional componentWillMount

  • componentWillMount(): void

  • Returns void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<Props>, nextContext: any): void

  • Parameters

    • nextProps: Readonly<Props>
    • nextContext: any

    Returns void

Optional componentWillUnmount

  • componentWillUnmount(): void

  • Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<Props>, nextState: Readonly<State>, nextContext: any): void

  • Parameters

    • nextProps: Readonly<Props>
    • nextState: Readonly<State>
    • nextContext: any

    Returns void

forceUpdate

  • forceUpdate(callback?: () => void): void

  • Parameters

    • Optional callback: () => void
        • (): void

        • Returns void

    Returns void

Optional getChildContext

  • getChildContext(): object

  • Returns object

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(oldProps: Readonly<Props>, oldState: Readonly<State>): any

  • Parameters

    • oldProps: Readonly<Props>
    • oldState: Readonly<State>

    Returns any

Abstract render

  • render(props?: RenderableProps<Props, any>, state?: Readonly<State>, context?: any): ComponentChild

  • Parameters

    • Optional props: RenderableProps<Props, any>
    • Optional state: Readonly<State>
    • Optional context: any

    Returns ComponentChild

setState

  • setState<K>(state: null | ((prevState: Readonly<State>, props: Readonly<Props>) => null | Pick<State, K> | Partial<State>) | Pick<State, K> | Partial<State>, callback?: () => void): void

  • Type parameters

    • K: string | number | symbol

    Parameters

    • state: null | ((prevState: Readonly<State>, props: Readonly<Props>) => null | Pick<State, K> | Partial<State>) | Pick<State, K> | Partial<State>
    • Optional callback: () => void
        • (): void

        • Returns void

    Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Props, nextState: State): boolean

  • Parameters

    • nextProps: Props
    • nextState: State

    Returns boolean

Static Optional getDerivedStateFromError

  • getDerivedStateFromError(error: any): null | object

  • Parameters

    • error: any

    Returns null | object

Static Optional getDerivedStateFromProps

  • getDerivedStateFromProps(props: object, state: object): null | object

  • Parameters

    • props: object
    • state: object

    Returns null | object

Generated using TypeDoc