Sidebar

A sidebar splits content into a secondary area that can be placed relative to the main content on a page.

Examples

Basic

Sidebar panel

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse dapibus nulla id augue dictum commodo. Donec mollis arcu massa, sollicitudin venenatis est rutrum vitae. Integer pulvinar ligula at augue mollis, ac pulvinar arcu semper. Maecenas nisi lorem, malesuada ac lectus nec, porta pretium neque. Ut convallis libero sit amet metus mattis, vel facilisis lorem malesuada. Duis consectetur ante sit amet magna efficitur, a interdum leo vulputate.

Praesent at odio nec sapien ultrices tincidunt in non mauris. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Duis consectetur nisl quis facilisis faucibus. Sed eu bibendum risus. Suspendisse porta euismod tortor, at elementum odio suscipit sed. Cras eget ultrices urna, ac feugiat lectus. Integer a pharetra velit, in imperdiet mi. Phasellus vel hendrerit velit. Vestibulum ut augue vitae erat vulputate bibendum a ut magna.

Stack

Sidebar panel stacked on top

Panel right with gutter

Sidebar panel on the right

Sticky panel

A tabIndex should be added to the Sidebar when there is scrollable content in order for the overflow content to be accessible by keyboard.

Sticky sidebar panel

Scroll me!

Static panel

A tabIndex should be added to the Sidebar when there is scrollable content in order for the overflow content to be accessible by keyboard.

Static sidebar panel

Scroll me!

Responsive panel width

A tabIndex should be added to the Sidebar when there is scrollable content in order for the overflow content to be accessible by keyboard.

Sidebar panel

Resize me!

Props

*required
Name	Type	Default	Description
children	React.ReactNode
hasGutter	boolean		Adds space between the panel and content.
hasNoBackground	boolean		Removes the background color.
isPanelRight	boolean	false	Indicates that the panel is displayed to the right of the content when the oritentation is split.
orientation	'stack' \| 'split'		Indicates the direction of the layout. Default orientation is stack on small screens, and split on medium screens and above.

SidebarContent

*required
Name	Type	Default	Description
childrenrequired	React.ReactNode
hasNoBackground	boolean		Removes the background color.

SidebarPanel

*required
Name	Type	Default	Description
childrenrequired	React.ReactNode
hasNoBackground	boolean		Removes the background color.
variant	'default' \| 'sticky' \| 'static'	'default'	Indicates whether the panel is positioned statically or sticky to the top. Default is sticky on small screens when the orientation is stack, and static on medium and above screens when the orientation is split.
width	{ default?: 'default' \| 'width_25' \| 'width_33' \| 'width_50' \| 'width_66' \| 'width_75' \| 'width_100'; sm?: 'default' \| 'width_25' \| 'width_33' \| 'width_50' \| 'width_66' \| 'width_75' \| 'width_100'; md?: 'default' \| 'width_25' \| 'width_33' \| 'width_50' \| 'width_66' \| 'width_75' \| 'width_100'; lg?: 'default' \| 'width_25' \| 'width_33' \| 'width_50' \| 'width_66' \| 'width_75' \| 'width_100'; xl?: 'default' \| 'width_25' \| 'width_33' \| 'width_50' \| 'width_66' \| 'width_75' \| 'width_100'; '2xl'?: 'default' \| 'width_25' \| 'width_33' \| 'width_50' \| 'width_66' \| 'width_75' \| 'width_100'; }		Sets the panel width at various breakpoints. Default is 250px when the orientation is split.

CSS variables


	.pf-c-sidebar	--pf-c-sidebar--BackgroundColor	#fff
--pf-c-sidebar--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-sidebar	--pf-c-sidebar__main--FlexDirection	column
	.pf-c-sidebar	--pf-c-sidebar__main--md--FlexDirection	row
	.pf-c-sidebar	--pf-c-sidebar__main--AlignItems	stretch
	.pf-c-sidebar	--pf-c-sidebar__main--md--AlignItems	start
	.pf-c-sidebar	--pf-c-sidebar__main--child--MarginTop	0
	.pf-c-sidebar	--pf-c-sidebar__main--child--MarginLeft	0
	.pf-c-sidebar	--pf-c-sidebar--m-gutter__main--Gap	1rem
--pf-c-sidebar--m-gutter__main--Gap --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-sidebar	--pf-c-sidebar--m-gutter__main--xl--Gap	1.5rem
--pf-c-sidebar--m-gutter__main--xl--Gap --pf-global--spacer--lg $pf-global--spacer--lg pf-size-prem(24px) 1.5rem
	.pf-c-sidebar	--pf-c-sidebar--m-panel-right__panel--Order	0
	.pf-c-sidebar	--pf-c-sidebar--m-panel-right__panel--md--Order	1
	.pf-c-sidebar	--pf-c-sidebar--m-stack__main--FlexDirection	column
	.pf-c-sidebar	--pf-c-sidebar--m-stack__main--AlignItems	stretch
	.pf-c-sidebar	--pf-c-sidebar--m-stack__panel--Position	sticky
	.pf-c-sidebar	--pf-c-sidebar--m-stack__panel--Top	0
	.pf-c-sidebar	--pf-c-sidebar--m-stack__panel--BoxShadow	0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
--pf-c-sidebar--m-stack__panel--BoxShadow --pf-c-sidebar__panel--BoxShadow--base 0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
	.pf-c-sidebar	--pf-c-sidebar--m-stack--m-panel-right__panel--Order	0
	.pf-c-sidebar	--pf-c-sidebar--m-split__main--AlignItems	start
	.pf-c-sidebar	--pf-c-sidebar--m-split__main--FlexDirection	row
	.pf-c-sidebar	--pf-c-sidebar--m-split__panel--Position	static
	.pf-c-sidebar	--pf-c-sidebar--m-split__panel--Top	auto
	.pf-c-sidebar	--pf-c-sidebar--m-split--m-panel-right__panel--Order	1
	.pf-c-sidebar	--pf-c-sidebar__panel--FlexBasis-base	auto
	.pf-c-sidebar	--pf-c-sidebar__panel--BoxShadow--base	0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
	.pf-c-sidebar	--pf-c-sidebar__panel--BoxShadow	0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
--pf-c-sidebar__panel--BoxShadow --pf-c-sidebar__panel--BoxShadow--base 0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
	.pf-c-sidebar	--pf-c-sidebar__panel--Top	0
	.pf-c-sidebar	--pf-c-sidebar__panel--md--Top	auto
	.pf-c-sidebar	--pf-c-sidebar__panel--Position	sticky
	.pf-c-sidebar	--pf-c-sidebar__panel--md--Position	static
	.pf-c-sidebar	--pf-c-sidebar__panel--FlexBasis	auto
--pf-c-sidebar__panel--FlexBasis --pf-c-sidebar__panel--FlexBasis-base auto
	.pf-c-sidebar	--pf-c-sidebar__panel--md--FlexBasis	15.625rem
	.pf-c-sidebar	--pf-c-sidebar__panel--m-split--FlexBasis	15.625rem
	.pf-c-sidebar	--pf-c-sidebar__panel--m-stack--FlexBasis	auto
	.pf-c-sidebar	--pf-c-sidebar__panel--ZIndex	100
--pf-c-sidebar__panel--ZIndex --pf-global--ZIndex--xs $pf-global--ZIndex--xs 100
	.pf-c-sidebar	--pf-c-sidebar__panel--Order	0
	.pf-c-sidebar	--pf-c-sidebar__panel--BackgroundColor	#fff
--pf-c-sidebar__panel--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-sidebar	--pf-c-sidebar__content--BackgroundColor	#fff
--pf-c-sidebar__content--BackgroundColor --pf-global--BackgroundColor--100 $pf-global--BackgroundColor--100 $pf-color-white #fff
	.pf-c-sidebar	--pf-c-sidebar__panel--m-sticky--Top	0
	.pf-c-sidebar	--pf-c-sidebar__panel--m-sticky--Position	sticky
	.pf-c-sidebar.pf-m-gutter	--pf-c-sidebar__main--child--MarginTop	1rem
--pf-c-sidebar__main--child--MarginTop --pf-c-sidebar--m-gutter__main--Gap --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-sidebar.pf-m-gutter	--pf-c-sidebar__main--child--MarginLeft	0
	.pf-c-sidebar.pf-m-panel-right	--pf-c-sidebar__panel--Order	0
--pf-c-sidebar__panel--Order --pf-c-sidebar--m-panel-right__panel--Order 0
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__main--FlexDirection	column
--pf-c-sidebar__main--FlexDirection --pf-c-sidebar--m-stack__main--FlexDirection column
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__main--AlignItems	stretch
--pf-c-sidebar__main--AlignItems --pf-c-sidebar--m-stack__main--AlignItems stretch
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__main--child--MarginTop	1rem
--pf-c-sidebar__main--child--MarginTop --pf-c-sidebar--m-gutter__main--Gap --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__main--child--MarginLeft	0
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__panel--Position	sticky
--pf-c-sidebar__panel--Position --pf-c-sidebar--m-stack__panel--Position sticky
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__panel--Top	0
--pf-c-sidebar__panel--Top --pf-c-sidebar--m-stack__panel--Top 0
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__panel--BoxShadow	0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
--pf-c-sidebar__panel--BoxShadow --pf-c-sidebar--m-stack__panel--BoxShadow --pf-c-sidebar__panel--BoxShadow--base 0 0.25rem 0.25rem -0.25rem rgba(3, 3, 3, 0.16)
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar__panel--FlexBasis	auto
--pf-c-sidebar__panel--FlexBasis --pf-c-sidebar__panel--m-stack--FlexBasis auto
	.pf-c-sidebar.pf-m-stack	--pf-c-sidebar--m-panel-right__panel--Order	0
--pf-c-sidebar--m-panel-right__panel--Order --pf-c-sidebar--m-stack--m-panel-right__panel--Order 0
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__main--FlexDirection	row
--pf-c-sidebar__main--FlexDirection --pf-c-sidebar--m-split__main--FlexDirection row
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__main--AlignItems	start
--pf-c-sidebar__main--AlignItems --pf-c-sidebar--m-split__main--AlignItems start
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__main--child--MarginTop	0
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__main--child--MarginLeft	1rem
--pf-c-sidebar__main--child--MarginLeft --pf-c-sidebar--m-gutter__main--Gap --pf-global--spacer--md $pf-global--spacer--md pf-size-prem(16px) 1rem
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__panel--Position	static
--pf-c-sidebar__panel--Position --pf-c-sidebar--m-split__panel--Position static
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__panel--Top	auto
--pf-c-sidebar__panel--Top --pf-c-sidebar--m-split__panel--Top auto
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__panel--BoxShadow	none
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar__panel--FlexBasis	15.625rem
--pf-c-sidebar__panel--FlexBasis --pf-c-sidebar__panel--m-split--FlexBasis 15.625rem
	.pf-c-sidebar.pf-m-split	--pf-c-sidebar--m-panel-right__panel--Order	1
--pf-c-sidebar--m-panel-right__panel--Order --pf-c-sidebar--m-split--m-panel-right__panel--Order 1
	.pf-c-sidebar__panel.pf-m-sticky	--pf-c-sidebar__panel--Position	sticky
--pf-c-sidebar__panel--Position --pf-c-sidebar__panel--m-sticky--Position sticky
	.pf-c-sidebar__panel.pf-m-sticky	--pf-c-sidebar__panel--Top	0
--pf-c-sidebar__panel--Top --pf-c-sidebar__panel--m-sticky--Top 0
	.pf-c-sidebar__panel.pf-m-static	--pf-c-sidebar__panel--Position	static
	.pf-c-sidebar__panel.pf-m-static	--pf-c-sidebar__panel--Top	auto
	.pf-c-sidebar__content.pf-m-no-background	--pf-c-sidebar__content--BackgroundColor	transparent
	.pf-c-sidebar__panel.pf-m-width-default	--pf-c-sidebar__panel--FlexBasis	auto
--pf-c-sidebar__panel--FlexBasis --pf-c-sidebar__panel--FlexBasis--base auto
	.pf-c-sidebar__panel.pf-m-width-25	--pf-c-sidebar__panel--FlexBasis	25%
	.pf-c-sidebar__panel.pf-m-width-33	--pf-c-sidebar__panel--FlexBasis	33%
	.pf-c-sidebar__panel.pf-m-width-50	--pf-c-sidebar__panel--FlexBasis	50%
	.pf-c-sidebar__panel.pf-m-width-66	--pf-c-sidebar__panel--FlexBasis	66%
	.pf-c-sidebar__panel.pf-m-width-75	--pf-c-sidebar__panel--FlexBasis	75%
	.pf-c-sidebar__panel.pf-m-width-100	--pf-c-sidebar__panel--FlexBasis	100%

View source on GitHub

QUICKLINKS

CONTRIBUTE

STAY IN TOUCH

Privacy statement Terms of use All policies and guidelines