Skip to Content

Drawer

Controlled like Modal, but slides from an edge. size is the width (left/right) or height (top/bottom).

import { Drawer, Button } from '@gg-software/ui'; const [open, setOpen] = useState(false); <Drawer open={open} onClose={() => setOpen(false)} placement="right" size={360} title="Filters" footer={<Button variant="primary" onClick={apply}>Apply</Button>} > <FilterForm /> </Drawer>;

Props

PropTypeDefaultDescription
open*boolean—
onClose*() => void—
titleReactNode—
childrenReactNode—content rendered inside the component
footerReactNode—
placement"left" | "right" | "top" | "bottom"right
sizestring | number—width (left/right) or height (top/bottom)
closeOnBackdropbooleantrue
showClosebooleantrue
classNamestring—

* required · generated from packages/ui/src/containers/Drawer/Drawer.tsx