Alert

To install, type the following into the command line at the root of your project:

npm i @brighthr/component-alert

To implement the Alert component into your project you’ll need to add the import:

import Alert from '@brighthr/component-alert';

After adding import into your project you can use it simply like:

<Alert />

Props

| Name | Type | Default | Description | | |--------------------------|------------------------------------------------------|---------------|----------------------------------------------------------------------|---| | alertValidationShowState | boolean | true | -- | | | betaBadgeAsButton | boolean | false | If true, the beta badge will be a button. | | | border | boolean | false | If true, the border will be displayed. | | | className | string | | -- | | | dismiss | boolean | false | If true, the alert will be dismissable. | | | fullWidth | boolean | false | If true, the alert will fill the width of it's container. | | | icon | string | | Will display the appropriate icon when passed the iconName. | | | inline | boolean | false | If true, the content inside the alert will be vertically centered. | | | isBeta | boolean | false | If true, the beta badge will be displayed. | | | isLabs | boolean | false | If true, the labs badge will be displayed. | | | onClickBetaBadge | () => void | | Function for handling the onClick beta badge. | | | onDismiss | () => void | | Function for handling the onDismiss. | | | size | 'xs' \| 'sm' \| 'base' | base | Sets the size of the alert. | | | title | string | | The title of the alert. | | | type | 'information' \| 'success' \| 'warning' \| 'error' | information | Sets the color theme of the alert. | |