Function useQueryState

useQueryState<T = unknown>(
    key: string,
    opts?: UseQueryStateOptions<T>,
): [
    T
    | undefined,
    (next: T | undefined, navOpts?: { replace?: boolean }) => void,
]
Synchronises a single query parameter with component state.
Type Parameters
- T = unknown
Parameters
- key: string
  Query key to read and update.
- opts: UseQueryStateOptions<T> = {}
  Behavioural options (default value, omitIfDefault, replace).
Returns [T | undefined, (next: T | undefined, navOpts?: { replace?: boolean }) => void]
Tuple containing current value and setter that updates query via navigate.
- Defined in packages/router/src/routing/useQueryState.ts:23