Skip to content

Latest commit

 

History

History
114 lines (87 loc) · 6.11 KB

README.md

File metadata and controls

114 lines (87 loc) · 6.11 KB
Raw

rn-checkbox-list

npm version CodeFactor Coverage Status Codacy Badge

The goal of rn-checkbox-list is to achieve the checkbox list with minimal effort and easy customisation.

Android screenshots

iOS screenshots

Support

rn-checkbox-list version Platform RN Version
>= 1.0.0 Android, iOS, Windows >=0.62.3
> 0.3 Android, iOS, Windows 0.61.5
<=0.2 Android 0.61.5

Setup

This library is available on npm, install it with: npm i @react-native-community/checkbox rn-checkbox-list or yarn add @react-native-community/checkbox rn-checkbox-list

and then run npx pod-install

Usage

  1. Import rn-checkbox-list:
import CheckboxList from 'rn-checkbox-list';
  1. Create data with id and name:
[{ id: 1, name: 'Green Book' }, { id: 2, name: 'Bohemian Rhapsody' }];
  1. Add data to imported component
<CheckboxList headerName="This is header name" listItems={data} />

Sample example

<CheckboxList
  headerName="Movies"
  theme="red"
  listItems={data}
  onChange={({ ids, items }) => console.log('My updated list :: ', ids)}
  listItemStyle={{ borderBottomColor: '#eee', borderBottomWidth: 1 }}
  checkboxProp={{ boxType: 'square' }} // iOS (supported from v0.3.0)
  onLoading={() => <LoaderComponent />}
/>

Check for complete example here.

Available props

Name Type Default Description
listItems object array [] List of checkboxes
selectedListItems object array [] List of selected items(subset of listItems)
headerName string '' Shows header with the given name
listItemStyle object {} Each check list style
checkboxProp object {} Custom checkbox style
headerStyle object See here Header check list style
onChange function null Fires on each checkbox select or deselect
onLoading function null When the list is empty and a loader needs to be shown
theme string #1A237E Custom theme color for checkbox
v1.1.0 & above
renderItem function Text Component Custom render component for each list item

Refer wiki for detailed usecases of the props

Improvements

  • Importing checkbox through updated react-native package (removing warnings)
  • Customisable checkbox colors
  • Provide selected items and selected ids
  • Support for default selected items
  • Support iOS

Pull requests, feedbacks and suggestions are welcome!