mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-15 01:41:20 +08:00
55348b30b6
* style: use prettier * style: just prettier format, no code changes * style: eslint fix object-shorthand, prefer-const * style: fix no-void * style: no-console
394 lines
15 KiB
Markdown
394 lines
15 KiB
Markdown
## NavMenu
|
|
|
|
Menu that provides navigation for your website.
|
|
|
|
### Top bar
|
|
|
|
Top bar NavMenu can be used in a variety of scenarios.
|
|
|
|
:::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.
|
|
|
|
```html
|
|
<el-menu
|
|
:default-active="activeIndex"
|
|
class="el-menu-demo"
|
|
mode="horizontal"
|
|
@select="handleSelect"
|
|
>
|
|
<el-menu-item index="1">Processing Center</el-menu-item>
|
|
<el-sub-menu index="2">
|
|
<template #title>Workspace</template>
|
|
<el-menu-item index="2-1">item one</el-menu-item>
|
|
<el-menu-item index="2-2">item two</el-menu-item>
|
|
<el-menu-item index="2-3">item three</el-menu-item>
|
|
<el-sub-menu index="2-4">
|
|
<template #title>item four</template>
|
|
<el-menu-item index="2-4-1">item one</el-menu-item>
|
|
<el-menu-item index="2-4-2">item two</el-menu-item>
|
|
<el-menu-item index="2-4-3">item three</el-menu-item>
|
|
</el-sub-menu>
|
|
</el-sub-menu>
|
|
<el-menu-item index="3" disabled>Info</el-menu-item>
|
|
<el-menu-item index="4">Orders</el-menu-item>
|
|
</el-menu>
|
|
<div class="line"></div>
|
|
<el-menu
|
|
:default-active="activeIndex2"
|
|
class="el-menu-demo"
|
|
mode="horizontal"
|
|
@select="handleSelect"
|
|
background-color="#545c64"
|
|
text-color="#fff"
|
|
active-text-color="#ffd04b"
|
|
>
|
|
<el-menu-item index="1">Processing Center</el-menu-item>
|
|
<el-sub-menu index="2">
|
|
<template #title>Workspace</template>
|
|
<el-menu-item index="2-1">item one</el-menu-item>
|
|
<el-menu-item index="2-2">item two</el-menu-item>
|
|
<el-menu-item index="2-3">item three</el-menu-item>
|
|
<el-sub-menu index="2-4">
|
|
<template #title>item four</template>
|
|
<el-menu-item index="2-4-1">item one</el-menu-item>
|
|
<el-menu-item index="2-4-2">item two</el-menu-item>
|
|
<el-menu-item index="2-4-3">item three</el-menu-item>
|
|
</el-sub-menu>
|
|
</el-sub-menu>
|
|
<el-menu-item index="3" disabled>Info</el-menu-item>
|
|
<el-menu-item index="4">Orders</el-menu-item>
|
|
</el-menu>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
activeIndex: '1',
|
|
activeIndex2: '1',
|
|
}
|
|
},
|
|
methods: {
|
|
handleSelect(key, keyPath) {
|
|
console.log(key, keyPath)
|
|
},
|
|
},
|
|
}
|
|
</script>
|
|
<!--
|
|
<setup>
|
|
|
|
import { defineComponent, ref } from 'vue';
|
|
|
|
export default defineComponent({
|
|
setup() {
|
|
const activeIndex = ref('1');
|
|
const activeIndex2 = ref('1');
|
|
const handleSelect = (key, keyPath) => {
|
|
console.log(key, keyPath);
|
|
};
|
|
return {
|
|
activeIndex,
|
|
activeIndex2,
|
|
handleSelect,
|
|
};
|
|
},
|
|
});
|
|
|
|
</setup>
|
|
-->
|
|
```
|
|
|
|
:::
|
|
|
|
### Side bar
|
|
|
|
Vertical NavMenu with sub-menus.
|
|
|
|
:::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.
|
|
|
|
```html
|
|
<el-row class="tac">
|
|
<el-col :span="12">
|
|
<h5>Default colors</h5>
|
|
<el-menu
|
|
default-active="2"
|
|
class="el-menu-vertical-demo"
|
|
@open="handleOpen"
|
|
@close="handleClose"
|
|
>
|
|
<el-sub-menu index="1">
|
|
<template #title>
|
|
<i class="el-icon-location"></i>
|
|
<span>Navigator One</span>
|
|
</template>
|
|
<el-menu-item-group title="Group One">
|
|
<el-menu-item index="1-1">item one</el-menu-item>
|
|
<el-menu-item index="1-2">item one</el-menu-item>
|
|
</el-menu-item-group>
|
|
<el-menu-item-group title="Group Two">
|
|
<el-menu-item index="1-3">item three</el-menu-item>
|
|
</el-menu-item-group>
|
|
<el-sub-menu index="1-4">
|
|
<template #title>item four</template>
|
|
<el-menu-item index="1-4-1">item one</el-menu-item>
|
|
</el-sub-menu>
|
|
</el-sub-menu>
|
|
<el-menu-item index="2">
|
|
<i class="el-icon-menu"></i>
|
|
<span>Navigator Two</span>
|
|
</el-menu-item>
|
|
<el-menu-item index="3" disabled>
|
|
<i class="el-icon-document"></i>
|
|
<span>Navigator Three</span>
|
|
</el-menu-item>
|
|
<el-menu-item index="4">
|
|
<i class="el-icon-setting"></i>
|
|
<span>Navigator Four</span>
|
|
</el-menu-item>
|
|
</el-menu>
|
|
</el-col>
|
|
<el-col :span="12">
|
|
<h5>Custom colors</h5>
|
|
<el-menu
|
|
default-active="2"
|
|
class="el-menu-vertical-demo"
|
|
@open="handleOpen"
|
|
@close="handleClose"
|
|
background-color="#545c64"
|
|
text-color="#fff"
|
|
active-text-color="#ffd04b"
|
|
>
|
|
<el-sub-menu index="1">
|
|
<template #title>
|
|
<i class="el-icon-location"></i>
|
|
<span>Navigator One</span>
|
|
</template>
|
|
<el-menu-item-group title="Group One">
|
|
<el-menu-item index="1-1">item one</el-menu-item>
|
|
<el-menu-item index="1-2">item one</el-menu-item>
|
|
</el-menu-item-group>
|
|
<el-menu-item-group title="Group Two">
|
|
<el-menu-item index="1-3">item three</el-menu-item>
|
|
</el-menu-item-group>
|
|
<el-sub-menu index="1-4">
|
|
<template #title>item four</template>
|
|
<el-menu-item index="1-4-1">item one</el-menu-item>
|
|
</el-sub-menu>
|
|
</el-sub-menu>
|
|
<el-menu-item index="2">
|
|
<i class="el-icon-menu"></i>
|
|
<span>Navigator Two</span>
|
|
</el-menu-item>
|
|
<el-menu-item index="3" disabled>
|
|
<i class="el-icon-document"></i>
|
|
<span>Navigator Three</span>
|
|
</el-menu-item>
|
|
<el-menu-item index="4">
|
|
<i class="el-icon-setting"></i>
|
|
<span>Navigator Four</span>
|
|
</el-menu-item>
|
|
</el-menu>
|
|
</el-col>
|
|
</el-row>
|
|
|
|
<script>
|
|
export default {
|
|
methods: {
|
|
handleOpen(key, keyPath) {
|
|
console.log(key, keyPath)
|
|
},
|
|
handleClose(key, keyPath) {
|
|
console.log(key, keyPath)
|
|
},
|
|
},
|
|
}
|
|
</script>
|
|
<!--
|
|
<setup>
|
|
|
|
import { defineComponent } from 'vue';
|
|
|
|
export default defineComponent({
|
|
setup() {
|
|
const handleOpen = (key, keyPath) => {
|
|
console.log(key, keyPath);
|
|
};
|
|
const handleClose = (key, keyPath) => {
|
|
console.log(key, keyPath);
|
|
};
|
|
return {
|
|
handleOpen,
|
|
handleClose,
|
|
};
|
|
},
|
|
});
|
|
|
|
</setup>
|
|
-->
|
|
```
|
|
|
|
:::
|
|
|
|
### Collapse
|
|
|
|
Vertical NavMenu could be collapsed.
|
|
|
|
:::demo
|
|
|
|
```html
|
|
<el-radio-group v-model="isCollapse" style="margin-bottom: 20px;">
|
|
<el-radio-button :label="false">expand</el-radio-button>
|
|
<el-radio-button :label="true">collapse</el-radio-button>
|
|
</el-radio-group>
|
|
<el-menu
|
|
default-active="2"
|
|
class="el-menu-vertical-demo"
|
|
@open="handleOpen"
|
|
@close="handleClose"
|
|
:collapse="isCollapse"
|
|
>
|
|
<el-sub-menu index="1">
|
|
<template #title>
|
|
<i class="el-icon-location"></i>
|
|
<span>Navigator One</span>
|
|
</template>
|
|
<el-menu-item-group>
|
|
<template #title><span>Group One</span></template>
|
|
<el-menu-item index="1-1">item one</el-menu-item>
|
|
<el-menu-item index="1-2">item two</el-menu-item>
|
|
</el-menu-item-group>
|
|
<el-menu-item-group title="Group Two">
|
|
<el-menu-item index="1-3">item three</el-menu-item>
|
|
</el-menu-item-group>
|
|
<el-sub-menu index="1-4">
|
|
<template #title><span>item four</span></template>
|
|
<el-menu-item index="1-4-1">item one</el-menu-item>
|
|
</el-sub-menu>
|
|
</el-sub-menu>
|
|
<el-menu-item index="2">
|
|
<i class="el-icon-menu"></i>
|
|
<template #title>Navigator Two</template>
|
|
</el-menu-item>
|
|
<el-menu-item index="3" disabled>
|
|
<i class="el-icon-document"></i>
|
|
<template #title>Navigator Three</template>
|
|
</el-menu-item>
|
|
<el-menu-item index="4">
|
|
<i class="el-icon-setting"></i>
|
|
<template #title>Navigator Four</template>
|
|
</el-menu-item>
|
|
</el-menu>
|
|
|
|
<style>
|
|
.el-menu-vertical-demo:not(.el-menu--collapse) {
|
|
width: 200px;
|
|
min-height: 400px;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
isCollapse: true,
|
|
}
|
|
},
|
|
methods: {
|
|
handleOpen(key, keyPath) {
|
|
console.log(key, keyPath)
|
|
},
|
|
handleClose(key, keyPath) {
|
|
console.log(key, keyPath)
|
|
},
|
|
},
|
|
}
|
|
</script>
|
|
<!--
|
|
<setup>
|
|
|
|
import { defineComponent, ref } from 'vue';
|
|
|
|
export default defineComponent({
|
|
setup() {
|
|
const isCollapse = ref(true);
|
|
const handleOpen = (key, keyPath) => {
|
|
console.log(key, keyPath);
|
|
};
|
|
const handleClose = (key, keyPath) => {
|
|
console.log(key, keyPath);
|
|
};
|
|
return {
|
|
isCollapse,
|
|
handleOpen,
|
|
handleClose,
|
|
};
|
|
},
|
|
});
|
|
|
|
</setup>
|
|
-->
|
|
```
|
|
|
|
:::
|
|
|
|
### 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 |
|
|
| background-color | background color of Menu (hex format) | string | — | #ffffff |
|
|
| text-color | text color of Menu (hex format) | string | — | #303133 |
|
|
| active-text-color | text color of currently active menu item (hex format) | string | — | #409EFF |
|
|
| 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 |
|
|
|
|
### Menu-Item Events
|
|
|
|
| Event Name | Description | Parameters |
|
|
| ---------- | ------------------------------------------- | ---------------------- |
|
|
| click | callback function when menu-item is clicked | el: menu-item instance |
|
|
|
|
### SubMenu Attributes
|
|
|
|
| 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 | 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 |
|
|
|
|
### 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 |
|
|
|
|
### Menu-Item-Group Attributes
|
|
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
|
| --------- | ----------- | ------ | --------------- | ------- |
|
|
| title | group title | string | — | — |
|