Query Param Hooks
Hooks for reading URL query parameters (query.* namespace).
Every query parameter must be declared in queryParams in your appfunnel.config.ts before it will be captured from the URL. The five UTM parameters (utm_source, utm_medium, utm_campaign, utm_content, utm_term) are included by default — all others must be explicitly declared.
useQueryParam(key)
Read a single URL query parameter by name. Read-only.
const utmSource = useQueryParam('utm_source')| Return | Type | Description |
|---|---|---|
value | string | Query parameter value (empty string if not present) |
useQueryParams()
Read all URL query parameters as a flat object. Only re-renders when a query.* variable changes.
const params = useQueryParams()
// { utm_source: 'google', ref: 'homepage' }| Return | Type | Description |
|---|---|---|
params | Record<string, string> | All query parameter key-value pairs |
Last updated on