# react-multiselect-button-dropdown

> A Dropdown Button which toggle a Multiselect List. React component accessible (A11y).

Latest version **2.0.1** (published 2023-01-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-multiselect-button-dropdown
pnpm add react-multiselect-button-dropdown
yarn add react-multiselect-button-dropdown
bun add react-multiselect-button-dropdown
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2023-01-08 |
| First published | 2019-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Mauricio Farinelli |
| Maintainers | maufarinelli |

## Links

- npm: https://www.npmjs.com/package/react-multiselect-button-dropdown
- Repository: https://github.com/maufarinelli/react-multiselect-dropdown-button
- Homepage: https://github.com/maufarinelli/react-multiselect-dropdown-button/#readme
- Issues: https://github.com/maufarinelli/react-multiselect-dropdown-button/issues
- npm.io page: https://npm.io/package/react-multiselect-button-dropdown

## Dependencies (1)

- [styled-components](https://npm.io/package/styled-components.md) ^5.3.6

## Recent versions

- 2.0.1 (latest) — 2023-01-08
- 2.0.0 — 2023-01-08
- 1.1.1 — 2019-06-12
- 1.1.0 — 2019-06-12
- 1.0.14 — 2019-06-12
- 1.0.13 — 2019-04-08
- 1.0.12 — 2019-03-26
- 1.0.11 — 2019-03-22
- 1.0.10 — 2019-03-22
- 1.0.9 — 2019-03-22
- 1.0.8 — 2019-03-19
- 1.0.7 — 2019-03-19
- 1.0.6 — 2019-03-19
- 1.0.5 — 2019-03-19
- 1.0.4 — 2019-03-19
- … 4 more at https://npm.io/package/react-multiselect-button-dropdown/versions

## README

# React MultiSelect Dropdown Button accessible (A11y).

A Dropdown Button which toggle a Multiselect List. React component accessible (A11y).

Finally, **Typescript** compatible

- Easy use with keyboard navigation (Tab, selection with Space, Arrows Up, Down, Home and End for the list) following A11y guide of https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/listbox_role
- Callback function provided, to give selected items applied
- Can be used multilanguage, as it receives text by props
- CSS classes provided in all tags, for you to style as you wish

![alt text](https://raw.githubusercontent.com/maufarinelli/react-multiselect-dropdown-button/master/public/react-multiselect-button-dropdown-examples2.png)

Try it out in this [Live Demo](https://xzkq2.codesandbox.io/)

## A11y notes

- In order to keep it fully accessible, make sure:
  - label does describe its associated input element: https://achecker.ca/checker/suggestion.php?id=189
  - the labels of each checkbox describes the purpose or function of it. https://achecker.ca/checker/suggestion.php?id=219

## How to use

`npm i react-multiselect-button-dropdown`

or

`yarn add react-multiselect-button-dropdown`

and import in your app

`import MultiSelect from "react-multiselect-button-dropdown";`

### props

- **list:** `Array<listItem>` (required)
  listItem is:
  `{ label: PropTypes.string.isRequired, id: PropTypes.string.isRequired, name: PropTypes.string, checked: PropTypes.bool.isRequired }`

  Provides a list of checkboxes to the component

- **dropdownButtonText:** `string` (required)

  The text for the button dropdown

- **isRightAligned:** `boolean` (optional)

  Used in order to align dropdown to the right of the button. The default is left aligned

- **onOptionChanged** `(optionState) => {}` (optional)

  A callback function to get the state of options selected/unselected.

- **onSelectionApplied:** `(list) => {}` (optional)

  A callback function to get the state of checkbox list.
  If this property is added, it activates the footer of the component, containing the "Apply" and "Reset" buttons

- **selectAllButtonText:** `string` (optional)

  The text to the select all button
  default: "Select All"

- **resetButtonText:** `string` (optional)

  The text to the reset button
  default: "Reset"

- **applyButtonText:** `string` (optional)

  The text to the apply button
  default: "Apply"

- **closeDropdownOnApply:** `boolean` (optional)

Used in order to close the dropdown when user click on Apply button

## Example

```
const props = {
    list: [
        {
            label: 'First option',
            name: 'first-option',
            id: 'first-option-1',
            checked: true
        },
        {
            label: 'Second option',
            name: 'second-option',
            id: 'second-option-2',
            checked: false
        },
        {
            label: 'Third option',
            name: 'third-option',
            id: 'third-option-3',
            checked: false
        }
    ],
    onSelectionApplied: selection => {
    console.log('Selected : ', selection);
    },
    dropdownButtonText: 'Selected',
    resetButtonText: 'Reset',
    applyButtonText: 'Apply'
    closeDropdownOnApply: true
};

<MultiSelect {...props} />
```

---
_Source: https://npm.io/package/react-multiselect-button-dropdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
