1.0.3 • Published 6 years ago

react-native-selectable-flatlist v1.0.3

Weekly downloads
13
License
MIT
Repository
github
Last release
6 years ago

react-native-selectable-flatlist

Single/Multi Select Flatlist

Getting started

$ npm install react-native-selectable-flatlist --save

DEMO

Usage

import React, { Component } from 'react';
import { View, Text,StyleSheet } from 'react-native';
import SelectableFlatlist, { STATE } from 'react-native-selectable-flatlist';

class Example extends Component {

  itemsSelected = (selectedItem) => {
    console.log(selectedItem);
  }

  rowItem = (item) => (
    <View
      style={{
        flex: 1,
        borderBottomWidth: 0.5,
        alignItems: 'flex-start',
        justifyContent: 'center',
        paddingVertical: 20,
        borderBottomColor: '##dfdfdf'
      }}
    >
      <Text>{item.test}</Text>
    </View>
  )

render(){
  return(
    <View style={styles.container}>
        <SelectableFlatlist
          data={[{ test: 'test1' }, { test: 'test2' }, { test: 'test3' }]}
          state={STATE.EDIT}
          multiSelect={false}
          itemsSelected={(selectedItem) => { this.itemsSelected(selectedItem); }}
          initialSelectedIndex={[0]}
          cellItemComponent={(item, otherProps) => this.rowItem(item)}
        />
    </View>
  )
}
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    paddingTop: 40
  }
});

export default Example;

Props

namerequireddefaultdescription
datayes[]data is just a plain array.
stateyesSTATE.EDITSTATE.DEFAULT, without selection. STATE.EDIT with selection.
cellItemComponentyesChild row component to render next check/uncheck componenet.
touchStylesnoStyles for touch wrapper.
renderChecknoCustom Component to render when a row is checked.
checkUncheckContainerStylenoContainer style of check/uncheck default component.
checkColorno#00FF00Default Color of check icon.
checkUncheckSizeno30Size(Number) of check/uncheck icon.
checkIconnoCustom check icon.
renderUnchecknoCustom Component to render when a row is unchecked.
uncheckColorno#dfdfdfDefault Color of uncheck icon.
uncheckIconnoCustom uncheck icon.
initialSelectedIndexyesArray of initially selected item index(Eg:- 0 or [] or 0,1,6).
itemsSelectedyesCallback function when an item checked/unchecked which returns selected items array.
multiSelectyesfalseBoolean, single/multi select, true refers to multiselect.