UNPKG

1.51 kBTypeScriptView Raw
1import * as React from 'react';
2import type { Animated, GestureResponderEvent, StyleProp, View, ViewStyle } from 'react-native';
3import type { $Omit } from './../../types';
4import AppbarAction from './AppbarAction';
5export type Props = $Omit<React.ComponentPropsWithoutRef<typeof AppbarAction>, 'icon'> & {
6 /**
7 * Custom color for back icon.
8 */
9 color?: string;
10 /**
11 * Optional icon size.
12 */
13 size?: number;
14 /**
15 * Whether the button is disabled. A disabled button is greyed out and `onPress` is not called on touch.
16 */
17 disabled?: boolean;
18 /**
19 * Accessibility label for the button. This is read by the screen reader when the user taps the button.
20 */
21 accessibilityLabel?: string;
22 /**
23 * Function to execute on press.
24 */
25 onPress?: (e: GestureResponderEvent) => void;
26 style?: Animated.WithAnimatedValue<StyleProp<ViewStyle>>;
27 ref?: React.RefObject<View>;
28};
29/**
30 * A component used to display a back button in the appbar.
31 *
32 * ## Usage
33 * ```js
34 * import * as React from 'react';
35 * import { Appbar } from 'react-native-paper';
36 *
37 * const MyComponent = () => (
38 * <Appbar.Header>
39 * <Appbar.BackAction onPress={() => {}} />
40 * </Appbar.Header>
41 * );
42 *
43 * export default MyComponent;
44 * ```
45 */
46declare const AppbarBackAction: import("../../utils/forwardRef").ForwardRefComponent<View, Props>;
47export default AppbarBackAction;
48export { AppbarBackAction };
49//# sourceMappingURL=AppbarBackAction.d.ts.map
\No newline at end of file