Skip to content

Commit b6b9dd6

Browse files
fix(Compass): replaced CompassPanel and background images (#5001)
1 parent 8d1896f commit b6b9dd6

22 files changed

Lines changed: 794 additions & 751 deletions

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@
3939
},
4040
"devDependencies": {
4141
"@octokit/rest": "^19.0.13",
42-
"@patternfly/patternfly": "^6.5.0-prerelease.64",
43-
"@patternfly/react-code-editor": "^6.5.0-prerelease.52",
44-
"@patternfly/react-core": "^6.5.0-prerelease.49",
45-
"@patternfly/react-table": "^6.5.0-prerelease.50",
42+
"@patternfly/patternfly": "^6.5.0-prerelease.81",
43+
"@patternfly/react-code-editor": "^6.5.0-prerelease.68",
44+
"@patternfly/react-core": "^6.5.0-prerelease.65",
45+
"@patternfly/react-table": "^6.5.0-prerelease.68",
4646
"glob": "^8.1.0",
4747
"lerna": "^9.0.5",
4848
"monaco-editor": "0.54.0",
@@ -74,9 +74,9 @@
7474
"ajv": ">=6.14.0",
7575
"qs": ">=6.15.0",
7676
"@isaacs/brace-expansion": ">=5.0.1",
77-
"@patternfly/react-code-editor": "^6.5.0-prerelease.52",
78-
"@patternfly/react-core": "^6.5.0-prerelease.49",
79-
"@patternfly/react-table": "^6.5.0-prerelease.50",
77+
"@patternfly/react-code-editor": "^6.5.0-prerelease.68",
78+
"@patternfly/react-core": "^6.5.0-prerelease.65",
79+
"@patternfly/react-table": "^6.5.0-prerelease.68",
8080
"monaco-editor": "0.54.0"
8181
}
8282
}

packages/documentation-framework/package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@
6868
"webpack-merge": "5.10.0"
6969
},
7070
"peerDependencies": {
71-
"@patternfly/patternfly": "^6.5.0-prerelease.64",
72-
"@patternfly/react-code-editor": "^6.5.0-prerelease.52",
73-
"@patternfly/react-core": "^6.5.0-prerelease.49",
74-
"@patternfly/react-icons": "^6.5.0-prerelease.20",
75-
"@patternfly/react-table": "^6.5.0-prerelease.50",
71+
"@patternfly/patternfly": "^6.5.0-prerelease.81",
72+
"@patternfly/react-code-editor": "^6.5.0-prerelease.68",
73+
"@patternfly/react-core": "^6.5.0-prerelease.65",
74+
"@patternfly/react-icons": "^6.5.0-prerelease.29",
75+
"@patternfly/react-table": "^6.5.0-prerelease.68",
7676
"react": "^17.0.0 || ^18.0.0",
7777
"react-dom": "^17.0.0 || ^18.0.0"
7878
},

packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ When building generative UI layouts using the Compass components, there are seve
1111
### Transparent containers
1212
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.
1313

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.
1515

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.
1717

1818
### Header
1919
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. `<
3535
```
3636

3737
### 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.
3939

4040
### Docked navigation
4141
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
4545
### Footer
4646
There are 2 methods of adding a footer to a compass layout.
4747

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:
4949

5050
```
5151
<CompassMessageBar>
52-
<CompassPanel isPill hasNoPadding hasNoBorder>
53-
<MessageBar />
54-
<div aria-live="polite" className="pf-v6-screen-reader">
55-
// aria anouncments for message bar's state updates
56-
</div>
57-
</CompassPanel>
52+
<Panel isGlass isPill hasNoBorder>
53+
<PanelMain>
54+
<MessageBar />
55+
<div aria-live="polite" className="pf-v6-screen-reader">
56+
// aria anouncments for message bar's state updates
57+
</div>
58+
</PanelMain>
59+
</Panel>
5860
</CompassMessageBar>
5961
```
6062

@@ -69,9 +71,9 @@ In both methods, the footer content will remain the same, typically containing a
6971
### Main content
7072
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>`.
7173

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.
7375

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).
7577

7678
## CSS customization
7779

0 commit comments

Comments
 (0)