Revert breaking change in autocomplete prop of Taginput #414
Conversation
This file contains 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
Removes the `autocomplete` prop from `FormElementMixin`, and reverts the breaking change that altered the `autocomplete` prop type of `Taginput` from `Boolean` to `String`. The following components which mix `FormElementMixin` in define their own `autocomplete` prop: - `Autocomplete` - `Input` - `Numberinput` Background: I introduced the breaking change to `Taginput` at the commit 085bd85. The change was intended to resolve the discrepancy in the `autocomplete` prop between `Taginput` and `FormElementMixin`, which ended up with weird type errors. I should not have changed the `autocomplete` prop type of `Taginput` but should have removed the prop from `FormElementMixin` instead, because `FormElementMixin` itself did not use it but just defined it; it was there only to save the typing cost in host components which use `FormElementMixin`, and most of the host components do not even use the `autocomplete` prop.
Updates `src/components/taginput/Taginput.spec.ts` because the `autocomplete` prop type was changed: `Boolean` → `String`.
Some test snapshots have to be updated due to the change in the attribute order of `Input`.
Changes the `autocomplete` prop type of `Taginput` from `String` to `Boolean`.
kikuomax
changed the title
wesdevpro
approved these changes
Jan 18, 2025
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.
No relevant issue.
Proposed Changes
autocompleteprop fromFormElementMixinautocompleteprop type ofTaginput, which was introduced at the commit 085bd85. The type becomesBooleanagain.autocomplete: Stringprop to each of the following components:AutocompleteInputNumberinputInputstubsBackground
While I was writing the changelog for v0.2.0, I found that the change in the
autocompleteprop ofTaginputwas the only major breaking change introduced by the TypeScript migration.I introduced the breaking change to
Taginputat the commit 085bd85. The change was intended to resolve the discrepancy in theautocompleteprop betweenTaginputandFormElementMixin, which ended up with weird type errors. However, I should not have changed theautocompleteprop type ofTaginputbut should have removed the prop fromFormElementMixininstead, becauseFormElementMixinitself did not use it but just defined it; it was there only to save the typing cost in host components which useFormElementMixin, and most of the host components did not even use theautocompleteprop.