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

2.5 KiB

AlertBox

Demos

Types

AlertBox component has 3 contextual types, which are success, info, anderror. Types are specified with the [type`](#props-type) prop.

With title

You can customize the title of alert box with the title prop.

API

Props

Name Type Default Description
open boolean false [^open]
type string= 'success' [^type]
title string= - The title of the alert box.
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=>` -
overlay-class `string Array Object=`
overlay-style `string Array Object=`

^^^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.