[@mantine/form] Fix missing TS suggestions for path in clearFieldError, resetField, clearFieldDirty#8810
Merged
Conversation
…ield, clearFieldDirty Align path parameter types with setFieldValue/setFieldError/validateField by using LooseKeys<Values> generic instead of unknown/PropertyKey. clearFieldDirty had the same issue and was included for consistency. Fixes mantinedev#8808
Member
|
Thanks! |
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
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.
Fixes #8808
Problem
clearFieldErrorandresetFieldhavepathparameters typed asunknownandPropertyKey, which disables TypeScript autocomplete for form values. This is inconsistent withsetFieldValue,setFieldError, andvalidateField, which useLooseKeys<Values>and provide proper suggestions.Fix
Aligned the
pathparameter type across the form API by using theLooseKeys<Values>generic:clearFieldError(path: unknown) => void<Field extends LooseKeys<Values>>(path: Field) => voidresetField(path: PropertyKey) => void<Field extends LooseKeys<Values>>(path: Field) => voidclearFieldDirty(path: unknown) => void<Field extends LooseKeys<Values>>(path: Field) => voidclearFieldDirtywasn't mentioned in the original issue but had the same problem, so I included it for consistency with the rest of the form API. Its runtime implementation (getPath-based, same assetFieldValue) already supports nested paths, so the type change reflects actual behavior.Testing
tsc --noEmit)@mantine/formtests passclearFieldError/resetField)