Skip to content

Fix android ripple color bug on fabric #3369

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.

Sign up for GitHub

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

Merged
latekvo merged 15 commits into from
Feb 3, 2025
Merged

Fix android ripple color bug on fabric #3369

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
389ec11
fix ripple color on Pressable
latekvo Jan 31, 2025
3e9ac80
remove duplicate function
latekvo Jan 31, 2025
d42cefd
add fabric checking to base button
latekvo Jan 31, 2025
d461b40
add proper typing to RawButton
latekvo Jan 31, 2025
f7d895d
adjust name
latekvo Jan 31, 2025
4e8dce8
remove unnecessary lint ignore
latekvo Jan 31, 2025
286ead3
memoize ripple color and default ripple color
latekvo Jan 31, 2025
a9d2031
merge both useMemo
latekvo Jan 31, 2025
1224637
Merge branch 'main' into @latekvo/fix-ripple-color-bug-on-fabric
latekvo Feb 3, 2025
ff48533
memo isFabric
latekvo Feb 3, 2025
2513b9e
fix working in `BaseButton`
latekvo Feb 3, 2025
2ff4683
change function to value
latekvo Feb 3, 2025
d62793c
add fabric value caching to BaseButton
latekvo Feb 3, 2025
15e1841
Merge branch 'main' into @latekvo/fix-ripple-color-bug-on-fabric
latekvo Feb 3, 2025
f8b2de5
simplify IS_FABRIC logic in Pressable
latekvo Feb 3, 2025
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
7 changes: 6 additions & 1 deletion src/components/GestureButtons.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import type {
BorderlessButtonWithRefProps,
BorderlessButtonProps,
} from './GestureButtonsProps';
import { isFabric } from '../utils';

export const RawButton = createNativeWrapper(GestureHandlerButton, {
shouldCancelWhenOutside: false,
Expand Down Expand Up @@ -122,10 +123,14 @@ class InnerBaseButton extends React.Component<BaseButtonWithRefProps> {
render() {
const { rippleColor, style, ...rest } = this.props;

const processedRippleColor = isFabric()
Copy link
Contributor

@m-bert m-bert Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about maybeProcessedRippleColor?

Copy link
Contributor

@m-bert m-bert Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, why don't we memoize value of isFabric instead of calling this everytime?

Copy link
Member Author

@latekvo latekvo Feb 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about maybeProcessedRippleColor?

Not a big fan of that name, the word processed already allows for lack of change.
But I agree that processed may be confusing due to processColor() function.
Maybe this will do better:
rippleColor -> unprocessedRippleColor
processedRippleColor -> rippleColor
?

Also, why don't we memoize value of isFabric instead of calling this everytime?

Sure, done in ff48533

Copy link
Contributor

@m-bert m-bert Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, done in ff48533

Not exactly what I meant. I thought about storing it in a variable. Now we still call function in each render.

Maybe this will do better:
rippleColor -> unprocessedRippleColor
processedRippleColor -> rippleColor

Looks good 👍

Copy link
Member Author

@latekvo latekvo Feb 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not exactly what I meant. I thought about storing it in a variable. Now we still call function in each render.

Done for BaseButton in d62793c

Changed useCallback to useMemo in 2ff4683

If you're referring to storing IS_FABRIC outside of the Pressable, we can't do that, isFabric() will return incorrect data outside of the function component, as the value it reads will not be initialised before the first render.

Copy link
Member Author

@latekvo latekvo Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

Done in 2513b9e

? rippleColor
: processColor(rippleColor ?? undefined);

return (
<RawButton
ref={this.props.innerRef}
rippleColor={processColor(rippleColor)}
rippleColor={processedRippleColor}
style={[style, Platform.OS === 'ios' && { cursor: undefined }]}
{...rest}
onGestureEvent={this.onGestureEvent}
Expand Down
9 changes: 7 additions & 2 deletions src/components/GestureButtonsProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import * as React from 'react';
import { AccessibilityProps, StyleProp, ViewStyle } from 'react-native';
import {
AccessibilityProps,
ColorValue,
StyleProp,
ViewStyle,
} from 'react-native';
import type { NativeViewGestureHandlerProps } from '../handlers/NativeViewGestureHandler';

export interface RawButtonProps
Expand All @@ -16,7 +21,7 @@ export interface RawButtonProps
*
* Defines color of native ripple animation used since API level 21.
*/
rippleColor?: any; // it was present in BaseButtonProps before but is used here in code
rippleColor?: number | ColorValue | null;

/**
* Android only.
Expand Down
14 changes: 10 additions & 4 deletions src/components/Pressable/Pressable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
} from './utils';
import { PressabilityDebugView } from '../../handlers/PressabilityDebugView';
import { GestureTouchEvent } from '../../handlers/gestureHandlerCommon';
import { INT32_MAX } from '../../utils';
import { INT32_MAX, isFabric } from '../../utils';

const DEFAULT_LONG_PRESS_DURATION = 500;

Expand Down Expand Up @@ -366,8 +366,6 @@ export default function Pressable(props: PressableProps) {

const gesture = Gesture.Simultaneous(...gestures);

const defaultRippleColor = android_ripple ? undefined : 'transparent';

// `cursor: 'pointer'` on `RNButton` crashes iOS
const pointerStyle: StyleProp<ViewStyle> =
Platform.OS === 'web' ? { cursor: 'pointer' } : {};
Expand All @@ -380,6 +378,14 @@ export default function Pressable(props: PressableProps) {
? children({ pressed: pressedState })
: children;

const rippleColor = useMemo(() => {
const defaultRippleColor = android_ripple ? undefined : 'transparent';
const unprocessedRippleColor = android_ripple?.color ?? defaultRippleColor;
Comment on lines +389 to +390
Copy link
Contributor

@m-bert m-bert Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't it be

const unprocessedRippleColor = android_ripple?.color ?? 'transparent';

?

I don't really see the point of defaultRippleColor in that case.

Copy link
Member Author

@latekvo latekvo Feb 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defaultRippleColor is required to properly replicate the behaviour of RN Pressable.
When android_ripple is set, but the color field is not provided, we want to set color to undefined, so that it uses the default system value (opaque whiteish).
When android_ripple is not set, we want to remove the ripple altogether, which is done via 'transparent'.

return isFabric()
? unprocessedRippleColor
: processColor(unprocessedRippleColor);
}, [android_ripple]);

return (
<GestureDetector gesture={gesture}>
<NativeButton
Expand All @@ -388,7 +394,7 @@ export default function Pressable(props: PressableProps) {
hitSlop={appliedHitSlop}
enabled={isPressableEnabled}
touchSoundDisabled={android_disableSound ?? undefined}
rippleColor={processColor(android_ripple?.color ?? defaultRippleColor)}
rippleColor={rippleColor}
rippleRadius={android_ripple?.radius ?? undefined}
style={[pointerStyle, styleProp]}>
{childrenProp}
Expand Down
Loading