@pyreon/url-state 0.11.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present Vit Bokisch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# @pyreon/url-state
+
+Reactive signals synced to URL query parameters.
+
+## Install
+
+```bash
+bun add @pyreon/url-state
+```
+
+## Usage
+
+```ts
+import { useUrlState } from "@pyreon/url-state"
+
+// Single param — auto type coercion from default value
+const page = useUrlState("page", 1)       // reads ?page=X, defaults to 1
+page()                                      // 1
+page.set(2)                                 // URL becomes ?page=2
+page.reset()                                // back to default
+page.remove()                               // removes ?page entirely
+
+// Schema mode — multiple params
+const { page, sort, q } = useUrlState({ page: 1, sort: "name", q: "" })
+
+// Debounced (for search inputs)
+const q = useUrlState("q", "", { debounce: 300 })
+```
+
+## Features
+
+- Auto type coercion (number, boolean, string, string[], object)
+- `replaceState` by default (no history pollution)
+- Debounced URL writes
+- `popstate` sync (back/forward buttons)
+- SSR-safe (returns defaults when no window)
+- Optional `@pyreon/router` integration
+- Array encoding: `"comma"` or `"repeat"` format
+
+## License
+
+MIT