-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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 KeyboardDismissingFlatList to a functional component #22805
Merged
marcaaron
merged 4 commits into
Expensify:main
from
kosmydel:@swm/refactor-keyboard-dismissing-flat-list
Jul 20, 2023
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,47 @@ | ||
import React, {Component} from 'react'; | ||
import React, {useRef, useEffect, useCallback} from 'react'; | ||
import {FlatList, Keyboard} from 'react-native'; | ||
import * as DeviceCapabilities from '../../libs/DeviceCapabilities'; | ||
|
||
class KeyboardDismissingFlatList extends Component { | ||
constructor(props) { | ||
super(props); | ||
function KeyboardDismissingFlatList(props) { | ||
const isScreenTouched = useRef(false); | ||
|
||
this.touchStart = this.touchStart.bind(this); | ||
this.touchEnd = this.touchEnd.bind(this); | ||
} | ||
const touchStart = () => { | ||
isScreenTouched.current = true; | ||
}; | ||
|
||
componentDidMount() { | ||
const touchEnd = () => { | ||
isScreenTouched.current = false; | ||
}; | ||
|
||
useEffect(() => { | ||
if (!DeviceCapabilities.canUseTouchScreen()) { | ||
return; | ||
} | ||
|
||
// We're setting `isScreenTouched` in this listener only for web platforms with touchscreen (mWeb) where | ||
// we want to dismiss the keyboard only when the list is scrolled by the user and not when it's scrolled programmatically. | ||
document.addEventListener('touchstart', this.touchStart); | ||
kosmydel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
document.addEventListener('touchend', this.touchEnd); | ||
} | ||
document.addEventListener('touchstart', touchStart); | ||
document.addEventListener('touchend', touchEnd); | ||
|
||
componentWillUnmount() { | ||
if (!DeviceCapabilities.canUseTouchScreen()) { | ||
return () => { | ||
document.removeEventListener('touchstart', touchStart); | ||
document.removeEventListener('touchend', touchEnd); | ||
}; | ||
}, []); | ||
|
||
const onScroll = useCallback(() => { | ||
// Only dismiss the keyboard whenever the user scrolls the screen | ||
if (!isScreenTouched.current) { | ||
return; | ||
} | ||
|
||
document.removeEventListener('touchstart', this.touchStart); | ||
document.removeEventListener('touchend', this.touchEnd); | ||
} | ||
|
||
touchStart() { | ||
this.isScreenTouched = true; | ||
} | ||
|
||
touchEnd() { | ||
this.isScreenTouched = false; | ||
} | ||
|
||
render() { | ||
return ( | ||
<FlatList | ||
// eslint-disable-next-line react/jsx-props-no-spreading | ||
{...this.props} | ||
onScroll={() => { | ||
// Only dismiss the keyboard whenever the user scrolls the screen | ||
if (!this.isScreenTouched) { | ||
return; | ||
} | ||
Keyboard.dismiss(); | ||
}} | ||
/> | ||
); | ||
} | ||
Keyboard.dismiss(); | ||
}, []); | ||
|
||
return ( | ||
<FlatList | ||
// eslint-disable-next-line react/jsx-props-no-spreading | ||
{...props} | ||
onScroll={onScroll} | ||
/> | ||
); | ||
} | ||
|
||
export default KeyboardDismissingFlatList; |
Oops, something went wrong.
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.
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.
NAB, I thought maybe it is slightly more correct to have these methods inside the
useEffect()
as only the methods created on first render would ever get used by the event listeners there. Not sure if it matters too much though.