@types/react

What is @types/react?

The @types/react package contains TypeScript type definitions for React (a JavaScript library for building user interfaces). It enables TypeScript developers to use React with type checking, which enhances development by catching errors early and providing autocompletion in code editors. This package is essential for developers working with React in TypeScript projects, as it defines the types for React APIs, components, hooks, and other utilities.

What are @types/react's main functionalities?

Component Type Definitions

Defines TypeScript types for React functional components, allowing for type checking of props.

import React from 'react';

interface Props {
  greeting: string;
}

const Greeting: React.FC<Props> = ({ greeting }) => <div>{greeting}</div>;

Hook Type Definitions

Provides type definitions for React hooks like useState, enabling type checking and autocompletion for hook-related code.

import React, { useState } from 'react';

const Counter: React.FC = () => {
  const [count, setCount] = useState<number>(0);
  return (
    <div>
      <p>{count}</p>
      <button onClick={() => setCount(count + 1)}>Increment</button>
    </div>
  );
};

Event Type Definitions

Includes type definitions for handling events in React, such as mouse and keyboard events, with appropriate type checking.

import React from 'react';

const Clicker: React.FC = () => {
  const handleClick = (event: React.MouseEvent<HTMLButtonElement>) => {
    console.log('Button clicked');
  };
  return <button onClick={handleClick}>Click Me</button>;
};

Other packages similar to @types/react

@types/react-dom

Provides TypeScript definitions for React DOM, similar to @types/react but specifically for DOM-related types. It's used alongside @types/react for web development.

@types/react-router-dom

Offers TypeScript definitions for React Router DOM, a library for routing in React applications. It complements @types/react by adding types for routing components and hooks.

@types/redux

Contains TypeScript definitions for Redux, a state management library often used with React. It provides types for Redux's store, actions, and reducers, enabling type-safe state management in React apps.

README

Installation

npm install --save @types/react

Summary

This package contains type definitions for react (https://react.dev/).

Details

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

Additional Details

• Last updated: Fri, 27 Sep 2024 16:08:32 GMT
• Dependencies: @types/prop-types, @types/scheduler, csstype

Credits

These definitions were written by Asana, AssureSign, Microsoft, John Reilly, Benoit Benezech, Patricio Zavolinsky, Eric Anderson, Dovydas Navickas, Josh Rutherford, Guilherme Hübner, Ferdy Budhidharma, Johann Rakotoharisoa, Olivier Pascal, Martin Hochel, Frank Li, Jessica Franco, Saransh Kataria, Kanitkorn Sujautra, Sebastian Silbermann, Kyle Scully, Cong Zhang, Dimitri Mitropoulos, JongChan Choi, Victor Magalhães, Dale Tan, Priyanshu Rav, and Costa Alexoglou.