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 |
|---|---|---|---|
| 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, you can reset it to the scrolling area and make a relative reposition. example |
Function(triggerNode) | () => document.body |
| overlay(v-slot) | the dropdown menu | Menu | - |
| overlayClassName | Class name of the dropdown root element | string | - |
| overlayStyle | Style of the dropdown root element | object | - |
| placement | placement of pop menu: bottomLeft bottomCenter bottomRight topLeft topCenter topRight |
String | bottomLeft |
| trigger | the trigger mode which executes the drop-down action, hover doesn't work on mobile device | Array<click|hover|contextmenu> |
['hover'] |
| visible(v-model) | whether the dropdown menu is visible | boolean | - |
events
| Events Name | Description | Arguments |
|---|---|---|
| visibleChange | a callback function takes an argument: visible, is executed when the visible state is changed |
function(visible) |
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 |
|---|---|---|---|---|
| disabled | whether the dropdown menu is disabled | boolean | - | |
| icon | Icon (appears on the right) | vNode | slot | - | 1.5.0 |
| overlay(v-slot) | the dropdown menu | Menu | - | |
| placement | placement of pop 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 drop-down action | Array<click|hover|contextmenu> |
['hover'] |
|
| type | type of the button, the same as Button | string | default |
|
| visible(v-model) | whether the dropdown menu is visible | boolean | - |
Dropdown.Button events
| Events Name | Description | Arguments |
|---|---|---|
| click | a callback function, the same as Button, which will be executed when you click the button on the left | Function |
| visibleChange | a callback function takes an argument: visible, is executed when the visible state is changed |
Function |