Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • P = {}

  • S = {}

  • SS = any

Hierarchy

Index

Constructors

  • new Component<P, S, SS>(props: P | Readonly<P>): Component<P, S, SS>
  • new Component<P, S, SS>(props: P, context: any): Component<P, S, SS>
  • Type parameters

    • P = {}

    • S = {}

    • SS = any

    Parameters

    Returns Component<P, S, SS>

  • Type parameters

    • P = {}

    • S = {}

    • SS = any

    Parameters

    • props: P
    • context: any

    Returns Component<P, S, SS>

Properties

context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or 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>
see

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

props: Readonly<P>
refs: {}

Type declaration

state: Readonly<S>
contextType?: Context<any>

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
  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void
  • UNSAFE_componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): void
  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

  • componentDidUpdate(prevProps: Readonly<P>, prevState: Readonly<S>, snapshot?: SS): void
  • 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
  • componentWillReceiveProps(nextProps: Readonly<P>, nextContext: any): void
  • 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.

    Returns void

  • componentWillUpdate(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): void
  • forceUpdate(callback?: () => void): void
  • Parameters

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

    Returns void

  • getSnapshotBeforeUpdate(prevProps: Readonly<P>, prevState: Readonly<S>): null | SS
  • 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 null | SS

  • Returns ReactNode

  • setState<K>(state: null | S | ((prevState: Readonly<S>, props: Readonly<P>) => null | S | Pick<S, K>) | Pick<S, K>, callback?: () => void): void
  • Type parameters

    • K: string | number | symbol

    Parameters

    • state: null | S | ((prevState: Readonly<S>, props: Readonly<P>) => null | S | Pick<S, K>) | Pick<S, K>
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

  • shouldComponentUpdate(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): boolean
  • 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

Generated using TypeDoc