29
18

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

React + TypeScript で react-router の URLパラメーターを取得する

Last updated at Posted at 2019-08-05

React + TypeScript で react-router の URLパラメーターを取得する時に、このようなコードでprops.matchを参照するとTS2339: Property 'match' does not exist on type '{ children?: ReactNode; }'.とエラーがでました。

page.tsx
import React, {FC} from "react";

const Page: FC<{}> = props => {
  return (
    <div>This is {props.match.params.id} Page.</div>
  )
};

export default Page;

たしかにmatchプロパティは、propsが受け取るオブジェクトとして定義されていないよな。。
と思ったものの、それならどのような型を読み込めば良いのかが分からなかったので調べました。

調べたみた所、react-router-dom の型定義ファイルにあるRouteComponentPropsを読み込めば良いとの事。

page.tsx
import React, {FC} from "react";
import {RouteComponentProps} from 'react-router-dom'

type PageProps = {} & RouteComponentProps<{id: string}>;

const Page: FC<PageProps> = props => {
  return (
    <div>This is {props.match.params.id} Page.</div>
  )
};

export default Page;

コンポーネントが受け取るpropsの型とRouteComponentPropsを型結合してまとめて、コンポーネントの型定義にします。

RouteComponentPropsのコードは、下のようになっており、ジェネリクスで受け取る型定義でmatchプロパティの中にあるプロパティを指定する事ができます。

index.d.ts
export interface RouteComponentProps<Params extends { [K in keyof Params]?: string } = {}, C extends StaticContext = StaticContext, S = H.LocationState> {
  history: H.History;
  location: H.Location<S>;
  match: match<Params>;
  staticContext?: C;
}

参考

React Router with TypeScriptでちゃんと型をつける
What TypeScript type should I use to reference the match object in my props?

29
18
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
29
18

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?