docs_vue2/one/docs/en-US/components/alert.md

92 lines
2.1 KiB
Markdown
Raw Normal View History

2020-08-13 11:47:56 +08:00
# Alert
## Demos
### Types
`Alert` component has 4 contextual types, which are `success`, `info`, `warning` and `error`. Types are specified with the [`type`](#props-type) prop.
2020-08-13 11:47:56 +08:00
[[ demo src="/demo/alert/type.vue" ]]
### Multiple messages
The [`message`](#props-message) prop can be an array to display multiple switchable messages.
2020-08-13 11:47:56 +08:00
[[ demo src="/demo/alert/multiple.vue" ]]
## API
### Props
| Name | Type | Default | Description |
| -- | -- | -- | -- |
| ``type`` | `string=` | `'success'` | [^type] |
| ``title`` | `string` | - | The alert title. |
| ``message`` | `string | Array<string>` | - | The alert message. When specified as an array, multiple messages will be displayed with previous/next navigation. |
| ``closable`` | `boolean=` | `false` | Whether the alert is allowed to be closed by users. |
| ``open`` | `boolean=` | `true` | [^open] |
| ``index`` | `number=` | `0` | [^index] |
2020-08-13 11:47:56 +08:00
^^^type
The contextual type of the alert message.
+++Enum values
| Value | Description |
| -- | -- |
| `info` | Information message. |
| `success` | Success message. |
| `warning` | Warning message. |
| `error` | Error message. |
+++
^^^
^^^open
:::badges
`.sync`
:::
Whether the message is displayed.
^^^
^^^index
:::badges
`.sync`
:::
The index of current message displayed when having multiple messages.
^^^
### Slots
| Name | Description |
| -- | -- |
| ``default`` | [^slot-default] |
| ``title`` | The content area of the alert title. |
| ``extra`` | The extra content after the alert message. |
| ``content`` | The content of the whole component, including message text, status icon, previous/next navigation and close button. |
2020-08-13 11:47:56 +08:00
^^^slot-default
2020-08-13 11:47:56 +08:00
The content of the message.
Default: message text.
2022-01-24 18:53:52 +08:00
+++Slot props
2020-08-13 11:47:56 +08:00
| Name | Type | Description |
| -- | -- | -- |
| `message` | `string` | Message text. |
| `index` | `number=` | The index of current message displayed when having multiple messages. |
+++
^^^
### Icons
| Name | Description |
| -- | -- |
| ``success`` | Success message. |
| ``warning`` | Warning message. |
| ``info`` | Information message. |
| ``error`` | Error message. |
| ``prev`` | Previous message. |
| ``next`` | Next message. |
| ``close`` | Close alert. |