feat: add debounce functionality to TouchableRipple #4828
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -46,6 +46,11 @@ export type Props = PressableProps & { | |||||
| * Function to execute on long press. | ||||||
| */ | ||||||
| onLongPress?: (e: GestureResponderEvent) => void; | ||||||
| /** | ||||||
| * Debounce time in milliseconds to prevent rapid successive presses. | ||||||
| * When set, subsequent onPress calls within this time window will be ignored. | ||||||
| */ | ||||||
| debounce?: number; | ||||||
| /** | ||||||
| * Function to execute immediately when a touch is engaged, before `onPressOut` and `onPress`. | ||||||
| */ | ||||||
|
|
@@ -93,6 +98,7 @@ export type Props = PressableProps & { | |||||
| * <TouchableRipple | ||||||
| * onPress={() => console.log('Pressed')} | ||||||
| * rippleColor="rgba(0, 0, 0, .32)" | ||||||
| * debounce={300} // Prevent double-clicks within 300ms | ||||||
| * > | ||||||
| * <Text>Press anywhere</Text> | ||||||
| * </TouchableRipple> | ||||||
|
|
@@ -113,6 +119,7 @@ const TouchableRipple = ( | |||||
| underlayColor: _underlayColor, | ||||||
| children, | ||||||
| theme: themeOverrides, | ||||||
| debounce, | ||||||
| ...rest | ||||||
| }: Props, | ||||||
| ref: React.ForwardedRef<View> | ||||||
|
|
@@ -126,6 +133,24 @@ const TouchableRipple = ( | |||||
| const { rippleEffectEnabled } = React.useContext<Settings>(SettingsContext); | ||||||
|
|
||||||
| const { onPress, onLongPress, onPressIn, onPressOut } = rest; | ||||||
| const lastPressTime = React.useRef<number>(0); | ||||||
|
|
||||||
| const debouncedOnPress = React.useCallback( | ||||||
| (e: GestureResponderEvent) => { | ||||||
| if (!onPress) return; | ||||||
|
|
||||||
| if (debounce && debounce > 0) { | ||||||
| const now = Date.now(); | ||||||
| if (now - lastPressTime.current < debounce) { | ||||||
| return; // Ignore this press as it's within the debounce window | ||||||
| } | ||||||
| lastPressTime.current = now; | ||||||
| } | ||||||
|
|
||||||
| onPress(e); | ||||||
| }, | ||||||
| [onPress, debounce] | ||||||
| ); | ||||||
|
|
||||||
| const handlePressIn = React.useCallback( | ||||||
| (e: any) => { | ||||||
|
|
@@ -273,10 +298,11 @@ const TouchableRipple = ( | |||||
| <Pressable | ||||||
| {...rest} | ||||||
| ref={ref} | ||||||
| onPress={debouncedOnPress} | ||||||
| onPressIn={handlePressIn} | ||||||
| onPressOut={handlePressOut} | ||||||
| disabled={disabled} | ||||||
| style={(state: PressableStateCallbackType) => [ | ||||||
|
There was a problem hiding this comment. [nitpick] Adding explicit type annotation here is unnecessary since TypeScript can infer the type from the Pressable component's props. This change adds no value and increases verbosity. Consider removing the type annotation unless there's a specific type inference issue. |
||||||
| styles.touchable, | ||||||
| borderless && styles.borderless, | ||||||
| // focused state is not ready yet: https://github.com/necolas/react-native-web/issues/1849 | ||||||
|
|
@@ -286,7 +312,7 @@ const TouchableRipple = ( | |||||
| typeof style === 'function' ? style(state) : style, | ||||||
| ]} | ||||||
| > | ||||||
| {(state: PressableStateCallbackType) => | ||||||
|
There was a problem hiding this comment. [nitpick] Adding explicit type annotation here is unnecessary since TypeScript can infer the type from the Pressable component's children render prop. This change adds no value and increases verbosity. Consider removing the type annotation unless there's a specific type inference issue.
Suggested change
|
||||||
| React.Children.only( | ||||||
| typeof children === 'function' ? children(state) : children | ||||||
| ) | ||||||
|
|
||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,54 @@ describe('TouchableRipple', () => { | |
| expect(onPress).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it('debounces onPress when debounce prop is provided', () => { | ||
| jest.useFakeTimers(); | ||
| const onPress = jest.fn(); | ||
| const { getByText } = render( | ||
| <TouchableRipple onPress={onPress} debounce={300}> | ||
| <Text>Button</Text> | ||
| </TouchableRipple> | ||
| ); | ||
|
|
||
| const button = getByText('Button'); | ||
|
|
||
| // Press multiple times rapidly | ||
| fireEvent.press(button); | ||
| fireEvent.press(button); | ||
| fireEvent.press(button); | ||
|
|
||
| // Should only be called once due to debouncing | ||
| expect(onPress).toHaveBeenCalledTimes(1); | ||
|
|
||
| // Fast forward time past debounce window | ||
| jest.advanceTimersByTime(400); | ||
|
There was a problem hiding this comment. The test advances timers by 400ms, but the debounce implementation uses |
||
|
|
||
| // Now pressing should work again | ||
| fireEvent.press(button); | ||
| expect(onPress).toHaveBeenCalledTimes(2); | ||
|
|
||
| jest.useRealTimers(); | ||
| }); | ||
|
There was a problem hiding this comment. Bug: Unmocked Time Improves Debounce Testing ReliabilityThe debounce test uses |
||
|
|
||
| it('does not debounce when debounce is not provided', () => { | ||
| const onPress = jest.fn(); | ||
| const { getByText } = render( | ||
| <TouchableRipple onPress={onPress}> | ||
| <Text>Button</Text> | ||
| </TouchableRipple> | ||
| ); | ||
|
|
||
| const button = getByText('Button'); | ||
|
|
||
| // Press multiple times rapidly | ||
| fireEvent.press(button); | ||
| fireEvent.press(button); | ||
| fireEvent.press(button); | ||
|
|
||
| // Should be called for each press | ||
| expect(onPress).toHaveBeenCalledTimes(3); | ||
| }); | ||
|
|
||
| it('disables the button when disabled prop is true', () => { | ||
| const onPress = jest.fn(); | ||
| const { getByText } = render( | ||
|
|
||
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.
[nitpick] Adding inline type annotation for a destructured parameter is unnecessarily verbose. TypeScript can infer this type from the Pressable component's children render prop. Consider removing the type annotation unless there's a specific type inference issue.