mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-01 11:39:28 +08:00
d44f404eae
* chore: improve sort api table scripts * sort api * add ignore * Revert "sort api" This reverts commit 343505d5f09d69349ce1fbdaea2a9faa7e852207. * sort api * Update package.json * sort api * Delete sort-api.js * sort api * sort api * sort api * fix * Update index.zh-CN.md * fix input-number * fix input-number * sort func * fix * Method moved to the end * carousel method
3.1 KiB
3.1 KiB
| category | type | title | cover |
|---|---|---|---|
| Components | Navigation | Dropdown | 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 | - | |
| 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 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
| overlay | The dropdown menu | 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 | (visible: boolean) => void | - |
You should use Menu as overlay. The menu items and dividers are also available by using Menu.Item and Menu.Divider.
Warning: You must set a unique
keyforMenu.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 | - | |
| placement | Placement of popup menu: bottomLeft bottomCenter bottomRight topLeft topCenter topRight |
string | bottomLeft |
|
| size | Size of the button, the same as Button | 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 | string | default |
|
| visible | Whether the dropdown menu is currently visible | boolean | - | |
| onClick | The same as Button: called when you click the button on the left | (event) => void | - | |
| onVisibleChange | Called when the visible state is changed | (visible: boolean) => void | - |