react-native-paper
Version:
Material design for React Native
90 lines (89 loc) • 4.33 kB
TypeScript
import * as React from 'react';
import { StyleProp, TextStyle, ViewStyle } from 'react-native';
declare type Props = {
/**
* Status of checkbox.
*/
status: 'checked' | 'unchecked' | 'indeterminate';
/**
* Whether checkbox is disabled.
*/
disabled?: boolean;
/**
* Label to be displayed on the item.
*/
label: string;
/**
* Function to execute on press.
*/
onPress?: () => void;
/**
* Custom color for unchecked checkbox.
*/
uncheckedColor?: string;
/**
* Custom color for checkbox.
*/
color?: string;
/**
* Additional styles for container View.
*/
style?: StyleProp<ViewStyle>;
/**
* Style that is passed to Label element.
*/
labelStyle?: StyleProp<TextStyle>;
/**
* @optional
*/
theme: ReactNativePaper.Theme;
/**
* testID to be used on tests.
*/
testID?: string;
/**
* Checkbox control position. Default is `trailing`.
*/
position?: 'leading' | 'trailing';
/**
* Whether `<Checkbox.Android />` or `<Checkbox.IOS />` should be used.
* Left undefined `<Checkbox />` will be used.
*/
mode?: 'android' | 'ios';
};
declare const _default: (React.ComponentClass<Pick<Props, "label" | "style" | "color" | "onPress" | "testID" | "position" | "labelStyle" | "disabled" | "mode" | "status" | "uncheckedColor"> & {
theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
}, any> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<(React.ComponentClass<Props, any> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}) | (React.FunctionComponent<Props> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}), {}>) | (React.FunctionComponent<Pick<Props, "label" | "style" | "color" | "onPress" | "testID" | "position" | "labelStyle" | "disabled" | "mode" | "status" | "uncheckedColor"> & {
theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
}> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<(React.ComponentClass<Props, any> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}) | (React.FunctionComponent<Props> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}), {}>);
export default _default;
declare const CheckboxItemWithTheme: (React.ComponentClass<Pick<Props, "label" | "style" | "color" | "onPress" | "testID" | "position" | "labelStyle" | "disabled" | "mode" | "status" | "uncheckedColor"> & {
theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
}, any> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<(React.ComponentClass<Props, any> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}) | (React.FunctionComponent<Props> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}), {}>) | (React.FunctionComponent<Pick<Props, "label" | "style" | "color" | "onPress" | "testID" | "position" | "labelStyle" | "disabled" | "mode" | "status" | "uncheckedColor"> & {
theme?: import("@callstack/react-theme-provider").$DeepPartial<ReactNativePaper.Theme> | undefined;
}> & import("@callstack/react-theme-provider/typings/hoist-non-react-statics").NonReactStatics<(React.ComponentClass<Props, any> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}) | (React.FunctionComponent<Props> & {
({ style, status, label, onPress, labelStyle, theme, testID, mode, position, ...props }: Props): JSX.Element;
displayName: string;
}), {}>);
export { CheckboxItemWithTheme as CheckboxItem };