Skip to content

docs(theming patterns): add best practices - #5102

Merged
andrew-ronaldson merged 5 commits into
patternfly:mainfrom
andrew-ronaldson:glass-theming
Sep 17, 2026
Merged

andrew-ronaldson merged 5 commits into
patternfly:mainfrom
andrew-ronaldson:glass-theming

Conversation

@andrew-ronaldson

@andrew-ronaldson andrew-ronaldson commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

@patternfly-build

patternfly-build commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Preview: https://pf-org--pr-5102-site.surge.sh

@andrew-ronaldson

Copy link
Copy Markdown
Contributor Author

Notes on this draft:

  • Theming needs its own section. We should specify that if you are a RH product then use Felt. If users are building open source they should default to PatternFly theme. Should we show Theming in products to end-users OR just show them Felt only.
  • Too many instances of Best practice in the doc. Consider a different title for Theming control section.
  • Replace product examples with generic image. Update in Figma guidelines file.

@andrew-ronaldson
andrew-ronaldson marked this pull request as ready for review September 10, 2026 17:24

- **Default to the system setting:** Provide a "System" option for color scheme and contrast mode, and select it by default, so your product respects the user's OS- or browser-level preferences until they choose to override them.
- **Persist user selections:** Store each user's choice, for example in `localStorage` or their account settings, so their preferences are remembered across sessions.
- **Apply changes immediately:** Update the UI as soon as a user makes a selection, without requiring a separate save or submit action.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I agree with this guideline, but will there ever be a case when these controls are placed in a User Preferences modal that requires a Save or Apply action for other settings? If so, do we still want theme updates to happen immediately? I don't see a huge problem with it, but it could get weird that some things require a Save or Apply and others don't.

@phcox phcox left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. Just made a single comment that I don't think should prevent this from being merged.

@andrew-ronaldson
andrew-ronaldson merged commit 9ae93d1 into patternfly:main Sep 17, 2026
6 checks passed
@patternfly-build

Copy link
Copy Markdown
Collaborator

Your changes have been released in:

  • @patternfly/ast-helpers@1.4.0-alpha.415
  • @patternfly/documentation-framework@6.51.14

Thanks for your contribution! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants