PatternFly

Background image

A background image allows you to place an image in the background of your page or area of a page.

Examples

Basic

Basic screenshot

Props

BackgroundImage

*required
NameTypeDefaultDescription
srcrequiredstringThe URL or file path of the image for the background
classNamestringAdditional classes added to the background image.

CSS variables

Expand or collapse columnSelectorVariableValue
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundColor
#151515
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundImage
none
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundSize--min-width
200px
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundSize--width
60%
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundSize--max-width
600px
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundSize
clamp(200px, 60%, 600px)
.pf-v5-c-background-image--pf-v5-c-background-image--BackgroundPosition
bottom right
:where(.pf-v5-m-dir-rtl, [dir=rtl]) .pf-v5-c-background-image--pf-v5-c-background-image--BackgroundPosition
bottom left

View source on GitHub