Interface ComponentSpec<P, S>

interface ComponentSpec<P, S> {
    childContextTypes?: ValidationMap<any>;
    contextTypes?: ValidationMap<any>;
    displayName?: string;
    mixins?: Mixin<P, S>[];
    propTypes?: ValidationMap<any>;
    statics?: {
        [key: string]: any;
    };
    componentDidCatch?(error: Error, errorInfo: ErrorInfo): void;
    componentDidMount?(): void;
    componentDidUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>, snapshot?: any): void;
    componentWillMount?(): void;
    componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void;
    componentWillUnmount?(): void;
    componentWillUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): void;
    getDefaultProps?(): P;
    getInitialState?(): S;
    getSnapshotBeforeUpdate?(prevProps: Readonly<P>, prevState: Readonly<S>): any;
    render(): ReactNode;
    shouldComponentUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): boolean;
    UNSAFE_componentWillMount?(): void;
    UNSAFE_componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void;
    UNSAFE_componentWillUpdate?(nextProps: Readonly<P>, nextState: Readonly<S>, nextContext: any): void;
    [propertyName: string]: any;
}

Type Parameters

  • P
  • S

Hierarchy (view full)

Indexable

  • [propertyName: string]: any

Properties

childContextTypes? contextTypes? displayName? mixins? propTypes? statics?

Methods

componentDidCatch? componentDidMount? componentDidUpdate? componentWillMount? componentWillReceiveProps? componentWillUnmount? componentWillUpdate? getDefaultProps? getInitialState? getSnapshotBeforeUpdate? render shouldComponentUpdate? UNSAFE_componentWillMount? UNSAFE_componentWillReceiveProps? UNSAFE_componentWillUpdate?

Properties

OptionalchildContextTypes

childContextTypes?: ValidationMap<any>

OptionalcontextTypes

contextTypes?: ValidationMap<any>

OptionaldisplayName

displayName?: string

Optionalmixins

mixins?: Mixin<P, S>[]

OptionalpropTypes

propTypes?: ValidationMap<any>

Optionalstatics

statics?: {
    [key: string]: any;
}

Methods

OptionalcomponentDidCatch

  • componentDidCatch(error, errorInfo): void

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

    Parameters

    Returns void

OptionalcomponentDidMount

  • componentDidMount(): void

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

    Returns void

OptionalcomponentDidUpdate

  • componentDidUpdate(prevProps, prevState, snapshot?): 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

    • prevProps: Readonly<P>
    • prevState: Readonly<S>
    • Optionalsnapshot: any

    Returns void

OptionalcomponentWillMount

OptionalcomponentWillReceiveProps

OptionalcomponentWillUnmount

  • 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

OptionalcomponentWillUpdate

OptionalgetDefaultProps

  • getDefaultProps(): P

  • Returns P

OptionalgetInitialState

  • getInitialState(): S

  • Returns S

OptionalgetSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps, prevState): any

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<S>

    Returns any

render

OptionalshouldComponentUpdate

  • shouldComponentUpdate(nextProps, nextState, nextContext): 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

    • nextProps: Readonly<P>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

OptionalUNSAFE_componentWillMount

OptionalUNSAFE_componentWillReceiveProps

OptionalUNSAFE_componentWillUpdate

On This Page

Properties
Methods