2.0.9-alpha • Published 6 years ago

react-multi-select-component v2.0.9-alpha

Weekly downloads
14,122
License
MIT
Repository
github
Last release
6 years ago

react-multi-select-component

Simple and lightweight multiple selection dropdown component with checkboxes, search and select-all

Storybook GitHub Actions Status NPM gzip

✨ Features

  • 🍃 Lightweight (~4KB)
  • 💅 Themeable
  • ✌ Written w/ TypeScript

🔧 Installation

npm i react-multi-select-component    # npm
yarn add react-multi-select-component # yarn

📦 Example

Example

import React, { useState } from "react";
import MultiSelect from "react-multi-select-component";

const Example: React.FC = () => {
  const options = [
    { label: "Grapes 🍇", value: "grapes" },
    { label: "Mango 🥭", value: "mango" },
    { label: "Strawberry 🍓", value: "strawberry", disabled: true },
  ];

  const [selected, setSelected] = useState([]);

  return (
    <div>
      <h1>Select Fruits</h1>
      <pre>{JSON.stringify(selected)}</pre>
      <MultiSelect
        options={options}
        value={selected}
        onChange={setSelected}
        labelledBy={"Select"}
      />
    </div>
  );
};

export default Example;

👀 Props

PropDescriptionTypeDefault
labelledByvalue for aria-labelledbystring
optionsoptions for dropdown[{label, value, disabled}]
valuepre-selected rows[{label, value}][]
focusSearchOnOpenfocus on search input when openingbooleantrue
hasSelectAlltoggle 'Select All' optionbooleantrue
isLoadingshow spinner on selectbooleanfalse
shouldToggleOnHovertoggle dropdown on hover optionbooleanfalse
overrideStringsOverride default strings for i18nobject
onChangeonChange callbackfunction
disableddisable dropdownbooleanfalse
selectAllLabelselect all labelstring
disableSearchhide search textboxbooleanfalse
filterOptionscustom filter optionsfunctionFuzzy Search
classNameclass name for parent componentstringmulti-select

🔍 Custom filter logic

By default this component uses fuzzy search algorithm to filter options but also allows you to opt-out and use your own logic if you want to below is the example doing just case insensitive search

export function filterOptions(options, filter) {
  if (!filter) {
    return options;
  }
  const re = new RegExp(filter, "i");
  return options.filter(({ value }) => value && value.match(re));
}

🌐 Internationalization

You can override the strings to be whatever you want, including translations for your languages.

{
  "selectSomeItems": "Select...",
  "allItemsAreSelected": "All items are selected.",
  "selectAll": "Select All",
  "search": "Search"
}

💅 Themeing

You can override css variables to customize appearance

.multi-select {
  --rmsc-primary: #4285f4;
  --rmsc-hover: #f1f3f5;
  --rmsc-selected: #e2e6ea;
  --rmsc-border: #ccc;
  --rmsc-gray: #aaa;
  --rmsc-background: #fff;
  --rmsc-spacing: 10px;
  --rmsc-border-radius: 4px;
  --rmsc-height: 38px;
}

🤠 Credits

📜 License

MIT © harshzalavadiya

4.3.4

3 years ago

4.3.2

3 years ago

4.3.1

3 years ago

4.3.3

3 years ago

4.3.0

3 years ago

4.2.7

4 years ago

4.2.9

4 years ago

4.2.8

4 years ago

4.2.5

4 years ago

4.2.4

4 years ago

4.2.3

4 years ago

4.2.2

4 years ago

4.2.1

4 years ago

4.2.0

4 years ago

4.1.16

4 years ago

4.1.15

4 years ago

4.1.14

4 years ago

4.1.13

4 years ago

4.1.12

4 years ago

4.1.11

4 years ago

4.1.1-0.canary-7

4 years ago

4.1.1-0.canary-6

4 years ago

4.1.1-0.canary-5

4 years ago

4.1.1-0.canary-4

4 years ago

4.1.1-0.canary-9

4 years ago

4.1.1-0.canary-3

4 years ago

4.1.1-0.canary-2

4 years ago

4.1.1-0.canary-1

4 years ago

4.1.10

4 years ago

4.1.9

4 years ago

4.1.8

4 years ago

4.1.7

4 years ago

4.1.6

4 years ago

4.1.2-canary.1

4 years ago

4.0.6-canary.1

4 years ago

4.1.4

4 years ago

4.1.3

4 years ago

4.1.5

4 years ago

4.1.0

4 years ago

4.1.2

4 years ago

4.1.1

4 years ago

4.0.6

4 years ago

4.0.5

4 years ago

4.0.4

4 years ago

4.0.3

4 years ago

4.0.2

5 years ago

4.0.1

5 years ago

4.0.0

5 years ago

3.1.7-canary.3

5 years ago

3.1.7-canary.2

5 years ago

3.1.7

5 years ago

3.1.6-canary.1

5 years ago

3.1.6

5 years ago

3.1.5

5 years ago

3.1.4

5 years ago

3.1.3

5 years ago

3.1.2

5 years ago

3.1.1

5 years ago

3.0.8

5 years ago

3.0.7

5 years ago

3.0.6

5 years ago

3.0.5

5 years ago

3.0.5-canary.1

5 years ago

3.0.4

5 years ago

3.0.3

5 years ago

3.0.2

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

2.0.14

5 years ago

2.0.13

5 years ago

2.0.12

5 years ago

2.0.11

6 years ago

2.0.10

6 years ago

2.0.9

6 years ago

2.0.9-alpha-r4

6 years ago

2.0.9-alpha-r3

6 years ago

2.0.9-alpha

6 years ago

2.0.9-alpha-r2

6 years ago

2.0.8

6 years ago

2.0.7-alpha

6 years ago

2.0.7

6 years ago

2.0.6

6 years ago

2.0.5

6 years ago

2.0.4

6 years ago

2.0.2-alpha

6 years ago

2.0.3

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago

2.0.0-alpha

6 years ago

2.0.0

6 years ago

1.3.3

6 years ago

1.3.2

6 years ago

1.3.1

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago

0.0.1

6 years ago