@types/react-dom

Version 18.2.4
Published 1 month ago
30.3 kB
1 dependency
MIT license

Install

npm i @types/react-dom

yarn add @types/react-dom

pnpm add @types/react-dom

Overview

TypeScript definitions for React (react-dom)

Variables

variable hydrate

const hydrate: Renderer;

variable render

const render: Renderer;

variable version

const version: string;

Functions

function createPortal

createPortal: (
    children: ReactNode,
    container: Element | DocumentFragment,
    key?: null | string
) => ReactPortal;

function experimental_useFormStatus

experimental_useFormStatus: () => FormStatus;

function findDOMNode

findDOMNode: (
    instance: ReactInstance | null | undefined
) => Element | null | Text;

function flushSync

flushSync: { <R>(fn: () => R): R; <A, R>(fn: (a: A) => R, a: A): R };

function preinit

preinit: (href: string, options?: PreinitOptions) => void;

function preload

preload: (href: string, options?: PreloadOptions) => void;

function unmountComponentAtNode

unmountComponentAtNode: (container: Element | DocumentFragment) => boolean;

function unstable_batchedUpdates

unstable_batchedUpdates: {
    <A, R>(callback: (a: A) => R, a: A): R;
    <R>(callback: () => R): R;
};

function unstable_renderSubtreeIntoContainer

unstable_renderSubtreeIntoContainer: {
    <T extends Element>(
        parentComponent: Component<any>,
        element: DOMElement<DOMAttributes<T>, T>,
        container: Element,
        callback?: (element: T) => any
    ): T;
    <P, T extends Component<P, ComponentState>>(
        parentComponent: Component<any>,
        element: CElement<P, T>,
        container: Element,
        callback?: (component: T) => any
    ): T;
    <P>(
        parentComponent: Component<any>,
        element: ReactElement<P>,
        container: Element,
        callback?: (component?: any) => any
    ): any;
};

Interfaces

interface FormStatusNotPending

interface FormStatusNotPending {}

property action

action: null;

property data

data: null;

property method

method: null;

property pending

pending: false;

interface FormStatusPending

interface FormStatusPending {}

property action

action: string | ((formData: FormData) => void | Promise<void>);

property data

data: FormData;

property method

method: string;

property pending

pending: true;

interface PreinitOptions

interface PreinitOptions {}

property as

as: PreinitAs;

property crossOrigin

crossOrigin?: string | undefined;

property integrity

integrity?: string | undefined;

property nonce

nonce?: string | undefined;

property precedence

precedence?: string | undefined;

interface PreloadOptions

interface PreloadOptions {}

property as

as: PreloadAs;

property crossOrigin

crossOrigin?: string | undefined;

property integrity

integrity?: string | undefined;

interface Renderer

interface Renderer {}

call signature

<T extends Element>(
    element: DOMElement<DOMAttributes<T>, T>,
    container: Container | null,
    callback?: () => void
): T;

call signature

(
    element: Array<DOMElement<DOMAttributes<any>, any>>,
    container: Container | null,
    callback?: () => void
): Element;

call signature

(
    element:
        | FunctionComponentElement<any>
        | Array<FunctionComponentElement<any>>,
    container: Container | null,
    callback?: () => void
): void;

call signature

<P, T extends Component<P, ComponentState>>(
    element: CElement<P, T>,
    container: Container | null,
    callback?: () => void
): T;

call signature

(
    element: Array<CElement<any, Component<any, ComponentState>>>,
    container: Container | null,
    callback?: () => void
): Component<any, ComponentState>;

call signature

<P>(
    element: ReactElement<P>,
    container: Container | null,
    callback?: () => void
): Component<P, ComponentState> | Element | void;

call signature

(element: ReactElement[], container: Container | null, callback?: () => void):
    | Component<any, ComponentState>
    | Element
    | void;

Type Aliases

type Container

type Container = Element | Document | DocumentFragment;

type FormStatus

type FormStatus = FormStatusPending | FormStatusNotPending;

type PreinitAs

type PreinitAs = 'script' | 'style';

type PreloadAs

type PreloadAs = 'font' | 'script' | 'style';

Package Files (3)

Dependencies (1)

@types/react

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/react-dom.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/react-dom)

HTML

<a href="https://www.jsdocs.io/package/@types/react-dom"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 23 days ago.
Package analyzed in 3512 ms.
Missing or incorrect documentation? Open an issue for this package.

@types/react-dom

Install

Overview

Index

Variables

Functions

Interfaces

Type Aliases

Variables

variable hydrate

variable render

variable version

Functions

function createPortal

function experimental_useFormStatus

function findDOMNode

function flushSync

function preinit

function preload

function unmountComponentAtNode

function unstable_batchedUpdates

function unstable_renderSubtreeIntoContainer

Interfaces

interface FormStatusNotPending

property action

property data

property method

property pending

interface FormStatusPending

property action

property data

property method

property pending

interface PreinitOptions

property as

property crossOrigin

property integrity

property nonce

property precedence

interface PreloadOptions

property as

property crossOrigin

property integrity

interface Renderer

call signature

call signature

call signature

call signature

call signature

call signature

call signature

Type Aliases

type Container

type FormStatus

type PreinitAs

type PreloadAs

Package Files (3)

Dependencies (1)

Dev Dependencies (0)

Peer Dependencies (0)

Badge