Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
eccd63b
docs(theming): Adds details around new unified theme.
edonehoo Mar 23, 2026
aad3e20
docs(theming): Add new theming details.
edonehoo Mar 24, 2026
1f44f70
docs(theming): Update theming docs.
edonehoo Mar 27, 2026
deb9a60
Adds glass mode handbook outline draft.
edonehoo Mar 31, 2026
4475558
Merge branch 'main' into iss4952
edonehoo Mar 31, 2026
2735c8a
Add tokens table and list of glass-supporting components.
edonehoo Apr 1, 2026
10a4a6d
Merge branch 'main' into iss4952
edonehoo Apr 7, 2026
0d784aa
Change name to Project Felt.
edonehoo Apr 23, 2026
9d832c9
Merge branch 'main' into iss4952
edonehoo Apr 23, 2026
9310dbb
Merge branch 'main' into iss4952
edonehoo Apr 28, 2026
f8ed613
Merge branch 'main' into iss4952
edonehoo Apr 29, 2026
3de1c3e
fix(theming doc): typo fix
andrew-ronaldson Apr 30, 2026
611309b
Updates from PR feedback.
edonehoo Apr 30, 2026
e9e54a4
Apply suggestion from @edonehoo
edonehoo May 1, 2026
31024c1
Merge branch 'main' into iss4952
edonehoo May 4, 2026
ae13969
Merge branch 'main' into iss4952
edonehoo May 11, 2026
f2d9935
feat: bump design-tokens package (#5002)
jschuler May 12, 2026
6c182c9
chore(release): releasing packages [ci skip]
patternfly-build May 12, 2026
54580e6
fix: move generative AI docs and bump PF versions (#5007)
nicolethoen May 12, 2026
a5fa42f
chore(release): releasing packages [ci skip]
patternfly-build May 12, 2026
2b992cb
Update CompassIntegrationsDemo.tsx
nicolethoen May 12, 2026
6291449
Update dashboard.tsx
nicolethoen May 12, 2026
f4187c9
chore(release): releasing packages [ci skip]
patternfly-build May 12, 2026
8b6ecc3
docs(content-design): Updates capitalization guidelines with recommen…
edonehoo May 12, 2026
efa0716
chore(release): releasing packages [ci skip]
patternfly-build May 12, 2026
2e37187
docs(content-design): Adds related icons to terminology table. (#4926)
edonehoo May 12, 2026
f9b843f
chore(release): releasing packages [ci skip]
patternfly-build May 12, 2026
2c253c4
feat: added documentation for patternfly cli. (#5009)
dlabaj May 13, 2026
05bb6a2
chore(release): releasing packages [ci skip]
patternfly-build May 13, 2026
4fb0c6b
Updates from review feedback
edonehoo May 18, 2026
9ac99f5
Merge upstream/main into iss4952
edonehoo May 18, 2026
d2445f5
Updates from feedback
edonehoo May 20, 2026
587999f
Merge branch 'main' into iss4952
edonehoo May 20, 2026
c346970
Fix image path
edonehoo May 20, 2026
b5e7c50
Apply suggestion from @edonehoo
edonehoo May 20, 2026
b4a4cc7
Merge branch 'main' into iss4952
edonehoo May 20, 2026
079fe6d
Update packages/documentation-site/patternfly-docs/content/foundation…
edonehoo May 20, 2026
5b5c313
Updates from pr review
edonehoo May 20, 2026
be8c842
Small edit in the high contrast handbook
edonehoo May 20, 2026
91e5cae
Merge branch 'main' into iss4952
edonehoo May 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,8 @@ Status and state colors are indicators that communicate data and actions to user

To check the contrast between background and text colors, use a <a href="https://color.a11y.com/?wc3" target="_blank" className="pf-m-link">WCAG AA-compliance tool.</a>

Beyond our standard contrast ratio, we support a high contrast and a glass contrast mode, as documented in our [theming guidelines](/foundations-and-styles/theming#contrast-modes).

## Color families
Our color palettes are organized into "families" that contain different shades of the same hue. In the following families, you can expand each color to see related tokens.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
id: Theming
section: foundations-and-styles
source: glass-mode-handbook
---

# Glass mode developer handbook

Glass mode is a contrast mode option that can be manually enabled in both our Default and Project Felt themes. Glass adds transparency, blurring, and depth to the UI to create a more dynamic visual effect where brand-approved background images and layered UI elements subtly show through.

When turned on, glass applies to the following components, including their uses within our extensions:
- Login page
- Masthead
- Navigation
- Page

Additionally, glass can be manually enabled on the following components, via the `isGlass` prop:
- Card
- Drawer
- Hero
- Panel
Comment thread
edonehoo marked this conversation as resolved.
Comment thread
edonehoo marked this conversation as resolved.

Many components also support the `isPlain` prop, which removes their default solid background color so they can sit directly on a glass-enabled surface without obscuring the intended depth effect.

## Glass-specific component variants

When glass is enabled, two component variants are automatically applied in place of their standard counterparts to help anchor the experience:

- **Banded masthead:** Adds a solid fill color and shadowed border to the masthead, setting it apart as a persistent dock above the rest of the page.
- **Floating side navigation:** Adds a solid fill color and shadowed border to the side navigation, insetting it to make it visually elevated and clearly readable as a navigation resource within the glass context.

## Background images

The glass effect is most visible when placed over a background image. To retain readability and ensure proper contrast ratios are met, images shouldn't contain high levels of detail or extreme contrast.

Background images, including non-branded and product-specific options are available to download from the [Red Hat brand portal](https://redhat.brand-portal.adobe.com/mediaportal.html/content/dam/mac/redhat/brand/brand-engagement-kit/wallpapers/product-interface-backgrounds?disableExpiredRedirect=true). If a Red Hat product team does not want to use one of the premade background options, then customized background images must be created in collaboration with the brand team.

Text must never be placed directly on a background image&mdash;it should be placed within a container that has a background color or glass effect. Titles or headings with stronger font weights can be placed directly on background images only if they pass specific brand and contrast requirements.

### Default background images

PatternFly includes background images for the glass theme and automatically applies them when you pull in PatternFly styles. Two sets of images are provided:

- **Default PatternFly theme:** `PF-Bkg-Generic-Light.svg` and `PF-Bkg-Generic-Dark.svg`
- **Project Felt theme:** `Felt-Bkg-Generic-Light.svg` and `Felt-Bkg-Generic-Dark.svg`

The path to these images depends on how you pull in PatternFly styles.

**From `@patternfly/patternfly`** (typically via `@patternfly/patternfly/patternfly.css`):
```
@patternfly/patternfly/assets/images/
```

**From `@patternfly/react-core`** (via `@patternfly/react-core/dist/styles/base.css`):
```
@patternfly/react-core/dist/styles/assets/images/
```

As long as you include PatternFly CSS through one of those two methods, the background images will be applied automatically.

### Customizing background images

If you are not using one of the standard import paths, or you want to supply your own images, you can override the following CSS variables. Overrides should be scoped to the `:root` selector.

| Variable | Default value | Usage |
| --- | --- | --- |
| `--pf-t--global--background--image--glass` | `url("./assets/images/PF-Bkg-Generic-Light.svg")` | Default/glass light theme background image |
| `--pf-t--global--background--image--glass--dark` | `url("./assets/images/PF-Bkg-Generic-Dark.svg")` | Default/glass dark theme background image |
| `--pf-t--global--background--image--felt--glass` | `url("./assets/images/Felt-Bkg-Generic-Light.svg")` | Felt/glass light theme background image |
| `--pf-t--global--background--image--felt--glass--dark` | `url("./assets/images/Felt-Bkg-Generic-Dark.svg")` | Felt/glass dark theme background image |

For example, to override both dark theme background images, add this to your application's CSS:

```css
:root {
--pf-t--global--background--image--glass--dark: url(../backgrounds/custom/my-glass-dark-image.jpg);
--pf-t--global--background--image--felt--glass--dark: url(../backgrounds/custom/my-felt-glass-dark-image.jpg);
}
```

## Opacity

The default opacity values used in our components have been tested for accessibility, legibility, and visual appeal. Glass surfaces (page, masthead, navigation, and similar components) use 50% opacity in both light and dark mode, with a background blur effect applied.

If a product team chooses to override these token values, they are responsible for conducting their own accessibility evaluation to ensure WCAG compliance.

## Enabling glass mode

Glass mode is designed to work across light and dark color schemes in both our Default and Project Felt themes. To enable glass, add the class `.pf-v6-theme-glass` to your application’s `<html>` tag. When implementing glass, it’s important to ensure that it does not harm the overall accessibility or usability of your product.

### Technical constraints

There are a few technical constraints to abide by when using glass in your product.

- **No glass-on-glass layering:** Never layer glass-enabled containers. Doing so can cause significant performance and accessibility problems. For example, child objects inside a blurred parent container can become illegibly blurred themselves. To mitigate this, we have intentionally adjusted the opacity of our background color design tokens to simulate depth without introducing extra blur.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be worth noting that we have introduced opaque styles for any items that are floating directly on top of glass elements (i.e. sticky sections, menus, popovers, overlay drawers, etc.)

- **High contrast precedence:** If high-contrast mode is enabled, all glass effects must be automatically disabled to prioritize functional accessibility.
- **User controls and preferences:** Because some users might experience legibility issues in glass mode, any product utilizing glass must also let users swap to default contrast or high contrast via a theme switcher or preferences menu. Products should also respect the OS-level `prefers-reduced-transparency` media query, disabling glass or replacing it with a solid high-opacity background to accommodate users appropriately.

## Glass design tokens

The following tokens are used together to create the glass effect.

| Token | Value | Usage |
| --- | --- | --- |
| `--pf-t--global--background--color--glass--primary--default` | Light mode value: #FFFFFF (50% opacity) <br /> Dark mode value: #292929 (50% opacity) | Base fill for glass containers. |
| `--pf-t--global--background--filter--glass--default` | Light mode value: 16% blur <br /> Dark mode value: 16% blur | Amount of blur applied to an element. |
| `--pf-t--global--border--color--glass--default` | `--pf-t--global--border--color--alt` | Boundary highlight for glass surfaces. |
| `--pf-t--global--border--radius--glass--default` | `--pf-t--global--border--radius--medium` | Rounded border for glass elements. |
| `--pf-t--global--box-shadow--glass--default` | `--pf-t--global--box-shadow--md` | Shadow that signifies elevation. |

**Note:** `--pf-t--global--background--color--sticky--default` is not a glass-specific token, but it is relevant in glass contexts by providing a solid background for non-glass elements (like sticky headers) that sit directly on top of glass content.

## Best practices

To ensure a successful implementation, follow these best practices:
- Ensure all text meets a 4.5:1 (AA) contrast ratio.
- Ensure that high contrast mode overrides any use of glass to maintain accessibility requirements.
- Always verify glass components against both light and dark background variations to catch contrast failures early.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ source: high-contrast-handbook

# High contrast mode developer handbook

High contrast mode increases the contrast of PatternFly components to support users with low vision or other visual impairments for whom higher contrast is a necessity. Our standard light and dark modes meet WCAG AA contrast ratios (4.5:1 for text), but high contrast mode goes further, targeting WCAG AAA text contrast ratios of 7:1. It also raises non-text element contrast (interactive elements and boundaries) to 4.5:1, and applies global border rules that define clear boundaries in place of shadows and subtle background fills, which can disappear in high contrast environments.

High contrast mode works across both the Default and Project Felt themes, in light and dark color schemes.

## High contrast mode vs. forced colors mode

Our high contrast mode increases the contrast of PatternFly components, often introducing additional borders to distinguish between elements, states, and interactions that otherwise rely on subtle background colors. High contrast mode is enabled by applying styles that are meant to target the [`prefers-contrast: more`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-contrast) media query, which is the mode triggered on MacOS via **System Settings** > **Accessibility** > **Display** > **Increase contrast**.

This is different from [`forced-colors: active`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/forced-colors), which is a more aggressive contrast mode where the browser enforces a limited, user-chosen color palette on a webpage, often by replacing author-defined colors with CSS system colors and removing styles like background colors and box shadows. Common triggers for forced colors mode are enabling Windows High Contrast Mode and Firefox High Contrast Mode. As outlined in [“Automatic high contrast”](#automatic-high-contrast), we recommend applying high contrast mode when `forced-colors: active` is `true`.
This is different from [`forced-colors: active`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/forced-colors), which is a more aggressive contrast mode where the browser enforces a limited, user-chosen color palette on a webpage, often by replacing author-defined colors with CSS system colors and removing styles like background colors and box shadows. Common triggers for forced colors mode are enabling Windows High Contrast Mode and Firefox High Contrast Mode. As outlined in [“Automatic high contrast”](#automatic-high-contrast), we recommend applying high contrast mode when the value of the `forced-colors` media query is `active`.

## Enabling high contrast mode

Expand Down Expand Up @@ -51,6 +55,10 @@ We also added the following tokens for plain actions (actions with a transparent
| `--pf-t--global--border--width--action--plain--hover` | 0px | `--pf-t--global--border--width--100` <br /><br/>Value: 1px |
| `--pf-t--global--border--width--action--plain--clicked` | 0px | `--pf-t--global--border--width--200` <br /><br/>Value: 2px |

## High contrast and glass mode

To ensure functional accessibility always takes priority when users need it, high contrast mode and glass mode are mutually exclusive. When high contrast mode is enabled manually or via the OS-level `prefers-reduced-transparency` media query, all glass mode effects are automatically disabled.

## Best practices

In addition to the [general theming best practices](/foundations-and-styles/theming#best-practices), ensure that you adhere to the following guidelines when working in high contrast mode.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading