Skip to content

Drawer ​

Left (default)

Loading...

Navigation drawers provide ergonomic access to destinations in a site or app.

  • Tag: <flint-drawer>
  • Class: FlintDrawer

Import ​

ts
import '@getufy/flint-ui'; // auto-registers all
// or
import { FlintDrawer } from '@getufy/flint-ui';

Usage ​

html
<flint-drawer></flint-drawer>

Properties ​

PropertyAttributeTypeDefaultDescription
openopenbooleanfalseWhether the drawer is open.
defaultOpendefault-openbooleanfalseInitial open state for uncontrolled usage.
placementplacementPlacement'left'Side from which the drawer slides in.
variantvariant'temporary' | 'persistent' | 'mini''temporary'Drawer behavior mode.
edgeedgebooleanfalseWhether the drawer uses edge spacing.
containercontainerbooleanfalseWhether the drawer is contained within its parent.
labellabelstring'Drawer'Accessible label for the drawer panel (used as aria-label on the panel).
initialFocusinitial-focusstring''CSS selector for the element to focus when the drawer opens.

Events ​

EventDetailDescription
flint-drawer-open&#123; open: true &#125;Dispatched after the drawer open animation completes. detail: &#123; open: true &#125;
flint-drawer-close&#123; open: false &#125;Dispatched when the drawer requests to be closed (backdrop click or Escape). detail: &#123; open: false &#125;

Slots ​

NameDescription
(default)Drawer content.

CSS Parts ​

NameDescription
backdropThe backdrop overlay element.
panelThe drawer panel element.

CSS Custom Properties ​

PropertyDefault
--flint-drawer-z-indexvar(--flint-z-overlay, 1040
--flint-drawer-bgvar(--flint-surface-1
--flint-drawer-width320px
--flint-drawer-shadow—
--flint-drawer-heightauto
--flint-drawer-mini-width72px
--flint-drawer-transition.225s cubic-bezier(0, 0, .2, 1
--flint-drawer-edge-width16px
--flint-backdrop-color—
--flint-border-color—