@types/react-router-dom

What is @types/react-router-dom?

The @types/react-router-dom package provides TypeScript type definitions for the react-router-dom library, which is a standard library for routing in React applications. It enables strong typing for components and functions from react-router-dom, enhancing development experience by offering compile-time type checking and IntelliSense support in code editors.

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

BrowserRouter

Defines a Router using the BrowserRouter component, setting up navigation and routes for a simple application.

import { BrowserRouter as Router, Route, Link } from 'react-router-dom';

function App() {
  return (
    <Router>
      <div>
        <nav>
          <ul>
            <li>
              <Link to='/'>Home</Link>
            </li>
            <li>
              <Link to='/about'>About</Link>
            </li>
          </ul>
        </nav>

        <Route path='/' exact component={Home} />
        <Route path='/about' component={About} />
      </div>
    </Router>
  );
}

Route Parameters

Demonstrates how to use route parameters with the useParams hook to display dynamic content based on the URL.

import { BrowserRouter as Router, Route, Link } from 'react-router-dom';

function Post() {
  let { postId } = useParams();
  return <div>Now showing post {postId}</div>;
}

function App() {
  return (
    <Router>
      <div>
        <Link to='/post/123'>Post 123</Link>
        <Route path='/post/:postId' component={Post} />
      </div>
    </Router>
  );
}

Nested Routes

Shows how to implement nested routes using the useRouteMatch hook to match parts of the URL and render accordingly.

import { BrowserRouter as Router, Route, Link, useRouteMatch } from 'react-router-dom';

function Topics() {
  let { path, url } = useRouteMatch();
  return (
    <div>
      <ul>
        <li>
          <Link to={`${url}/components`}>Components</Link>
        </li>
        <li>
          <Link to={`${url}/props-v-state`}>Props v. State</Link>
        </li>
      </ul>

      <Route path={`${path}/:topicId`} component={Topic} />
    </div>
  );
}

Other packages similar to @types/react-router-dom

vue-router

Vue Router is the official router for Vue.js. It deeply integrates with Vue.js core to make building Single Page Applications with Vue.js a breeze. Compared to @types/react-router-dom, vue-router is designed specifically for Vue.js rather than React, offering similar functionality in a different ecosystem.

README

Installation

npm install --save @types/react-router-dom

Summary

This package contains type definitions for react-router-dom (https://github.com/ReactTraining/react-router).

Details

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

Additional Details

• Last updated: Tue, 18 Jan 2022 22:01:52 GMT
• Dependencies: @types/react-router, @types/react, @types/history
• Global values: none

Credits

These definitions were written by Huy Nguyen, Philip Jackson, John Reilly, Sebastian Silbermann, Daniel Nixon, Tony Ward, and Pirasis Leelatanon.