Skip to content
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
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 32 additions & 43 deletions src/components/KeyboardDismissingFlatList/index.js
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;
};

Copy link
Contributor

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.

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;
Loading