-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor Hoverable component into functional #29052
Changes from 1 commit
a839a64
95ce7ae
70999e7
c9eb5a7
16cabc5
b5f9a86
5461a71
0246282
a4a4ea0
599b119
c585d31
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
import _ from 'underscore'; | ||
import React, {Component} from 'react'; | ||
import React, {useEffect, useCallback, useState, useRef, useMemo, useImperativeHandle} from 'react'; | ||
import {DeviceEventEmitter} from 'react-native'; | ||
import {propTypes, defaultProps} from './hoverablePropTypes'; | ||
import * as DeviceCapabilities from '../../libs/DeviceCapabilities'; | ||
|
@@ -37,111 +37,147 @@ function assignRef(ref, el) { | |
* because nesting Pressables causes issues where the hovered state of the child cannot be easily propagated to the | ||
* parent. https://github.com/necolas/react-native-web/issues/1875 | ||
*/ | ||
class Hoverable extends Component { | ||
constructor(props) { | ||
super(props); | ||
|
||
this.handleVisibilityChange = this.handleVisibilityChange.bind(this); | ||
this.checkHover = this.checkHover.bind(this); | ||
function InnerHoverable({disabled, onHoverIn, onHoverOut, children, shouldHandleScroll}, outerRef) { | ||
const [isHovered, setIsHovered] = useState(false); | ||
|
||
this.state = { | ||
isHovered: false, | ||
}; | ||
const isScrolling = useRef(false); | ||
const isHoveredRef = useRef(false); | ||
const ref = useRef(null); | ||
|
||
this.isHoveredRef = false; | ||
this.isScrollingRef = false; | ||
this.wrapperView = null; | ||
} | ||
const updateIsHoveredOnScrolling = useCallback( | ||
(hovered) => { | ||
if (disabled) { | ||
return; | ||
} | ||
|
||
componentDidMount() { | ||
document.addEventListener('visibilitychange', this.handleVisibilityChange); | ||
document.addEventListener('mouseover', this.checkHover); | ||
|
||
/** | ||
* Only add the scrolling listener if the shouldHandleScroll prop is true | ||
* and the scrollingListener is not already set. | ||
*/ | ||
if (!this.scrollingListener && this.props.shouldHandleScroll) { | ||
this.scrollingListener = DeviceEventEmitter.addListener(CONST.EVENTS.SCROLLING, (scrolling) => { | ||
/** | ||
* If user has stopped scrolling and the isHoveredRef is true, then we should update the hover state. | ||
*/ | ||
if (!scrolling && this.isHoveredRef) { | ||
this.setState({isHovered: this.isHoveredRef}, this.props.onHoverIn); | ||
} else if (scrolling && this.isHoveredRef) { | ||
/** | ||
* If the user has started scrolling and the isHoveredRef is true, then we should set the hover state to false. | ||
* This is to hide the existing hover and reaction bar. | ||
*/ | ||
this.setState({isHovered: false}, this.props.onHoverOut); | ||
} | ||
this.isScrollingRef = scrolling; | ||
}); | ||
} | ||
} | ||
isHoveredRef.current = hovered; | ||
|
||
componentDidUpdate(prevProps) { | ||
if (prevProps.disabled === this.props.disabled) { | ||
return; | ||
} | ||
|
||
if (this.props.disabled && this.state.isHovered) { | ||
this.setState({isHovered: false}); | ||
} | ||
} | ||
if (shouldHandleScroll && isScrolling.current) { | ||
return; | ||
} | ||
setIsHovered(hovered); | ||
}, | ||
[disabled, shouldHandleScroll], | ||
); | ||
|
||
componentWillUnmount() { | ||
document.removeEventListener('visibilitychange', this.handleVisibilityChange); | ||
document.removeEventListener('mouseover', this.checkHover); | ||
if (this.scrollingListener) { | ||
this.scrollingListener.remove(); | ||
} | ||
} | ||
useEffect(() => { | ||
const unsetHoveredWhenDocumentIsHidden = () => document.visibilityState === 'hidden' && setIsHovered(false); | ||
|
||
/** | ||
* Sets the hover state of this component to true and execute the onHoverIn callback. | ||
* | ||
* @param {Boolean} isHovered - Whether or not this component is hovered. | ||
*/ | ||
setIsHovered(isHovered) { | ||
if (this.props.disabled) { | ||
return; | ||
} | ||
document.addEventListener('visibilitychange', unsetHoveredWhenDocumentIsHidden); | ||
|
||
/** | ||
* Capture whther or not the user is hovering over the component. | ||
* We will use this to determine if we should update the hover state when the user has stopped scrolling. | ||
*/ | ||
this.isHoveredRef = isHovered; | ||
return () => document.removeEventListener('visibilitychange', unsetHoveredWhenDocumentIsHidden); | ||
}, []); | ||
|
||
/** | ||
* If the isScrollingRef is true, then the user is scrolling and we should not update the hover state. | ||
*/ | ||
if (this.isScrollingRef && this.props.shouldHandleScroll && !this.state.isHovered) { | ||
useEffect(() => { | ||
if (!shouldHandleScroll) { | ||
return; | ||
} | ||
|
||
if (isHovered !== this.state.isHovered) { | ||
this.setState({isHovered}, isHovered ? this.props.onHoverIn : this.props.onHoverOut); | ||
} | ||
} | ||
const scrollingListener = DeviceEventEmitter.addListener(CONST.EVENTS.SCROLLING, (scrolling) => { | ||
isScrolling.current = scrolling; | ||
if (!scrolling) { | ||
setIsHovered(isHoveredRef.current); | ||
} | ||
}); | ||
|
||
return () => scrollingListener.remove(); | ||
}, [shouldHandleScroll]); | ||
|
||
/** | ||
* Checks the hover state of a component and updates it based on the event target. | ||
* This is necessary to handle cases where the hover state might get stuck due to an unreliable mouseleave trigger, | ||
* such as when an element is removed before the mouseleave event is triggered. | ||
* @param {Event} e - The hover event object. | ||
*/ | ||
checkHover(e) { | ||
if (!this.wrapperView || !this.state.isHovered) { | ||
const unsetHoveredIfOutside = useCallback( | ||
(e) => { | ||
kacper-mikolajczak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (!ref.current || !isHovered) { | ||
return; | ||
} | ||
|
||
if (ref.current.contains(e.target)) { | ||
return; | ||
} | ||
|
||
setIsHovered(false); | ||
}, | ||
[isHovered], | ||
); | ||
|
||
useEffect(() => { | ||
if (!DeviceCapabilities.hasHoverSupport()) { | ||
return; | ||
} | ||
|
||
document.addEventListener('mouseover', unsetHoveredIfOutside); | ||
|
||
return () => document.removeEventListener('mouseover', unsetHoveredIfOutside); | ||
}, [unsetHoveredIfOutside]); | ||
|
||
useEffect(() => { | ||
if (!disabled || !isHovered) { | ||
return; | ||
} | ||
setIsHovered(false); | ||
}, [disabled, isHovered]); | ||
|
||
if (this.wrapperView.contains(e.target)) { | ||
useEffect(() => { | ||
if (disabled) { | ||
return; | ||
} | ||
if (onHoverIn && isHovered) { | ||
return onHoverIn(); | ||
} | ||
if (onHoverOut && !isHovered) { | ||
return onHoverOut(); | ||
} | ||
}, [disabled, isHovered, onHoverIn, onHoverOut]); | ||
|
||
// Expose inner ref to parent through outerRef. This enable us to use ref both in parent and child. | ||
useImperativeHandle(outerRef, () => ref.current, []); | ||
|
||
const child = useMemo(() => React.Children.only(mapChildren(children, isHovered)), [children, isHovered]); | ||
|
||
const onMouseEnter = useCallback( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The method should be named for what it does and never what callback they handle, the same for onMouseLeave and onBlur
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done ✅ |
||
(el) => { | ||
kacper-mikolajczak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
updateIsHoveredOnScrolling(true); | ||
|
||
if (_.isFunction(child.props.onMouseEnter)) { | ||
child.props.onMouseEnter(el); | ||
} | ||
}, | ||
[child.props, updateIsHoveredOnScrolling], | ||
); | ||
|
||
const onMouseLeave = useCallback( | ||
(el) => { | ||
kacper-mikolajczak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
updateIsHoveredOnScrolling(false); | ||
|
||
if (_.isFunction(child.props.onMouseLeave)) { | ||
child.props.onMouseLeave(el); | ||
} | ||
}, | ||
[child.props, updateIsHoveredOnScrolling], | ||
); | ||
|
||
const onBlur = useCallback( | ||
(el) => { | ||
kacper-mikolajczak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// Check if the blur event occurred due to clicking outside the element | ||
// and the wrapperView contains the element that caused the blur and reset isHovered | ||
if (!ref.current.contains(el.target) && !ref.current.contains(el.relatedTarget)) { | ||
setIsHovered(false); | ||
} | ||
|
||
if (_.isFunction(child.props.onBlur)) { | ||
child.props.onBlur(el); | ||
} | ||
}, | ||
[child.props], | ||
); | ||
|
||
this.setIsHovered(false); | ||
if (!DeviceCapabilities.hasHoverSupport()) { | ||
return child; | ||
} | ||
|
||
return React.cloneElement(child, { | ||
|
@@ -155,68 +191,10 @@ class Hoverable extends Component { | |
}); | ||
} | ||
|
||
this.setIsHovered(false); | ||
} | ||
|
||
render() { | ||
let child = this.props.children; | ||
if (_.isArray(this.props.children) && this.props.children.length === 1) { | ||
child = this.props.children[0]; | ||
} | ||
|
||
if (_.isFunction(child)) { | ||
child = child(this.state.isHovered); | ||
} | ||
|
||
if (!DeviceCapabilities.hasHoverSupport()) { | ||
return child; | ||
} | ||
|
||
return React.cloneElement(React.Children.only(child), { | ||
ref: (el) => { | ||
this.wrapperView = el; | ||
|
||
// Call the original ref, if any | ||
const {ref} = child; | ||
if (_.isFunction(ref)) { | ||
ref(el); | ||
return; | ||
} | ||
|
||
if (_.isObject(ref)) { | ||
ref.current = el; | ||
} | ||
}, | ||
onMouseEnter: (el) => { | ||
this.setIsHovered(true); | ||
|
||
if (_.isFunction(child.props.onMouseEnter)) { | ||
child.props.onMouseEnter(el); | ||
} | ||
}, | ||
onMouseLeave: (el) => { | ||
this.setIsHovered(false); | ||
|
||
if (_.isFunction(child.props.onMouseLeave)) { | ||
child.props.onMouseLeave(el); | ||
} | ||
}, | ||
onBlur: (el) => { | ||
// Check if the blur event occurred due to clicking outside the element | ||
// and the wrapperView contains the element that caused the blur and reset isHovered | ||
if (!this.wrapperView.contains(el.target) && !this.wrapperView.contains(el.relatedTarget)) { | ||
this.setIsHovered(false); | ||
} | ||
|
||
if (_.isFunction(child.props.onBlur)) { | ||
child.props.onBlur(el); | ||
} | ||
}, | ||
}); | ||
} | ||
} | ||
const Hoverable = React.forwardRef(InnerHoverable); | ||
|
||
Hoverable.propTypes = propTypes; | ||
Hoverable.defaultProps = defaultProps; | ||
Hoverable.displayName = 'Hoverable'; | ||
|
||
export default Hoverable; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This function could be inside useEffect with mouseover listener as it is not used anywhere else
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done ✅