vue-qs / useQueryState
Function: useQueryState()
Call Signature
useQueryState<
T,K>(key,parser):QueryStateRef<NonNullable<T>>
Defined in: composables/use-query-state.ts:66
Binds a URL query key to a writable ref.
Type Parameters
T
T
K
K extends ParserType
Parameters
key
string
The query key in the URL
parser
ParserBuilderWithDefault<T, K>
A parser (e.g. parseAsInteger.withDefault(1)), or options for a string state
Returns
QueryStateRef<NonNullable<T>>
Example
const q = useQueryState('q') // Ref<string | null>
const page = useQueryState('page', parseAsInteger.withDefault(1)) // Ref<number>
page.value++ // ?page=2
await page.set((p) => p + 1, { history: 'push' })
await page.set(null) // removes ?page, page.value === 1<input v-model="q" />Call Signature
useQueryState<
T,K>(key,parser):QueryStateRef<T|null>
Defined in: composables/use-query-state.ts:70
Binds a URL query key to a writable ref.
Type Parameters
T
T
K
K extends ParserType
Parameters
key
string
The query key in the URL
parser
ParserBuilder<T, K>
A parser (e.g. parseAsInteger.withDefault(1)), or options for a string state
Returns
QueryStateRef<T | null>
Example
const q = useQueryState('q') // Ref<string | null>
const page = useQueryState('page', parseAsInteger.withDefault(1)) // Ref<number>
page.value++ // ?page=2
await page.set((p) => p + 1, { history: 'push' })
await page.set(null) // removes ?page, page.value === 1<input v-model="q" />Call Signature
useQueryState(
key,options):QueryStateRef<string>
Defined in: composables/use-query-state.ts:74
Binds a URL query key to a writable ref.
Parameters
key
string
The query key in the URL
options
Options & object & object
Returns
QueryStateRef<string>
Example
const q = useQueryState('q') // Ref<string | null>
const page = useQueryState('page', parseAsInteger.withDefault(1)) // Ref<number>
page.value++ // ?page=2
await page.set((p) => p + 1, { history: 'push' })
await page.set(null) // removes ?page, page.value === 1<input v-model="q" />Call Signature
useQueryState(
key,options?):QueryStateRef<string|null>
Defined in: composables/use-query-state.ts:78
Binds a URL query key to a writable ref.
Parameters
key
string
The query key in the URL
options?
Returns
QueryStateRef<string | null>
Example
const q = useQueryState('q') // Ref<string | null>
const page = useQueryState('page', parseAsInteger.withDefault(1)) // Ref<number>
page.value++ // ?page=2
await page.set((p) => p + 1, { history: 'push' })
await page.set(null) // removes ?page, page.value === 1<input v-model="q" />