Add gallery to the about page #366
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,14 +4,27 @@ id: About component groups | |||||
| sortValue: 1 | ||||||
| sourceLink: https://github.com/patternfly/react-component-groups/blob/main/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md | ||||||
| --- | ||||||
| import { SectionGallery } from '@patternfly/documentation-framework/components/sectionGallery/sectionGallery'; | ||||||
| import galleryData from './gallery-data.json'; | ||||||
|
|
||||||
| Component groups lives in its own package [`@patternfly/react-component-groups`](https://www.npmjs.com/package/@patternfly/react-component-groups) | ||||||
|
|
||||||
| # Component groups | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| Below, you can see a gallery of categories representing the components: | ||||||
|
|
||||||
| <SectionGallery | ||||||
| section="Component groups" | ||||||
| galleryItemsData={galleryData} | ||||||
| placeholderText="Search component groups by name" | ||||||
|
There was a problem hiding this comment.
Suggested change
maybe we can just remove the search bar for now, since there's not a lot to filter through? but if that's a lot of work, it's doing no harm by being there! There was a problem hiding this comment. @edonehoo the gallery component does not allow it yet. We may want to talk to @nicolethoen about the possibility of adding that configuration. |
||||||
| includeSubsections={true} | ||||||
| hasGridText={true} | ||||||
| isFullWidth={false} | ||||||
| /> | ||||||
|
|
||||||
| **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`. | ||||||
|
There was a problem hiding this comment.
Suggested change
What do you think about moving this up to line 11 or so? Right below the note about the package location. Just to make sure it's easy to spot |
||||||
|
|
||||||
|
|
@@ -25,4 +38,4 @@ Specific contribution guidelines and instructions are outlined in [the component | |||||
|
|
||||||
| 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. | ||||||
|
|
||||||
| 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. | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,17 @@ | ||||||
| { | ||||||
| "content-containers": { | ||||||
| "summary": "Provide layout components to organize and display content in structured and flexible formats." | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| }, | ||||||
| "controls": { | ||||||
| "summary": "Include components that manage user interactions and input, enabling intuitive navigation and selection." | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| }, | ||||||
| "error-communication": { | ||||||
| "summary": "Contain various error and alert states to communicate issues or restrictions." | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| }, | ||||||
| "helpers": { | ||||||
| "summary": "Offer utility components that enhance usability and provide additional guidance or information within the UI." | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| }, | ||||||
| "status-and-state-indicators": { | ||||||
| "summary": "Visualize entity states, statuses, and loading indicators to inform users of system conditions or processes." | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.