UNPKG

1.3 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 checkbox.
20 */
21 color?: string;
22 /**
23 * @optional
24 */
25 theme?: ThemeProp;
26 /**
27 * testID to be used on tests.
28 */
29 testID?: string;
30};
31/**
32 * Checkboxes allow the selection of multiple options from a set.
33 * This component follows platform guidelines for iOS, but can be used
34 * on any platform.
35 *
36 * @extends TouchableRipple props https://callstack.github.io/react-native-paper/docs/components/TouchableRipple
37 */
38declare const CheckboxIOS: {
39 ({ status, disabled, onPress, theme: themeOverrides, testID, ...rest }: Props): React.JSX.Element;
40 displayName: string;
41};
42export default CheckboxIOS;
43export { CheckboxIOS };
44//# sourceMappingURL=CheckboxIOS.d.ts.map
\No newline at end of file