useParams
useParams
は、現在の URL によって設定されたルートの動的パラメータを読み取ることができるクライアントコンポーネント用フックです。
パラメータ
useParams
はパラメータを受け取りません。
戻り値
useParams
は、現在のルートで設定された動的パラメータを含むオブジェクトを返します。
- オブジェクトの各プロパティはアクティブな動的セグメントです
- プロパティ名はセグメント名、プロパティ値はセグメントに設定された値です
- プロパティ値は動的セグメントのタイプに応じて
string
またはstring
の配列になります - ルートに動的パラメータが含まれていない場合、
useParams
は空のオブジェクトを返します - Pages Router で使用した場合、
useParams
は初期レンダリング時にnull
を返し、ルーターの準備が整った後に上記のルールに従ってプロパティを含むオブジェクトを返します
例:
ルート | URL | useParams() |
---|---|---|
app/shop/page.js | /shop | {} |
app/shop/[slug]/page.js | /shop/1 | { slug: '1' } |
app/shop/[tag]/[item]/page.js | /shop/1/2 | { tag: '1', item: '2' } |
app/shop/[...slug]/page.js | /shop/1/2 | { slug: ['1', '2'] } |
バージョン履歴
バージョン | 変更内容 |
---|---|
v13.3.0 | useParams が導入されました。 |