Expo 复选框

一个通用的 React 组件,提供基本的复选框功能。

Android
iOS
Web

expo-checkbox 为所有平台提供基本的 boolean 输入元素。

¥expo-checkbox provides a basic boolean input element for all platforms.

安装

¥Installation

Terminal
npx expo install expo-checkbox

用法

¥Usage

Basic Checkbox usage
import Checkbox from 'expo-checkbox';
import { useState } from 'react';
import { StyleSheet, Text, View } from 'react-native';

export default function App() {
const [isChecked, setChecked] = useState(false);

return (
  <View style={styles.container}>
    <View style={styles.section}>
      <Checkbox style={styles.checkbox} value={isChecked} onValueChange={setChecked} />
      <Text style={styles.paragraph}>Normal checkbox</Text>
    </View>
    <View style={styles.section}>
      <Checkbox
        style={styles.checkbox}
        value={isChecked}
        onValueChange={setChecked}
        color={isChecked ? '#4630EB' : undefined}
      />
      <Text style={styles.paragraph}>Custom colored checkbox</Text>
    </View>
    <View style={styles.section}>
      <Checkbox style={styles.checkbox} disabled value={isChecked} onValueChange={setChecked} />
      <Text style={styles.paragraph}>Disabled checkbox</Text>
    </View>
  </View>
);
}

const styles = StyleSheet.create({
container: {
  flex: 1,
  marginHorizontal: 16,
  marginVertical: 32,
},
section: {
  flexDirection: 'row',
  alignItems: 'center',
},
paragraph: {
  fontSize: 15,
},
checkbox: {
  margin: 8,
},
});

API

import Checkbox from 'expo-checkbox';

Component

Checkbox

Android
iOS
Web

Type: React.Element<CheckboxProps>

CheckboxProps

color

Android
iOS
Web
Optional • Type: ColorValue

The tint or color of the checkbox. This overrides the disabled opaque style.

disabled

Android
iOS
Web
Optional • Type: boolean

If the checkbox is disabled, it becomes opaque and uncheckable.

onChange

Android
iOS
Web
Optional • Type: (event: NativeSyntheticEvent<CheckboxEvent> | SyntheticEvent<HTMLInputElement, CheckboxEvent>) => void

Callback that is invoked when the user presses the checkbox.

event: NativeSyntheticEvent<CheckboxEvent> | SyntheticEvent<HTMLInputElement, CheckboxEvent>

A native event containing the checkbox change.

onValueChange

Android
iOS
Web
Optional • Type: (value: boolean) => void

Callback that is invoked when the user presses the checkbox.

value: boolean

A boolean indicating the new checked state of the checkbox.

value

Android
iOS
Web
Optional • Type: boolean • Default: false

Value indicating if the checkbox should be rendered as checked or not.

Inherited Props

Types

CheckboxEvent

Android
iOS
Web
PropertyTypeDescription
targetany

On native platforms, a NodeHandle for the element on which the event has occurred. On web, a DOM node on which the event has occurred.

valueboolean

A boolean representing checkbox current value.