@8x8/oxygen-alert-banner
v3.0.0
Published
Oxygen - AlertBanner
Keywords
Readme
AlertBanner
The AlertBanner component is used as a warning for important system messages. It pushes the content of the page down and cannot be dismissed.
Installation
$ yarn add @8x8/oxygen-alert-banner
$ npm install @8x8/oxygen-alert-bannerProps
interface AlertBannerProps
| Name | Type | Default | Description |
| ----------------- | --------------------------- | ----------- | --------------------------------------------------------------------------------------------------------- |
| children | React.ReactNode | undefined | Text content |
| actionText? | string | undefined | Text for the optional action button. If specified it expects the actionCallback to be provided as well. |
| actionCallback? | () => void | undefined | Callback for the optional action button. If specified it expects the actionText to be provided as well. |
| testId? | string | 'Alert' | Test ID DOM attribute value |
| iconAriaLabel? | string | 'Warning' | Accessibility label for the warning icon |
| theme? | Partial<AlertBannerTheme> | {} | Overrides applied on top of the light or dark settings resolved by OxygenProvider |
