import * as React from 'react'; import { Animated, ColorValue, GestureResponderEvent, Pressable, StyleProp, StyleSheet, TextStyle, View, ViewStyle, } from 'react-native'; import { useSafeAreaInsets } from 'react-native-safe-area-context'; import FAB from './FAB'; import { getFABGroupColors } from './utils'; import { useInternalTheme } from '../../core/theming'; import type { ThemeProp } from '../../types'; import Card from '../Card/Card'; import type { IconSource } from '../Icon'; import Text from '../Typography/Text'; const AnimatedPressable = Animated.createAnimatedComponent(Pressable); export type Props = { /** * Action items to display in the form of a speed dial. * An action item should contain the following properties: * - `icon`: icon to display (required) * - `label`: optional label text * - `color`: custom icon color of the action item * - `labelTextColor`: custom label text color of the action item * - `accessibilityLabel`: accessibility label for the action, uses label by default if specified * - `accessibilityHint`: accessibility hint for the action * - `style`: pass additional styles for the fab item, for example, `backgroundColor` * - `containerStyle`: pass additional styles for the fab item label container, for example, `backgroundColor` @supported Available in 5.x * - `labelStyle`: pass additional styles for the fab item label, for example, `fontSize` * - `labelMaxFontSizeMultiplier`: specifies the largest possible scale a title font can reach. * - `onPress`: callback that is called when `FAB` is pressed (required) * - `onLongPress`: callback that is called when `FAB` is long pressed * - `toggleStackOnLongPress`: callback that is called when `FAB` is long pressed * - `size`: size of action item. Defaults to `small`. @supported Available in v5.x * - `testID`: testID to be used on tests * - `rippleColor`: color of the ripple effect. */ actions: Array<{ icon: IconSource; label?: string; color?: string; labelTextColor?: string; accessibilityLabel?: string; accessibilityHint?: string; style?: Animated.WithAnimatedValue>; containerStyle?: Animated.WithAnimatedValue>; labelStyle?: StyleProp; labelMaxFontSizeMultiplier?: number; onPress: (e: GestureResponderEvent) => void; size?: 'small' | 'medium'; testID?: string; rippleColor?: ColorValue; }>; /** * Icon to display for the `FAB`. * You can toggle it based on whether the speed dial is open to display a different icon. */ icon: IconSource; /** * Accessibility label for the FAB. This is read by the screen reader when the user taps the FAB. */ accessibilityLabel?: string; /** * Custom color for the `FAB`. */ color?: string; /** * Custom backdrop color for opened speed dial background. */ backdropColor?: string; /** * Color of the ripple effect. */ rippleColor?: ColorValue; /** * Function to execute on pressing the `FAB`. */ onPress?: (e: GestureResponderEvent) => void; /** * Function to execute on long pressing the `FAB`. */ onLongPress?: (e: GestureResponderEvent) => void; /** * Makes actions stack appear on long press instead of on press. */ toggleStackOnLongPress?: boolean; /** * Changes the delay for long press reaction. */ delayLongPress?: number; /** * Allows for onLongPress when stack is opened. */ enableLongPressWhenStackOpened?: boolean; /** * Whether the speed dial is open. */ open: boolean; /** * Callback which is called on opening and closing the speed dial. * The open state needs to be updated when it's called, otherwise the change is dropped. */ onStateChange: (state: { open: boolean }) => void; /** * Whether `FAB` is currently visible. */ visible: boolean; /** * Style for the group. You can use it to pass additional styles if you need. * For example, you can set an additional padding if you have a tab bar at the bottom. */ style?: StyleProp; /** * Style for the FAB. It allows to pass the FAB button styles, such as backgroundColor. */ fabStyle?: Animated.WithAnimatedValue>; /** * @supported Available in v5.x with theme version 3 * * Color mappings variant for combinations of container and icon colors. */ variant?: 'primary' | 'secondary' | 'tertiary' | 'surface'; /** * @optional */ theme?: ThemeProp; /** * Optional label for `FAB`. */ label?: string; /** * Pass down testID from Group props to FAB. */ testID?: string; }; /** * A component to display a stack of FABs with related actions in a speed dial. * To render the group above other components, you'll need to wrap it with the [`Portal`](../Portal) component. * * ## Usage * ```js * import * as React from 'react'; * import { FAB, Portal, PaperProvider } from 'react-native-paper'; * * const MyComponent = () => { * const [state, setState] = React.useState({ open: false }); * * const onStateChange = ({ open }) => setState({ open }); * * const { open } = state; * * return ( * * * console.log('Pressed add') }, * { * icon: 'star', * label: 'Star', * onPress: () => console.log('Pressed star'), * }, * { * icon: 'email', * label: 'Email', * onPress: () => console.log('Pressed email'), * }, * { * icon: 'bell', * label: 'Remind', * onPress: () => console.log('Pressed notifications'), * }, * ]} * onStateChange={onStateChange} * onPress={() => { * if (open) { * // do something if the speed dial is open * } * }} * /> * * * ); * }; * * export default MyComponent; * ``` */ const FABGroup = ({ actions, icon, open, onPress, onLongPress, toggleStackOnLongPress, accessibilityLabel, theme: themeOverrides, style, fabStyle, visible, label, testID, onStateChange, color: colorProp, delayLongPress = 200, variant = 'primary', enableLongPressWhenStackOpened = false, backdropColor: customBackdropColor, rippleColor, }: Props) => { const theme = useInternalTheme(themeOverrides); const { current: backdrop } = React.useRef( new Animated.Value(0) ); const animations = React.useRef( actions.map(() => new Animated.Value(open ? 1 : 0)) ); const [prevActions, setPrevActions] = React.useState< | { icon: IconSource; label?: string; color?: string; accessibilityLabel?: string; style?: Animated.WithAnimatedValue>; onPress: (e: GestureResponderEvent) => void; testID?: string; }[] | null >(null); const { scale } = theme.animation; const { isV3 } = theme; React.useEffect(() => { if (open) { Animated.parallel([ Animated.timing(backdrop, { toValue: 1, duration: 250 * scale, useNativeDriver: true, }), Animated.stagger( isV3 ? 15 : 50 * scale, animations.current .map((animation) => Animated.timing(animation, { toValue: 1, duration: 150 * scale, useNativeDriver: true, }) ) .reverse() ), ]).start(); } else { Animated.parallel([ Animated.timing(backdrop, { toValue: 0, duration: 200 * scale, useNativeDriver: true, }), ...animations.current.map((animation) => Animated.timing(animation, { toValue: 0, duration: 150 * scale, useNativeDriver: true, }) ), ]).start(); } }, [open, actions, backdrop, scale, isV3]); const close = () => onStateChange({ open: false }); const toggle = () => onStateChange({ open: !open }); const { labelColor, backdropColor, stackedFABBackgroundColor } = getFABGroupColors({ theme, customBackdropColor }); const backdropOpacity = open ? backdrop.interpolate({ inputRange: [0, 0.5, 1], outputRange: [0, 1, 1], }) : backdrop; const opacities = animations.current; const scales = opacities.map((opacity) => open ? opacity.interpolate({ inputRange: [0, 1], outputRange: [0.5, 1], }) : 1 ); const translations = opacities.map((opacity) => open ? opacity.interpolate({ inputRange: [0, 1], outputRange: [24, -8], }) : -8 ); const labelTranslations = opacities.map((opacity) => open ? opacity.interpolate({ inputRange: [0, 1], outputRange: [8, -8], }) : -8 ); const { top, bottom, right, left } = useSafeAreaInsets(); const containerPaddings = { paddingBottom: bottom, paddingRight: right, paddingLeft: left, paddingTop: top, }; if (actions.length !== prevActions?.length) { animations.current = actions.map( (_, i) => animations.current[i] || new Animated.Value(open ? 1 : 0) ); setPrevActions(actions); } return ( {actions.map((it, i) => { const labelTextStyle = { color: it.labelTextColor ?? labelColor, ...(isV3 ? theme.fonts.titleMedium : {}), }; const marginHorizontal = typeof it.size === 'undefined' || it.size === 'small' ? 24 : 16; const accessibilityLabel = typeof it.accessibilityLabel !== 'undefined' ? it.accessibilityLabel : it.label; const size = typeof it.size !== 'undefined' ? it.size : 'small'; return ( {it.label && ( { it.onPress(e); close(); }} accessibilityHint={it.accessibilityHint} importantForAccessibility="no-hide-descendants" accessibilityElementsHidden={true} style={[ styles.containerStyle, { transform: [ isV3 ? { translateY: labelTranslations[i] } : { scale: scales[i] }, ], opacity: opacities[i], }, isV3 && styles.v3ContainerStyle, it.containerStyle, ]} > {it.label} )} { it.onPress(e); close(); }} importantForAccessibility="no-hide-descendants" testID={it.testID} visible={open} rippleColor={it.rippleColor} /> ); })} { onPress?.(e); if (!toggleStackOnLongPress || open) { toggle(); } }} onLongPress={(e) => { if (!open || enableLongPressWhenStackOpened) { onLongPress?.(e); if (toggleStackOnLongPress) { toggle(); } } }} delayLongPress={delayLongPress} icon={icon} color={colorProp} accessibilityLabel={accessibilityLabel} accessibilityRole="button" accessibilityState={{ expanded: open }} style={[styles.fab, fabStyle]} theme={theme} visible={visible} label={label} testID={testID} variant={variant} rippleColor={rippleColor} /> ); }; FABGroup.displayName = 'FAB.Group'; export default FABGroup; // @component-docs ignore-next-line export { FABGroup }; const styles = StyleSheet.create({ safeArea: { alignItems: 'flex-end', }, container: { ...StyleSheet.absoluteFillObject, justifyContent: 'flex-end', }, fab: { marginHorizontal: 16, marginBottom: 16, marginTop: 0, }, backdrop: { ...StyleSheet.absoluteFillObject, }, containerStyle: { borderRadius: 5, paddingHorizontal: 12, paddingVertical: 6, marginVertical: 8, marginHorizontal: 16, elevation: 2, }, item: { marginBottom: 16, flexDirection: 'row', justifyContent: 'flex-end', alignItems: 'center', }, // eslint-disable-next-line react-native/no-color-literals v3ContainerStyle: { backgroundColor: 'transparent', elevation: 0, }, });