mirror of https://github.com/ElemeFE/element
55 lines
1.5 KiB
Markdown
55 lines
1.5 KiB
Markdown
|
# element-message
|
||
|
|
> A element-message component for Vue.js.
|
||
|
|
|
||
|
|
## Demo
|
||
|
|
http://element-component.github.io/element-message
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
```shell
|
||
|
|
npm i element-message -D
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
```javascript
|
||
|
|
import Vue from 'vue'
|
||
|
|
import ElMessage from 'element-message'
|
||
|
|
import 'element-theme-default/dist/message.css'
|
||
|
|
|
||
|
|
Vue.use(ElMessage)
|
||
|
|
```
|
||
|
|
|
||
|
|
### 全局方法
|
||
|
|
|
||
|
|
Element 为 Vue.prototype 添加了全局方法 $message。因此在 vue instance 中可以采用本页面中的方式调用 `Message`。
|
||
|
|
|
||
|
|
此时调用方法为 `Message(options)`。我们也为每个 type 定义了各自的方法，如 `Message.success(options)`。
|
||
|
|
|
||
|
|
### Options
|
||
|
|
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
|
|
|---------- |-------------- |---------- |-------------------------------- |-------- |
|
||
|
|
| message | 消息文字 | string | — | — |
|
||
|
|
| type | 主题 | string | success/warning/info/error | info |
|
||
|
|
| duration | 显示时间, 毫秒。设为 0 则不会自动关闭 | number | — | 3000 |
|
||
|
|
| showClose | 是否显示关闭按钮 | boolean | — | false |
|
||
|
|
| onClose | 关闭时的回调函数, 参数为被关闭的 message 实例 | function | — | — |
|
||
|
|
|
||
|
|
### 方法
|
||
|
|
调用 `Message` 或 `this.$message` 会返回当前 Message 的实例。如果需要手动关闭实例，可以调用它的 `close` 方法。
|
||
|
|
| 方法名 | 说明 |
|
||
|
|
| ---- | ---- |
|
||
|
|
| close | 关闭当前的 Message |
|
||
|
|
|
||
|
|
## Development
|
||
|
|
```shell
|
||
|
|
make dev
|
||
|
|
|
||
|
|
## test
|
||
|
|
make test
|
||
|
|
|
||
|
|
## build
|
||
|
|
make build
|
||
|
|
```
|
||
|
|
|
||
|
|
# License
|
||
|
|
[MIT](https://opensource.org/licenses/MIT)
|