Interface HostComponent<P>

Represents a native component, such as those returned from requireNativeComponent.

See

https://github.com/facebook/react-native/blob/v0.62.0-rc.5/Libraries/Renderer/shims/ReactNativeTypes.js

Todo

This should eventually be defined as an AbstractComponent, but that should first be introduced in the React typings.

interface HostComponent<P> {
    new HostComponentnew (props, context?): Component<P, {}, any> & Readonly<NativeMethods>;
    childContextTypes?: ValidationMap<any>;
    contextType?: Context<any>;
    contextTypes?: ValidationMap<any>;
    defaultProps?: Partial<P>;
    displayName?: string;
    getDerivedStateFromError?: GetDerivedStateFromError<P, any>;
    getDerivedStateFromProps?: GetDerivedStateFromProps<P, any>;
    propTypes?: WeakValidationMap<P>;
}

Type Parameters

  • P

Hierarchy (view full)

Constructors

constructor

Properties

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

Constructors

constructor

  • new HostComponent(props, context?): Component<P, {}, any> & Readonly<NativeMethods>

  • Parameters

    • props: P
    • Optional context: any

    Returns Component<P, {}, any> & Readonly<NativeMethods>

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, any>

Optional getDerivedStateFromProps

getDerivedStateFromProps?: GetDerivedStateFromProps<P, any>

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