Skip to content

ChronicStone/nuxt-ui-tools / skills/consumer/query-state

nuxt-ui-tools-query-state

Verified

Use this skill when building or debugging URL-backed state with nuxt-ui-tools as a package consumer. Covers codecs, useQueryState, useQueryStates, dynamicQueryState, grouped state, dynamic keys, and practical query-string examples.

references/getting-started.md

View on GitHub
# Query State Getting Started

## Single Value

```ts
const layout = useQueryState({
  key: 'layout',
  codec: createEnumCodec(['grid', 'table']),
  defaultValue: 'table',
})
```

Result:

- `layout.value` is a writable typed ref-like value
- the URL uses the `layout` key

Example:

```txt
?layout=grid
```

## Grouped Values

```ts
const pagination = useQueryStates({
  prefix: 'p',
  schema: {
    pageIndex: { urlKey: 'page', codec: numberCodec, defaultValue: 1 },
    pageSize: { urlKey: 'size', codec: numberCodec, defaultValue: 20 },
  },
  historyMode: 'push',
})
```

Resulting URL shape:

```txt
?p.page=2&p.size=50
```

Access pattern:

```ts
pagination.value.pageIndex
pagination.value.pageSize
pagination.value = {
  pageIndex: 3,
  pageSize: 100,
}
```

## Dynamic Values

Use `dynamicQueryState(...)` when the key set depends on runtime definitions instead of a fixed static shape.

A real package example is table UI filters, which use dynamic keys such as:

```txt
?f.ui.department=Engineering
?f.ui.salary~gte=100000
```

Use this when the keys are discovered from runtime definitions rather than hardcoded in the component.
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall