{"id":22087763,"url":"https://github.com/rainxh11/qwik-querysignal","last_synced_at":"2025-10-13T02:32:55.822Z","repository":{"id":219142111,"uuid":"748249247","full_name":"rainxh11/qwik-querysignal","owner":"rainxh11","description":"Type-safe search params state manager for Qwik - Like useSignal(), but stored in the URL query string.","archived":false,"fork":false,"pushed_at":"2024-01-27T15:44:34.000Z","size":199,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-13T14:11:45.006Z","etag":null,"topics":["hooks","query","qwik","searchparams","signal","url"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/qwik-querysignal","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rainxh11.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-25T15:32:12.000Z","updated_at":"2025-06-28T14:59:36.000Z","dependencies_parsed_at":"2024-01-25T18:00:48.374Z","dependency_job_id":"fe2db3f5-e936-4674-b6d4-7edb0490a30f","html_url":"https://github.com/rainxh11/qwik-querysignal","commit_stats":null,"previous_names":["rainxh11/qwik-querysignal"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rainxh11/qwik-querysignal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainxh11%2Fqwik-querysignal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainxh11%2Fqwik-querysignal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainxh11%2Fqwik-querysignal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainxh11%2Fqwik-querysignal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rainxh11","download_url":"https://codeload.github.com/rainxh11/qwik-querysignal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainxh11%2Fqwik-querysignal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279014012,"owners_count":26085346,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hooks","query","qwik","searchparams","signal","url"],"created_at":"2024-12-01T02:06:35.164Z","updated_at":"2025-10-13T02:32:55.807Z","avatar_url":"https://github.com/rainxh11.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM](https://img.shields.io/npm/v/qwik-querysignal?color=blue)](https://www.npmjs.com/package/qwik-querysignal)\n[![MIT License](https://img.shields.io/github/license/rainxh11/qwik-querysignal.svg?color=cyan)](https://github.com/rainxh11/qwik-querysignal/blob/next/LICENSE)\n\n# qwik-querysignal for [Qwik](https://qwik.builder.io/)\n\nType-safe search params state manager for [Qwik](https://qwik.builder.io/) - Like `useSignal()`, but stored in the URL query string.\nThis project was inspired by [nuqs](https://github.com/47ng/nuqs) library for Next.js\n\n## Features\n\n- 🧘‍♀️ Simple: the URL is the source of truth\n- 🕰 Reload, Replace, append [Route History ](#route-options) to use the Back button to navigate state updates\n- ⚡️ Built-in [serializers](#working-with-other-types) for common state types (integer, float, boolean, Date, and more)\n- 📦 Support for working with [arrays](#working-with-arrays)\n- ⌛️ _**new:**_ Support for [debounced](#debouncing) query state changes.\n\n## Under the hood:\n\n`useQuerySignal()`, `useQueryStringSignal()` and `useQueryArraySignal()` track current route url search-params for any changes and vice versa tracks the returned signal state and updates the search-params.\nit uses Qwik's builtin `useNavigation()` under the hood to navigate to the updated url\n\n## Installation\n\n```shell\npnpm add qwik-querysignal\n```\n\n```shell\nyarn add qwik-querysignal\n```\n\n```shell\nnpm install qwik-querysignal\n```\n\n# Example Usage:\n\n## Working with strings:\n\n```ts\nimport { component$ } from \"@builder.io/qwik\";\nimport {\n  useQueryStringSignal,\n} from \"qwik-querysignal\";\n\nexport default component$(() =\u003e {\n  const sortBy = useQueryStringSignal(\"sortBy\", \"desc\", {\n    replaceState: true,\n  });\n  return (\n    \u003cdiv class=\"m-12 flex flex-col gap-1\"\u003e\n      \u003ch1 class=\"text-3xl\"\u003eHello👋\u003c/h1\u003e\n      \u003cinput\n        class=\"rounded-md border-2 border-blue-400 px-2 py-1 hover:border-blue-700\"\n        value={sortBy.value}\n        onInput$={(e) =\u003e (sortBy.value = e.target?.value)}\n      /\u003e\n    \u003c/div\u003e\n  );\n});\n```\n\n## Working with other types:\n\nIf your state type is not a string, you must pass a serializer in the second argument object.\n\nWe provide builtin serializers for common and more advanced object types:\n\n- String:\n\n```ts\nimport { parseAsString } from \"qwik-querysignal\"\nconst search = useQueryStringSignal(\"search\", \"default\", {\n  replaceState: true,\n})\n// or with passing a serializer manually\nconst search = useQuerySignal(\"search\", parseAsString(\"default\"))\n```\n\n![Example](https://raw.githubusercontent.com/rainxh11/qwik-querysignal/main/assets/example_string.gif)\n\n- Boolean:\n\n```ts\nimport { parseAsBoolean } from \"qwik-querysignal\"\nconst checked = useQuerySignal(\"checked\", parseAsBoolean())\n```\n\n- Numbers:\n\n```ts\nimport { parseAsInteger, parseAsFloat, parseAsHex } from \"qwik-querysignal\"\nconst count = useQuerySignal(\"count\", parseAsInteger())\nconst sum = useQuerySignal(\"sum\", parseAsFloat())\nconst hex = useQuerySignal(\"hex\", parseAsHex(\"FFA1\"))\n```\n\n- Dates:\n\n```ts\nimport {\n  parseAsIsoDateTime,\n  parseAsDateTimeFormatted,\n  parseAsTimestamp,\n} from \"qwik-querysignal\"\nconst date = useQuerySignal(\"date\", parseAsIsoDateTime())\nconst today = useQuerySignal(\"today\", parseAsDateTimeFormatted(\"yyyy-MM-dd\"))\nconst timestamp = useQuerySignal(\"ts\", parseAsTimestamp())\n```\n\n- Objects as JSON:\n\n```ts\nimport { parseAsJson } from \"qwik-querysignal\"\nconst options = useQuerySignal(\n  \"options\",\n  parseAsJson({ sortBy: \"id\", desc: false }),\n)\n```\n\n- Enums\n\n```ts\nimport { parseAsStringEnum } from \"qwik-querysignal\"\nconst sortBy = useQuerySignal(\n  \"sortBy\",\n  parseAsStringEnum([\"asc\", \"desc\", \"auto\"]),\n)\n```\n\n## Working with arrays:\n\nto work with array use `useQueryArraySignal()`, and provide a `separator` and `itemSerializer`:\n\n```ts\nimport { useQueryArraySignal, parseAsString } from \"qwik-querysignal\"\nconst names = useQueryArraySignal(\"names\", \",\", parseAsString())\n```\n\n# Route Options:\n\n`useQuerySignal()` accepts an optional `options` third parameter to tweak route navigation behavior after query state change.\n\n```ts\nconst search = useQuerySignal(\"search\", parseAsString(), {\n  replaceState: true, // Replace history\n  forceReload: false, // Reload page on state change\n  scroll: true, // Preserve scroll state\n})\n```\n\n## Debouncing:\n\n`useQuerySignalDebounced` and `useQueryArraySignalDebounced`\ncan be used to include debounce filter to delay navigation until _x milliseconds_ has passed from the last state change.\n\n```ts\nimport { useQuerySignalDebounced } from \"qwik-querysignal\"\nconst [search, searchDebounced] = useQuerySignalDebounced(\n  \"search\",\n  parseAsString(),\n  500 /*in milliseconds*/,\n)\n```\n\n![Example](https://raw.githubusercontent.com/rainxh11/qwik-querysignal/main/assets/example_debounce.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainxh11%2Fqwik-querysignal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frainxh11%2Fqwik-querysignal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainxh11%2Fqwik-querysignal/lists"}