From f8cd9bdfe4ba720e668d471ca303e3f4fbc44c6f Mon Sep 17 00:00:00 2001 From: SkyAo Date: Wed, 7 Sep 2016 18:46:20 +0800 Subject: [PATCH] update document of basic --- examples/docs/alert.md | 10 +++++----- examples/docs/button.md | 3 +-- examples/docs/card.md | 2 +- examples/docs/dialog.md | 31 +++---------------------------- examples/docs/icon.md | 4 +--- examples/docs/layout.md | 14 +++++++------- examples/docs/loading.md | 10 +++++----- examples/docs/message-box.md | 8 ++++---- examples/docs/message.md | 4 ++-- 9 files changed, 29 insertions(+), 57 deletions(-) diff --git a/examples/docs/alert.md b/examples/docs/alert.md index 8502902cb..b4d975560 100644 --- a/examples/docs/alert.md +++ b/examples/docs/alert.md @@ -11,7 +11,7 @@ .demo-box.demo-alert .el-alert { margin: 20px 0 0; } - + .demo-box.demo-alert .el-alert:first-child { margin: 0; } @@ -23,7 +23,7 @@ ### 基本用法 -页面中的非浮层元素,不会自动消失 +页面中的非浮层元素,不会自动消失。 ::: demo Alert 组件提供四种主题,由`type`属性指定,默认值为`info`。 ```html @@ -50,7 +50,7 @@ ### 自定义关闭按钮 -自定义关闭按钮为文字或其他符号 +自定义关闭按钮为文字或其他符号。 ::: demo 在 Alert 组件中,你可以设置是否可关闭,关闭按钮的文本以及关闭时的回调函数。`closable`属性决定是否可关闭,接受`boolean`,默认为`true`。你可以设置`close-text`属性来代替右侧的关闭图标,注意:`close-text`必须为文本。设置`close`事件来设置关闭时的回调。 ```html @@ -86,7 +86,7 @@ ### 带有 icon -表示某种状态时提升可读性 +表示某种状态时提升可读性。 ::: demo 通过设置`show-icon`属性来显示 Alert 的 icon,这能更有效地向用户展示你的显示意图。 ```html @@ -117,7 +117,7 @@ ### 带有辅助性文字介绍 -包含标题和内容,解释更详细的警告 +包含标题和内容,解释更详细的警告。 ::: demo 除了必填的`title`属性外,你可以设置`description`属性来帮助你更好地介绍,我们称之为辅助性文字。辅助性文字只能存放单行文本,会自动换行显示。 ```html diff --git a/examples/docs/button.md b/examples/docs/button.md index ab268ba30..ad94c330d 100644 --- a/examples/docs/button.md +++ b/examples/docs/button.md @@ -64,7 +64,7 @@ ## Button 按钮 -常用的操作按钮 +常用的操作按钮。 ### 基础用法 @@ -146,7 +146,6 @@ 上一页 下一页 -
diff --git a/examples/docs/card.md b/examples/docs/card.md index a06637c83..0538f8029 100644 --- a/examples/docs/card.md +++ b/examples/docs/card.md @@ -43,7 +43,7 @@ } ## Card 卡片 -将信息聚合在卡片容器中展示 +将信息聚合在卡片容器中展示。 ### 基础用法 diff --git a/examples/docs/dialog.md b/examples/docs/dialog.md index 5ac5cb9c3..174fc49be 100644 --- a/examples/docs/dialog.md +++ b/examples/docs/dialog.md @@ -64,7 +64,7 @@ } ## Dialog 对话框 -在保留当前页面状态的情况下,告知用户并承载相关操作 +在保留当前页面状态的情况下,告知用户并承载相关操作。 ### 基本用法 @@ -85,31 +85,6 @@ Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只 ``` ::: -### 设置尺寸 - -:::demo 提供四种尺寸:`tiny`, `small`, `large`, `full`。通过`size`属性来设置。 - -```html - -点击打开小尺寸 Dialog - - - 这是一段内容 - - 取 消 - 确 定 - - - - -点击打开全屏幕 Dialog - - - - -``` -::: - ### 使用 Dialog 方法打开 :::demo 使用实例`open`和`close`方法,不用显式改变`v-modal`的值。 @@ -141,7 +116,7 @@ Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只 ### 自定义内容 -Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单,下面是应用了 Element Table 和 Form 组件的两个样例,除此以外,它们并没有什么特殊之处。 +Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单,下面是应用了 Element Table 和 Form 组件的两个样例。 :::demo ```html @@ -196,7 +171,7 @@ Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单 | footer | Dialog 按钮操作区的内容 | ### 方法 -每个`el-dialog`实例都暴露了如下方法,用于在不显式改变`v-model`值的情况下打开 / 关闭实例: +每个 `el-dialog` 实例都暴露了如下方法,用于在不显式改变 `v-model` 值的情况下打开 / 关闭实例: | 方法名 | 说明 | |------|--------| | open | 打开当前实例 | diff --git a/examples/docs/icon.md b/examples/docs/icon.md index e1d73164c..f6f61365d 100644 --- a/examples/docs/icon.md +++ b/examples/docs/icon.md @@ -60,7 +60,7 @@ ### 使用方法 -直接通过设置类名为`el-icon-iconName`来使用即可。 +直接通过设置类名为 `el-icon-iconName` 来使用即可。例如: :::demo ```html @@ -74,8 +74,6 @@ ### 图标集合 -下面是目前 Element 所有的图标集合: -