From 066c8f727f3b5c611983893a9bd058bfa2e65798 Mon Sep 17 00:00:00 2001 From: SkyAo Date: Fri, 19 Aug 2016 14:45:08 +0800 Subject: [PATCH] finish documents of basic & fix bug --- examples/docs/button.md | 2 +- examples/docs/dialog.md | 103 ++++++++++++++++++++++------- examples/docs/loading.md | 24 ++++--- examples/docs/message.md | 76 ++++++++++++--------- examples/docs/notification.md | 72 ++++++++++++-------- examples/docs/popover.md | 31 +++++---- examples/docs/tooltip.md | 9 ++- examples/icon.json | 2 +- packages/message/src/main.vue | 2 +- packages/notification/src/main.vue | 5 +- 10 files changed, 211 insertions(+), 115 deletions(-) diff --git a/examples/docs/button.md b/examples/docs/button.md index 771b04635..d5213c433 100644 --- a/examples/docs/button.md +++ b/examples/docs/button.md @@ -138,7 +138,7 @@ Button 组件提供的`loading`属性可以方便的让你处理 loading 状态 Search -除此以外,你也可以设置在文字右边的 icon ,只要使用`i`标签即可,使用图标组件来实现它: +除此以外,你也可以设置在文字右边的 icon ,只要使用`i`标签即可,使用图标组件来实现它,由此,你可以使用自己的图标了:
Upload diff --git a/examples/docs/dialog.md b/examples/docs/dialog.md index f8604a4ed..275fd11e6 100644 --- a/examples/docs/dialog.md +++ b/examples/docs/dialog.md @@ -24,6 +24,7 @@ dialogFullVisible: false, dialogStubbornVisible: false, dialogTableVisible: false, + dialogBindVisible: false, dialogFormVisible: false, form: { name: '', @@ -37,6 +38,11 @@ }, formLabelWidth: '80px' }; + }, + methods: { + openDialog() { + this.$refs.dialogBind.open(); + } } }; @@ -51,7 +57,7 @@ } .el-dialog__wrapper { margin: 0; - } + } .el-input { width: 300px; } @@ -60,7 +66,15 @@ ## 基本用法 -点击打开 Dialog +Dialog 弹出一个对话框,适合需要定制性更大的场景,如果只是弹出框,可以尝试 MessageBox 组件。 + +要使用 Dialog 组件,首先你需要设置`v-model`属性,它接收`Boolean`,当为`true`时显示 Dialog。 + +Dialog 分为两个部分:`body`和`footer`,`footer`需要具名为`footer`的`slot`。 + +`title`属性用于定义标题,它是可选的,默认值为空,下面是一个最简单的用例: + +点击打开 Dialog
@@ -73,7 +87,7 @@
```html -点击打开 Dialog +点击打开 Dialog 这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息 @@ -86,7 +100,9 @@ ## 设置尺寸 -点击打开小尺寸 Dialog +Dialog 组件提供四种尺寸:`tiny`, `small`, `large`, `full`。通过`size`属性来设置,下面是一个 tiny 的例子。 + +点击打开小尺寸 Dialog
@@ -99,7 +115,7 @@
```html -点击打开小尺寸 Dialog +点击打开小尺寸 Dialog 这是一段内容 @@ -110,7 +126,9 @@ ``` -点击打开全屏幕 Dialog +下面是一个全屏幕 Dialog 的样例: + +点击打开全屏幕 Dialog
@@ -119,16 +137,18 @@
```html -点击打开全屏幕 Dialog +点击打开全屏幕 Dialog ``` -## 设置能否通过点击modal或按下esc关闭dialog +## 设置能否通过点击modal或按下esc关闭Dialog -打开 Dialog,点击 modal 或按下 esc 关闭无法将其关闭 +在默认条件下,你可以通过 ESC 和点击 modal 关闭 Dialog,但是可以通过设置`close-on-click-modal`属性和`close-on-press-escape`属性来关闭这一功能,它们接收`Boolean`,默认均为`true`。 + +打开 Dialog,点击 modal 或按下 esc 关闭无法将其关闭
```html -打开 Dialog,点击 modal 或按下 esc 关闭无法将其关闭 +打开 Dialog,点击 modal 或按下 esc 关闭无法将其关闭 ``` +## 使用 Dialog 方法打开 + +使用`v-model`确实是一个不错的做法,为了一些特殊需求,我们暴露了实例`open`和`close`方法,你可以不用显式改变`v-modal`的值了: + +使用Dialog方法 + +
+ + 这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息,这是一段信息 + +
+ +```html + + +``` + ## 自定义内容 -打开嵌套表格的 Dialog +Dialog 组件的正文标题可以是任意的,甚至可以是表格或表单,下面是应用了 Element Table 和 Form 组件的两个样例,除此以外,它们并没有什么特殊之处: + +打开嵌套表格的 Dialog
@@ -164,7 +220,7 @@
-打开嵌套表单的 Dialog +打开嵌套表单的 Dialog
@@ -187,7 +243,7 @@
```html -打开嵌套表格的 Dialog +打开嵌套表格的 Dialog @@ -197,7 +253,7 @@ -打开嵌套表单的 Dialog +打开嵌套表单的 Dialog @@ -218,23 +274,24 @@ ``` -## API +## Attributes | 参数 | 说明 | 类型 | 可选值 | 默认值 | |---------- |-------------- |---------- |-------------------------------- |-------- | -| title | dialog 的标题 | string | | | -| size | dialog 的大小 | string | 'tiny', 'small', 'large', 'full' | 'small' | -| customClass | dialog 的自定义类名 | string | | | -| closeOnClickModal | 是否可以通过点击 modal 关闭 dialog | boolean | | true | -| closeOnPressEscape | 是否可以通过按下 esc 关闭 dialog | boolean | | true | +| title | Dialog 的标题 | string | | | +| size | Dialog 的大小 | string | 'tiny', 'small', 'large', 'full' | 'small' | +| modal | 是否需要遮罩层 | boolean | | true | +| customClass | Dialog 的自定义类名 | string | | | +| closeOnClickModal | 是否可以通过点击 modal 关闭 Dialog | boolean | | true | +| closeOnPressEscape | 是否可以通过按下 ESC 关闭 Dialog | boolean | | true | ## Slot | name | 说明 | |------|--------| -| - | dialog 的内容 | -| footer | dialog 按钮操作区的内容 | +| - | Dialog 的内容 | +| footer | Dialog 按钮操作区的内容 | ## 方法 -每个 el-dialog 实例都暴露了如下方法,用于在不使用 v-model 的情况下打开 / 关闭实例: +每个`el-dialog`实例都暴露了如下方法,用于在不显式改变`v-model`值的情况下打开 / 关闭实例: | 方法名 | 说明 | |------|--------| | open | 打开当前实例 | diff --git a/examples/docs/loading.md b/examples/docs/loading.md index 6980895ce..05bf4aacc 100644 --- a/examples/docs/loading.md +++ b/examples/docs/loading.md @@ -3,7 +3,7 @@ border: solid 1px #999; padding: 10px; text-align: center; - + p { font-size: 30px; color: #999; @@ -43,7 +43,7 @@ }] } }, - + methods: { loadTable() { this.tableLoading = true; @@ -51,7 +51,7 @@ this.tableLoading = false; }, 2000); }, - + openFullScreen() { this.fullscreenLoading = true; setTimeout(() => { @@ -64,14 +64,16 @@ ## 基本用法 -打开 / 关闭 loading +在 Loading 组件中,Element 准备了自定义命令`v-loading`,只需要绑定`Boolean`即可,默认状况下,Loading 遮罩会插入到绑定元素的子节点。 + +打开 / 关闭 loading

点击上面的按钮,本区域显示 loading 遮罩

```html -打开 / 关闭 loading +打开 / 关闭 loading

点击上面的按钮,本区域显示 loading 遮罩

@@ -80,16 +82,16 @@ ## 修饰符 -loading 遮罩默认插入至绑定了 `v-loading` 指令的元素上。通过添加 `body` 修饰符,可以使遮罩插入至 body 上 +Loading 遮罩默认插入至绑定了 `v-loading` 指令的元素上。通过添加 `body` 修饰符,可以使遮罩插入至 DOM 中的 body 上。 -打开 / 关闭 loading +打开 / 关闭 loading

点击上面的按钮,本区域显示 loading 遮罩

```html -打开 / 关闭 loading +打开 / 关闭 loading

点击上面的按钮,本区域显示 loading 遮罩

@@ -98,13 +100,13 @@ loading 遮罩默认插入至绑定了 `v-loading` 指令的元素上。通过 当需要全屏遮罩时,可使用 `fullscreen` 修饰符(此时遮罩会插入至 body 上) -打开全屏 loading +打开全屏 loading ```html