Wrapper

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

❌

children

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

position

To change the default rendering position of the component.

isOpen

To control the open state.

hideOverlay

To hide the overlay, when open.

maxWidth

To easily change the maxWidth the drawer can take.

onClose

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

Last updated