Interface ComponentClass<P, S>

Represents a component class in React.

interface ComponentClass<P, S> {
    new ComponentClassnew (props, deprecatedLegacyContext?): Component<P, S, any>;
    childContextTypes?: ValidationMap<any>;
    contextType?: Context<any>;
    contextTypes?: ValidationMap<any>;
    defaultProps?: Partial<P>;
    displayName?: string;
    getDerivedStateFromError?: GetDerivedStateFromError<P, S>;
    getDerivedStateFromProps?: GetDerivedStateFromProps<P, S>;
    propTypes?: WeakValidationMap<P>;
}

Type Parameters

  • P = {}

    The props the component accepts.

  • S = ComponentState

    The internal state of the component.

Hierarchy (view full)

Constructors

constructor

Properties

childContextTypes? contextType? contextTypes? defaultProps? displayName? getDerivedStateFromError? getDerivedStateFromProps? propTypes?

Constructors

constructor

  • new ComponentClass(props, deprecatedLegacyContext?): Component<P, S, any>

  • Parameters

    • props: P
    • Optional deprecatedLegacyContext: any

      Deprecated

      See

      React Docs

    Returns Component<P, S, any>

Properties

Optional childContextTypes

childContextTypes?: ValidationMap<any>

Deprecated

See

Legacy React Docs

Optional contextType

contextType?: Context<any>

Optional contextTypes

contextTypes?: ValidationMap<any>

Deprecated

use ComponentClass.contextType instead

Lets you specify which legacy context is consumed by this component.

See

Legacy React Docs

Optional defaultProps

defaultProps?: Partial<P>

Used to define default values for the props accepted by the component.

See

React Docs

Optional displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Optional getDerivedStateFromError

getDerivedStateFromError?: GetDerivedStateFromError<P, S>

Optional getDerivedStateFromProps

getDerivedStateFromProps?: GetDerivedStateFromProps<P, S>

Optional propTypes

propTypes?: WeakValidationMap<P>

Used to declare the types of the props accepted by the component. These types will be checked during rendering and in development only.

We recommend using TypeScript instead of checking prop types at runtime.

See

React Docs

On This Page