react-native-sectioned-multi-select

A multi (or single) select component with support for sub categories, search, chips. It's intended for long-ish lists, as it opens in a Modal (I might make this optional in the future).

This is based on https://github.com/toystars/react-native-multiple-select. The problems I had were that I needed it to be in a modal, because of nested ScrollViews not working on Android, and I needed to display categories with sub-categories.

Caveats

• Currently all ids must be unique. So if you're pulling data from multiple sources, be aware that id clashes will cause (major) problems i.e both items with the same id will get selected. Looking for contributors for this - would require a bit of a refactor (see #33).
• There is no ajax support.

Preview

Usage

You can install this package with the following command: npm i react-native-sectioned-multi-select or yarn add react-native-sectioned-multi-select

Icons

By default, the library uses React Native Vector Icons Material Icons. Before installing, please make sure you have react-native-vector-icons set up.

If you prefer to use your own icon images or icon font, the iconRenderer prop can be used to replace the icons used. See an example here: https://github.com/renrizzolo/react-native-sectioned-multi-select/blob/9c5f71852aef7a7ac03e7761d5dd810cd2ccef5d/exampleapp/App.js#L322-L397 (note the switch, you can refer to this to know what to map icon names to e.g if you're just passing in a different RN Vector Icons font).

Required props:

items | array
uniqueKey | string
onSelectedItemsChange | function

Basic Example

import React, { Component } from 'react'; import { View } from 'react-native'; import SectionedMultiSelect from 'react-native-sectioned-multi-select';  const items = [   // this is the parent or 'item'   {     name: 'Fruits',     id: 0,     // these are the children or 'sub items'     children: [       {         name: 'Apple',         id: 10,       },       {         name: 'Strawberry',         id: 17,       },       {         name: 'Pineapple',         id: 13,       },       {         name: 'Banana',         id: 14,       },       {         name: 'Watermelon',         id: 15,       },       {         name: 'Kiwi fruit',         id: 16,       },     ],   },   {     // next parent item    ...   },  ];  export default class App extends Component {   constructor() {     super();     this.state = {       selectedItems: [],     };   }   onSelectedItemsChange = (selectedItems) => {     this.setState({ selectedItems });   };    render() {     return (       <View>         <SectionedMultiSelect           items={items}           uniqueKey="id"           subKey="children"           selectText="Choose some things..."           showDropDowns={true}           readOnlyHeadings={true}           onSelectedItemsChange={this.onSelectedItemsChange}           selectedItems={this.state.selectedItems}         />       </View>     );   } }

You can programatically remove all items by setting up a ref to the component:

<SectionedMultiSelect     ...     ref={SectionedMultiSelect => this.SectionedMultiSelect = SectionedMultiSelect} /> 

and then use the _removeAllItems function:

onPress={() => this.SectionedMultiSelect._removeAllItems()} 

You can open the modal programatically with the _toggleSelector() method:

onPress={() => this.SectionedMultiSelect._toggleSelector()} 

Recipes

See Recipes for more detailed usage examples / customizations.

Items

Your items should have a uniqueKey(default: 'id') and a displayKey (default: 'name'). Any child items of that item should be in subKey, and they will have uniqueKey and displayKey properties. As you can see from the example above, my items all have a unique id property and the child items is an array within the subKey property.

Sub categories are optional, there's no need to have subKey items if you don't want to.

Props

Props, there are lots.

Main

Options

Customization

Colors

You can pass a colors object to theme it how you like.

These are the available colors and their defaults:

Styles

You can pass a styles object to style it how you like.

These are the styles you can change:
container modalWrapper backdrop listContainer
selectToggle
selectToggleText
item
selectedItem
subItem
itemText selectedItemText
selectedSubItemText selectedSubItem subItemText
searchBar
center
separator
subSeparator
chipsWrapper
chipContainer parentChipContainer parentChipText chipText
chipIcon
searchTextInput
scrollView
button
confirmText
cancelButton
itemIconStyle

Changelog

View changelog.