React-multi-select-advanced NPM

react-multi-select-advanced

Description

The React Multi-select Advanced component is a powerful tool that can handle massive data sets without any struggle. It comes with various customizable features that make it very easy to use, so you can tailor it to your specific needs. Now it supports server side search.

Like Beyoncé once said, If you liked it, then you should a put a ⭐ on it. ➽

Features

Typescript: Types included, ensuring compatibility with your project.
Zero dependency: No need to worry about other libraries.
Powerful: Handles massive data sets without problem.
Responsive: Ensures that the component fit all device resolutions depending on parent component.
Customizable: Allow you to add custom class and change button, icons as components.
Auto direction: Ensures that list items open in the correct direction based on their placement on the page.
Localization: Easy to integrate any language.
Keyboard navigation: Supports keyboard arrows and tab.
Highlight keywords: Highlights entered text on list results.
Match priority: If label starts with keyword, shows first.
Server side search: Supports server side search.
Storybook : Document and test playground.

Getting Started

1. Installation

npm

npm install react-multi-select-advanced

yarn

yarn add react-multi-select-advanced

2. Basic Usage

import { useState } from 'react'

// Import component / and types if need it.
import MultiSelectAdvanced, { MultiSelectAdvancedOption } from 'react-multi-select-advanced'

// Mock data
const options = [
 { label: 'Istanbul', value: 'Istanbul' },
 { label: 'Paris', value: 'Paris' },
 { label: 'London', value: 'London' },
 { label: 'Buenos Aires', value: 'Buenos Aires' },
 { label: 'Canberra', value: 'Canberra' },
 { label: 'Havana', value: 'Havana' },
 { label: 'Helsinki', value: 'Helsinki', disabled: true },
 { label: 'Tokyo', value: 'Tokyo' },
 { label: 'Amsterdam', value: 'Amsterdam' },
 { label: 'Moscow', value: 'Moscow' },
 { label: 'Stockholm', value: 'Stockholm', disabled: true },
 { label: 'Singapore', value: 'Singapore' },
 { label: 'Lisbon', value: 'Lisbon' },
 { label: 'Oslo', value: 'Oslo' },
 { label: 'Reykjavík', value: 'Reykjavík' }
]

// Mock pre selected data
const selectedValues = [
 { label: 'London', value: 'London' },
 { label: 'Tokyo', value: 'Tokyo' }
]

// App
function App() {

 // Pre-select or not
 const [selectedItems, setSelectedItems] = useState(selectedValues as MultiSelectAdvancedOption[])

 // Onchange handler
 const handleChange = (items: MultiSelectAdvancedOption[]) => setSelectedItems(items)

 return (
  <div className="App">

   <MultiSelectAdvanced options={options} selectedValues={selectedItems} onChange={handleChange} />

  </div>
 )
}

export default App

3. Server side search

import { useState } from 'react'

// Import component / and types if need it.
import MultiSelectAdvanced, { MultiSelectAdvancedOption } from 'react-multi-select-advanced'

// Mock data
const options = [
 { label: 'Istanbul', value: 'Istanbul' },
 { label: 'Paris', value: 'Paris' },
 { label: 'London', value: 'London' },
 { label: 'Buenos Aires', value: 'Buenos Aires' },
 { label: 'Canberra', value: 'Canberra' },
 { label: 'Havana', value: 'Havana' },
 { label: 'Helsinki', value: 'Helsinki', disabled: true },
 { label: 'Tokyo', value: 'Tokyo' },
 { label: 'Amsterdam', value: 'Amsterdam' },
 { label: 'Moscow', value: 'Moscow' },
 { label: 'Stockholm', value: 'Stockholm', disabled: true },
 { label: 'Singapore', value: 'Singapore' },
 { label: 'Lisbon', value: 'Lisbon' },
 { label: 'Oslo', value: 'Oslo' },
 { label: 'Reykjavík', value: 'Reykjavík' }
]

// App
function App() {

 // Pre-select or not
 const [selectedItems, setSelectedItems] = useState([] as MultiSelectAdvancedOption[])

 // Onchange handler
 const handleChange = (items: MultiSelectAdvancedOption[]) => setSelectedItems(items)

// Server side search function
const searchOnServer = async (keyword:string) => {
	try {
		// Before return the data make sure structure is matching with array of MultiSelectAdvancedOption
		return await search(keyword)
	} catch (error){
		return error
	}
}

// Mock server response
const search = async (keyword:string) => {
	return new Promise(resolve => {
		const filteredData = options.cities.filter(city => city.label.toLowerCase().includes(keyword.toLowerCase()))
		return setTimeout(() => resolve(filteredData), 500)
	})
}

 return (
  <div className="App">

   <MultiSelectAdvanced isServerSide={true} selectedValues={selectedItems} onChange={handleChange} onKeywordChange={keyword => searchOnServer(keyword)} />

  </div>
 )
}

export default App

4. Props

Prop	Type	Default	Description
`className`	`string`		Options data.
`options`	`array`	`[]`	Options data.
`selectedValues`	`array`	`[]`	Pre-selected options.

5. Localization

Easy to localize component by passing object to prop languageOverwrite. Default values are as below.

{
 selectionLimitReached : 'Max selection limit reached.',
 selectionShowClearTitle: 'Clear All',
 selectionDeleteTitle: 'Remove',
 moreItemsText: '{{count}} more items...'
}