UNPKG

1.41 kBTypeScriptView Raw
1import * as React from 'react';
2import { GestureResponderEvent } from 'react-native';
3import type { $RemoveChildren, ThemeProp } from '../../types';
4import TouchableRipple from '../TouchableRipple/TouchableRipple';
5export declare type Props = $RemoveChildren<typeof TouchableRipple> & {
6 /**
7 * Status of checkbox.
8 */
9 status: 'checked' | 'unchecked' | 'indeterminate';
10 /**
11 * Whether checkbox is disabled.
12 */
13 disabled?: boolean;
14 /**
15 * Function to execute on press.
16 */
17 onPress?: (e: GestureResponderEvent) => void;
18 /**
19 * Custom color for unchecked checkbox.
20 */
21 uncheckedColor?: string;
22 /**
23 * Custom color for checkbox.
24 */
25 color?: string;
26 /**
27 * @optional
28 */
29 theme?: ThemeProp;
30 /**
31 * testID to be used on tests.
32 */
33 testID?: string;
34};
35/**
36 * Checkboxes allow the selection of multiple options from a set.
37 * This component follows platform guidelines for Android, but can be used
38 * on any platform.
39 *
40 * @extends TouchableRipple props https://callstack.github.io/react-native-paper/docs/components/TouchableRipple
41 */
42declare const CheckboxAndroid: {
43 ({ status, theme: themeOverrides, disabled, onPress, testID, ...rest }: Props): React.JSX.Element;
44 displayName: string;
45};
46export default CheckboxAndroid;
47export { CheckboxAndroid };
48//# sourceMappingURL=CheckboxAndroid.d.ts.map
\No newline at end of file