nuqs について
nuqsのリファレンススキルです。nuqsはURLクエリパラメーターと状態を同期する、React.useStateの型安全な代替となるReactライブラリです。タスクに応じてドキュメントの分類を案内し、関連APIの確認を支援します。
主な機能
- 01タスクに応じたドキュメント分類
- 02フックとパーサーのリファレンス
- 03フレームワークアダプターの案内
- 04オプションとサーバーAPIのリファレンス
- 05制限・サンプル・スクリプトの案内
活用シーン
- 01useQueryStateやuseQueryStatesの確認
- 02組み込みまたはカスタムパーサーの選択
- 03Reactフレームワーク向けアダプターの設定
- 04URL制限やサーバー側解析の情報確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ fandhe-ai/ agent-reference-skills --skill nuqsインストール後、Claude Code で/nuqsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/adapters/adapters.mdREADME.mdreferences/guides/README.mdseo.mdtips-tricks.mdtroubleshooting.mdreferences/hooks/README.mduseQueryState.mduseQueryStates.mdreferences/limits/limits.mdREADME.mdreferences/options/options.mdREADME.mdreferences/parsers/built-in.mdcommunity-effect-schema.mdcommunity-sury.mdcommunity-tanstack-table.mdcommunity-zod-codecs.mdcustom.mdREADME.mdreferences/server/README.mdserver-side.mdreferences/utilities/createSerializer.mdcreateStandardSchemaV1.mdinferParserType.mdREADME.mdsamples/adapter-setup.mdarray-params.mdbasic-query-state.mdcustom-parser.md詳細
プロジェクトの README よりnuqs API リファレンス
nuqs — Type-safe URL query state management for React。
React.useState のドロップイン置換として URL クエリパラメータと状態を同期する。
対象 nuqs v2.10.2(2026-10-08、GitHub tag v2.10.2、docs 原本 packages/docs/content/docs at that tag)。
ディレクトリ構成
skills/nuqs/
SKILL.md
references/
hooks/
README.md
useQueryState.md
useQueryStates.md
parsers/
README.md
built-in.md
custom.md
community-zod-codecs.md
community-effect-schema.md
community-sury.md
community-tanstack-table.md
adapters/
README.md
adapters.md
guides/
README.md
troubleshooting.md
seo.md
tips-tricks.md
options/
README.md
options.md
server/
README.md
server-side.md
utilities/
README.md
createSerializer.md
createStandardSchemaV1.md
inferParserType.md
limits/
README.md
limits.md
samples/
README.md
basic-query-state.md
typed-state-with-parsers.md
multiple-params-batch-update.md
search-filter-debounce.md
server-side-parsing.md
search-params-cache.md
adapter-setup.md
custom-parser.md
url-key-remapping.md
array-params.md
testing.md
suspense-boundary.md
seo-canonical-url.md
scripts/
README.md
install.md
setup.md
testing.md
debug.md
探索手順
タスクからカテゴリを引き、カテゴリの README.md で目的のページを特定する:
- 下記マッピング表でタスクに対応するカテゴリを探す
- そのカテゴリの
references/{category}/README.mdを参照して目的のページを特定する - 該当ページの
.mdを Read して詳細を確認する
タスク → カテゴリ マッピング
| タスク | カテゴリ | 参照 README |
|---|---|---|
| useQueryState の基本的な使い方、単一パラメータの読み書き | hooks | references/hooks/README.md |
| useQueryStates でバッチ更新、複数パラメータの同期 | hooks | references/hooks/README.md |
| ビルトインパーサー(parseAsString / parseAsInteger / parseAsBoolean / parseAsArrayOf 等)の使い方 | parsers | references/parsers/README.md |
| createParser でカスタムパーサーを作成する、Zod codecs / Effect Schema / Sury / TanStack Table コミュニティパーサー | parsers | references/parsers/README.md |
| フレームワーク別 NuqsAdapter(Next.js app/pages/unified、React SPA、Remix、React Router v6/v7/v8、TanStack Router)、serverSearch、非推奨 adapter | adapters | references/adapters/README.md |
| Suspense boundary エラー、同一 key の異なるパーサー、Pages Router SSR の null、canonical URL / SEO、カスタムフック再利用 | guides | references/guides/README.md |
| history, shallow, scroll, throttle, debounce, clearOnDefault, startTransition オプション設定 | options | references/options/README.md |
| createLoader, createSearchParamsCache でサーバーサイド解析 | server | references/server/README.md |
| createSerializer, createStandardSchemaV1, inferParserType でパーサーからユーティリティを生成する | utilities | references/utilities/README.md |
| URL 長さ・ブラウザ制限(throttling, max URL length)を知りたい | limits | references/limits/README.md |
| 典型的な使い方を知りたい | samples | samples/README.md |
| インストール・CLI コマンド・テスト・デバッグ手順を知りたい | scripts | scripts/README.md |
コメント
Markdown 対応