Hero Image

Components

Drawer

Display content that opens from the left or right side of the screen..

Code

import { Drawer } from 'trinidad-ui';

// Default
<Drawer position="right" isOpen onDimmerClick={callback function}>
  {/* Drawer content */}
</Drawer>

// Dimmer disabled
<Drawer position="right" isOpen isDimmerDisabled onDimmerClick={callback function}>
  {/* Drawer content */}
</Drawer>

// Auto fold drawer on small and medium screens
<Drawer autoFold position="right" isOpen isDimmerDisabled onDimmerClick={callback function}>
  {/* Drawer content */}
</Drawer>

Properties

Prop nameTypeDefault valueDescription
isDimmerDisabledboolfalseIf dimmer should be present.
isOpenboolfalseOpen or closed dimmer.
positionstringleftPosition of drawer, left or right.
childrennodeContent.
classNamestringAdd custom class.
onDimmerClickedfuncCallback when dimmer is clicked.

Accessibility

This component has been validated to meet the WCAG 2.1 AA accessibility guidelines.

Read more about WCAG 2.1 AA.