Wrapper

The Modal component wrapper.

circle-info

This is a compound component.

API

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

Props
Type
Required

children

ReactNode

βœ…

isOpen

boolean

❌

maxWidth

string

❌

height

string

❌

onClose

() => void;

❌

position

'top' | 'center'

❌

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

Prop that controls if the modal is being displayed or not on the interface

chevron-rightmaxWidthhashtag

Controls the max-width property style of the card inside of the modal.

chevron-rightheighthashtag

Controls the height property style of the card inside of the modal.

chevron-rightonClosehashtag

Optional prop that closes the modal by clicking outside the card, on the x button or just by pressing the Esc key.

chevron-rightpositionhashtag

Used to set a default display position, either at the top or center of the parent.

Last updated