@finastra/alert-message
v1.8.1
Published
AlertMessage Web Component
Downloads
385
Readme
AlertMessage
An alert displays a short, important message in a way that attracts the user's attention without interrupting the user's task.
Usage
Import
npm i @finastra/alert-messageimport '@finastra/alert-message';
...
<fds-alert-message type="success" title="Success" description="A banner displays an important, succinct message, and provides actions for users to address or dismiss the banner.">
</fds-alert-message>API
Properties
| Property | Attribute | Type | Default | Description |
|-------------------|-------------------|---------------------------------|--------------|--------------------------------------------------|
| dense | dense | boolean | false | dense . |
| description | description | string | "" | Alert description. |
| icon | icon | string | "" | Alert Icon. |
| layout | layout | multiLines\|singleLine | "multiLines" | Define the layout type |
| showCloseButton | showCloseButton | boolean | false | Display the close button to dismiss the alert message. |
| title | title | string | "" | Alert title. |
| type | type | info\|error\|success\|warning | "success" | Define the alert type |
| withoutIcon | withoutIcon | boolean | false | Remove the Icon from the alert message. |
Methods
| Method | Type |
|--------------|-------------------------|
| renderIcon | (): TemplateResult<1> |