@types/react-dom

What is @types/react-dom?

The @types/react-dom package provides TypeScript type definitions for React DOM. It's used in TypeScript projects to enable type checking and IntelliSense for React DOM APIs. This package is essential for developers working with React in a TypeScript environment, as it enhances code quality and developer productivity by providing compile-time type checking and autocompletion.

What are @types/react-dom's main functionalities?

Rendering Elements

This feature allows you to render React elements to the DOM. The code sample demonstrates how to use ReactDOM.render() to render an element into the DOM in the simplest way.

import ReactDOM from 'react-dom';

const element = <h1>Hello, world!</h1>;
ReactDOM.render(element, document.getElementById('root'));

Portals

Portals provide a way to render children into a DOM node that exists outside the DOM hierarchy of the parent component. The code sample shows how to create a portal.

import ReactDOM from 'react-dom';

const portalRoot = document.getElementById('portal-root');
const element = <div>Portal Example</div>;
ReactDOM.createPortal(element, portalRoot);

Server-side Rendering

This feature is for server-side rendering of React components to HTML. The code sample demonstrates how to use renderToString() to render a component to a static HTML string, which can then be sent to the client for a faster initial load.

import { renderToString } from 'react-dom/server';

const element = <div>Server Side Rendering</div>;
const htmlString = renderToString(element);

Other packages similar to @types/react-dom

@types/react

Provides TypeScript definitions for React core. Similar to @types/react-dom, but focuses on React's core functionalities like components, props, and state, rather than DOM-specific methods.

prop-types

Used for runtime type checking for React props and similar objects. It serves a similar purpose to @types/react-dom in terms of ensuring correct usage of components, but does so at runtime rather than compile time.

react-router-dom

Offers navigation components for React applications using the DOM. It's related to @types/react-dom in that it extends React's interaction with the DOM, specifically for routing purposes.

README

Installation

npm install --save @types/react-dom

Summary

This package contains type definitions for React (react-dom) (https://reactjs.org).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-dom.

Additional Details

• Last updated: Wed, 04 Oct 2023 14:05:53 GMT
• Dependencies: @types/react
• Global values: ReactDOM, ReactDOMServer

Credits

These definitions were written by Asana, AssureSign, Microsoft, MartynasZilinskas, Josh Rutherford, Jessica Franco, and Sebastian Silbermann.