wouter-vue Documentation

useSearchParams

Get and manipulate URL search parameters.

Description

Returns a tuple [searchParams, setSearchParams] where:

  • searchParams is a reactive Ref<URLSearchParams> containing parsed query parameters
  • setSearchParams is a function to update search parameters

Returns

Example

setSearchParams Behavior

  • Setting a value: setSearchParams({ page: '2' }) - adds or updates the parameter
  • Removing a value: setSearchParams({ page: null }) - removes the parameter
  • Multiple parameters: setSearchParams({ page: '2', sort: 'asc' }) - updates multiple at once

Notes

  • URLSearchParams is the standard browser API
  • Changes to search params update the URL without page reload
  • All updates are reactive and trigger component updates

Built with wouter-vue • GitHub