Edit page

Drawer

The off-canvas "drawer" pattern is used primarily for top-level mobile navigation.

Import Syntax

Basic Usage

Props

PropertyTypeRequiredDefaultDescription
drawerWidthNumberfalse280Width (in px) of the drawer nav
onRequestCloseFuncfalse() => {}Function called when the user clicks the overlay area of a drawer
childrenNodefalse-Child elements to be rendered inside the Drawer
activeBoolfalse-Toggle visibility of the drawer
rightBoolfalse-Display the drawer on the right side of the screen
drawerNavStyleNodefalse-Styles passed to the DrawerNav sub-component