docs(use-search-params): add warning about optional default values for schema#398
Open
kyrregjerstad wants to merge 3 commits intosvecosystem:mainfrom
Open
docs(use-search-params): add warning about optional default values for schema#398kyrregjerstad wants to merge 3 commits intosvecosystem:mainfrom
kyrregjerstad wants to merge 3 commits intosvecosystem:mainfrom
Conversation
🦋 Changeset detectedLatest commit: c10636b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.