Skip to content

docs(use-search-params): add warning about optional default values for schema …#397

Closed
kyrregjerstad wants to merge 1 commit intosvecosystem:mainfrom
kyrregjerstad:main
Closed

docs(use-search-params): add warning about optional default values for schema …#397
kyrregjerstad wants to merge 1 commit intosvecosystem:mainfrom
kyrregjerstad:main

Conversation

@kyrregjerstad
Copy link

Summary

Adds documentation warning that schema fields using .optional() without explicit defaults will be silently ignored and cannot update the URL.

Why

useSearchParams extracts field information by validating an empty object against the schema. Fields without defaults won't appear in the validation result, so the hook doesn't recognize them as valid parameters for URL updates.

This caused me some headache when params.fieldName = value silently failed to update the URL.

@changeset-bot
Copy link

changeset-bot bot commented Dec 23, 2025

⚠️ No Changeset found

Latest commit: 2ccf8c5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

Hi @kyrregjerstad, thanks for the PR!

This PR was opened from the main branch of your fork. That prevents maintainers from safely pushing edits.

Please create a new branch in your fork (e.g. feat/my-change) and open a new PR.

Closing this PR to keep things tidy.

@github-actions github-actions bot closed this Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant