Merge pull request Expensify#30074 from software-mansion-labs/ts-migr…

…ation/opacity-view-component

[TS migration] Migrate 'OpacityView.js' component to TypeScript

src/components/OpacityView.tsx

@@ -0,0 +1,55 @@
+import React from 'react';
+import {StyleProp, ViewStyle} from 'react-native';
+import Animated, {AnimatedStyle, useAnimatedStyle, useSharedValue, withTiming} from 'react-native-reanimated';
+import shouldRenderOffscreen from '@libs/shouldRenderOffscreen';
+import variables from '@styles/variables';
+
+type OpacityViewProps = {
+    /** Should we dim the view */
+    shouldDim: boolean;
+
+    /** Content to render */
+    children: React.ReactNode;
+
+    /**
+     * Array of style objects
+     * @default []
+     */
+    style?: StyleProp<AnimatedStyle<ViewStyle>>;
+
+    /**
+     * The value to use for the opacity when the view is dimmed
+     * @default variables.hoverDimValue
+     */
+    dimmingValue?: number;
+
+    /** Whether the view needs to be rendered offscreen (for Android only) */
+    needsOffscreenAlphaCompositing?: boolean;
+};
+
+function OpacityView({shouldDim, children, style = [], dimmingValue = variables.hoverDimValue, needsOffscreenAlphaCompositing = false}: OpacityViewProps) {
+    const opacity = useSharedValue(1);
+    const opacityStyle = useAnimatedStyle(() => ({
+        opacity: opacity.value,
+    }));
+
+    React.useEffect(() => {
+        if (shouldDim) {
+            opacity.value = withTiming(dimmingValue, {duration: 50});
+        } else {
+            opacity.value = withTiming(1, {duration: 50});
+        }
+    }, [shouldDim, dimmingValue, opacity]);
+
+    return (
+        <Animated.View
+            style={[opacityStyle, style]}
+            needsOffscreenAlphaCompositing={shouldRenderOffscreen ? needsOffscreenAlphaCompositing : undefined}
+        >
+            {children}
+        </Animated.View>
+    );
+}
+
+OpacityView.displayName = 'OpacityView';
+export default OpacityView;