mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 11:40:04 +08:00
53 lines
3.3 KiB
Markdown
53 lines
3.3 KiB
Markdown
---
|
|
category: Components
|
|
type: Navigation
|
|
title: Dropdown
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/eedWN59yJ/Dropdown.svg
|
|
---
|
|
|
|
A dropdown list.
|
|
|
|
## When To Use
|
|
|
|
When there are more than a few options to choose from, you can wrap them in a `Dropdown`. By hovering or clicking on the trigger, a dropdown menu will appear, which allows you to choose an option and execute the relevant action.
|
|
|
|
## API
|
|
|
|
### Dropdown
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| arrow | Whether the dropdown arrow should be visible | boolean | false | |
|
|
| disabled | Whether the dropdown menu is disabled | boolean | - | |
|
|
| destroyPopupOnHide | Whether destroy dropdown when hidden | boolean | false | |
|
|
| getPopupContainer | To set the container of the dropdown menu. The default is to create a div element in body, but you can reset it to the scrolling area and make a relative reposition. [Example on CodePen](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
| overlay | The dropdown menu | [Menu](/components/menu) \| () => Menu | - | |
|
|
| overlayClassName | The class name of the dropdown root element | string | - | |
|
|
| overlayStyle | The style of the dropdown root element | CSSProperties | - | |
|
|
| placement | Placement of popup menu: `bottomLeft`, `bottomCenter`, `bottomRight`, `topLeft`, `topCenter` or `topRight` | string | `bottomLeft` | |
|
|
| trigger | The trigger mode which executes the dropdown action. Note that hover can't be used on touchscreens | Array<`click`\|`hover`\|`contextMenu`> | \[`hover`] | |
|
|
| visible | Whether the dropdown menu is currently visible | boolean | - | |
|
|
| onVisibleChange | Called when the visible state is changed. Not trigger when hidden by click item | (visible: boolean) => void | - | |
|
|
|
|
You should use [Menu](/components/menu/) as `overlay`. The menu items and dividers are also available by using `Menu.Item` and `Menu.Divider`.
|
|
|
|
> Warning: You must set a unique `key` for `Menu.Item`.
|
|
>
|
|
> Menu of Dropdown is unselectable by default, you can make it selectable via `<Menu selectable>`.
|
|
|
|
### Dropdown.Button
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| buttonsRender | Custom buttons inside Dropdown.Button | (buttons: ReactNode\[]) => ReactNode\[] | - | |
|
|
| disabled | Whether the dropdown menu is disabled | boolean | - | |
|
|
| icon | Icon (appears on the right) | ReactNode | - | |
|
|
| overlay | The dropdown menu | [Menu](/components/menu) | - | |
|
|
| placement | Placement of popup menu: `bottomLeft` `bottomCenter` `bottomRight` `topLeft` `topCenter` `topRight` | string | `bottomLeft` | |
|
|
| size | Size of the button, the same as [Button](/components/button/#API) | string | `default` | |
|
|
| trigger | The trigger mode which executes the dropdown action | Array<`click`\|`hover`\|`contextMenu`> | \[`hover`] | |
|
|
| type | Type of the button, the same as [Button](/components/button/#API) | string | `default` | |
|
|
| visible | Whether the dropdown menu is currently visible | boolean | - | |
|
|
| onClick | The same as [Button](/components/button/#API): called when you click the button on the left | (event) => void | - | |
|
|
| onVisibleChange | Called when the visible state is changed | (visible: boolean) => void | - | |
|