2016-11-10 13:46:55 +00:00
< script >
export default {
methods: {
handleClick() {
alert('button click');
}
}
}
< / script >
## Dropdown
Toggleable menu for displaying lists of links and actions.
### Basic usage
Hover on the dropdown menu to unfold it for more actions.
:::demo The triggering element is rendered by the default `slot` , and the dropdown part is rendered by the `slot` named `dropdown` . By default, dropdown list shows when you hover on the triggering element without having to click it.
```html
< el-dropdown >
< span class = "el-dropdown-link" >
Dropdown List< i class = "el-icon-caret-bottom el-icon--right" > < / i >
< / span >
< el-dropdown-menu slot = "dropdown" >
< el-dropdown-item > Action 1< / el-dropdown-item >
< el-dropdown-item > Action 2< / el-dropdown-item >
< el-dropdown-item > Action 3< / el-dropdown-item >
< el-dropdown-item disabled > Action 4< / el-dropdown-item >
< el-dropdown-item divided > Action 5< / el-dropdown-item >
< / el-dropdown-menu >
< / el-dropdown >
```
:::
### Triggering element
Use the button to trigger the dropdown list.
:::demo Use `split-button` to split the triggering element into a button group with the left button being a normal button and right one the actual triggering target. If you wanna insert a separator line between item three and item four, just add a class `divider` to item four.
```html
< el-dropdown >
< el-button type = "primary" >
Dropdown List< i class = "el-icon-caret-bottom el-icon--right" > < / i >
< / el-button >
< el-dropdown-menu slot = "dropdown" >
< el-dropdown-item > Action 1< / el-dropdown-item >
< el-dropdown-item > Action 2< / el-dropdown-item >
< el-dropdown-item > Action 3< / el-dropdown-item >
< el-dropdown-item > Action 4< / el-dropdown-item >
< el-dropdown-item > Action 5< / el-dropdown-item >
< / el-dropdown-menu >
< / el-dropdown >
< el-dropdown split-button type = "primary" @click =" handleClick " >
Dropdown List
< el-dropdown-menu slot = "dropdown" >
< el-dropdown-item > Action 1< / el-dropdown-item >
< el-dropdown-item > Action 2< / el-dropdown-item >
< el-dropdown-item > Action 3< / el-dropdown-item >
< el-dropdown-item > Action 4< / el-dropdown-item >
< el-dropdown-item > Action 5< / el-dropdown-item >
< / el-dropdown-menu >
< / el-dropdown >
```
:::
### How to trigger
Click the triggering element or hover on it.
:::demo Use the attribute `trigger` . By default, it is `hover` .
```html
< el-row class = "block-col-2" >
< el-col :span = "12" >
< span class = "demonstration" > hover to trigger< / span >
< el-dropdown >
< span class = "el-dropdown-link" >
Dropdown List< i class = "el-icon-caret-bottom el-icon--right" > < / i >
< / span >
< el-dropdown-menu slot = "dropdown" >
< el-dropdown-item > Action 1< / el-dropdown-item >
< el-dropdown-item > Action 2< / el-dropdown-item >
< el-dropdown-item > Action 3< / el-dropdown-item >
< el-dropdown-item > Action 4< / el-dropdown-item >
< el-dropdown-item > Action 5< / el-dropdown-item >
< / el-dropdown-menu >
< / el-dropdown >
< / el-col >
< el-col :span = "12" >
< span class = "demonstration" > click to trigger< / span >
< el-dropdown trigger = "click" >
< span class = "el-dropdown-link" >
Dropdown List< i class = "el-icon-caret-bottom el-icon--right" > < / i >
< / span >
< el-dropdown-menu slot = "dropdown" >
< el-dropdown-item > Action 1< / el-dropdown-item >
< el-dropdown-item > Action 2< / el-dropdown-item >
< el-dropdown-item > Action 3< / el-dropdown-item >
< el-dropdown-item > Action 4< / el-dropdown-item >
< el-dropdown-item > Action 5< / el-dropdown-item >
< / el-dropdown-menu >
< / el-dropdown >
< / el-col >
< / el-row >
```
:::
2016-12-20 11:15:38 +00:00
### Menu hiding behavior
Use `hide-on-click` to define if menu closes on clicking.
:::demo By default menu will close when you click on menu items, and it can be turned off by setting hide-on-click to false.
```html
< el-dropdown :hide-on-click = "false" >
< span class = "el-dropdown-link" >
Dropdown List< i class = "el-icon-caret-bottom el-icon--right" > < / i >
< / span >
< el-dropdown-menu slot = "dropdown" >
< el-dropdown-item > Action 1< / el-dropdown-item >
< el-dropdown-item > Action 2< / el-dropdown-item >
< el-dropdown-item > Action 3< / el-dropdown-item >
< el-dropdown-item disabled > Action 4< / el-dropdown-item >
< el-dropdown-item divided > Action 5< / el-dropdown-item >
< / el-dropdown-menu >
< / el-dropdown >
```
:::
2016-11-10 13:46:55 +00:00
### Dropdown Attributes
| Attribute | Description | Type | Accepted Values | Default |
|------------- |---------------- |---------------- |---------------------- |-------- |
| type | menu button type, refer to `Button` Component, only works when `split-button` is true | string | — | — |
| size | menu button size, refer to `Button` Component, only works when `split-button` is true | string | — | — |
| split-button | whether a button group is displayed | boolean | — | false |
| size | component size, refer to `Button` component | string | large, small, mini | — |
| menu-align | horizontal alignment | string | start/end | end |
| trigger | how to trigger | string | hover/click | hover |
2016-12-20 10:42:44 +00:00
| hide-on-click | whether to hide menu after clicking menu-item | boolean | - | true |
2016-11-10 13:46:55 +00:00
### Dropdown Events
| Event 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 |
### Dropdown Menu Item Attributes
| Attribute | Description | Type | Accepted Values | Default |
|------------- |---------------- |---------------- |---------------------- |-------- |
| command | a command to be dispatched to Dropdown's `command` callback | string | — | — |
| disabled | whether the item is disabled | boolean | — | false |
| divided | whether a divider is displayed | boolean | — | false |