mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-14 01:11:25 +08:00
104 lines
6.1 KiB
Markdown
104 lines
6.1 KiB
Markdown
|
# Notification
|
||
|
|
|
||
|
|
Displays a global notification message at a corner of the page.
|
||
|
|
|
||
|
|
## Basic usage
|
||
|
|
|
||
|
|
:::demo Element Plus has registered the `$notify` method and it receives an object as its parameter. In the simplest case, you can set the `title` field and the` message` field for the title and body of the notification. By default, the notification automatically closes after 4500ms, but by setting `duration` you can control its duration. Specifically, if set to `0`, it will not close automatically. Note that `duration` receives a `Number` in milliseconds.
|
||
|
|
|
||
|
|
notification/basic
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## With types
|
||
|
|
|
||
|
|
We provide four types: success, warning, info and error.
|
||
|
|
|
||
|
|
:::demo Element Plus provides four notification types: `success`, `warning`, `info` and `error`. They are set by the `type` field, and other values will be ignored. We also registered methods for these types that can be invoked directly like `open3` and `open4` without passing a `type` field.
|
||
|
|
|
||
|
|
notification/different-types
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Custom position
|
||
|
|
|
||
|
|
Notification can emerge from any corner you like.
|
||
|
|
|
||
|
|
:::demo The `position` attribute defines which corner Notification slides in. It can be `top-right`, `top-left`, `bottom-right` or `bottom-left`. Defaults to `top-right`.
|
||
|
|
|
||
|
|
notification/positioning
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## With offset
|
||
|
|
|
||
|
|
Customize Notification's offset from the edge of the screen.
|
||
|
|
|
||
|
|
:::demo Set the `offset` attribute to customize Notification's offset from the edge of the screen. Note that every Notification instance of the same moment should have the same offset.
|
||
|
|
|
||
|
|
notification/offsetting
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Use HTML string
|
||
|
|
|
||
|
|
`message` supports HTML string.
|
||
|
|
|
||
|
|
:::demo Set `dangerouslyUseHTMLString` to true and `message` will be treated as an HTML string.
|
||
|
|
|
||
|
|
notification/raw-html
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
:::warning
|
||
|
|
|
||
|
|
Although `message` property supports HTML strings, dynamically rendering arbitrary HTML on your website can be very dangerous because it can easily lead to [XSS attacks](https://en.wikipedia.org/wiki/Cross-site_scripting). So when `dangerouslyUseHTMLString` is on, please make sure the content of `message` is trusted, and **never** assign `message` to user-provided content.
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Hide close button
|
||
|
|
|
||
|
|
It is possible to hide the close button
|
||
|
|
|
||
|
|
:::demo Set the `showClose` attribute to `false` so the notification cannot be closed by the user.
|
||
|
|
|
||
|
|
notification/no-close
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Global method
|
||
|
|
|
||
|
|
Element Plus has added a global method `$notify` for `app.config.globalProperties`. So in a vue instance you can call `Notification` like what we did in this page.
|
||
|
|
|
||
|
|
## Local import
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import { ElNotification } from 'element-plus'
|
||
|
|
```
|
||
|
|
|
||
|
|
In this case you should call `ElNotification(options)`. We have also registered methods for different types, e.g. `ElNotification.success(options)`. You can call `ElNotification.closeAll()` to manually close all the instances.
|
||
|
|
|
||
|
|
## Options
|
||
|
|
|
||
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
||
|
|
| ------------------------ | ------------------------------------------------------------------------------------------------------------------ | ---------------- | ------------------------------------------- | --------- |
|
||
|
|
| title | title | string | — | — |
|
||
|
|
| message | description text | string/Vue.VNode | — | — |
|
||
|
|
| dangerouslyUseHTMLString | whether `message` is treated as HTML string | boolean | — | false |
|
||
|
|
| type | notification type | string | success/warning/info/error | — |
|
||
|
|
| iconClass | custom icon's class. It will be overridden by `type` | string | — | — |
|
||
|
|
| customClass | custom class name for Notification | string | — | — |
|
||
|
|
| duration | duration before close. It will not automatically close if set 0 | number | — | 4500 |
|
||
|
|
| position | custom position | string | top-right/top-left/bottom-right/bottom-left | top-right |
|
||
|
|
| showClose | whether to show a close button | boolean | — | true |
|
||
|
|
| onClose | callback function when closed | function | — | — |
|
||
|
|
| onClick | callback function when notification clicked | function | — | — |
|
||
|
|
| offset | offset from the top edge of the screen. Every Notification instance of the same moment should have the same offset | number | — | 0 |
|
||
|
|
|
||
|
|
## Methods
|
||
|
|
|
||
|
|
`Notification` and `this.$notify` returns the current Notification instance. To manually close the instance, you can call `close` on it.
|
||
|
|
| Method | Description |
|
||
|
|
| ---- | ---- |
|
||
|
|
| close | close the Notification |
|