Skip to content
On this page

VAlert

Props

NameTypeDescription
aria-currentEnum:
page
step
location
date
time
true
false
Indicates the element that represents the current item within a container or set of related elements.
dismiss-button-aria-labelstringAllows setting a custom aria-label for the dismiss button.
removablebooleanAdds a close button to the Alert.
placementEnum:
top
top-start
top-end
bottom
bottom-start
bottom-end
The placement of the Alert on the screen.
headlinestringAdds a headline to the Alert.
textstringThe main text of the Alert.
iconEnum:
10-sec-backward-line
10-sec-backward-solid
10-sec-forward-line
10-sec-forward-solid
30-sec-backward-line
30-sec-backward-solid
30-sec-forward-line
30-sec-forward-solid
5-sec-backward-line
5-sec-backward-solid
5-sec-forward-line
5-sec-forward-solid
... 1217 more ...
The icon to display in the Alert. Takes precedence over the connotation's icon. See the Vivid Icon Gallery for available icons: https://icons.vivid.vonage.com/
timeoutmsnumberTimeout after which the Alert will close.
connotationEnum:
accent
information
success
warning
announcement
alert
Sets an appropriate icon / icon color for the connotation.
strategyEnum:
fixed
static
Controls the position of the Alert.
openbooleanOpen state of the Alert.

Events

NameEvent TypeDescription
clickMouseEventFires when a pointing device button (such as a mouse's primary mouse button) is both pressed and released while the pointer is located inside the element.
focusFocusEventFires when the element receives focus.
blurFocusEventFires when the element loses focus.
keydownKeyboardEventFires when a key is pressed.
keyupKeyboardEventFires when a key is released.
inputEventFires when the value of an element has been changed.
openCustomEvent<undefined>Fired when the Alert is opened
closeCustomEvent<undefined>Fired when the Alert is closed

Slots

NameDescription
mainThe main content of the Alert.
action-itemsAdd action items to the Alert using this slot.
iconAdd an icon to the component.

Methods

NameTypeDescription
openChanged(oldValue: boolean,newValue: boolean) => void