useParams
useParams
ist ein Client Component-Hook, der es ermöglicht, die dynamischen Parameter einer Route auszulesen, die durch die aktuelle URL gefüllt werden.
Parameter
useParams
akzeptiert keine Parameter.
Rückgabewert
useParams
gibt ein Objekt zurück, das die gefüllten dynamischen Parameter der aktuellen Route enthält.
- Jede Eigenschaft im Objekt entspricht einem aktiven dynamischen Segment.
- Der Eigenschaftsname ist der Name des Segments, und der Eigenschaftswert ist der Wert, mit dem das Segment gefüllt wurde.
- Der Eigenschaftswert ist entweder ein
string
oder ein Array vonstring
s, abhängig vom Typ des dynamischen Segments. - Wenn die Route keine dynamischen Parameter enthält, gibt
useParams
ein leeres Objekt zurück. - Bei Verwendung im Pages Router gibt
useParams
beim ersten Rendernnull
zurück und aktualisiert sich mit den Eigenschaften gemäß den oben genannten Regeln, sobald der Router bereit ist.
Beispiele:
Route | 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'] } |
Versionsverlauf
Version | Änderungen |
---|---|
v13.3.0 | useParams eingeführt. |