fix(useOutsideClickEffect): restrict event type to MouseEvent in handleDocumentClick#258
Open
fix(useOutsideClickEffect): restrict event type to MouseEvent in handleDocumentClick#258
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR resolves a type mismatch in the useOutsideClickEffect hook by restricting the event type in the handleDocumentClick callback to MouseEvent, aligning the expected type with the actual events being listened to.
- The callback's parameter type was changed from MouseEvent | TouchEvent to MouseEvent.
- This change ensures type consistency and avoids potential type errors.
Comments suppressed due to low confidence (1)
src/hooks/useOutsideClickEffect/useOutsideClickEffect.ts:33
- Since the event handler now accepts only MouseEvent, please update any related inline comments or documentation to reflect that touch events are no longer handled.
const handleDocumentClick = usePreservedCallback(({ target }: MouseEvent) => {
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #258 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 37 37
Lines 1093 1093
Branches 324 324
=========================================
Hits 1093 1093 🚀 New features to boost your workflow:
|
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.
Overview
This PR resolves a type mismatch in
useOutsideClickEffectwhere the event handler incorrectly expectedTouchEventwhile only listening toclickevents. The changes ensure type consistency between event listeners and handlers.Reason for Change
The hook was listening exclusively to
clickevents (which fireMouseEvent), but the handler acceptedMouseEvent | TouchEvent. This caused:Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?