feat: publicize doc implemetation
This commit is contained in:
38
one/docs/plugins/alert.md
Normal file
38
one/docs/plugins/alert.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# alert
|
||||
|
||||
## 安装
|
||||
|
||||
```js
|
||||
import alert from 'veui/plugins/alert'
|
||||
|
||||
Vue.use(alert)
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
该插件在安装后会在所有组件实例上提供 `$alert` 方法,类型为 `function(content, title, options): Promise<void>`。
|
||||
|
||||
该方法返回 `Promise` 对象,会在弹框成功关闭后被 resolve。
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| -- | -- | -- |
|
||||
| `content` | `string` | 显示在警告弹框中的文本内容。 |
|
||||
| `title` | `string` | 警告弹框的标题。 |
|
||||
| `options` | `Object=` | [^options] |
|
||||
|
||||
^^^options
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -- | -- | -- |
|
||||
| `type` | `string` | 提示类型,可选值为 `'success'`/`'warning'`/`'info'`/`'errro'`。默认值为 `'success'`。 |
|
||||
| `overlayClass` | `string|Object|Array<string>` | 添加到警告弹框浮层根节点的类名。 |
|
||||
| `ok` | `function(): Promise<void>` | 点击“知道了”按钮后调用。如果该函数返回的 `Promise` 被 resolve,则弹框会被关闭,否则不会关闭。 |
|
||||
^^^
|
||||
|
||||
`$alert` 方法上还提供如下快捷方法,将把 `options` 中的 `type` 指定为对应类型值:
|
||||
|
||||
| 方法名 | 类型 | 描述 |
|
||||
| -- | -- | -- |
|
||||
| `success` | `function(content, title, options): Promise<void>` | 展示“成功”样式的弹框。 |
|
||||
| `warn` | `function(content, title, options): Promise<void>` | 展示“警告”样式的弹框。 |
|
||||
| `info` | `function(content, title, options): Promise<void>` | 展示“普通消息”样式的弹框。 |
|
||||
| `error` | `function(content, title, options): Promise<void>` | 展示“错误”样式的弹框。 |
|
||||
29
one/docs/plugins/confirm.md
Normal file
29
one/docs/plugins/confirm.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# confirm
|
||||
|
||||
## 安装
|
||||
|
||||
```js
|
||||
import confirm from 'veui/plugins/confirm'
|
||||
|
||||
Vue.use(confirm)
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
该插件在安装后会在所有组件实例上提供 `$confirm` 方法,类型为 `function(content, title, options): Promise<boolean>`。
|
||||
|
||||
该方法返回 `Promise` 对象,会在弹框成功关闭后被 resolve。如果用户点击了“确定”按钮,则 resolve 值为 `true`,否则为 `false`。
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| -- | -- | -- |
|
||||
| `content` | `string` | 显示在确认弹框中的文本内容。 |
|
||||
| `title` | `string` | 确认弹框的标题。 |
|
||||
| `options` | `Object=` | [^options] |
|
||||
|
||||
^^^options
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -- | -- | -- |
|
||||
| `overlayClass` | `string|Object|Array<string>` | 添加到确认弹框浮层根节点的类名。 |
|
||||
| `ok` | `function(): Promise<void>` | 点击“确定”按钮后调用。如果该函数返回的 `Promise` 被 resolve,则弹框会被关闭,否则不会关闭。 |
|
||||
| `cancel` | `function(): Promise<void>` | 点击“取消”按钮后调用。如果该函数返回的 `Promise` 被 resolve,则弹框会被关闭,否则不会关闭。 |
|
||||
^^^
|
||||
29
one/docs/plugins/prompt.md
Normal file
29
one/docs/plugins/prompt.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# prompt
|
||||
|
||||
## 安装
|
||||
|
||||
```js
|
||||
import prompt from 'veui/plugins/prompt'
|
||||
|
||||
Vue.use(prompt)
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
该插件在安装后会在所有组件实例上提供 `$prompt` 方法,类型为 `function(content, title, options): Promise<?string>`。
|
||||
|
||||
该方法返回 `Promise` 对象,会在弹框成功关闭后被 resolve。如果用户点击了“确定”按钮,resolve 结果为用户输入的字符串;如果点击了“取消”按钮,结果值就为 `null`。
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| -- | -- | -- |
|
||||
| `content` | `string` | 显示在输入弹框中的文本内容。 |
|
||||
| `title` | `string` | 输入弹框的标题。 |
|
||||
| `options` | `Object=` | [^options] |
|
||||
|
||||
^^^options
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -- | -- | -- |
|
||||
| `overlayClass` | `string|Object|Array<string>` | 添加到输入弹框浮层根节点的类名。 |
|
||||
| `ok` | `function(): Promise<void>` | 点击“确定”按钮后,在 `success` 方法返回的 `Promise` resolve 前插入异步流程。如果该函数返回的 `Promise` 被 resolve,则弹框会被关闭,否则不会关闭。 |
|
||||
| `cancel` | `function(): Promise<void>` | 点击“取消”按钮后,在 `success` 方法返回的 `Promise` resolve 前插入异步流程。如果该函数返回的 `Promise` 被 resolve,则弹框会被关闭,否则不会关闭。 |
|
||||
^^^
|
||||
34
one/docs/plugins/toast.md
Normal file
34
one/docs/plugins/toast.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# toast
|
||||
|
||||
## 安装
|
||||
|
||||
```js
|
||||
import toast from 'veui/plugins/toast'
|
||||
|
||||
Vue.use(toast)
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
该插件在安装后会在所有组件实例上提供 `$toast` 对象,类型为 `function(message, options): void`。
|
||||
|
||||
| 参数名 | 类型 | 说明 |
|
||||
| -- | -- | -- |
|
||||
| `message` | `string` | 显示在消息弹层中的文本内容。 |
|
||||
| `options` | `Object=` | [^options] |
|
||||
|
||||
^^^options
|
||||
| 名称 | 类型 | 默认值 | 描述 |
|
||||
| -- | -- | -- | -- |
|
||||
| `type` | `string` | `'info'` | 提示类型,可选值为 `'success'`/`'warning'`/`'info'`/`'errro'`。 |
|
||||
| `duration` | `number` | `3000` | 设置消息经过指定的毫秒数之后消失。 |
|
||||
^^^
|
||||
|
||||
`$toast` 方法上还提供如下快捷方法,将把 `options` 中的 `type` 指定为对应类型值:
|
||||
|
||||
| 方法名 | 类型 | 描述 |
|
||||
| -- | -- | -- |
|
||||
| `success` | `function(message, options): void` | 展示“成功”样式的消息。 |
|
||||
| `warn` | `function(message, options): void` | 展示“警告”样式的消息。 |
|
||||
| `info` | `function(message, options): void` | 展示“普通消息”样式的消息。 |
|
||||
| `error` | `function(message, options): void` | 展示“错误”样式的消息。 |
|
||||
Reference in New Issue
Block a user