NarraLeaf

useParams

現在の Layout のパスパターンで捕捉されたルートパラメータを返す useParams フック

親の Layout のパスパターンに従って、現在のパスから抽出したパラメータオブジェクトを返します。

import { useParams } from "narraleaf-react";

// inside /user/:id/layout
const { id } = useParams<{ id: string }>();

レイアウトが name=":id" として定義されている場合、そのレイアウトにマッチしたときに useParams から捕捉された値が得られます。

定義

function useParams<T extends Record<string,string>>(): T;

このフックは型安全です。ジェネリクスを渡すことで、返されるオブジェクトの型を絞り込めます。

関連項目:usePathnameuseQueryParams

このページの目次