This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 57).

Expo Checkbox

A universal React component that provides basic checkbox functionality.

Android

iOS

tvOS

Web

Included in Expo Go

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

Installation

Terminal

- npx expo install expo-checkbox

- yarn expo install expo-checkbox

- pnpm expo install expo-checkbox

- bun 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,
  },
});

An example of how expo-checkbox appears on Android and iOS is shown below:

API

import { Checkbox } from 'expo-checkbox';

No API data file found, sorry!