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

75 lines
2.4 KiB
Markdown
Raw Normal View History

2020-08-13 11:47:56 +08:00
# AlertBox
## Demos
### Types
`AlertBox` component has 3 contextual types, which are `success`, `info`, ` and `error`. Types are specified with the `type` prop.
[[ demo src="/demo/alert-box/type.vue" ]]
### With title
You can customize the title of alert box with the `title` prop.
[[ demo src="/demo/alert-box/title.vue" ]]
## API
### Props
| Name | Type | Default | Description |
| -- | -- | -- | -- |
| `open` | `boolean` | `false` | [^open] |
| `type` | `string=` | `'success'` | [^type] |
| `title` | `string=` | - | The title of the alert box. |
2021-08-23 19:37:43 +08:00
| `loading` | `boolean=` | `false` | Wehter the confirm box is in loading state. When loading, the OK button will enter loading state as well and become unclickable. |
| `disabled` | `boolean=` | `false` | Wehter the confirm box is disabled. When disabled, the OK button will be disabled as well and become unclickable. |
| `ok-label` | `string=` | - | The text content of the “OK” button. |
| `before-close` | `function(string): boolean=|Promise<boolean=>` | - | Executed when user interaction is about to trigger closing the alert box. See the [`before-close`](./dialog#props) prop of the [`Dialog`](./dialog) component. |
| `overlay-class` | `string|Array|Object=` | - | See the [`overlay-class`](./overlay#props) prop of the [`Overlay`](./overlay) component. |
| `overlay-style` | `string|Array|Object=` | - | See the [`overlay-style`](./overlay#props) prop of the [`Overlay`](./overlay) component. |
2020-08-13 11:47:56 +08:00
^^^open
:::badges
`.sync`
:::
Whether the alert box is displayed.
^^^
^^^type
The contextual type of the alert box.
+++Enum values
| Value | Description |
| -- | -- |
| `info` | Information alert box. |
| `success` | Success alert box. |
| `error` | Error alert box. |
+++
^^^
### Slots
| Name | Description |
| -- | -- |
| `default` | The content of the alert box. |
| `title` | The title of the alert box. Will ignore the `title` prop when specified. |
| `foot` | The foot area of the alert box. Displays an “OK” button by default. |
### Events
| Name | Description |
| -- | -- |
| `ok` | Triggered when the “OK” button is clicked. |
| `afterclose` | Triggered after the box overlay is closed. If leaving transition is provided by the theme, the event will be triggered after the transition completes. |
### Icons
| Name | Description |
| -- | -- |
| `info` | Information alert. |
| `success` | Success alert. |
| `error` | Error alert. |