useParams

useParams est un hook pour les Composants Client qui permet de lire les paramètres dynamiques d'une route remplis par l'URL actuelle.

'use client'

import { useParams } from 'next/navigation'

export default function ExampleClientComponent() {
  const params = useParams<{ tag: string; item: string }>()

  // Route -> /shop/[tag]/[item]
  // URL -> /shop/shoes/nike-air-max-97
  // `params` -> { tag: 'shoes', item: 'nike-air-max-97' }
  console.log(params)

  return '...'
}

Paramètres

const params = useParams()

useParams ne prend aucun paramètre.

Valeur retournée

useParams retourne un objet contenant les paramètres dynamiques remplis de la route actuelle.

  • Chaque propriété de l'objet correspond à un segment dynamique actif.
  • Le nom de la propriété correspond au nom du segment, et sa valeur correspond à ce avec quoi le segment est rempli.
  • La valeur de la propriété sera soit une string soit un tableau de string selon le type de segment dynamique.
  • Si la route ne contient aucun paramètre dynamique, useParams retourne un objet vide.
  • Si utilisé dans le Pages Router, useParams retournera null lors du rendu initial et mettra à jour avec les propriétés suivant les règles ci-dessus une fois que le routeur est prêt.

Par exemple :

RouteURLuseParams()
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'] }

Historique des versions

VersionChangements
v13.3.0Introduction de useParams.

On this page