Wrapper

circle-info

This is a compound component.

API

This component extends the native div tag props. This means this component can receive the native html div attributes, for example, the className attribute (which is why it's not included in the table).

Props
Type
Required

children

ReactNode

βœ…

isOpen

boolean

βœ…

position

'left' | 'right'

❌

hideOverlay

boolean

❌

maxWidth

string

❌

onClose

() => void

❌

chevron-rightchildrenhashtag

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

chevron-rightpositionhashtag

To change the default rendering position of the component.

chevron-rightisOpenhashtag

To control the open state.

chevron-righthideOverlayhashtag

To hide the overlay, when open.

chevron-rightmaxWidthhashtag

To easily change the maxWidth the drawer can take.

chevron-rightonClosehashtag

Executed when clicking outside, normally attached to a state change trigger pointing to isOpen.

Last updated