Wrapper

This component extends the native <div>arrow-up-right API, for example, the title attribute.

API

This component extends the native <div>arrow-up-right API. That's why the className prop is not included in the table.

Props
Data Type
Required

children

ReactNode

βœ…

isOpen

boolean

βœ…

heading

string

❌

display

'block' | 'overlay'

❌

zIndex

number

❌

variant

'default' | 'success' | 'danger' | 'warning';

❌

onClose

() => void

❌

chevron-rightchildrenhashtag

The subcomponents provided.

chevron-rightisOpenhashtag

To control the state of the Banner.

chevron-rightheadinghashtag

The title rendered.

chevron-rightdisplayhashtag

The behavior of the Banner,if 'overlay' is used, the component will overlay everything, depending on the zIndex passed, taking an absolute position. If not, a normal block is rendered.

chevron-rightzIndexhashtag

A number used to control the zIndex directly at the component level.

chevron-rightvarianthashtag

To change the presentation of the Banner.

chevron-righticonhashtag

A custom icon that overrides the default ones.

chevron-rightonClosehashtag

A function executed when the 'x' button is clicked. Tipically triggering a state change to isOpen.

Last updated