react-native-select-multiple

A customiseable FlatList that allows you to select multiple rows.

Install

1npm install react-native-select-multiple

Usage

1import React, { Component } from 'react'
2import { View } from 'react-native'
3import SelectMultiple from 'react-native-select-multiple'
4
5const fruits = ['Apples', 'Oranges', 'Pears']
6// --- OR ---
7// const fruits = [
8//   { label: 'Apples', value: 'appls' },
9//   { label: 'Oranges', value: 'orngs' },
10//   { label: 'Pears', value: 'pears' }
11// ]
12
13class App extends Component {
14  state = { selectedFruits: [] }
15
16  onSelectionsChange = (selectedFruits) => {
17    // selectedFruits is array of { label, value }
18    this.setState({ selectedFruits })
19  }
20
21  render () {
22    return (
23      <View>
24        <SelectMultiple
25          items={fruits}
26          selectedItems={this.state.selectedFruits}
27          onSelectionsChange={this.onSelectionsChange} />
28      </View>
29    )
30  }
31}
32export default App
33

Customize label

1import React, { Component } from 'react'
2import { View, Text, Image } from 'react-native'
3import SelectMultiple from 'react-native-select-multiple'
4
5const fruits = ['Apples', 'Oranges', 'Pears']
6// --- OR ---
7// const fruits = [
8//   { label: 'Apples', value: 'appls' },
9//   { label: 'Oranges', value: 'orngs' },
10//   { label: 'Pears', value: 'pears' }
11// ]
12
13const renderLabel = (label, style) => {
14  return (
15    <View style={{flexDirection: 'row', alignItems: 'center'}}>
16      <Image style={{width: 42, height: 42}} source={{uri: 'https://dummyimage.com/100x100/52c25a/fff&text=S'}} />
17      <View style={{marginLeft: 10}}>
18        <Text style={style}>{label}</Text>
19      </View>
20    </View>
21  )
22}
23
24class App extends Component {
25  state = { selectedFruits: [] }
26
27  onSelectionsChange = (selectedFruits) => {
28    // selectedFruits is array of { label, value }
29    this.setState({ selectedFruits })
30  }
31
32  render () {
33    return (
34      <View>
35        <SelectMultiple
36          items={fruits}
37          renderLabel={renderLabel}
38          selectedItems={this.state.selectedFruits}
39          onSelectionsChange={this.onSelectionsChange} />
40      </View>
41    )
42  }
43}

Properties

Prop	Default	Type	Description
items	-	array	All items available in the list (array of string or { label, value })
selectedItems	[]	array	The currently selected items (array of string or { label, value })
onSelectionsChange	-	func	Callback called when a user selects or de-selects an item, passed (selections, item)
keyExtractor	index	func	keyExtractor for the FlatList
checkboxSource	image	object	Image source for the checkbox (unchecked).
selectedCheckboxSource	image	object	Image source for the checkbox (checked).
flatListProps	{}	object	Additional props for the flat list
style	default styles	object	Style for the FlatList container.
rowStyle	default styles	object	Style for the row container.
checkboxStyle	default styles	object	Style for the checkbox image.
labelStyle	default styles	object	Style for the text label.
selectedRowStyle	default styles	object	Style for the row container when selected.
selectedCheckboxStyle	default styles	object	Style for the checkbox image when selected.
selectedLabelStyle	default styles	object	Style for the text label when selected.
renderLabel	null	func	Function for render label.
maxSelect	null	int	Maximum number of selected items

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

ISC © TABLEFLIP

---

A (╯°□°）╯︵TABLEFLIP side project.