element/examples/docs/zh-CN/menu.md

347 lines
11 KiB
Markdown
Raw Normal View History

2016-07-27 06:15:02 +00:00
<style>
2016-09-01 02:48:06 +00:00
.demo-box.demo-menu {
.el-menu-demo {
padding-left: 55px;
2016-07-27 06:15:02 +00:00
}
.el-menu-vertical-demo:not(.el-menu--collapse) {
2017-09-16 12:50:19 +00:00
width: 240px;
2016-10-04 12:10:57 +00:00
min-height: 400px;
2016-07-27 06:15:02 +00:00
}
2016-09-01 02:48:06 +00:00
.line {
height: 1px;
background-color: #e0e6ed;
margin: 35px -24px;
2016-07-27 06:15:02 +00:00
}
2016-09-01 02:48:06 +00:00
h5 {
font-size: 14px;
2016-07-27 06:15:02 +00:00
color: #8492a6;
2016-09-01 02:48:06 +00:00
margin-top: 10px;
2016-07-27 06:15:02 +00:00
}
2016-09-01 02:48:06 +00:00
.tac {
text-align: center;
2016-07-27 06:15:02 +00:00
2016-09-01 02:48:06 +00:00
.el-menu-vertical-demo {
display: inline-block;
text-align: left;
2016-07-27 06:15:02 +00:00
}
}
}
</style>
<script>
export default {
2017-02-17 03:29:27 +00:00
data() {
return {
activeIndex: '1',
activeIndex2: '1',
isCollapse: true
2017-02-17 03:29:27 +00:00
};
},
2016-07-27 06:15:02 +00:00
methods: {
handleOpen(key, keyPath) {
2016-07-27 06:15:02 +00:00
console.log(key, keyPath);
},
handleClose(key, keyPath) {
2016-07-27 06:15:02 +00:00
console.log(key, keyPath);
},
handleSelect(key, keyPath) {
2016-07-27 06:15:02 +00:00
console.log(key, keyPath);
}
}
}
</script>
2016-09-01 02:48:06 +00:00
## NavMenu 导航菜单
2016-07-27 06:15:02 +00:00
为网站提供导航功能的菜单。
2016-07-27 06:15:02 +00:00
2016-09-01 02:48:06 +00:00
### 顶栏
2016-07-27 06:15:02 +00:00
2016-09-01 02:48:06 +00:00
适用广泛的基础用法。
2016-07-27 06:15:02 +00:00
2017-12-12 04:45:09 +00:00
:::demo 导航菜单默认为垂直模式,通过`mode`属性可以使导航菜单变更为水平模式。另外,在菜单中通过`submenu`组件可以生成二级菜单。Menu 还提供了`background-color`、`text-color`和`active-text-color`,分别用于设置菜单的背景色、菜单的文字颜色和当前激活菜单的文字颜色。
2016-07-27 06:15:02 +00:00
```html
2017-09-16 12:50:19 +00:00
<el-menu :default-active="activeIndex" class="el-menu-demo" mode="horizontal" @select="handleSelect">
2016-09-01 02:48:06 +00:00
<el-menu-item index="1">处理中心</el-menu-item>
2018-01-08 05:38:51 +00:00
<el-submenu index="2">
2016-09-05 03:30:05 +00:00
<template slot="title">我的工作台</template>
<el-menu-item index="2-1">选项1</el-menu-item>
<el-menu-item index="2-2">选项2</el-menu-item>
<el-menu-item index="2-3">选项3</el-menu-item>
<el-submenu index="2-4">
<template slot="title">选项4</template>
<el-menu-item index="2-4-1">选项1</el-menu-item>
<el-menu-item index="2-4-2">选项2</el-menu-item>
<el-menu-item index="2-4-3">选项3</el-menu-item>
</el-submenu>
2016-09-05 03:30:05 +00:00
</el-submenu>
2018-02-11 06:59:46 +00:00
<el-menu-item index="3" disabled>消息中心</el-menu-item>
<el-menu-item index="4"><a href="https://www.ele.me" target="_blank">订单管理</a></el-menu-item>
2016-09-01 02:48:06 +00:00
</el-menu>
<div class="line"></div>
2017-09-16 12:50:19 +00:00
<el-menu
:default-active="activeIndex2"
class="el-menu-demo"
mode="horizontal"
@select="handleSelect"
background-color="#545c64"
text-color="#fff"
active-text-color="#ffd04b">
2016-09-01 02:48:06 +00:00
<el-menu-item index="1">处理中心</el-menu-item>
2016-09-05 03:30:05 +00:00
<el-submenu index="2">
<template slot="title">我的工作台</template>
<el-menu-item index="2-1">选项1</el-menu-item>
<el-menu-item index="2-2">选项2</el-menu-item>
<el-menu-item index="2-3">选项3</el-menu-item>
<el-submenu index="2-4">
<template slot="title">选项4</template>
<el-menu-item index="2-4-1">选项1</el-menu-item>
<el-menu-item index="2-4-2">选项2</el-menu-item>
<el-menu-item index="2-4-3">选项3</el-menu-item>
</el-submenu>
2016-09-05 03:30:05 +00:00
</el-submenu>
2018-02-11 06:59:46 +00:00
<el-menu-item index="3" disabled>消息中心</el-menu-item>
<el-menu-item index="4"><a href="https://www.ele.me" target="_blank">订单管理</a></el-menu-item>
2016-09-01 02:48:06 +00:00
</el-menu>
<script>
export default {
2017-02-17 03:29:27 +00:00
data() {
return {
activeIndex: '1',
activeIndex2: '1'
};
},
methods: {
handleSelect(key, keyPath) {
console.log(key, keyPath);
}
}
}
</script>
2016-07-27 06:15:02 +00:00
```
2016-09-01 02:48:06 +00:00
:::
2016-07-27 06:15:02 +00:00
2016-09-01 02:48:06 +00:00
### 侧栏
2016-07-27 06:15:02 +00:00
2016-09-01 02:48:06 +00:00
垂直菜单,可内嵌子菜单。
2016-08-23 02:00:13 +00:00
2017-12-12 04:45:09 +00:00
:::demo 通过`el-menu-item-group`组件可以实现菜单进行分组,分组名可以通过`title`属性直接设定,也可以通过具名 slot 来设定。
2016-08-23 02:00:13 +00:00
```html
2016-09-01 02:48:06 +00:00
<el-row class="tac">
2017-09-16 12:50:19 +00:00
<el-col :span="12">
<h5>默认颜色</h5>
<el-menu
default-active="2"
class="el-menu-vertical-demo"
@open="handleOpen"
@close="handleClose">
2016-09-01 02:48:06 +00:00
<el-submenu index="1">
2017-09-16 12:50:19 +00:00
<template slot="title">
2017-10-18 08:12:54 +00:00
<i class="el-icon-location"></i>
2017-09-16 12:50:19 +00:00
<span>导航一</span>
</template>
<el-menu-item-group>
<template slot="title">分组一</template>
2016-09-05 03:30:05 +00:00
<el-menu-item index="1-1">选项1</el-menu-item>
<el-menu-item index="1-2">选项2</el-menu-item>
</el-menu-item-group>
<el-menu-item-group title="分组2">
<el-menu-item index="1-3">选项3</el-menu-item>
</el-menu-item-group>
2016-12-19 15:45:40 +00:00
<el-submenu index="1-4">
<template slot="title">选项4</template>
<el-menu-item index="1-4-1">选项1</el-menu-item>
</el-submenu>
2016-07-27 06:15:02 +00:00
</el-submenu>
2017-09-16 12:50:19 +00:00
<el-menu-item index="2">
<i class="el-icon-menu"></i>
<span slot="title">导航二</span>
</el-menu-item>
2018-02-11 06:59:46 +00:00
<el-menu-item index="3" disabled>
<i class="el-icon-document"></i>
2017-09-16 12:50:19 +00:00
<span slot="title">导航三</span>
</el-menu-item>
2018-02-11 06:59:46 +00:00
<el-menu-item index="4">
<i class="el-icon-setting"></i>
<span slot="title">导航四</span>
</el-menu-item>
2016-09-01 02:48:06 +00:00
</el-menu>
</el-col>
2017-09-16 12:50:19 +00:00
<el-col :span="12">
<h5>自定义颜色</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">
2016-09-01 02:48:06 +00:00
<el-submenu index="1">
2017-09-16 12:50:19 +00:00
<template slot="title">
2017-10-18 08:12:54 +00:00
<i class="el-icon-location"></i>
2017-09-16 12:50:19 +00:00
<span>导航一</span>
</template>
<el-menu-item-group>
<template slot="title">分组一</template>
2016-09-05 03:30:05 +00:00
<el-menu-item index="1-1">选项1</el-menu-item>
<el-menu-item index="1-2">选项2</el-menu-item>
</el-menu-item-group>
<el-menu-item-group title="分组2">
<el-menu-item index="1-3">选项3</el-menu-item>
</el-menu-item-group>
2016-12-19 15:45:40 +00:00
<el-submenu index="1-4">
<template slot="title">选项4</template>
<el-menu-item index="1-4-1">选项1</el-menu-item>
</el-submenu>
2016-07-27 06:15:02 +00:00
</el-submenu>
2017-09-16 12:50:19 +00:00
<el-menu-item index="2">
<i class="el-icon-menu"></i>
<span slot="title">导航二</span>
</el-menu-item>
2018-02-11 06:59:46 +00:00
<el-menu-item index="3" disabled>
<i class="el-icon-document"></i>
2017-09-16 12:50:19 +00:00
<span slot="title">导航三</span>
</el-menu-item>
2018-02-11 06:59:46 +00:00
<el-menu-item index="4">
<i class="el-icon-setting"></i>
<span slot="title">导航四</span>
</el-menu-item>
2016-09-01 02:48:06 +00:00
</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>
2016-07-27 06:15:02 +00:00
```
2016-09-01 02:48:06 +00:00
:::
2016-07-27 06:15:02 +00:00
### 折叠
2017-12-12 04:45:09 +00:00
:::demo
```html
<el-radio-group v-model="isCollapse" style="margin-bottom: 20px;">
<el-radio-button :label="false">展开</el-radio-button>
<el-radio-button :label="true">收起</el-radio-button>
</el-radio-group>
2017-07-27 02:33:15 +00:00
<el-menu default-active="1-4-1" class="el-menu-vertical-demo" @open="handleOpen" @close="handleClose" :collapse="isCollapse">
<el-submenu index="1">
<template slot="title">
2017-10-18 08:12:54 +00:00
<i class="el-icon-location"></i>
<span slot="title">导航一</span>
</template>
<el-menu-item-group>
<span slot="title">分组一</span>
<el-menu-item index="1-1">选项1</el-menu-item>
<el-menu-item index="1-2">选项2</el-menu-item>
</el-menu-item-group>
<el-menu-item-group title="分组2">
<el-menu-item index="1-3">选项3</el-menu-item>
</el-menu-item-group>
<el-submenu index="1-4">
<span slot="title">选项4</span>
<el-menu-item index="1-4-1">选项1</el-menu-item>
</el-submenu>
</el-submenu>
<el-menu-item index="2">
<i class="el-icon-menu"></i>
<span slot="title">导航二</span>
</el-menu-item>
2018-02-11 06:59:46 +00:00
<el-menu-item index="3" disabled>
<i class="el-icon-document"></i>
<span slot="title">导航三</span>
</el-menu-item>
2018-02-11 06:59:46 +00:00
<el-menu-item index="4">
<i class="el-icon-setting"></i>
<span slot="title">导航四</span>
</el-menu-item>
</el-menu>
2017-07-30 03:25:39 +00:00
<style>
.el-menu-vertical-demo:not(.el-menu--collapse) {
width: 200px;
min-height: 400px;
}
</style>
<script>
export default {
data() {
return {
2017-07-30 03:25:39 +00:00
isCollapse: true
};
},
methods: {
handleOpen(key, keyPath) {
console.log(key, keyPath);
},
handleClose(key, keyPath) {
console.log(key, keyPath);
}
}
}
</script>
```
:::
2016-09-01 02:48:06 +00:00
### Menu Attribute
2016-07-27 06:15:02 +00:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2017-10-18 10:31:03 +00:00
| mode | 模式 | string | horizontal / vertical | vertical |
| collapse | 是否水平折叠收起菜单(仅在 mode 为 vertical 时可用)| boolean | — | false |
2017-09-16 12:50:19 +00:00
| background-color | 菜单的背景色(仅支持 hex 格式) | string | — | #ffffff |
2017-12-12 04:45:09 +00:00
| text-color | 菜单的文字颜色(仅支持 hex 格式) | string | — | #303133 |
| active-text-color | 当前激活菜单的文字颜色(仅支持 hex 格式) | string | — | #409EFF |
2016-09-05 03:30:05 +00:00
| default-active | 当前激活菜单的 index | string | — | — |
| default-openeds | 当前打开的sub-menu的 key 数组 | Array | — | — |
| unique-opened | 是否只保持一个子菜单的展开 | boolean | — | false |
2016-10-26 03:51:41 +00:00
| menu-trigger | 子菜单打开的触发方式(只在 mode 为 horizontal 时有效) | string | — | hover |
2016-09-05 03:30:05 +00:00
| router | 是否使用 vue-router 的模式,启用该模式会在激活导航时以 index 作为 path 进行路由跳转 | boolean | — | false |
| collapse-transition | 是否开启折叠动画 | boolean | — | true |
2016-09-01 02:48:06 +00:00
### Menu Methods
| 事件名称 | 说明 | 参数 |
|---------- |-------- |---------- |
| open | 展开指定的 sub-menu | index: 需要打开的 sub-menu 的 index |
| close | 收起指定的 sub-menu | index: 需要收起的 sub-menu 的 index |
2016-09-01 02:48:06 +00:00
### Menu Events
| 事件名称 | 说明 | 回调参数 |
|---------- |-------- |---------- |
| select | 菜单激活回调 | index: 选中菜单项的 index, indexPath: 选中菜单项的 index path |
| open | sub-menu 展开的回调 | index: 打开的 sub-menu 的 index indexPath: 打开的 sub-menu 的 index path |
| close | sub-menu 收起的回调 | index: 收起的 sub-menu 的 index indexPath: 收起的 sub-menu 的 index path |
2016-09-01 02:48:06 +00:00
### SubMenu Attribute
2016-07-27 06:15:02 +00:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-05 03:30:05 +00:00
| index | 唯一标志 | string | — | — |
| popper-class | 弹出菜单的自定义类名 | string | — | — |
| show-timeout | 展开 sub-menu 的延时 | number | — | 300 |
| hide-timeout | 收起 sub-menu 的延时 | number | — | 300 |
2018-02-11 06:59:46 +00:00
| disabled | 是否禁用 | boolean | — | false |
2016-07-27 06:15:02 +00:00
2016-09-01 02:48:06 +00:00
### Menu-Item Attribute
2016-07-27 06:15:02 +00:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-05 03:30:05 +00:00
| index | 唯一标志 | string | — | — |
2016-09-29 18:18:40 +00:00
| route | Vue Router 路径对象 | Object | — | — |
2018-02-11 06:59:46 +00:00
| disabled | 是否禁用 | boolean | — | false |
2016-08-23 02:00:13 +00:00
2016-09-01 02:48:06 +00:00
### Menu-Group Attribute
2016-08-23 02:00:13 +00:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-01 02:48:06 +00:00
| title | 分组标题 | string | — | — |