Drawer

Info alert:Beta feature

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

The Drawer is a sliding panel that enters from the right edge of the viewport. It can be configured to either overlay content on a page or create a sidebar by pushing that content to the left.

Examples Documentation CSS Variables

Examples

Closed panel on right (default)

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.

Expanded panel on right

drawer-panel

Closed panel on left

Expanded panel on left

drawer-panel

Expanded inline panel

drawer-panel

Expanded inline panel on left

drawer-panel

Stacked content body elements

content-body

content-body with padding

content-body

drawer-panel

drawer-panel with no padding

drawer-panel

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.

drawer-panel

Modified panel padding

drawer-panel

Modified panel width

drawer-panel

Additional section above main

drawer-section

drawer-panel

Static

Static drawers don't have interactive elements. 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

Documentation

Accessibility

Attribute	Applied to	Outcome
`aria-expanded="true"`	`action that opens drawer`	Indicates that the expandable content is visible. Required
`aria-expanded="false"`	`action that opens drawer`	Indicates that the expandable content is hidden. Required
`hidden`	`.pf-c-drawer__panel`	Hides the drawer panel from assistive technologies. Required

Usage

Class	Applied to	Outcome
`.pf-c-drawer`	`<div>`	Initiates the drawer container. Required
`.pf-c-drawer__section`	`<div>`	Initiates a drawer section area. This element can be used above or below `.pf-c-drawer__main` for titles, toolbars, footers, etc.
`.pf-c-drawer__main`	`<div>`	Initiates the drawer main area. Required
`.pf-c-drawer__content`	`<div>`	Initiates the drawer content container. Required
`.pf-c-drawer__panel`	`<aside>`	Initiates the drawer panel container. Required
`.pf-c-drawer__body`	`<div>`	Initiates a drawer body container and is the child of `.pf-c-drawer__content` and `.pf-c-drawer__panel`. Required
`.pf-c-drawer__head`	`<div>`	Initiates a drawer head container. This container positions `.pf-c-drawer__actions`, if present.
`.pf-c-drawer__actions`	`<div>`	Identifies the drawer close button.
`.pf-c-drawer__close`	`<div>`	Identifies the drawer close button.
`.pf-m-expanded`	`.pf-c-drawer`	Modifies the drawer panel for the expanded state.
`.pf-m-static{-on-[lg, xl, 2xl]}`	`.pf-c-drawer`	Modifies the drawer panel state to always show both content and panel.
`.pf-m-inline{-on-[lg, xl, 2xl]}`	`.pf-c-drawer`	Modifies the drawer so the content element and panel element are displayed side by side. `.pf-m-inline` used without a breakpoint will default to the `md` breakpoint.
`.pf-m-no-border`	`.pf-c-drawer__panel`	Modifies the drawer panel border treatment to disable all border treatment.
`.pf-m-padding`	`.pf-c-drawer__body`	Modifies the element to add padding.
`.pf-m-no-padding`	`.pf-c-drawer__body`	Modifies the element to remove padding.
`.pf-m-no-background`	`.pf-c-drawer__section`, `.pf-c-drawer__content`, `.pf-c-drawer__panel`	Modifies the drawer body/panel background color to transparent.
`.pf-m-width-{25, 33, 50, 66, 75, 100}{-on-[breakpoint]}`	`.pf-c-drawer__panel`	Modifies the drawer panel width.

CSS Variables


	.pf-c-drawer	--pf-c-drawer__section--BackgroundColor	#fff
--pf-c-drawer__section--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-drawer	--pf-c-drawer__content--FlexBasis	100%
	.pf-c-drawer	--pf-c-drawer__content--BackgroundColor	#fff
--pf-c-drawer__content--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-drawer	--pf-c-drawer__content--ZIndex	100
--pf-c-drawer__content--ZIndex --pf-global--ZIndex--xs $pf-global--ZIndex--xs 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--xl--MinWidth	28.125rem
	.pf-c-drawer	--pf-c-drawer__panel--xl--FlexBasis	28.125rem
	.pf-c-drawer	--pf-c-drawer__panel--ZIndex	200
--pf-c-drawer__panel--ZIndex --pf-global--ZIndex--sm $pf-global--ZIndex--sm 200
	.pf-c-drawer	--pf-c-drawer__panel--BackgroundColor	#fff
--pf-c-drawer__panel--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-drawer	--pf-c-drawer__panel--TransitionDuration	.25s
	.pf-c-drawer	--pf-c-drawer__panel--TransitionProperty	margin, transform, box-shadow
	.pf-c-drawer	--pf-c-drawer--child--PaddingTop	1rem
--pf-c-drawer--child--PaddingTop --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--PaddingRight	1rem
--pf-c-drawer--child--PaddingRight --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--PaddingBottom	1rem
--pf-c-drawer--child--PaddingBottom --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--PaddingLeft	1rem
--pf-c-drawer--child--PaddingLeft --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--md--PaddingTop	1.5rem
--pf-c-drawer--child--md--PaddingTop --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--md--PaddingRight	1.5rem
--pf-c-drawer--child--md--PaddingRight --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--md--PaddingBottom	1.5rem
--pf-c-drawer--child--md--PaddingBottom --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--md--PaddingLeft	1.5rem
--pf-c-drawer--child--md--PaddingLeft --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--PaddingTop	1rem
--pf-c-drawer--child--m-padding--PaddingTop --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--PaddingRight	1rem
--pf-c-drawer--child--m-padding--PaddingRight --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--PaddingBottom	1rem
--pf-c-drawer--child--m-padding--PaddingBottom --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--PaddingLeft	1rem
--pf-c-drawer--child--m-padding--PaddingLeft --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--md--PaddingTop	1.5rem
--pf-c-drawer--child--m-padding--md--PaddingTop --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--md--PaddingRight	1.5rem
--pf-c-drawer--child--m-padding--md--PaddingRight --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--md--PaddingBottom	1.5rem
--pf-c-drawer--child--m-padding--md--PaddingBottom --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-drawer	--pf-c-drawer--child--m-padding--md--PaddingLeft	1.5rem
--pf-c-drawer--child--m-padding--md--PaddingLeft --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 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(0.375rem * -1)
	.pf-c-drawer	--pf-c-drawer__actions--MarginRight	calc(0.375rem * -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--m-expanded__panel--BoxShadow --pf-global--BoxShadow--lg-left $pf-global--BoxShadow--lg-left pf-size-prem(-12px) 0 pf-size-prem(12px) pf-size-prem(-8px) rgba($pf-color-black-1000, .18) pf-size-prem(-12px) 0 pf-size-prem(12px) pf-size-prem(-8px) rgba(#030303, .18) -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--m-expanded--m-panel-left__panel--BoxShadow --pf-global--BoxShadow--lg-right $pf-global--BoxShadow--lg-right pf-size-prem(12px) 0 pf-size-prem(12px) pf-size-prem(-8px) rgba($pf-color-black-1000, .18) pf-size-prem(12px) 0 pf-size-prem(12px) pf-size-prem(-8px) rgba(#030303, .18) 0.75rem 0 0.75rem -0.5rem rgba(3, 3, 3, 0.18)
	.pf-c-drawer	--pf-c-drawer__panel--after--Width	1px
--pf-c-drawer__panel--after--Width --pf-global--BorderWidth--sm $pf-global--BorderWidth--sm 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--m-inline--m-expanded__panel--after--BackgroundColor --pf-global--BorderColor--100 $pf-global--BorderColor--100 $pf-color-black-300 #d2d2d2
	.pf-c-drawer__section.pf-m-no-background	--pf-c-drawer__section--BackgroundColor	transparent
	.pf-c-drawer__content	--pf-c-drawer--child--PaddingTop	0
--pf-c-drawer--child--PaddingTop --pf-c-drawer__content--child--PaddingTop 0
	.pf-c-drawer__content	--pf-c-drawer--child--PaddingRight	0
--pf-c-drawer--child--PaddingRight --pf-c-drawer__content--child--PaddingRight 0
	.pf-c-drawer__content	--pf-c-drawer--child--PaddingBottom	0
--pf-c-drawer--child--PaddingBottom --pf-c-drawer__content--child--PaddingBottom 0
	.pf-c-drawer__content	--pf-c-drawer--child--PaddingLeft	0
--pf-c-drawer--child--PaddingLeft --pf-c-drawer__content--child--PaddingLeft 0
	.pf-c-drawer__content.pf-m-no-background	--pf-c-drawer__content--BackgroundColor	transparent
	.pf-c-drawer__panel.pf-m-no-background	--pf-c-drawer__content--BackgroundColor	transparent
	.pf-c-drawer__body.pf-m-no-padding	--pf-c-drawer__actions--MarginTop	0
	.pf-c-drawer__body.pf-m-no-padding	--pf-c-drawer__actions--MarginRight	0
	.pf-c-drawer__body.pf-m-no-padding	--pf-c-drawer--child--PaddingTop	0
	.pf-c-drawer__body.pf-m-no-padding	--pf-c-drawer--child--PaddingRight	0
	.pf-c-drawer__body.pf-m-no-padding	--pf-c-drawer--child--PaddingBottom	0
	.pf-c-drawer__body.pf-m-no-padding	--pf-c-drawer--child--PaddingLeft	0
	.pf-c-drawer__body.pf-m-padding	--pf-c-drawer--child--PaddingTop	1rem
--pf-c-drawer--child--PaddingTop --pf-c-drawer--child--m-padding--PaddingTop --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer__body.pf-m-padding	--pf-c-drawer--child--PaddingRight	1rem
--pf-c-drawer--child--PaddingRight --pf-c-drawer--child--m-padding--PaddingRight --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer__body.pf-m-padding	--pf-c-drawer--child--PaddingBottom	1rem
--pf-c-drawer--child--PaddingBottom --pf-c-drawer--child--m-padding--PaddingBottom --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer__body.pf-m-padding	--pf-c-drawer--child--PaddingLeft	1rem
--pf-c-drawer--child--PaddingLeft --pf-c-drawer--child--m-padding--PaddingLeft --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-drawer__body:not(.pf-m-no-padding) + *	--pf-c-drawer--child--PaddingTop	0