API Reference
Alert indicators allow users to view semantic messages that are prominent and can be dismissable.
Parameters
props
- Type:
@vtex/shoreline-components.AlertProps & @types/react.React.RefAttributes<typescript.HTMLDivElement>
Props
children (optional)
The content of the alert.
- Type:
@types/react.React.ReactNode
onDismiss (optional)
Callback fired when the alert is dismissed.
- Type:
@types/react.React.MouseEventHandler<typescript.HTMLButtonElement>
variant (optional)
Variants of the alert, one of: informational, success, critical, warning.
-
Type:
@vtex/shoreline-components.AlertVariant -
Default:
'informational'