Description
The Drawer component is a Modal variation that appears as a side panel at any chosen side of the page; top, bottom, left or right (default right
). A Drawer is typically used to show additional information. It can also be used to have easy/quick tasks while being in context.
Parts in Drawer
To provide custom content to parts of the Drawer, a set of component parts are provided:
<Drawer.Navigation>
: The navigation field at the top of the component, default with a close button (Equal to the propnavContent
).<Drawer.Header>
: The header field of the component, where thetitle
will appear (Equal to the propheaderContent
).<Drawer.Body>
: The body of the Drawer, provided with a section background color, defaultblack-3
(Equal to the propmodalContent
).
More detailed information
For more details regarding the component functionality, check out the Modal documentation.
Converting from Modal mode drawer
If you are converting from <Modal mode="drawer" />
to <Drawer />
, there are a few differences you need to take into consideration:
- All
trigger_*
props are not supported for Drawer, usetriggerAttributes
instead to pass in props for the trigger button.- Change prop
trigger_hidden
toomitTriggerButton
to omit the default trigger button from Modal.
- Change prop
- Only camelCase props are supported for Drawer, so you will need to update the prop names.
Modal.Inner
/Modal.Content
converts toDrawer.Body
.Modal.Bar
converts toDrawer.Navigaton
.Modal
was a class component andDrawer
is a functional component.