Reference version

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

Expo Checkbox

A universal React component that provides basic checkbox functionality.

Android
iOS
tvOS
Web
Included in Expo Go

For the complete documentation index, see llms.txt. Use this Use this file to discover all available pages.

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

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

API

import { Checkbox } from 'expo-checkbox';

Component

Checkbox

Android
iOS
tvOS
Web

Type: React.Element<CheckboxProps>

CheckboxProps

color

Android
iOS
tvOS
Web
Optional • Type: ColorValue

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

disabled

Android
iOS
tvOS
Web
Optional • Type: boolean

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

onChange

Android
iOS
tvOS
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
tvOS
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
tvOS
Web
Optional • Type: boolean • Default: false

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

Inherited Props

Types

CheckboxEvent

Android
iOS
tvOS
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.