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

Checkbox

A toggle control that represents a checked or unchecked state.

Android

iOS

Web

Included in Expo Go

A controlled checkbox. Pair value with onValueChange to manage state from React.

Installation

Terminal

- npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Basic checkbox

CheckboxExample.tsx

import { useState } from 'react';
import { Host, Checkbox } from '@expo/ui';

export default function CheckboxExample() {
  const [accepted, setAccepted] = useState(false);

  return (
    <Host matchContents>
      <Checkbox label="I accept the terms" value={accepted} onValueChange={setAccepted} />
    </Host>
  );
}

Disabled

DisabledCheckboxExample.tsx

import { Host, Checkbox } from '@expo/ui';

export default function DisabledCheckboxExample() {
  return (
    <Host matchContents>
      <Checkbox label="Locked option" value onValueChange={() => {}} disabled />
    </Host>
  );
}

API

import { Checkbox } from '@expo/ui';

No API data file found, sorry!