2021-10-22 19:32:39 +08:00
---
2021-10-25 15:21:08 +08:00
title: Menu
2021-10-22 19:32:39 +08:00
lang: en-US
---
2021-09-26 13:55:19 +08:00
# Menu
2021-09-17 00:18:50 +08:00
Menu that provides navigation for your website.
## Top bar
2021-09-22 22:38:21 +08:00
Top bar Menu can be used in a variety of scenarios.
2021-09-17 00:18:50 +08:00
:::demo By default Menu is vertical, but you can change it to horizontal by setting the mode prop to 'horizontal'. In addition, you can use the sub-menu component to create a second level menu. Menu provides `background-color` , `text-color` and `active-text-color` to customize the colors.
menu/basic
:::
## Side bar
2021-09-22 22:38:21 +08:00
Vertical Menu with sub-menus.
2021-09-17 00:18:50 +08:00
:::demo You can use the el-menu-item-group component to create a menu group, and the name of the group is determined by the title prop or a named slot.
menu/vertical
:::
## Collapse
2021-09-22 22:38:21 +08:00
Vertical Menu could be collapsed.
2021-09-17 00:18:50 +08:00
:::demo
menu/collapse
:::
## Menu Attributes
| Attribute | Description | Type | Accepted Values | Default |
| ------------------- | ---------------------------------------------------------------------------------------------------------- | ------- | --------------------- | -------- |
| mode | menu display mode | string | horizontal / vertical | vertical |
| collapse | whether the menu is collapsed (available only in vertical mode) | boolean | — | false |
2021-10-14 14:59:00 +08:00
| ellipsis | whether the menu is ellipsis (available only in horizontal mode) | boolean | — | true |
2022-05-12 22:38:26 +08:00
| background-color | background color of Menu (hex format) (deprecated, use `--bg-color` instead) | string | — | #ffffff |
| text-color | text color of Menu (hex format) (deprecated, use `--text-color` instead) | string | — | #303133 |
| active-text-color | text color of currently active menu item (hex format) (deprecated, use `--active-color` instead) | string | — | #409EFF |
2021-09-17 00:18:50 +08:00
| default-active | index of currently active menu | string | — | — |
| default-openeds | array that contains indexes of currently active sub-menus | Array | — | — |
| unique-opened | whether only one sub-menu can be active | boolean | — | false |
| menu-trigger | how sub-menus are triggered, only works when `mode` is 'horizontal' | string | hover / click | hover |
| router | whether `vue-router` mode is activated. If true, index will be used as 'path' to activate the route action | boolean | — | false |
| collapse-transition | whether to enable the collapse transition | boolean | — | true |
## Menu Methods
| Methods Name | Description | Parameters |
| ------------ | ------------------------- | ------------------------------------- |
| open | open a specific sub-menu | index: index of the sub-menu to open |
| close | close a specific sub-menu | index: index of the sub-menu to close |
## Menu Events
| Event Name | Description | Parameters |
| ---------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| select | callback function when menu is activated | index: index of activated menu, indexPath: index path of activated menu, item: the selected menu item, routeResult: result returned by `vue-router` if `router` is enabled |
| open | callback function when sub-menu expands | index: index of expanded sub-menu, indexPath: index path of expanded sub-menu |
| close | callback function when sub-menu collapses | index: index of collapsed sub-menu, indexPath: index path of collapsed sub-menu |
2021-10-04 08:26:51 +08:00
## Menu Slots
2021-09-17 00:18:50 +08:00
2021-10-04 08:26:51 +08:00
| Name | Description | Subtags |
| ---- | ------------------------- | ------------------------------------- |
| — | customize default content | SubMenu / Menu-Item / Menu-Item-Group |
2021-09-17 00:18:50 +08:00
## SubMenu Attributes
2022-02-04 14:59:58 +08:00
| Attribute | Description | Type | Accepted Values | Default |
| --------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------- | --------------- | ----------------------------------------------- |
| index | unique identification | string | — | — |
| popper-class | custom class name for the popup menu | string | — | — |
| show-timeout | timeout before showing a sub-menu | number | — | 300 |
| hide-timeout | timeout before hiding a sub-menu | number | — | 300 |
| disabled | whether the sub-menu is disabled | boolean | — | false |
| popper-append-to-body(deprecated) | whether to append the popup menu to body. If the positioning of the menu is wrong, you can try setting this prop | boolean | - | level one SubMenu: true / other SubMenus: false |
2022-02-15 11:06:21 +08:00
| popper-offset | offset of the popper | number | — | 6 |
2021-09-17 00:18:50 +08:00
2021-10-04 08:26:51 +08:00
## SubMenu Slots
| Name | Description | Subtags |
| ---- | ------------------------- | ------------------------------------- |
| — | customize default content | SubMenu / Menu-Item / Menu-Item-Group |
2021-09-17 00:18:50 +08:00
## Menu-Item Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | --------------------- | ----------- | --------------- | ------- |
| index | unique identification | string/null | — | null |
| route | Vue Router object | object | — | — |
| disabled | whether disabled | boolean | — | false |
2021-10-04 08:26:51 +08:00
## Menu-Item Events
| Event Name | Description | Parameters |
| ---------- | ------------------------------------------- | ---------------------- |
| click | callback function when menu-item is clicked | el: menu-item instance |
## Menu-Item Slots
| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
2021-09-17 00:18:50 +08:00
## Menu-Item-Group Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------- | ----------- | ------ | --------------- | ------- |
| title | group title | string | — | — |
2021-10-04 08:26:51 +08:00
## Menu-Item-Group Slots
| Name | Description | Subtags |
| ---- | ------------------------- | --------- |
| — | customize default content | Menu-Item |
