1- # @ rdub/ use-url -params
1+ # use-params
22
33Type-safe URL query parameter management with minimal, human-readable encoding.
44
@@ -16,15 +16,15 @@ Type-safe URL query parameter management with minimal, human-readable encoding.
1616## Installation
1717
1818``` bash
19- npm install @rdub/ use-url -params
19+ npm install use-params
2020# or
21- pnpm add @rdub/ use-url -params
21+ pnpm add use-params
2222```
2323
2424## Quick Start
2525
2626``` typescript
27- import { useUrlParam , boolParam , stringParam , intParam } from ' @rdub/ use-url -params'
27+ import { useUrlParam , boolParam , stringParam , intParam } from ' use-params'
2828
2929function MyComponent() {
3030 const [zoom, setZoom] = useUrlParam (' z' , boolParam )
@@ -90,7 +90,7 @@ const [ids, setIds] = useUrlParam('ids', numberArrayParam([]))
9090
9191### Multi-value Arrays (repeated keys)
9292``` typescript
93- import { useMultiUrlParam , multiStringParam , multiIntParam } from ' @rdub/ use-url -params'
93+ import { useMultiUrlParam , multiStringParam , multiIntParam } from ' use-params'
9494
9595const [tags, setTags] = useMultiUrlParam (' tag' , multiStringParam ())
9696// ?tag=foo&tag=bar&tag=baz → ["foo", "bar", "baz"]
@@ -133,7 +133,7 @@ const [page, setPage] = useUrlParam('p', paginationParam(20))
133133Create your own param encoders/decoders:
134134
135135``` typescript
136- import type { Param } from ' @rdub/ use-url -params'
136+ import type { Param } from ' use-params'
137137
138138// Example: Compact date encoding (YYMMDD)
139139const dateParam: Param <Date > = {
@@ -161,7 +161,7 @@ const [date, setDate] = useUrlParam('d', dateParam)
161161Use ` useUrlParams() ` to update multiple parameters atomically:
162162
163163``` typescript
164- import { useUrlParams , intParam , boolParam } from ' @rdub/ use-url -params'
164+ import { useUrlParams , intParam , boolParam } from ' use-params'
165165
166166const { values, setValues } = useUrlParams ({
167167 page: intParam (1 ),
@@ -192,7 +192,7 @@ setDevices(['gym', 'bedroom'])
192192Use the core utilities without React:
193193
194194``` typescript
195- import { boolParam , serializeParams , parseParams } from ' @rdub/ use-url -params'
195+ import { boolParam , serializeParams , parseParams } from ' use-params'
196196
197197// Encode
198198const params = { z: boolParam .encode (true ), d: ' gym' }
@@ -209,7 +209,7 @@ Use hash fragment (`#key=value`) instead of query string (`?key=value`):
209209
210210``` typescript
211211// Just change the import path
212- import { useUrlParam , boolParam } from ' @rdub/ use-url -params/hash'
212+ import { useUrlParam , boolParam } from ' use-params/hash'
213213
214214const [zoom, setZoom] = useUrlParam (' z' , boolParam )
215215// URL: https://example.com/#z (instead of ?z)
@@ -303,7 +303,7 @@ type MultiParam<T> = {
303303
304304## Examples
305305
306- Projects using ` @ rdub / use - url -params ` :
306+ Projects using ` use -params ` :
307307
308308- [runsascoded/awair] – Air quality dashboard with URL-persisted chart settings
309309
0 commit comments