Skip to content

Commit c7d1a18

Browse files
authored
docs(generative ui): draft of a generative ui/compass intro page (#4854)
* docs(generative ui): draft of a generative ui/compass intro page * update with links and reorganize order * add screenshot * clean up * update screenshots * update wording again * update more wording
1 parent e0e8a46 commit c7d1a18

File tree

8 files changed

+76
-0
lines changed

8 files changed

+76
-0
lines changed
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
id: About generative UIs
3+
section: PatternFly-AI
4+
subsection: Generative UIs
5+
---
6+
7+
import { Alert } from "@patternfly/react-core";
8+
9+
## What is generative UI?
10+
11+
Generative UI (GenUI) refers to a user interface design approach where AI is leveraged to dynamically create and adapt UI elements based on context, user needs, and data. Unlike traditional, static UIs, GenUI can produce layouts, components, and visual styles in real-time, offering more flexible and personalized user experiences.
12+
13+
## PatternFly's exploration: Compass
14+
15+
Generative UI represents a significant opportunity for PatternFly to explore new patterns, layouts, and styles that support AI-driven interface generation. PatternFly has been calling this proof of concept Compass. It investigates how the design system can evolve to support generative UI use cases.
16+
17+
<Alert isInline variant="info" title="Compass is best suited for use as a POC in other proof-of-concept generative UI use cases. It is not yet production quality code and should be used for exploration and experimentation purposes only." />
18+
19+
### AI-enabled seed app
20+
21+
We are creating an [AI-enabled seed app](https://github.com/gitdallas/patternfly-react-seed/tree/compass_theme) that you can use to create your own PatternFly Compass-based POC. The seed app includes the Compass layout fully wired out with all styles set up, providing a solid foundation that you can build on top of. It can be leveraged with AI tools like Cursor or Claude Code to build out your own POC, making it easier to experiment with generative UI patterns and explore new use cases.
22+
23+
### What does Compass include?
24+
25+
To explore Compass and its features, take a look at a number of our full page demos:
26+
- [Full page demo with card view and table layouts](/patternfly-ai/generative-uis/compass#card-and-data-view-layout)
27+
- [Full page demo with dashboard layout](/patternfly-ai/generative-uis/compass/org-demos#dashboard-layout)
28+
- [Static, full page HTML demo with multiple content sections](/patternfly-ai/generative-uis/compass/html-demos#multiple-sections)
29+
- [Static, full page HTML demo with drawer](/patternfly-ai/generative-uis/compass/html-demos#with-drawer)
30+
31+
To support the different ways you might use Compass, we've introduced several new capabilities to PatternFly:
32+
33+
- **Design tokens**: New design tokens that enable:
34+
- Glass-like visual effects
35+
- Background and border gradients
36+
- Additional smooth animations
37+
- Background image explorations
38+
- [**Compass layout component**](/components/compass): A new layout component designed specifically for generative UI patterns
39+
- **Additional components and component variants**:
40+
- Transparency & Effects:
41+
- `isPlain` makes cards, data lists, and tables transparent to allow background effects (like a glass look) to show through.
42+
- Layout & Navigation:
43+
- `isVertical` changes action lists to a vertical layout, suitable for sidebars.
44+
- `isNav` applies a new style to tabs, optimized for top-site navigation bars.
45+
- Shape & Form:
46+
- `isCircle` creates circular buttons and icon menu toggles, and pill-shaped standard menu toggles.
47+
- `isPill` gives the drawer (slide-out panel) a rounded, floating look.
48+
- AI Indicators:
49+
- `isThinking` adds a pulsing animation to show a system is actively processing (like an AI "thinking").
50+
- `hasAiIndicator` adds a gradient border to visually highlight AI-related content.
51+
52+
### Accessibility focus
53+
54+
Accessibility has been a major focus throughout the Compass exploration. As generative UIs introduce new interaction patterns and visual styles, ensuring these experiences remain accessible to all users is paramount.
55+
56+
### Integration with react-flow
57+
58+
Some stakeholdres have been experimenting with Generative UI use cases using React Flow. The React Flow package `@xyflow/react` is compatible with PatternFly through customization of its [theme](https://reactflow.dev/learn/customization/theming) and [rendered nodes](https://reactflow.dev/learn/customization/custom-nodes). A custom override stylesheet can assign PatternFly's global tokens to React Flow's own tokens to ensure a consistent styling. We have created some [documentation and a demo](/patternfly-ai/generative-uis/react-flow) for integrations with PatternFly as a POC for these use cases.
59+
60+
### Current status
61+
62+
Compass is still under development, with new components being built, evaluated, and refined based on feedback. As we hear from your experiments and learn more about GenUI patterns, the design of Compass will continuously evolve to support practical applications.
63+
64+
As of Nov 10, 2025, these are the prereleases available for building out Compass based UI POCs.
65+
66+
- "@patternfly/patternfly": "6.5.0-prerelease.23"
67+
- "@patternfly/react-charts": "8.5.0-prerelease.4"
68+
- "@patternfly/react-code-editor": "6.5.0-prerelease.11"
69+
- "@patternfly/react-core": "6.5.0-prerelease.11"
70+
- "@patternfly/react-drag-drop": "6.5.0-prerelease.11"
71+
- "@patternfly/react-icons": "6.5.0-prerelease.4"
72+
- "@patternfly/react-styles": "6.5.0-prerelease.4"
73+
- "@patternfly/react-table": "6.5.0-prerelease.11"
74+
- "@patternfly/react-tokens": "6.5.0-prerelease.4"
75+
- "@patternfly/react-templates": "6.5.0-prerelease.11"
76+
- "@patternfly/chatbot": "6.5.0-prerelease.15"
226 KB
Loading
238 KB
Loading
243 KB
Loading
185 KB
Loading
Loading
220 KB
Loading
22.3 KB
Loading

0 commit comments

Comments
 (0)