# @acrool/react-dropdown

> Dropdown list with React Component

Latest version **3.1.1** (published 2025-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @acrool/react-dropdown
pnpm add @acrool/react-dropdown
yarn add @acrool/react-dropdown
bun add @acrool/react-dropdown
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2025-04-26 |
| First published | 2024-05-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=14 |
| Dependencies | 1 |
| Unpacked size | 41.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Maintainers | imagine10255 |
| Keywords | react, typescript, dropdown |

## Links

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

## Dependencies (1)

- [clsx](https://npm.io/package/clsx.md) ^2.1.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.1.1 (latest) — 2025-04-26
- 3.0.20-alpha.2 (alpha) — 2024-10-13
- 3.1.0 — 2025-04-21
- 3.0.20 — 2024-10-27
- 3.0.20-alpha.1 — 2024-10-13
- 3.0.20-alpha.0 — 2024-10-13
- 3.0.19 — 2024-10-11
- 3.0.19-alpha.4 — 2024-10-10
- 3.0.19-alpha.3 — 2024-10-07
- 3.0.19-alpha.2 — 2024-10-06
- 3.0.19-alpha.1 — 2024-10-06
- 3.0.19-alpha.0 — 2024-10-06
- 3.0.18 — 2024-10-01
- 3.0.17 — 2024-09-27
- 3.0.17-alpha.0 — 2024-09-26
- … 27 more at https://npm.io/package/@acrool/react-dropdown/versions

## README

# Acrool React Dropdown

<a href="https://acrool-react-dropdown.pages.dev/" title="Acrool React Dropdown - Dropdown list with React Component">
    <img src="https://raw.githubusercontent.com/acrool/acrool-react-dropdown/main/example/public/og.webp" alt="Acrool React Dropdown Logo"/>
</a>

<p align="center">
    Drop-down menu with rich functions, including search/groups options/avatar/multi for Reactjs
</p>

<div align="center">

[![NPM](https://img.shields.io/npm/v/@acrool/react-dropdown.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/react-dropdown)
[![npm](https://img.shields.io/bundlejs/size/@acrool/react-dropdown?style=for-the-badge)](https://github.com/acrool/@acrool/react-dropdown/blob/main/LICENSE)
[![npm](https://img.shields.io/npm/l/@acrool/react-dropdown?style=for-the-badge)](https://github.com/acrool/react-dropdown/blob/main/LICENSE)

[![npm downloads](https://img.shields.io/npm/dm/@acrool/react-dropdown.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/react-dropdown)
[![npm](https://img.shields.io/npm/dt/@acrool/react-dropdown.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/react-dropdown)

</div>


`^3.1.0 support react >=18.0.0 <20.0.0`


## Features

- Supports two themes (light/dark)
- Support multiple selection function
- Support groups options
- Support avatar display
- Support search search function
- Support value custom type (string, number, boolean, object...)
- Support accessibility (keyboard Tab, Arrow Top, Bottom, Enter)

## Install

```bash
yarn add @acrool/react-dropdown
```

## Usage

add in your index.tsx
```tst
import "@acrool/react-dropdown/dist/index.css";
```

then in your page
```tsx
import {Dropdown, DropdownMulti} from '@acrool/react-dropdown';


const Example = () => {
    const [value, setValue] = useState<string|null>('');
    const [multiValue, setMultiValue] = useState<Array<string|null>|null>(null);

    const renderDropdown = () => {
        const options = [
            {text: 'Jack Wu', value: '1'},
            {text: 'Imagine Chiu', value: '2'},
            {text: 'Jason Dinwiddie', value: '3'},
            {text: 'Gloria Lu', value: '4'},
        ];
        return <Dropdown value={value} onChange={setValue} options={options}/>;
    }
    
    const renderDropdownMulti = () => {
        const options = [
            {text: 'Select option item...', value: '', avatarUrl: ''},
            {text: 'Jack Wu', value: '1', avatarUrl: asset('/images/avatar/female-1.jpg')},
            {text: 'Imagine Chiu', value: '2', avatarUrl: asset('/images/avatar/female-2.jpg')},
            {text: 'Jason Dinwiddie', value: '3', avatarUrl: asset('/images/avatar/female-3.jpg')},
            {text: 'Gloria Lu', value: '4', avatarUrl: asset('/images/avatar/female-4.jpg')},
        ];
        return <DropdownMulti value={multiValue} onChange={setMultiValue} options={options2} isDark/>;
    }
    
    return (
        <>
            {renderDropdown()}
            {renderDropdownMulti()}
        </>
    );

};
```

<img src="https://acrool-react-dropdown.pages.dev/preview.webp" alt="Acrool React Dropdown Preview" width="700"/>



## Options

if need use `null` value, options type

```json
{
    "compilerOptions": {
        "strictNullChecks": false
    }
}
```

There is also a example that you can play with it:

[![Play react-editext-example](https://raw.githubusercontent.com/acrool/acrool-react-dropdown/main/play-in-example-button.svg)](https://acrool-react-dropdown.pages.dev)


## License

MIT © [Acrool](https://github.com/acrool) & [Imagine](https://github.com/imagine10255)

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