Props
API reference for BannerMessage. For usage examples, see the React tab.
| Name | Type | Default |
|---|
| children* (required) | ReactNode | — |
The content of the Banner Message. |
| alignment | "center" | "left" | center |
Determines the horizontal alignment of the banner content. |
| severity | "error" | "info" | "warning" | info |
The severity of the Banner Message indicates which background color and icon is used. |
| Name | Type | Default |
|---|
| aria-describedby | string | — |
Identifies the element (or elements) that describes the object. |
| aria-details | string | — |
Identifies the element (or elements) that provide a detailed, extended description for the object. |
| aria-label | string | — |
Defines a string value that labels the current element. |
| aria-labelledby | string | — |
Identifies the element (or elements) that labels the current element. |
| id | string | — |
The unique identifier for the DOM element. |
| role | AriaRole | — |
The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc. |
| Name | Type | Default |
|---|
| onDismiss | (() => void) | — |
Adds a close button that accepts an event handler. |
| Name | Type | Default |
|---|
| className | string | — |
CSS class names to apply custom styling. |
| style | CSSProperties | — |
Inline styles specified as a React-compatible CSS properties object. |