From 9919ef5c8a3febb224e96be172665b9fe9b3ca3c Mon Sep 17 00:00:00 2001 From: SkyAo Date: Fri, 26 Aug 2016 18:34:54 +0800 Subject: [PATCH] change all rewrited components documents to new templates --- examples/docs/badge.md | 13 ++-- examples/docs/breadcrumb.md | 7 +- examples/docs/button.md | 17 +++-- examples/docs/card.md | 10 ++- examples/docs/checkbox.md | 12 +-- examples/docs/dialog.md | 16 ++-- examples/docs/dropdown.md | 134 +++++----------------------------- examples/docs/icon.md | 2 +- examples/docs/input-number.md | 12 +-- examples/docs/loading.md | 6 +- examples/docs/message-box.md | 12 +-- examples/docs/pagination.md | 63 ++++------------ examples/docs/popover.md | 92 ++++------------------- examples/docs/progress.md | 24 ++---- examples/docs/radio.md | 81 ++++++-------------- examples/docs/steps.md | 89 +++++----------------- examples/docs/table.md | 7 +- examples/docs/tabs.md | 14 ++-- examples/docs/tag.md | 13 ++-- examples/docs/tooltip.md | 78 +++++--------------- packages/table/src/table.vue | 13 ++-- 21 files changed, 207 insertions(+), 508 deletions(-) diff --git a/examples/docs/badge.md b/examples/docs/badge.md index 646942b7f..d1f0497eb 100644 --- a/examples/docs/badge.md +++ b/examples/docs/badge.md @@ -1,4 +1,7 @@ -## 基础用法 +## Badge 标记 +出现在按钮、图标旁的数字或状态标记 + +### 基础用法 Badge 组件可以在右上角展示标记,最常见的用法是用于展示消息数。 :::demo 定义`value`属性,它接受`Number`或者`String`。 @@ -24,7 +27,7 @@ Badge 组件可以在右上角展示标记,最常见的用法是用于展示 ``` ::: -## 最大值 +### 最大值 为了方便使用,Badge 组件可以自定义显示的最大值。 :::demo 由`max`属性定义,它接受一个`Number`,需要注意的是,只有当`value`为`Number`时,它才会生效。 @@ -39,7 +42,7 @@ Badge 组件可以在右上角展示标记,最常见的用法是用于展示 ``` ::: -## 自定义内容 +### 自定义内容 下面是两个样例,它们可以启发你在适时的情况使用 Badge: @@ -55,7 +58,7 @@ Badge 组件可以在右上角展示标记,最常见的用法是用于展示 ``` ::: -## 小红点 +### 小红点 可以使 Badge 组件显示为一个小红点,来提醒用户需要关注的内容,此时设置其他属性均无效。 @@ -90,7 +93,7 @@ Badge 组件可以在右上角展示标记,最常见的用法是用于展示 } -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |------------- |---------------- |---------------- |---------------------- |-------- | | value | 显示值 | string, number | | | diff --git a/examples/docs/breadcrumb.md b/examples/docs/breadcrumb.md index 7f702c42b..6a44f3525 100644 --- a/examples/docs/breadcrumb.md +++ b/examples/docs/breadcrumb.md @@ -1,4 +1,7 @@ -## 基础使用 +## Breadcrumb 面包屑 +显示当前页面的路径,快速返回之前的任意页面 + +### 基础使用 Breadcrumb,面包屑导航,用于提供给用户一个回溯到首页的路径,最后一级即为当前位置。 @@ -14,7 +17,7 @@ Breadcrumb,面包屑导航,用于提供给用户一个回溯到首页的路 ``` ::: -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------------- |---------- |-------------------------------- |-------- | | separator | 分隔符 | string | | 斜杠'/' | diff --git a/examples/docs/button.md b/examples/docs/button.md index b89321c9b..c89e1d398 100644 --- a/examples/docs/button.md +++ b/examples/docs/button.md @@ -29,7 +29,10 @@ } -## 基础用法 +## Button 按钮 +常用的操作按钮 + +### 基础用法 :::demo Button 组件默认提供7种主题,由`type`属性来定义,默认为`default`。 @@ -51,7 +54,7 @@ ``` ::: -## Plain Button +### Plain Button 默认的`Default`主题,我们称之为朴素按钮(Plain Button),你可以 hover 在样例上进行预览。 :::demo 朴素按钮同样设置了不同的`type`属性对应的样式(可选值同上),默认为`info`。设置`plain`属性,它接受一个`Boolean`。注意,在该情况下,`type`虽然可以为`text`,但是是没有意义的,会显示为`text button`的样式。 @@ -65,7 +68,7 @@ ``` ::: -## 尺寸 +### 尺寸 Button 组件提供除了默认值以外的三种尺寸,可以在不同场景下选择合适的按钮尺寸。 @@ -79,7 +82,7 @@ Button 组件提供除了默认值以外的三种尺寸,可以在不同场景 ``` ::: -## Loading +### Loading 可以方便的处理 loading 状态,点击下面的按钮预览效果。 @@ -93,7 +96,7 @@ Button 组件提供除了默认值以外的三种尺寸,可以在不同场景 ``` ::: -## 图标按钮 +### 图标按钮 带图标的按钮可增强辨识度(有文字)或节省空间(无文字)。 @@ -106,7 +109,7 @@ Button 组件提供除了默认值以外的三种尺寸,可以在不同场景 ``` ::: -## 按钮组 +### 按钮组 如果你需要多个并列的按钮,按钮组可以帮你轻松的实现它。 @@ -127,7 +130,7 @@ Button 组件提供除了默认值以外的三种尺寸,可以在不同场景 ``` ::: -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------- |---------- |------------- |-------- | | size | 尺寸 | string | large,small,mini | | diff --git a/examples/docs/card.md b/examples/docs/card.md index 0b92dc293..4ecd3a75d 100644 --- a/examples/docs/card.md +++ b/examples/docs/card.md @@ -42,8 +42,10 @@ @utils-clearfix; } +## Card 卡片 +将信息聚合在卡片容器中展示 -## 基础用法 +### 基础用法 下面是一个带有标题、内容和操作(按钮)的 Card 组件示例,需要注意的是,部分样式需要你自己填入。 @@ -62,7 +64,7 @@ ``` ::: -## 简单卡片 +### 简单卡片 卡片可以只有内容区域。 @@ -76,7 +78,7 @@ ``` ::: -## 进阶使用 +### 进阶使用 可以让你的卡片极大程度的被个性化,为更丰富的内容展示服务。 下例是一个带图片的示例,能帮助你更好地理解`body-style`配合分发内容自定义样式的强大: @@ -100,7 +102,7 @@ ``` ::: -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------- |---------- |------------- |-------- | | header | 设置 header,也可以通过 `slot#header` 传入 DOM | string| | | diff --git a/examples/docs/checkbox.md b/examples/docs/checkbox.md index f868dcbc1..a4f04f82d 100644 --- a/examples/docs/checkbox.md +++ b/examples/docs/checkbox.md @@ -25,8 +25,10 @@ } } +## Checkbox 多选框 +一组备选项中进行多选 -## 基础用法 +### 基础用法 :::demo 在`el-checkbox`元素中定义`v-model`绑定变量,单一的`checkbox`中,默认绑定变量的值会是`Boolean`,选中为`true`。 @@ -46,7 +48,7 @@ ``` ::: -## 多选框组 +### 多选框组 :::demo `checkbox-group`元素能把多个 checkbox 管理为一组,只需要在 Group 中使用`v-model`绑定`Array`类型的变量即可,`label`属性除了改变 checkbox 按钮后的介绍外,同时也是该 checkbox 对应的值,`label`与数组中的元素值相对应,如果存在指定的值则为选中状态,否则为不选中。 @@ -76,7 +78,7 @@ ``` ::: -## 绑定 value 的多选框 +### 绑定 value 的多选框 :::demo 使用`true-label`和`false-label`可以自定义选中时和未选中时的值,可以为`String`或`Number`类型。 @@ -104,7 +106,7 @@ ``` ::: -## Checkbox Attributes +### Checkbox Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------- |---------- |------------- |-------- | | label | 选中状态的值(只有在`checkbox-group`下有意义) | string | | | @@ -112,7 +114,7 @@ | false-label | 没有选中时的值 | string, number | | | | disabled | 按钮禁用 | boolean | | false | -## Checkbox-group Events +### Checkbox-group Events | 事件名称 | 说明 | 回调参数 | |---------- |-------- |---------- | | change | 当绑定值变化时触发的事件 | 选中的 Checkbox Label 值 | diff --git a/examples/docs/dialog.md b/examples/docs/dialog.md index c8f8d266f..164109638 100644 --- a/examples/docs/dialog.md +++ b/examples/docs/dialog.md @@ -63,8 +63,10 @@ } } +## Dialog 对话框 +在保留当前页面状态的情况下,告知用户并承载相关操作 -## 基本用法 +### 基本用法 Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只是弹出框,可以尝试 MessageBox 组件。 @@ -83,7 +85,7 @@ Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只 ``` ::: -## 设置尺寸 +### 设置尺寸 :::demo 提供四种尺寸:`tiny`, `small`, `large`, `full`。通过`size`属性来设置。 @@ -108,7 +110,7 @@ Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只 ``` ::: -## 使用 Dialog 方法打开 +### 使用 Dialog 方法打开 :::demo 使用实例`open`和`close`方法,不用显式改变`v-modal`的值。 @@ -137,7 +139,7 @@ Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只 ``` ::: -## 自定义内容 +### 自定义内容 Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单,下面是应用了 Element Table 和 Form 组件的两个样例,除此以外,它们并没有什么特殊之处。 @@ -177,7 +179,7 @@ Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单 ``` ::: -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------------- |---------- |-------------------------------- |-------- | | title | Dialog 的标题 | string | | | @@ -187,13 +189,13 @@ Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单 | closeOnClickModal | 是否可以通过点击 modal 关闭 Dialog | boolean | | true | | closeOnPressEscape | 是否可以通过按下 ESC 关闭 Dialog | boolean | | true | -## Slot +### Slot | name | 说明 | |------|--------| | - | Dialog 的内容 | | footer | Dialog 按钮操作区的内容 | -## 方法 +### 方法 每个`el-dialog`实例都暴露了如下方法,用于在不显式改变`v-model`值的情况下打开 / 关闭实例: | 方法名 | 说明 | |------|--------| diff --git a/examples/docs/dropdown.md b/examples/docs/dropdown.md index a883465ef..1227e4512 100644 --- a/examples/docs/dropdown.md +++ b/examples/docs/dropdown.md @@ -22,23 +22,15 @@ } } +## Dropdown 下拉菜单 -## 基础用法 +将动作或菜单折叠到下拉菜单中。 -Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可生成对应的下拉菜单,通过`text`属性来设置按钮文字。 +### 基础用法 -默认条件下,他又一个主要按钮和一个下拉按钮组成,`el-dropdown`中的主要按钮同样可以设置点击事件,只要使用`mainclick`事件即可。 +移动到下拉菜单上,展开更多操作。 -默认情况下,下拉按钮只要`hover`即可,无需点击也会显示下拉菜单。 - -
- - 选项一 - 选项二 - 选项三 - 选项四 哈哈哈哈 - -
+:::demo 通过`text`属性来设置按钮文字。默认条件下,他由一个主要按钮和一个下拉按钮组成,`el-dropdown`中的主要按钮同样可以设置点击事件,只要使用`mainclick`事件即可。默认情况下,下拉按钮只要`hover`即可,无需点击也会显示下拉菜单。 ```html @@ -48,19 +40,11 @@ Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可 选项四 ``` +::: -## 不带独立按钮的下拉菜单 +### 不带独立按钮的下拉菜单 -如果不需要默认的主要按钮与下拉按钮的组合,可以通过设置`icon-separate`属性来呈现不带独立按钮的下拉菜单,它接受一个`Boolean`,设置为`false`即可。 - -在下例中,可以看到,在选项三和选项四中插入了一条分割线,要达成这个效果很简单,只需要在选项四中设置`class`为`divider`。 - - - 选项一 - 选项二 - 选项三 - 选项四 - +:::demo 设置`icon-separate`属性来呈现不带独立按钮的下拉菜单,设置为`false`即可。在选项三和选项四中插入了一条分割线,只需要在选项四中设置`class`为`divider`。 ```html @@ -70,26 +54,11 @@ Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可 选项四 ``` +::: -## 通过点击触发下拉 - -默认通过 Hover 即可出现下拉菜单,如果有需求,可以改成 click ,只要在`trigger`属性设置为`click`即可。 - -
- - 选项一 - 选项二 - 选项三 - 选项四 哈哈哈哈 - - - 选项一 - 选项二 - 选项三 - 选项四 - -
+### 通过点击触发下拉 +:::demo 在`trigger`属性设置为`click`即可。 ```html 选项一 @@ -104,20 +73,13 @@ Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可 选项四 ``` +::: -## 按钮样式 +### 按钮样式 除了上述属性以外,由于本质还是按钮,`el-dropdown`同样拥有 Button 组件的相关属性:`type`和`size`,关于这点,可以参考 Button 组件的对应文档,下两例说明了相应字段的功能: -
- - 选项一 - 选项二 - 选项三 - 选项四 - -
- +:::demo ```html 选项一 @@ -126,34 +88,9 @@ Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可
  • 选项四 ``` +::: -
    - - 选项一 - 选项二 - 选项三 -
  • 选项四 - - - 选项一 - 选项二 - 选项三 - 选项四 - - - 选项一 - 选项二 - 选项三 - 选项四 - - - 选项一 - 选项二 - 选项三 - 选项四 - - - +:::demo ```html 选项一 @@ -180,44 +117,9 @@ Dropdown 组件只需要`el-dropdown`和它的子元素`el-dropdown-item`即可 选项四 ``` +::: -## 对齐方式 - -下拉菜单的对齐方式有两种:`start`与`end`,在下例中演示了它们的区别,你可以通过设置`menu-align`来选择一种对齐方式,默认为`end`: - -
    - - 选项一 - 选项二 - 选项三 - 选项四 - - - - 选项一 - 选项二 - 选项三 - 选项四 - -
    - -```html - - 选项一 - 选项二 - 选项三 - 选项四 - - - - 选项一 - 选项二 - 选项三 - 选项四 - -``` - -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |------------- |---------------- |---------------- |---------------------- |-------- | | text | 菜单按钮文本 | string | | | diff --git a/examples/docs/icon.md b/examples/docs/icon.md index 0007f931b..08611c1c2 100644 --- a/examples/docs/icon.md +++ b/examples/docs/icon.md @@ -48,7 +48,7 @@ } } -## icon-font 图标 +## Icon 图标 提供了一套常用的图标集合。 diff --git a/examples/docs/input-number.md b/examples/docs/input-number.md index 5d0f732d5..642b497d7 100644 --- a/examples/docs/input-number.md +++ b/examples/docs/input-number.md @@ -16,8 +16,10 @@ } } +## Input Number 数字输入框 +通过鼠标或键盘输入字符 -## 基础使用 +### 基础使用 需要标准的数字值时可以用到 Input Number 组件,你提供了数值输入提供了范围控制和递增递减的步数控制。 @@ -41,7 +43,7 @@ ``` ::: -## 禁用状态 +### 禁用状态 :::demo `disabled`属性接受一个`Boolean`,设置为`true`即可禁用整个组件,如果你只需要控制数值在某一范围内,可以设置`min`属性和`max`属性,不设置`min`和`max`时,最小值为 0。 @@ -51,7 +53,7 @@ ``` ::: -## 步长 +### 步长 让组件按照步长来增减。 @@ -62,7 +64,7 @@ ``` ::: -## 尺寸 +### 尺寸 和其他组件一样,Input Number 同样具有不同的尺寸。 @@ -75,7 +77,7 @@ ``` ::: -## Attributes +### Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |----------|-------------- |----------|-------------------------------- |-------- | | min | 设置计数器允许的最小值 | number | | 0 | diff --git a/examples/docs/loading.md b/examples/docs/loading.md index e4fd20968..006b5b033 100644 --- a/examples/docs/loading.md +++ b/examples/docs/loading.md @@ -62,8 +62,10 @@ } } +## Loading 加载 +加载数据时显示动效 -## 基本用法 +### 基本用法 :::demo 在 Loading 组件中,Element 准备了自定义命令`v-loading`,只需要绑定`Boolean`即可,默认状况下,Loading 遮罩会插入到绑定元素的子节点。 @@ -76,7 +78,7 @@ ``` ::: -## 修饰符 +### 修饰符 通过修饰符,我们可以使用全屏幕 Loading 或将 Loading 设置在 body 上。 diff --git a/examples/docs/message-box.md b/examples/docs/message-box.md index 59eb27f31..500381d89 100644 --- a/examples/docs/message-box.md +++ b/examples/docs/message-box.md @@ -61,8 +61,10 @@ } }; +## Message box 信息提示 +模拟系统的消息提示框而实现的一套摸态对话框组件,用于消息提示、成功提示、错误提示、询问信息 -## 基本用法 +### 基本用法 MessageBox 组件提供了四种不同的样式来替代浏览器提供的`alert`等功能:`$msgbox`,`$alert`,`$confirm`以及`$prompt`。 @@ -87,7 +89,7 @@ MessageBox 组件提供了四种不同的样式来替代浏览器提供的`alert ``` ::: -## 配置项 +### 配置项 MessageBox 组件也拥有极高的定制性,我们可以传入`options`作为第三个参数,它是一个字面量对象。 @@ -209,11 +211,11 @@ Msgbox 框是最基本的弹框,与 Alert 的区别在于 Alert 无法通过 E ``` ::: -## 全局方法 +### 全局方法 Element 为 Vue.prototype 添加了如下全局方法:$msgbox, $alert, $confirm 和 $prompt。因此在 vue instance 中可以采用本页面中的方式调用 `MessageBox`。 -## 单独引用 +### 单独引用 单独引入 `MessageBox`: @@ -223,7 +225,7 @@ import { MessageBox } from 'element-ui'; 对应于上述四个全局方法的调用方法依次为:MessageBox, MessageBox.alert, MessageBox.confirm 和 MessageBox.prompt。 -## Options +### Options | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------------- |---------- |-------------------------------- |-------- | diff --git a/examples/docs/pagination.md b/examples/docs/pagination.md index 89e82b9c0..77db1f655 100644 --- a/examples/docs/pagination.md +++ b/examples/docs/pagination.md @@ -1,31 +1,23 @@ -## 基础用法 +## Pagination 分页 -Pagination 组件实现分页,只要设置`Number`类型的`total`值即可,它代表页码的个数,之后我们还可以设置`layout`,代码需要显示的内容,用逗号分隔,布局元素会依次显示。 +当数据量过多时,使用分页分解数据 -下例中,`prev`表示上一页,`next`为上一页,`pager`表示页码列表,除此以外还提供了`jumper`和`total`,`size`和特殊的布局符号`->`,`->`后的元素会靠右显示,`jumper`表示跳页元素,`total`表示显示页码总数,`size`用于设置每页显示的页码数量。 - - - +### 基础用法 +:::demo 设置`layout`,表示需要显示的内容,用逗号分隔,布局元素会依次显示。`prev`表示上一页,`next`为上一页,`pager`表示页码列表,除此以外还提供了`jumper`和`total`,`size`和特殊的布局符号`->`,`->`后的元素会靠右显示,`jumper`表示跳页元素,`total`表示显示页码总数,`size`用于设置每页显示的页码数量。 ```html ``` +::: -## 小型分页 +### 小型分页 -在空间有限的情况下,可以使用简单的小型分页,只需要一个`small`属性,它接受一个`Boolean`,默认为`false`,设为`true`即可启用。 - - - +在空间有限的情况下,可以使用简单的小型分页。 +:::demo 只需要一个`small`属性,它接受一个`Boolean`,默认为`false`,设为`true`即可启用。 ```html ``` +::: -## 附加功能 +### 附加功能 -此例是一个完整的用例,使用了`sizechange`和`currentchange`事件来处理页码大小和当前页变动时候触发的事件。 - -`page-sizes`接受一个整型数组,数组元素为展示的选择每页显示个数的选项,`[100, 200, 300, 400]`表示四个选项,每页显示100个,200个,300个或者400个。 - -`page-size`接受一个`Number`,表示每页显示个数。 - -`current-page`接受一个`Number`,表示当前页页码。 - - - +:::demo 此例是一个完整的用例,使用了`sizechange`和`currentchange`事件来处理页码大小和当前页变动时候触发的事件。`page-sizes`接受一个整型数组,数组元素为展示的选择每页显示个数的选项,`[100, 200, 300, 400]`表示四个选项,每页显示100个,200个,300个或者400个。 ```html