react-native-paper
Version:
Material design for React Native
62 lines • 1.51 kB
TypeScript
import * as React from 'react';
import { GestureResponderEvent } from 'react-native';
import type { ThemeProp } from '../../types';
export type Props = {
/**
* Status of checkbox.
*/
status: 'checked' | 'unchecked' | 'indeterminate';
/**
* Whether checkbox is disabled.
*/
disabled?: boolean;
/**
* Function to execute on press.
*/
onPress?: (e: GestureResponderEvent) => void;
/**
* Custom color for unchecked checkbox.
*/
uncheckedColor?: string;
/**
* Custom color for checkbox.
*/
color?: string;
/**
* @optional
*/
theme?: ThemeProp;
/**
* testID to be used on tests.
*/
testID?: string;
};
/**
* Checkboxes allow the selection of multiple options from a set.
*
* ## Usage
* ```js
* import * as React from 'react';
* import { Checkbox } from 'react-native-paper';
*
* const MyComponent = () => {
* const [checked, setChecked] = React.useState(false);
*
* return (
* <Checkbox
* status={checked ? 'checked' : 'unchecked'}
* onPress={() => {
* setChecked(!checked);
* }}
* />
* );
* };
*
* export default MyComponent;
* ```
*/
declare const Checkbox: ({ theme: themeOverrides, ...props }: Props) => React.JSX.Element;
export default Checkbox;
declare const CheckboxWithTheme: ({ theme: themeOverrides, ...props }: Props) => React.JSX.Element;
export { CheckboxWithTheme as Checkbox };
//# sourceMappingURL=Checkbox.d.ts.map