Skip to main content

CheckList

CheckLists are used for displaying a list of items with checkboxes. They are useful for managing lists of data, such as to-do items, with the ability to check or uncheck items as they are completed.

Import

import { CheckList } from '@nomada-sh/react-native-eyecandy';

Example

Props

View Props

Inherits View Props.


Required
children

Type
CheckListOption or CheckListOption[]

Required
selected

Type
string[]

Required
onSelectedChange

(selected: string[]) => void;
Type
function
  • 'selected' (string[]): array of selected item ids.

onPress

({ id: string, value: any }) => void;
Type
function
  • 'id' (string): id of the option.
  • 'value' (any): value of the option.

maxSelected

Type
number

marginBottom

TypeDefault
number20