package.docs.components.BackgroundImage.examples.BackgroundImage.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patternfly Show documentation

Assets, source, tooling, and content for PatternFly 4

The newest version!

---
id: Background image
section: components
cssPrefix: pf-v6-c-background-image
---## Examples

### Basic

```html isFullscreen


```

## Documentation

### Overview

In order to set the background image to be used, set the `--pf-v6-c-background-image--BackgroundImage` CSS variable to the path of the image. For example: `--pf-v6-c-background-image--BackgroundImage: url(custom/path/image.jpg);`

### Usage

| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-background-image` | `*` | A fixed background image is applied to the background of the page. |
| `--pf-v6-c-background-image--BackgroundImage` | `.pf-v6-c-background-image` | Sets the background image to be used. **Required** |