Skip to content

Commit 5080157

Browse files
fhlavacedonehoo
andauthored
Add gallery to the about page (#366)
* fix(nav): Fix ResponsiveActions displaying * fix(gallery): Add gallery to the about page * fix(gallery): Adress review notes * Update packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md Co-authored-by: Erin Donehoo <[email protected]> --------- Co-authored-by: Erin Donehoo <[email protected]>
1 parent 8d93ee2 commit 5080157

File tree

4 files changed

+39
-9
lines changed

4 files changed

+39
-9
lines changed

packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,29 @@ id: About component groups
44
sortValue: 1
55
sourceLink: https://github.com/patternfly/react-component-groups/blob/main/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md
66
---
7+
import { SectionGallery } from '@patternfly/documentation-framework/components/sectionGallery/sectionGallery';
8+
import galleryData from './gallery-data.json';
79

810
Component groups lives in its own package [`@patternfly/react-component-groups`](https://www.npmjs.com/package/@patternfly/react-component-groups)
911

12+
**Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previously used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`.
13+
1014
# Component groups
1115

12-
The component groups extension contains a range of React components that are more complex than basic PatternFly components. These component groups combine and adjust multiple base components to provide opinionated solutions for recurring use cases across products using PatternFly.
16+
The component groups extension contains a range of React components that are more complex than basic PatternFly components. These component groups combine and adjust multiple base components to provide opinionated solutions for recurring use cases across products using PatternFly.
17+
18+
The creation and maintenance of this extension is a collaborative effort between the PatternFly and Red Hat Hybrid Cloud Console teams. All component groups receive accessibility and design reviews, and we are working to improve internationalization, add test coverage, and ensure that CSS overrides all correctly reference the PatternFly CSS API.
1319

14-
The creation and maintenance of this extension is a collaborative effort between the PatternFly and Red Hat Hybrid Cloud Console teams. All component groups receive accessibility and design reviews, and we are working to improve internationalization, add unit test coverage, and ensure that CSS overrides all correctly reference the PatternFly CSS API.
20+
There are a few different functional categories of component groups:
1521

16-
**Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previoulsy used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`.
22+
<SectionGallery
23+
section="Component groups"
24+
galleryItemsData={galleryData}
25+
placeholderText="Search component groups by name"
26+
includeSubsections={true}
27+
hasGridText={true}
28+
isFullWidth={false}
29+
/>
1730

1831
## Contribution guidelines
1932

@@ -25,4 +38,4 @@ Specific contribution guidelines and instructions are outlined in [the component
2538

2639
We aim to align the standards of component groups as closely as possible with existing PatternFly standards. Given that this is a multi-team collaboration, we will continue to work towards this goal together.
2740

28-
If you notice a bug or have a suggestion for a new component group, feel free to file an issue in our [GitHub repository](https://github.com/patternfly/react-component-groups/issues)! Please make sure to check if there is already a pre-existing issue before creating a new issue.
41+
If you notice a bug or have a suggestion for a new component group, open an issue in our [GitHub repository](https://github.com/patternfly/react-component-groups/issues)! Please make sure to check if there is already a pre-existing issue before creating a new one.

packages/module/patternfly-docs/content/extensions/component-groups/examples/ResponsiveActions/ResponsiveActions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
# Sidenav top-level section
33
# should be the same for all markdown files
4-
section: extensions
5-
subsection: Component groups
4+
section: Component groups
5+
subsection: Controls
66
# Sidenav secondary level section
77
# should be the same for all markdown files
88
id: Responsive actions
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"content-containers": {
3+
"summary": "Organize and display information in structured or flexible containers."
4+
},
5+
"controls": {
6+
"summary": "Enable more effective navigation and selection by providing users with options for interaction and input."
7+
},
8+
"error-communication": {
9+
"summary": "Communicate issues or restrictions through error and alert states."
10+
},
11+
"helpers": {
12+
"summary": "Provide users with utilities that enhance usability and provide additional guidance or information within the UI."
13+
},
14+
"status-and-state-indicators": {
15+
"summary": "Inform users of system conditions or processes through visualizations of entity states, statuses, and loading indicators."
16+
}
17+
}

yarn.lock

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1760,9 +1760,9 @@
17601760
version "5.0.0-prerelease.0"
17611761
resolved "file:packages/module"
17621762
dependencies:
1763-
"@patternfly/react-core" "^6.0.0-alpha.101"
1764-
"@patternfly/react-icons" "^6.0.0-alpha.36"
1765-
"@patternfly/react-table" "^6.0.0-alpha.102"
1763+
"@patternfly/react-core" "^6.0.0-prerelease.21"
1764+
"@patternfly/react-icons" "^6.0.0-prerelease.7"
1765+
"@patternfly/react-table" "^6.0.0-prerelease.22"
17661766
clsx "^2.1.1"
17671767
react-jss "^10.10.0"
17681768

0 commit comments

Comments
 (0)