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

204 lines
7.0 KiB
Markdown
Raw Normal View History

2016-07-27 14:15:02 +08:00
<style>
2016-09-01 10:48:06 +08:00
.demo-box.demo-menu {
.el-menu-demo {
padding-left: 55px;
2016-07-27 14:15:02 +08:00
}
2016-09-01 10:48:06 +08:00
.el-menu-vertical-demo {
width: 200px;
2016-10-04 20:10:57 +08:00
min-height: 400px;
2016-07-27 14:15:02 +08:00
}
2016-09-01 10:48:06 +08:00
.line {
height: 1px;
background-color: #e0e6ed;
margin: 35px -24px;
2016-07-27 14:15:02 +08:00
}
2016-09-01 10:48:06 +08:00
h5 {
font-size: 14px;
2016-07-27 14:15:02 +08:00
color: #8492a6;
2016-09-01 10:48:06 +08:00
margin-top: 10px;
2016-07-27 14:15:02 +08:00
}
2016-09-01 10:48:06 +08:00
.tac {
text-align: center;
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
.el-menu-vertical-demo {
display: inline-block;
text-align: left;
2016-07-27 14:15:02 +08:00
}
}
}
</style>
<script>
export default {
methods: {
handleOpen(key, keyPath) {
2016-07-27 14:15:02 +08:00
console.log(key, keyPath);
},
handleClose(key, keyPath) {
2016-07-27 14:15:02 +08:00
console.log(key, keyPath);
},
handleSelect(key, keyPath) {
2016-07-27 14:15:02 +08:00
console.log(key, keyPath);
}
}
}
</script>
2016-09-01 10:48:06 +08:00
## NavMenu 导航菜单
2016-07-27 14:15:02 +08:00
为网站提供导航功能的菜单。
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
### 顶栏
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
适用广泛的基础用法。
2016-07-27 14:15:02 +08:00
::: demo 导航菜单默认为垂直模式,通过 `mode` 属性可以使导航菜单变更为水平模式。另外,在菜单中通过 `submenu` 组件可以生成二级菜单。
2016-07-27 14:15:02 +08:00
```html
<el-menu theme="dark" default-active="1" class="el-menu-demo" mode="horizontal" @select="handleSelect">
2016-09-01 10:48:06 +08:00
<el-menu-item index="1">处理中心</el-menu-item>
2016-09-05 11:30:05 +08: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>
2016-09-01 10:48:06 +08:00
<el-menu-item index="3">订单管理</el-menu-item>
</el-menu>
<div class="line"></div>
<el-menu default-active="1" class="el-menu-demo" mode="horizontal" @select="handleSelect">
2016-09-01 10:48:06 +08:00
<el-menu-item index="1">处理中心</el-menu-item>
2016-09-05 11:30:05 +08: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>
2016-09-01 10:48:06 +08:00
<el-menu-item index="3">订单管理</el-menu-item>
</el-menu>
<script>
export default {
methods: {
handleSelect(key, keyPath) {
console.log(key, keyPath);
}
}
}
</script>
2016-07-27 14:15:02 +08:00
```
2016-09-01 10:48:06 +08:00
:::
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
### 侧栏
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
垂直菜单,可内嵌子菜单。
2016-08-23 10:00:13 +08:00
::: demo 通过 `el-menu-item-group` 组件可以实现菜单进行分组,分组名可以通过 `title` 属性直接设定也可以通过具名 slot 来设定。
2016-08-23 10:00:13 +08:00
```html
2016-09-01 10:48:06 +08:00
<el-row class="tac">
<el-col :span="8">
<h5>带 icon</h5>
<el-menu default-active="2" class="el-menu-vertical-demo" @open="handleOpen" @close="handleClose">
2016-09-01 10:48:06 +08:00
<el-submenu index="1">
<template slot="title"><i class="el-icon-message"></i>导航一</template>
<el-menu-item-group>
<template slot="title">分组一</template>
2016-09-05 11:30:05 +08: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 23:45:40 +08: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 14:15:02 +08:00
</el-submenu>
2016-09-01 10:48:06 +08:00
<el-menu-item index="2"><i class="el-icon-menu"></i>导航二</el-menu-item>
<el-menu-item index="3"><i class="el-icon-setting"></i>导航三</el-menu-item>
</el-menu>
</el-col>
<el-col :span="8">
<h5>不带 icon</h5>
<el-menu default-active="2" class="el-menu-vertical-demo" @open="handleOpen" @close="handleClose" theme="dark">
2016-09-01 10:48:06 +08:00
<el-submenu index="1">
<template slot="title">导航一</template>
2016-09-05 11:30:05 +08:00
<el-menu-item-group title="分组一">
<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 23:45:40 +08: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 14:15:02 +08:00
</el-submenu>
2016-09-01 10:48:06 +08:00
<el-menu-item index="2">导航二</el-menu-item>
<el-menu-item index="3">导航三</el-menu-item>
2016-07-27 14:15:02 +08:00
</el-menu>
2016-09-01 10:48:06 +08:00
</el-col>
<el-col :span="8">
<h5>分组</h5>
<el-menu mode="vertical" default-active="1" class="el-menu-vertical-demo">
<el-menu-item-group title="分组一">
<el-menu-item index="1"><i class="el-icon-message"></i>导航一</el-menu-item>
<el-menu-item index="2"><i class="el-icon-message"></i>导航二</el-menu-item>
2016-08-23 10:00:13 +08:00
</el-menu-item-group>
2016-09-01 10:48:06 +08:00
<el-menu-item-group title="分组二">
<el-menu-item index="3"><i class="el-icon-message"></i>导航三</el-menu-item>
<el-menu-item index="4"><i class="el-icon-message"></i>导航四</el-menu-item>
2016-08-23 10:00:13 +08:00
</el-menu-item-group>
2016-09-01 10:48:06 +08: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 14:15:02 +08:00
```
2016-09-01 10:48:06 +08:00
:::
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
### Menu Attribute
2016-07-27 14:15:02 +08:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-05 11:30:05 +08:00
| mode | 模式 | string | horizontal,vertical | vertical |
2016-07-27 14:15:02 +08:00
| theme | 主题色 | string | light,dark | light |
2016-09-05 11:30:05 +08:00
| default-active | 当前激活菜单的 index | string | — | — |
2016-09-01 10:48:06 +08:00
| default-openeds | 当前打开的submenu的 key 数组 | Array | — | — |
| unique-opened | 是否只保持一个子菜单的展开 | boolean | — | false |
2016-10-26 11:51:41 +08:00
| menu-trigger | 子菜单打开的触发方式(只在 mode 为 horizontal 时有效) | string | — | hover |
2016-09-05 11:30:05 +08:00
| router | 是否使用 vue-router 的模式,启用该模式会在激活导航时以 index 作为 path 进行路由跳转 | boolean | — | false |
2016-09-01 10:48:06 +08:00
### Menu Events
| 事件名称 | 说明 | 回调参数 |
|---------- |-------- |---------- |
2016-09-05 11:30:05 +08:00
| select | 菜单激活回调 | index: 选中菜单项的 indexPath: 选中菜单项的 index path |
| open | SubMenu 展开的回调 | index: 打开的 subMenu 的 index indexPath: 打开的 subMenu 的 index path |
| close | SubMenu 收起的回调 | index: 收起的 subMenu 的 index indexPath: 收起的 subMenu 的 index path |
2016-09-01 10:48:06 +08:00
### SubMenu Attribute
2016-07-27 14:15:02 +08:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-05 11:30:05 +08:00
| index | 唯一标志 | string | — | — |
2016-07-27 14:15:02 +08:00
2016-09-01 10:48:06 +08:00
### Menu-Item Attribute
2016-07-27 14:15:02 +08:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-05 11:30:05 +08:00
| index | 唯一标志 | string | — | — |
2016-09-30 02:18:40 +08:00
| route | Vue Router 路径对象 | Object | — | — |
2016-08-23 10:00:13 +08:00
2016-09-01 10:48:06 +08:00
### Menu-Group Attribute
2016-08-23 10:00:13 +08:00
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---------- |-------- |---------- |------------- |-------- |
2016-09-01 10:48:06 +08:00
| title | 分组标题 | string | — | — |