-
Notifications
You must be signed in to change notification settings - Fork 147
docs(theming): Adds details around new theme and glass mode. #4983
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
edonehoo
wants to merge
13
commits into
patternfly:main
Choose a base branch
from
edonehoo:iss4952
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+161
−45
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
eccd63b
docs(theming): Adds details around new unified theme.
edonehoo aad3e20
docs(theming): Add new theming details.
edonehoo 1f44f70
docs(theming): Update theming docs.
edonehoo deb9a60
Adds glass mode handbook outline draft.
edonehoo 4475558
Merge branch 'main' into iss4952
edonehoo 2735c8a
Add tokens table and list of glass-supporting components.
edonehoo 10a4a6d
Merge branch 'main' into iss4952
edonehoo 0d784aa
Change name to Project Felt.
edonehoo 9d832c9
Merge branch 'main' into iss4952
edonehoo 9310dbb
Merge branch 'main' into iss4952
edonehoo f8ed613
Merge branch 'main' into iss4952
edonehoo 3de1c3e
fix(theming doc): typo fix
andrew-ronaldson 611309b
Updates from PR feedback.
edonehoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
...rnfly-docs/content/foundations-and-styles/styles/theming/glass-mode-handbook.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| id: Theming | ||
| section: foundations-and-styles | ||
| source: glass-mode-handbook | ||
| --- | ||
|
|
||
| # Glass mode developer handbook | ||
|
|
||
| ## What is glass mode? | ||
|
|
||
| Glass mode is a contrast mode option that's enabled in our Project Felt theme by default and can be manually enabled in our Default theme. 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: | ||
| - Card | ||
| - Drawer | ||
| - Login page | ||
| - Masthead | ||
| - Navigation | ||
| - Page | ||
| - Panel | ||
|
|
||
| ### 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 should be selected for each Red Hat product in collaboration with the Brand team. | ||
|
|
||
| Text must never be placed directly on a background image—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. | ||
|
|
||
| ### Opacity | ||
|
|
||
| The default opacity values used in our components have been tested for accessibility, legibility, and visual appeal. | ||
| - Project Felt light typically utilizes a 40% opacity to maintain AAA contrast for standard text. | ||
| - Project Felt dark utilizes a 60% opacity to provide better reliability for the dark color scheme. | ||
|
|
||
| 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 and is enabled by default in our Project Felt theme. To manually enable glass in our Default theme, add the class `.pf-v6-theme-glass` to your application’s `<html>` tag. When implementing glass with our Default theme, it's important to ensure that glass 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. | ||
| - **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 (in Project Felt theme) | Usage | | ||
| | --- | --- | --- | | ||
| | `--pf-t--global--background--color--glass--primary--default` | Light mode value: #FFFFFF (60% opacity) <br /> Dark mode value: #292929 at 50% opacity | Base fill for glass containers. | | ||
| | `--pf-t--global--background--filter--glass--default` | Light mode value: #C7C7C7 (25% opacity) <br /> Dark mode value: #C7C7C7 (15% opacity) | Overlay tint used to enhance blur visibility. | | ||
| | `--pf-t--global--border--color--glass--default` | Light mode value: #FFFFFF (60% opacity) <br /> Dark mode value: #292929 (50% opacity) | Boundary highlight for glass surfaces. | | ||
| | `--pf-t--global--border--radius--glass--default` | #D6D6D6 with 16px radius | Default rounded border for glass element. | | ||
| | `--pf-t--global--background--color--sticky--default` | Light mode value: #FFFFFF (100% opacity) <br /> Dark mode value: #292929 (100% opacity) | Solid background for sticky elements, like headers. | | ||
| | `--pf-t--global--box-shadow--medium` | #292929 (15% opacity) | Shadow that signifies elevation. | | ||
|
|
||
| ## 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. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.