Git Product home page Git Product logo

react-multi-select-component's Introduction

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" },
  ];

  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

Prop Description Type Default
labelledBy value for aria-labelledby string
options options for dropdown [{label, value}]
value pre-selected rows [{label, value}] []
focusSearchOnOpen focus on search input when opening boolean true
hasSelectAll toggle 'Select All' option boolean true
isLoading show spinner on select boolean false
shouldToggleOnHover toggle dropdown on hover option boolean false
overrideStrings Override default strings for i18n object
onChange onChange callback function
disabled disable dropdown boolean false
selectAllLabel select all label string
disableSearch hide search textbox boolean false
filterOptions custom filter options function Fuzzy Search
className class name for parent component string multi-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

react-multi-select-component's People

Contributors

cristianbote avatar dependabot-preview[bot] avatar dependabot[bot] avatar harshzalavadiya avatar porteron avatar ryzoo avatar tefferson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.