Dropdown
Toggleable menu for displaying lists of links and actions.
TIP
This component requires the <client-only></client-only> wrap when used in SSR (eg: Nuxt) and SSG (eg: VitePress).
Basic usage
Hover on the dropdown menu to unfold it for more actions.
Triggering element
Use the button to trigger the dropdown list.
How to trigger
Click the triggering element or hover on it.
Menu hiding behavior
Use hide-on-click to define if menu closes on clicking.
Command event
Clicking each dropdown item fires an event whose parameter is assigned by each item.
Dropdown methods
You can open or close the dropdown menu by manually use handleOpen or handleClose
Sizes
Besides default size, Dropdown component provides three additional sizes for you to choose among different scenarios.
Dropdown Attributes
| Name | Description | Type | Accepted Values | Default |
|---|---|---|---|---|
| type | menu button type, refer to Button Component, only works when split-button is true | string | — | — |
| size | menu size, also works on the split button | string | large / default / small | default |
| max-height | the max height of menu | string / number | — | — |
| split-button | whether a button group is displayed | boolean | — | false |
| disabled | Whether to disable | boolean | — | false |
| placement | placement of pop menu | string | top/top-start/top-end/bottom/bottom-start/bottom-end | bottom |
| trigger | how to trigger | string | hover/click/contextmenu | hover |
| hide-on-click | whether to hide menu after clicking menu-item | boolean | — | true |
| show-timeout | Delay time before show a dropdown (only works when trigger is hover) | number | — | 250 |
| hide-timeout | Delay time before hide a dropdown (only works when trigger is hover) | number | — | 150 |
| role | The ARIA role attribute for the dropdown menu. Depending on the use case, you may want to change this to 'navigation' | string | — | 'menu' |
| tabindex | tabindex of Dropdown | number | — | 0 |
| popper-class | custom class name for Dropdown's dropdown | string | — | — |
| popper-options | popper.js parameters | Object | refer to popper.js doc | {modifiers: [{name: 'computeStyles',options: {gpuAcceleration: false}}]} |
| teleported 2.2.20 | whether the dropdown popup is teleported to the body | boolean | — | true |
Dropdown Slots
| Name | Description | Subtags |
|---|---|---|
| — | content of Dropdown. Notice: Must be a valid html dom element (ex. <span>, <button> etc.) or el-component, to attach the trigger listener | — |
| dropdown | content of the Dropdown Menu, usually a <el-dropdown-menu> element | Dropdown-Menu |
Dropdown Events
| Name | Description | Parameters |
|---|---|---|
| click | if split-button is true, triggers when left button is clicked | — |
| command | triggers when a dropdown item is clicked | the command dispatched from the dropdown item |
| visible-change | triggers when the dropdown appears/disappears | true when it appears, and false otherwise |
Dropdown Methods
| Method | Description | Parameters |
|---|---|---|
| handleOpen | open the dropdown menu | — |
| handleClose | close the dropdown menu | — |
Dropdown-Menu Slots
| Name | Description | Subtags |
|---|---|---|
| — | content of Dropdown Menu | Dropdown-Item |
Dropdown-Item Attributes
| Name | Description | Type | Accepted Values | Default |
|---|---|---|---|---|
| command | a command to be dispatched to Dropdown's command callback | string/number/object | — | — |
| disabled | whether the item is disabled | boolean | — | false |
| divided | whether a divider is displayed | boolean | — | false |
| icon | custom icon | string | Component | — | — |
Dropdown-Item Slots
| Name | Description |
|---|---|
| — | customize of Dropdown Item |