Installation
npm install --save @types/react-router-config
Summary
This package contains type definitions for react-router-config (https://github.com/ReactTraining/react-router/tree/master/packages/react-router-config).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-router-config.
index.d.ts
// Type definitions for react-router-config 5.0
// Project: https://github.com/ReactTraining/react-router/tree/master/packages/react-router-config, https://github.com/reacttraining/react-router
// Definitions by: John Reilly <https://github.com/johnnyreilly>
// Mathieu TUDISCO <https://github.com/mathieutu>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
import * as React from 'react';
import { RouteComponentProps, SwitchProps, match } from 'react-router';
import { Location } from 'history';
export interface RouteConfigComponentProps<Params extends { [K in keyof Params]?: string } = {}>
extends RouteComponentProps<Params> {
route?: RouteConfig | undefined;
}
export interface RouteConfig {
key?: React.Key | undefined;
location?: Location | undefined;
component?: React.ComponentType<RouteConfigComponentProps<any>> | React.ComponentType | undefined;
path?: string | string[] | undefined;
exact?: boolean | undefined;
strict?: boolean | undefined;
routes?: RouteConfig[] | undefined;
render?: ((props: RouteConfigComponentProps<any>) => React.ReactNode) | undefined;
[propName: string]: any;
}
export interface MatchedRoute<
Params extends { [K in keyof Params]?: string },
TRouteConfig extends RouteConfig = RouteConfig
> {
route: TRouteConfig;
match: match<Params>;
}
export function matchRoutes<
Params extends { [K in keyof Params]?: string },
TRouteConfig extends RouteConfig = RouteConfig
>(routes: TRouteConfig[], pathname: string): Array<MatchedRoute<Params, TRouteConfig>>;
export function renderRoutes(
routes: RouteConfig[] | undefined,
extraProps?: any,
switchProps?: SwitchProps,
): JSX.Element;
Additional Details
- Last updated: Tue, 18 Jan 2022 22:01:52 GMT
- Dependencies: @types/react, @types/react-router, @types/history
- Global values: none
Credits
These definitions were written by John Reilly, and Mathieu TUDISCO.