Wrapper

The Alert component wrapper.

circle-info

This is a compound component.

API

This component extends the animated div component tag props. This means this component can receive the react-spring native animated.divarrow-up-right props, for example, the className attribute (which is why it's not included in the table).

Props
Type
Required

children

ReactNode

βœ…

isOpen

boolean

❌

heading

string

❌

variant

'info' | 'warning' | 'danger' | 'default'

❌

hideIcon

boolean

❌

chevron-rightchildrenhashtag

The children in this case, because it is a compound component, should be the ones provided by this design system, listed before.

chevron-rightisOpenhashtag

This prop controls the displaying state of the alert

chevron-rightheadinghashtag

The heading of the Alert component.

chevron-rightvarianthashtag

To change the state and style of the alert based on the selection

chevron-righticon hashtag

Controls the icon to show on the Alert.

chevron-righthideIconhashtag

To prevent icon to be shown.

Last updated