# @uiw/react-dropdown

> Dropdown component

Latest version **4.22.3** (published 2023-11-29) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; has provenance.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.22.3 |
| Published | 2023-11-29 |
| First published | 2020-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| Author | Kenny Wong |
| Maintainers | uiwjs, wcjiang |
| Keywords | dropdown, react-dropdown, design, uiw, uiw-react, react.js, react, react-component, component, components, ui, css, uikit, react-ui, framework, front-end, frontend |

## Links

- npm: https://www.npmjs.com/package/@uiw/react-dropdown
- Repository: https://github.com/uiwjs/uiw
- Homepage: https://uiwjs.github.io/#/components/dropdown
- Issues: https://github.com/uiwjs/uiw/issues
- Funding: https://jaywcjlove.github.io/#/sponsor
- npm.io page: https://npm.io/package/@uiw/react-dropdown

## Dependencies (2)

- [@uiw/utils](https://npm.io/package/@uiw/utils.md) ^4.22.3
- [@uiw/react-overlay-trigger](https://npm.io/package/@uiw/react-overlay-trigger.md) ^4.22.3

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 4.22.3 (latest) — 2023-11-29
- 5.0.0-bate.2.1 (bate) — 2023-03-10
- 4.22.2 — 2023-11-09
- 4.22.1 — 2023-11-08
- 4.22.0 — 2023-09-19
- 4.21.28 — 2023-05-05
- 4.21.27 — 2023-04-21
- 4.21.26 — 2023-04-20
- 4.21.25 — 2023-03-14
- 4.21.24 — 2023-03-08
- 5.0.0-bate.2.0 — 2023-03-02
- 4.21.23 — 2022-12-21
- 4.21.22 — 2022-12-19
- 4.21.21 — 2022-12-19
- 5.0.0-bate-19 — 2022-12-12
- … 157 more at https://npm.io/package/@uiw/react-dropdown/versions

## README

Dropdown 下拉菜单
===

[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)
[![Open in unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-dropdown/file/README.md)
[![NPM Downloads](https://img.shields.io/npm/dm/@uiw/react-dropdown.svg?style=flat)](https://www.npmjs.com/package/@uiw/react-dropdown)
[![npm version](https://img.shields.io/npm/v/@uiw/react-dropdown.svg?label=@uiw/react-dropdown)](https://npmjs.com/@uiw/react-dropdown)

向下弹出的列表。

```jsx
import { Dropdown } from 'uiw';
// or
import Dropdown from '@uiw/react-dropdown';
```

### 基本用法

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Dropdown, Menu, ButtonGroup, Button, Divider, Icon } from 'uiw';

const menu = (
  <div>
    <Menu bordered style={{ minWidth: 120 }}>
      <Menu.Item icon="reload" text="重新加载" />
      <Menu.Item icon="heart-on" text="另存为" active />
      <Menu.Item icon="appstore" text="应用商城" />
      <Menu.Item icon="bar-chart" text="月统计报表" />
      <Menu.Item icon="setting" text="偏好设置" />
    </Menu>
  </div>
);

class Demo extends React.Component {
  render() {
    return (
      <div>
        <Dropdown menu={menu}>
          <a href='#' onClick={e => e.preventDefault()}>
            鼠标经过出现菜单 <Icon type="down" />
          </a>
        </Dropdown>
        <Dropdown trigger="click" menu={menu}>
          <a href='#' onClick={e => e.preventDefault()}>
            点击我出现下拉菜单 <Icon type="down" />
          </a>
        </Dropdown>
      </div>
    )
  }
}

export default Demo;
```

### 被禁用

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Dropdown, Menu, ButtonGroup, Button } from 'uiw';

const menu = (
  <div>
    <Menu bordered style={{ maxWidth: 200 }}>
      <Menu.Item icon="reload" text="重新加载" />
      <Menu.Divider />
      <Menu.Item icon="heart-on" text="另存为" active />
      <Menu.Item icon="appstore" text="应用商城" />
      <Menu.Item icon="bar-chart" text="月统计报表导出" />
      <Menu.Item icon="setting" text="偏好设置" />
    </Menu>
  </div>
);

export default function Demo() {
  return(
    <div>
      <ButtonGroup style={{ marginRight: 5, display: 'inline-block' }}>
        <Button disabled icon="copy">点击右边</Button>
        <Dropdown disabled trigger="click" placement="bottomRight" menu={menu}>
          <Button icon="more" />
        </Dropdown>
      </ButtonGroup>
      <Dropdown disabled menu={menu}>
        <Button basic type="link"> (超连接样式)link </Button>
      </Dropdown>
      <Dropdown disabled menu={menu}>
        <Button type="primary">主要按钮</Button>
      </Dropdown>
      <Dropdown disabled menu={menu}>
        <Button type="success">成功按钮</Button>
      </Dropdown>
      <Dropdown disabled menu={menu}>
        <Button type="warning">警告按钮</Button>
      </Dropdown>
      <Dropdown disabled menu={menu}>
        <Button type="danger">错误按钮</Button>
      </Dropdown>
      <Dropdown disabled menu={menu}>
        <Button type="light">亮按钮</Button>
      </Dropdown>
      <Dropdown disabled menu={menu}>
        <Button type="dark">暗按钮</Button>
      </Dropdown>
    </div>
  );
}
```

### 弹出位置

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Dropdown, Menu, Divider, ButtonGroup, Button } from 'uiw';

const menu = (
  <div>
    <Menu bordered style={{ maxWidth: 200 }}>
      <Menu.Item icon="reload" text="重新加载" />
      <Menu.Divider />
      <Menu.Item icon="heart-on" text="另存为" active />
      <Menu.Item icon="appstore" text="应用商城" />
      <Menu.Item icon="bar-chart" text="月统计报表导出" />
      <Menu.Item icon="setting" text="偏好设置" />
    </Menu>
  </div>
);

export default function Demo() {
  return(
    <div>
      <ButtonGroup style={{ marginRight: 5, display: 'inline-block' }}>
        <Button icon="copy">top</Button>
        <Dropdown trigger="click" placement="top" menu={menu}>
          <Button icon="more" />
        </Dropdown>
      </ButtonGroup>
      <Dropdown menu={menu} trigger="click" placement="topLeft">
        <Button type="primary">topLeft</Button>
      </Dropdown>
      <Dropdown menu={menu} trigger="click" placement="topRight">
        <Button type="success">topRight</Button>
      </Dropdown>
      <Divider />
      <Dropdown menu={menu} trigger="click" placement="bottomRight">
        <Button type="light">bottomRight</Button>
      </Dropdown>
      <Dropdown menu={menu} trigger="click" placement="bottom">
        <Button type="warning">bottom</Button>
      </Dropdown>
      <Dropdown menu={menu} trigger="click" placement="bottomLeft">
        <Button type="danger">bottomLeft</Button>
      </Dropdown>
      <Dropdown menu={menu} trigger="click" placement="right">
        <Button type="dark">right</Button>
      </Dropdown>
    </div>
  );
}
```

### 选择器

```jsx mdx:preview&bg=#fff
import React from 'react';
import { Dropdown, Menu, Button, Icon } from 'uiw';

function Select(props) {
  const { option, onChange } = props;
  const [open, setOpen] = React.useState(false);
  const [value, setValue] = React.useState(props.value);
  const label = option.find(item => value === item.value);

  React.useEffect(() => {
    if (props.value !== value) {
      setValue(props.value);
    }
  }, [props.value]);

  return (
    <Dropdown
      trigger="click"
      onVisibleChange={(isOpen) => setOpen(isOpen)}
      isOpen={open}
      menu={
        <div>
          <Menu bordered style={{ minWidth: 120 }}>
            {option.map((item, idx) => {
              const active = value === item.value;
              return (
                <Menu.Item
                  key={idx}
                  active={active}
                  text={item.label}
                  onClick={(e) => {
                    setValue(item.value)
                    setOpen(false)
                    onChange && onChange(item.value, e)
                  }}
                />
              );
            })}
          </Menu>
        </div>
      }
    >
      <Button type="link">{label.label}<Icon type={open ? 'up' : 'down'} /></Button>
    </Dropdown>
  )
}

const option = [
  { label: '往返', value: 1 },
  { label: '单程', value: 2 },
  { label: '联程', value: 3 },
  { label: 'Nomad', value: 4 },
];

const option2 = [
  { label: '经济舱', value: 1 },
  { label: '豪华经济舱', value: 2 },
  { label: '商务舱', value: 3 },
  { label: '头等舱', value: 4 },
];


export default function Demo() {
  return(
    <div>
      <Select option={option} value={1} onChange={(item) => { console.log('item', item); }} />
      <Select option={option2} value={2} onChange={(item) => { console.log('item', item); }} />
    </div>
  );
}
```

## Props

| 参数 | 说明 | 类型 | 默认值 |
| -------- | -------- | -------- | -------- |
| menu | 菜单 | [`<Menu>`](#/components/menu) | - |
| disabled | 菜单是否禁用 | Boolean | - |
| trigger[`<OverlayTrigger>`](#/components/overlay-trigger) | 悬停/点击弹出窗口 | Enum{`hover`, `click`, `focus`} | `hover` |
| placement[`<OverlayTrigger>`](#/components/overlay-trigger) | 指定弹出框位置，支持 12 个访问展示菜单。 | Enum{} | `bottomLeft` |

更多属性文档请参考 [OverlayTrigger](#/components/overlay-trigger)。

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