edit dropdown/message/tab docs

examples/docs/dropdown.md

@@ -25,7 +25,11 @@
 
 ## 基础用法
 
-<p>通过与 button 一致的 type 属性来指定菜单按钮类型。</p>
+Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可生成对应的下拉菜单，通过`text`属性来设置按钮文字。
+
+默认条件下，他又一个主要按钮和一个下拉按钮组成，`el-dropdown`中的主要按钮同样可以设置点击事件，只要使用`mainclick`事件即可。
+
+默认情况下，下拉按钮只要`hover`即可，无需点击也会显示下拉菜单。
 
 <div class="demo-box">
   <el-dropdown text="主要按钮" type="primary" @mainclick="handleMainClick()">
@@ -47,7 +51,9 @@
 
 ## 不带独立按钮的下拉菜单
 
-可以通过将`icon-separate`属性设为`false`来呈现不带独立按钮的下拉菜单。
+如果不需要默认的主要按钮与下拉按钮的组合，可以通过设置`icon-separate`属性来呈现不带独立按钮的下拉菜单，它接受一个`Boolean`，设置为`false`即可。
+
+在下例中，可以看到，在选项三和选项四中插入了一条分割线，要达成这个效果很简单，只需要在选项四中设置`class`为`divider`。
 
 <el-dropdown text="下拉菜单" type="primary" :icon-separate="false">
   <el-dropdown-item>选项一</el-dropdown-item>
@@ -67,6 +73,8 @@
 
 ## 通过点击触发下拉
 
+默认通过 Hover 即可出现下拉菜单，如果有需求，可以改成click，只要在`trigger`属性设置为`click`即可。
+
 <div class="demo-box">
   <el-dropdown text="主要按钮" type="primary" trigger="click">
     <el-dropdown-item>选项一</el-dropdown-item>
@@ -97,7 +105,9 @@
 </el-dropdown>
 ```
 
-## 文字类型下拉菜单
+## 按钮样式
+
+除了上述属性以外，由于本质还是按钮，`el-dropdown`同样拥有 Button 组件的相关属性：`type`和`size`，关于这点，可以参考 Button 组件的对应文档，下两例说明了相应字段的功能：
 
 <div class="demo-box">
   <el-dropdown text="下拉菜单" type="text" :icon-separate="false">
@@ -117,25 +127,26 @@
 </el-dropdown>
 ```
 
-## 尺寸
-
 <div class="demo-box">
   <el-dropdown text="下拉菜单" type="primary" size="large">
     <el-dropdown-item>选项一</el-dropdown-item>
     <el-dropdown-item>选项二</el-dropdown-item>
     <el-dropdown-item>选项三</el-dropdown-item>
     <li class="divider">选项四</el-dropdown-item>
-  </el-dropdown><el-dropdown text="下拉菜单" type="primary">
+  </el-dropdown>
+  <el-dropdown text="下拉菜单" type="primary">
     <el-dropdown-item>选项一</el-dropdown-item>
     <el-dropdown-item>选项二</el-dropdown-item>
     <el-dropdown-item>选项三</el-dropdown-item>
     <el-dropdown-item class="divider">选项四</el-dropdown-item>
-  </el-dropdown><el-dropdown text="下拉菜单" type="primary" size="small">
+  </el-dropdown>
+  <el-dropdown text="下拉菜单" type="primary" size="small">
     <el-dropdown-item>选项一</el-dropdown-item>
     <el-dropdown-item>选项二</el-dropdown-item>
     <el-dropdown-item>选项三</el-dropdown-item>
     <el-dropdown-item class="divider">选项四</el-dropdown-item>
-  </el-dropdown><el-dropdown text="下拉菜单" type="primary" size="mini">
+  </el-dropdown>
+  <el-dropdown text="下拉菜单" type="primary" size="mini">
     <el-dropdown-item>选项一</el-dropdown-item>
     <el-dropdown-item>选项二</el-dropdown-item>
     <el-dropdown-item>选项三</el-dropdown-item>
@@ -145,6 +156,60 @@
 
 ```html
 <el-dropdown text="下拉菜单" type="primary" size="large">
+  <el-dropdown-item>选项一</el-dropdown-item>
+  <el-dropdown-item>选项二</el-dropdown-item>
+  <el-dropdown-item>选项三</el-dropdown-item>
+  <li class="divider">选项四</el-dropdown-item>
+</el-dropdown>
+<el-dropdown text="下拉菜单" type="primary">
+  <el-dropdown-item>选项一</el-dropdown-item>
+  <el-dropdown-item>选项二</el-dropdown-item>
+  <el-dropdown-item>选项三</el-dropdown-item>
+  <el-dropdown-item class="divider">选项四</el-dropdown-item>
+</el-dropdown>
+<el-dropdown text="下拉菜单" type="primary" size="small">
+  <el-dropdown-item>选项一</el-dropdown-item>
+  <el-dropdown-item>选项二</el-dropdown-item>
+  <el-dropdown-item>选项三</el-dropdown-item>
+  <el-dropdown-item class="divider">选项四</el-dropdown-item>
+</el-dropdown>
+<el-dropdown text="下拉菜单" type="primary" size="mini">
+  <el-dropdown-item>选项一</el-dropdown-item>
+  <el-dropdown-item>选项二</el-dropdown-item>
+  <el-dropdown-item>选项三</el-dropdown-item>
+  <el-dropdown-item class="divider">选项四</el-dropdown-item>
+</el-dropdown>
+```
+
+## 对齐方式
+
+Element 提供两种下拉菜单的对齐方式：`start`与`end`，在下例中演示了它们的区别，你可以通过设置`menu-align`来选择一种对齐方式，默认为`end`：
+
+<div class="demo-box">
+  <el-dropdown text="下拉菜单 end" type="primary" menu-align="end">
+    <el-dropdown-item>选项一</el-dropdown-item>
+    <el-dropdown-item>选项二</el-dropdown-item>
+    <el-dropdown-item>选项三</el-dropdown-item>
+    <el-dropdown-item class="divider">选项四</el-dropdown-item>
+  </el-dropdown>
+
+  <el-dropdown text="下拉菜单 start" type="primary" menu-align="start">
+    <el-dropdown-item>选项一</el-dropdown-item>
+    <el-dropdown-item>选项二</el-dropdown-item>
+    <el-dropdown-item>选项三</el-dropdown-item>
+    <el-dropdown-item class="divider">选项四</el-dropdown-item>
+  </el-dropdown>
+</div>
+
+```html
+<el-dropdown text="下拉菜单 end" type="primary" menu-align="end">
+  <el-dropdown-item>选项一</el-dropdown-item>
+  <el-dropdown-item>选项二</el-dropdown-item>
+  <el-dropdown-item>选项三</el-dropdown-item>
+  <el-dropdown-item class="divider">选项四</el-dropdown-item>
+</el-dropdown>
+
+<el-dropdown text="下拉菜单 start" type="primary" menu-align="start">
   <el-dropdown-item>选项一</el-dropdown-item>
   <el-dropdown-item>选项二</el-dropdown-item>
   <el-dropdown-item>选项三</el-dropdown-item>
@@ -152,12 +217,12 @@
 </el-dropdown>
 ```
 
-## API
+## Attributes
 | 参数          | 说明            | 类型            | 可选值                 | 默认值   |
 |-------------  |---------------- |---------------- |---------------------- |-------- |
 | text          | 菜单按钮文本      | string          |                       |         |
-| type          | 菜单按钮类型，同 button    | string  |                       |         |
+| type          | 菜单按钮类型，同 Button 组件   | string  |                       |         |
 | trigger       | 触发下拉菜单的方式    | string  |    hover,click  |  hover |
-| icon-separate | 独立的下拉菜单按钮 | boolean         | true, false           | false   |
-| size          | 菜单按钮尺寸，同 button     | string          | large, small, mini  |     |
+| icon-separate | 独立的下拉菜单按钮 | boolean         |            | false   |
+| size          | 菜单按钮尺寸，同 Button 组件     | string          | large, small, mini  |     |
 | menu-align    | 菜单水平对齐方向     | string          | start, end  | end |

examples/docs/message.md

@@ -31,22 +31,22 @@
       open5() {
         this.$message({
           showClose: true,
-          message: '恭喜你，这是一条成功消息'
+          message: '这是一条消息提示'
         });
       },
 
       open6() {
         this.$message({
           showClose: true,
-          message: '警告哦，这是一条警告消息',
-          type: 'warning'
+          message: '恭喜你，这是一条成功消息',
+          type: 'success'
         });
       },
 
       open7() {
         this.$message({
           showClose: true,
-          message: '错了哦，这是一条错误消息',
+          message: '警告哦，这是一条警告消息',
           type: 'warning'
         });
       },

examples/docs/tabs.md

@@ -15,7 +15,7 @@
           title: '选项卡四',
           content: '选项卡四内容'
         }],
-        activeName: '3',
+        activeName: 'two',
         activeName2: ''
       }
     },
@@ -37,25 +37,44 @@
 
 ## 基础使用
 
+Tabs 组件提供了选项卡功能，只需要使用`el-tabs`和子元素`el-tab-pane`即可，在两个元素中，我们分别提供了一系列的属性来方便使用，`el-tab-pane`中`label`决定了选项卡标题，标签内部写入内容即可。
+
+在下例中我们在`el-tabs`中设置了`active-name`属性，接受一个`String`值，表明选中的选项卡，在`el-tab-pane`中可以设置对应的`name`属性，如果没有设置`name`，则默认值为顺序的`1`/`2`/`3`/`4`……。
+
+下例会选中选项卡2，如果不设置`name`，将`active-name`设为`2`，可以达成相同效果。
+
 <div>
   <el-tabs>
     <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
-    <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
+    <el-tab-pane name="two" label="选项卡二">选项卡二内容</el-tab-pane>
     <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
     <el-tab-pane label="选项卡四">选项卡四内容</el-tab-pane>
   </el-tabs>
 </div>
 
 ```html
-<el-tabs :active-name="activeName">
-  <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
-  <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
-  <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
-  <el-tab-pane label="选项卡四">选项卡四内容</el-tab-pane>
-</el-tabs>
+<template>
+  <el-tabs :active-name="activeName">
+    <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
+    <el-tab-pane name="two" label="选项卡二">选项卡二内容</el-tab-pane>
+    <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
+    <el-tab-pane label="选项卡四">选项卡四内容</el-tab-pane>
+  </el-tabs>
+</template>
+<script>
+  export default {
+    data() {
+      return {
+        activeName: 'two'
+      };
+    }
+  };
+</script>
 ```
 
-## 标签风格
+## 多种风格
+
+除了上例中的风格外，我们还提供了标签和卡片两种风格，只需要设置`type`属性即可，如果需要标签风格，将其设置为`card`，卡片风格，则为`border-card`。
 
 <div>
   <el-tabs type="card">
@@ -75,20 +94,17 @@
 </el-tabs>
 ```
 
-## 可关闭的标签
-
 <div>
-  <el-tabs type="card" :closable="true" :on-remove="handleRemove" :on-click="handleClick">
+  <el-tabs type="border-card">
     <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
     <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
     <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
     <el-tab-pane label="选项卡四">选项卡四内容</el-tab-pane>
   </el-tabs>
 </div>
-{{activeName2}}
 
 ```html
-<el-tabs type="card" :closable="true" :on-remove="handleRemove" :on-click="handleClick">
+<el-tabs type="border-card">
   <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
   <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
   <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
@@ -96,10 +112,14 @@
 </el-tabs>
 ```
 
-## 卡片风格
+## 可关闭的标签
+
+在`el-tabs`中设置`closable`属性，接受一个`Boolean`，设置为`true`时为可关闭。
+
+除此以外，我们在`el-tabs`中准备了两个钩子，用于在 Tab 被选中时和被删除时自定义属性：`on-click`和`on-remove`，接受`Function`，它们都提供一个参数`tab`，为操作的目标标签。
 
 <div>
-  <el-tabs type="border-card">
+  <el-tabs type="card" :closable="true" :on-click="handleClick" :on-remove="handleRemove">
     <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
     <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
     <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
@@ -108,25 +128,39 @@
 </div>
 
 ```html
-<el-tabs type="border-card">
-  <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
-  <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
-  <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
-  <el-tab-pane label="选项卡四">选项卡四内容</el-tab-pane>
-</el-tabs>
+<template>
+  <el-tabs type="card" :closable="true" :on-click="handleClick" :on-remove="handleRemove">
+    <el-tab-pane label="选项卡一">选项卡一内容</el-tab-pane>
+    <el-tab-pane label="选项卡二">选项卡二内容</el-tab-pane>
+    <el-tab-pane label="选项卡三">选项卡三内容</el-tab-pane>
+    <el-tab-pane label="选项卡四">选项卡四内容</el-tab-pane>
+  </el-tabs>
+</template>
+<script>
+  export default {
+    methods: {
+      handleRemove(tab) {
+        console.log(tab);
+      },
+      handleClick(tab) {
+        console.log(tab);
+      }
+    }
+  };
+</script>
 ```
 
-## TABS API
+## Tabs Attributes
 | 参数       | 说明     | 类型      | 可选值       | 默认值   |
 |---------- |-------- |---------- |-------------  |-------- |
 | type     | 风格类型   | string   | card, border-card  |         |
-| closable  | 真实值   | boolean   | true, false |  false  |
-| activeName  | 当前选中面板的 name  | string   |    |    |
-| on-click  | tab 被点击的钩子  | string   |    |    |
-| on-remove  | tab 被删除的钩子  | string   |    |    |
+| closable  | 标签是否可关闭   | boolean   | true, false |  false  |
+| active-name  | 选中选项卡的 name  | string   |    |    |
+| on-click  | tab 被选中的钩子(提供一个参数tab)  | function | |    |
+| on-remove  | tab 被删除的钩子(提供一个参数tab)  | function |   |
 
-## TAB-PANE API
+## TAB-PANE Attributes
 | 参数       | 说明     | 类型      | 可选值       | 默认值   |
 |---------- |-------- |---------- |-------------  |-------- |
 | label     | 选项卡标题   | string   |  |         |
-| name       | 与选项卡 activeName 对应的标识符   | string   |  |  该选项卡在选项卡中的 name 值，如第一个选项卡则为'1'  |
+| name       | 与选项卡 activeName 对应的标识符，表示选项卡别名   | string   |  |  该选项卡在选项卡中的 name 值，如第一个选项卡则为'1'  |