Patternfly Logo

Info alert:Beta feature

This Beta component is currently under review, so please join in and give us your feedback on the PatternFly forum.

Examples

Basic

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Panel on right

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Panel on left

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Panel on bottom

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Basic inline

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Inline panel on right

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Inline panel on left

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Stacked content body elements

content-body
content-body with padding
content-body

Stacked content body elements

content-body
content-body with padding
content-body

Modified content padding

Drawer content padding. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Modified panel padding

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Additional section above drawer content

drawer-section
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Static drawer

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.
drawer-panel

Breakpoint

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pretium est a porttitor vehicula. Quisque vel commodo urna. Morbi mattis rutrum ante, id vehicula ex accumsan ut. Morbi viverra, eros vel porttitor facilisis, eros purus aliquet erat,nec lobortis felis elit pulvinar sem. Vivamus vulputate, risus eget commodo eleifend, eros nibh porta quam, vitae lacinia leo libero at magna. Maecenas aliquam sagittis orci, et posuere nisi ultrices sit amet. Aliquam ex odio, malesuada sed posuere quis, pellentesque at mauris. Phasellus venenatis massa ex, eget pulvinar libero auctor pretium. Aliquam erat volutpat. Duis euismod justo in quam ullamcorper, in commodo massa vulputate.

Props

Drawer properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent rendered in the left hand panel
classNamestringNo''Additional classes added to the Drawer.
isExpandedbooleanNofalseIndicates if the drawer is expanded
isInlinebooleanNofalseIndicates if the content element and panel element are displayed side by side.
isStaticbooleanNofalseIndicates if the drawer will always show both content and panel.
onExpand() => voidNo() => {}Callback when drawer panel is expanded after waiting 250ms for animation to complete.
position'left' | 'right' | 'bottom'No'right'Position of the drawer panel
DrawerContent properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent to be rendered in the drawer.
classNamestringNo''Additional classes added to the Drawer.
panelContentReact.ReactNodeYesContent rendered in the drawer panel.
DrawerPanelContent properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent to be rendered in the drawer panel.
classNamestringNo''Additional classes added to the drawer.
hasNoBorderbooleanNofalseFlag indicating that the drawer panel should not have a border.
widths{ default?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100'; lg?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100'; xl?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100'; '2xl'?: 'width_25' | 'width_33' | 'width_50' | 'width_66' | 'width_75' | 'width_100'; }NoWidth for drawer panel at various breakpoints
DrawerContentBody properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent to be rendered in the drawer
classNamestringNo''Additional classes added to the Drawer.
hasPaddingbooleanNofalseIndicates if there should be padding around the drawer content body
DrawerPanelBody properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent to be rendered in the drawer
classNamestringNo''Additional classes added to the Drawer.
hasNoPaddingbooleanNofalseIndicates if there should be no padding around the drawer panel body
DrawerSection properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent to be rendered in the drawer section.
classNamestringNo''Additional classes added to the drawer section.
DrawerHead properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoContent to be rendered in the drawer head
classNamestringNo''Additional classes added to the drawer head.
hasNoPaddingbooleanNofalseIndicates if there should be no padding around the drawer panel body of the head
DrawerActions properties
NameTypeRequiredDefaultDescription
childrenReact.ReactNodeNoActions to be rendered in the panel head.
classNamestringNo''Additional classes added to the drawer actions button.
DrawerCloseButton properties
NameTypeRequiredDefaultDescription
aria-labelstringNo'Close drawer panel'Accessible label for the drawer close button
classNamestringNo''Additional classes added to the drawer close button outer <div>.
onClose() => voidNo() => undefined as anyA callback for when the close button is clicked

CSS variables

.pf-c-drawer--pf-c-drawer__section--BackgroundColor
#fff
.pf-c-drawer--pf-c-drawer__content--FlexBasis
100%
.pf-c-drawer--pf-c-drawer__content--BackgroundColor
#fff
.pf-c-drawer--pf-c-drawer__content--ZIndex
100
.pf-c-drawer--pf-c-drawer__panel--FlexBasis
100%
.pf-c-drawer--pf-c-drawer__panel--md--FlexBasis
50%
.pf-c-drawer--pf-c-drawer__panel--MinWidth
50%
.pf-c-drawer--pf-c-drawer__panel--MaxHeight
auto
.pf-c-drawer--pf-c-drawer--m-panel-bottom__panel--md--MinHeight
50%
.pf-c-drawer--pf-c-drawer__panel--xl--MinWidth
28.125rem
.pf-c-drawer--pf-c-drawer__panel--xl--FlexBasis
28.125rem
.pf-c-drawer--pf-c-drawer--m-panel-bottom__panel--xl--MinHeight
18.75rem
.pf-c-drawer--pf-c-drawer--m-panel-bottom__panel--xl--FlexBasis
18.75rem
.pf-c-drawer--pf-c-drawer__panel--ZIndex
200
.pf-c-drawer--pf-c-drawer__panel--BackgroundColor
#fff
.pf-c-drawer--pf-c-drawer__panel--TransitionDuration
250ms
.pf-c-drawer--pf-c-drawer__panel--TransitionProperty
margin, transform, box-shadow
.pf-c-drawer--pf-c-drawer--child--PaddingTop
1rem
.pf-c-drawer--pf-c-drawer--child--PaddingRight
1rem
.pf-c-drawer--pf-c-drawer--child--PaddingBottom
1rem
.pf-c-drawer--pf-c-drawer--child--PaddingLeft
1rem
.pf-c-drawer--pf-c-drawer--child--md--PaddingTop
1.5rem
.pf-c-drawer--pf-c-drawer--child--md--PaddingRight
1.5rem
.pf-c-drawer--pf-c-drawer--child--md--PaddingBottom
1.5rem
.pf-c-drawer--pf-c-drawer--child--md--PaddingLeft
1.5rem
.pf-c-drawer--pf-c-drawer--child--m-padding--PaddingTop
1rem
.pf-c-drawer--pf-c-drawer--child--m-padding--PaddingRight
1rem
.pf-c-drawer--pf-c-drawer--child--m-padding--PaddingBottom
1rem
.pf-c-drawer--pf-c-drawer--child--m-padding--PaddingLeft
1rem
.pf-c-drawer--pf-c-drawer--child--m-padding--md--PaddingTop
1.5rem
.pf-c-drawer--pf-c-drawer--child--m-padding--md--PaddingRight
1.5rem
.pf-c-drawer--pf-c-drawer--child--m-padding--md--PaddingBottom
1.5rem
.pf-c-drawer--pf-c-drawer--child--m-padding--md--PaddingLeft
1.5rem
.pf-c-drawer--pf-c-drawer__content--child--PaddingTop
0
.pf-c-drawer--pf-c-drawer__content--child--PaddingRight
0
.pf-c-drawer--pf-c-drawer__content--child--PaddingBottom
0
.pf-c-drawer--pf-c-drawer__content--child--PaddingLeft
0
.pf-c-drawer--pf-c-drawer__actions--MarginTop
calc(pf-global--spacer--form-element * -1)
.pf-c-drawer--pf-c-drawer__actions--MarginRight
calc(pf-global--spacer--form-element * -1)
.pf-c-drawer--pf-c-drawer__panel--BoxShadow
none
.pf-c-drawer--pf-c-drawer--m-expanded__panel--BoxShadow
-0.75rem 0 0.75rem -0.5rem rgba(3, 3, 3, 0.18)
.pf-c-drawer--pf-c-drawer--m-expanded--m-panel-left__panel--BoxShadow
0.75rem 0 0.75rem -0.5rem rgba(3, 3, 3, 0.18)
.pf-c-drawer--pf-c-drawer--m-expanded--m-panel-bottom__panel--BoxShadow
0 -0.75rem 0.75rem -0.5rem rgba(3, 3, 3, 0.18)
.pf-c-drawer--pf-c-drawer__panel--after--Width
1px
.pf-c-drawer--pf-c-drawer--m-panel-bottom__panel--after--Height
1px
.pf-c-drawer--pf-c-drawer__panel--after--BackgroundColor
transparent
.pf-c-drawer--pf-c-drawer--m-inline--m-expanded__panel--after--BackgroundColor
#d2d2d2
.pf-c-drawer--pf-c-drawer--m-inline__panel--PaddingLeft
1px
.pf-c-drawer--pf-c-drawer--m-panel-left--m-inline__panel--PaddingRight
1px
.pf-c-drawer--pf-c-drawer--m-panel-bottom--m-inline__panel--PaddingTop
1px

View source on GitHub