Skip to main content
Version: Bleeding Edge 🚧

CheckBox

CheckBoxes allow users to complete tasks that involve making choices such as selecting options, or switching settings - On or Off. It provides a clear visual of either a true or false choice.

Import

import { CheckBox } from "@rneui/themed";

Usage

Props

note

Includes all CheckBoxIcon, View props.

NameTypeDefaultDescription
ComponentReact ComponentSpecify React Native component for main button.
centerbooleanfalseAligns checkbox to center.
checkedTitlestringSpecify a custom checked message.
containerStyleView StyleStyle of main container.
disabledbooleanfalseDisables user interaction.
disabledStyleView StyleStyle of the checkbox container when disabled.
disabledTitleStyleText StyleStyle of the title when disabled.
fontFamilystringSpecify different font family.
iconRightbooleanfalseMoves icon to right of text.
rightbooleanfalseAligns checkbox to right.
textStyleText StyleStyle of text.
titlestring | ReactElement<{}, string | JSXElementConstructor<any>>Title of checkbox.
titlePropsTextProps{}Additional props for the title Text component.
wrapperStyleView StyleStyle for the wrapper of checkbox.

Playground

Loading...