You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ When building generative UI layouts using the Compass components, there are seve
11
11
### Transparent containers
12
12
Transparent containers create a modern glass look and feel. To enable transparency on a container, apply `pf-v6-theme-glass` to the `html` element class list, similar to the approach for enabling the dark mode theme.
13
13
14
-
Within Compass layouts, elements with a transparent glass background and rounded borders should be wrapped in a `<CompassPanel>` (some Compass components do this automatically). You can adjust various options of the `<CompassPanel>` to adapt its padding and behavior to fit the context of your use case.
14
+
Within Compass layouts, elements with a transparent glass background and rounded borders should be wrapped in a `<Panel>`and `<PanelMain>`(some Compass components do this automatically). You can adjust various options of the `<Panel>` to adapt its padding and behavior to fit the context of your use case.
15
15
16
-
To prevent styling issues, do not nest `<CompassPanel>` components while using the glass effects.
16
+
To prevent styling issues, do not nest `<Panel>` components while using the glass effects.
17
17
18
18
### Header
19
19
You can add a header to a Compass layout via the `<CompassHeader>` component. `<CompassHeader>` constructs 3 sections, which can contain any custom content, but will typically include the following:
@@ -35,7 +35,7 @@ You can add a header to a Compass layout via the `<CompassHeader>` component. `<
35
35
```
36
36
37
37
### Sidebars
38
-
There are 2 vertical sidebars in a Compass layout: 1 at the start of the page and another at the end. There are no specific helper components for these sections, so they're usually created by passing a `<CompassPanel>` that contains an [`<ActionList>`](/components/action-list) with the `isVertical` flag.
38
+
There are 2 vertical sidebars in a Compass layout: 1 at the start of the page and another at the end. There are no specific helper components for these sections, so they're usually created by passing a `<Panel>` and `<PanelMain>` that contains an [`<ActionList>`](/components/action-list) with the `isVertical` flag.
39
39
40
40
### Docked navigation
41
41
As an alternative to the above header and sidebars, a docked navigation may be used to organize navigation elements into a single anchored sidebar. You can add a docked nav to the Compass layout via the `dock` property.
@@ -45,16 +45,18 @@ A docked nav will typically contain a [`<Masthead>`](/components/masthead) with
45
45
### Footer
46
46
There are 2 methods of adding a footer to a compass layout.
47
47
48
-
In both methods, the footer content will remain the same, typically containing a [ChatBot `<MessageBar>`](/extensions/chatbot/messages/), wrapped in a `<CompassPanel>` and `<CompassMessageBar>` component:
48
+
In both methods, the footer content will remain the same, typically containing a [ChatBot `<MessageBar>`](/extensions/chatbot/messages/), wrapped in a `<Panel>`, `<PanelMain>`, and `<CompassMessageBar>` component:
// aria anouncments for message bar's state updates
57
+
</div>
58
+
</PanelMain>
59
+
</Panel>
58
60
</CompassMessageBar>
59
61
```
60
62
@@ -69,9 +71,9 @@ In both methods, the footer content will remain the same, typically containing a
69
71
### Main content
70
72
The main content in a Compass layout includes the generated information displays. Main content fills the center of the viewport and typically consists of a `<Hero>` or `<CompassMainHeader>`, a `<CompassContent>`, and an optional `<CompassMainFooter>`.
71
73
72
-
Often, the main section will contain a `<CompassMainHeader>` and `<CompassContent>` with a `<CompassPanel>`child containing the primary page content.
74
+
Often, the main section will contain a `<CompassMainHeader>` and `<CompassContent>` with `<Panel>` and `<PanelMain>`children containing the primary page content.
73
75
74
-
When making [a dashboard view](/patterns/dashboard), use a `<Hero>` instead of a `<CompassMainHeader>`. Instead of having a single `<CompassPanel>` within a `<CompassContent>`, each individual dashboard item should be wrapped in a `<CompassPanel>`. For example, in a dashboard with many content cards, each `<Card>` (with `isPlain` flag) should be wrapped by a `<CompassPanel>` inside of a [`<Grid>`](/foundations-and-styles/layouts/grid).
76
+
When making [a dashboard view](/patterns/dashboard), use a `<Hero>` instead of a `<CompassMainHeader>`. Instead of having a single `<Panel>`and `<PanelMain>` structure within a `<CompassContent>`, each individual dashboard item should be wrapped in a `<Panel>` and `<PanelMain>`. For example, in a dashboard with many content cards, each `<Card>` (with `isPlain` flag) should be wrapped by a `<Panel>` and `<PanelMain>` structure inside of a [`<Grid>`](/foundations-and-styles/layouts/grid).
0 commit comments