@patternfly/documentation-framework 6.37.0 → 6.38.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/components/index.js +1 -1
- package/components/link/{link.js → link.jsx} +1 -1
- package/components/sectionGallery/{sectionDataListLayout.js → sectionDataListLayout.jsx} +2 -2
- package/components/sectionGallery/sectionGallery.js +1 -78
- package/components/sectionGallery/sectionGallery.jsx +78 -0
- package/components/sectionGallery/{sectionGalleryLayout.js → sectionGalleryLayout.jsx} +1 -1
- package/components/sideNav/sideNav.js +1 -1
- package/package.json +2 -2
- package/templates/design-guidelines.js +1 -1
- /package/components/sectionGallery/{TextSummary.js → TextSummary.jsx} +0 -0
- /package/components/sectionGallery/{sectionGalleryToolbar.js → sectionGalleryToolbar.jsx} +0 -0
- /package/components/sectionGallery/{sectionGalleryWrapper.js → sectionGalleryWrapper.jsx} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,25 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## 6.38.1 (2026-04-15)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# 6.38.0 (2026-04-14)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **site:** update doc-core to 1.22.0 ([#4946](https://github.com/patternfly/patternfly-org/issues/4946)) ([fc290d0](https://github.com/patternfly/patternfly-org/commit/fc290d030bc34d1728fc9a3948fed4e5b4be5df3))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
6
25
|
# 6.37.0 (2026-04-06)
|
|
7
26
|
|
|
8
27
|
|
package/components/index.js
CHANGED
|
@@ -8,7 +8,7 @@ export * from './propsTable/propsTable';
|
|
|
8
8
|
export * from './navAnnouncementBanner/navAnnouncementBanner';
|
|
9
9
|
export * from './sideNav/sideNav';
|
|
10
10
|
export * from './topNav/topNav';
|
|
11
|
-
export * from './link/link';
|
|
11
|
+
export * from './link/link.jsx';
|
|
12
12
|
export * from './tableOfContents/tableOfContents';
|
|
13
13
|
export * from './inlineAlert/inlineAlert';
|
|
14
14
|
export * from './themeSelector/themeSelector';
|
|
@@ -11,8 +11,8 @@ import {
|
|
|
11
11
|
ContentVariants,
|
|
12
12
|
Label,
|
|
13
13
|
} from "@patternfly/react-core";
|
|
14
|
-
import { Link } from "../link/link";
|
|
15
|
-
import { TextSummary } from "./TextSummary";
|
|
14
|
+
import { Link } from "../link/link.jsx";
|
|
15
|
+
import { TextSummary } from "./TextSummary.jsx";
|
|
16
16
|
|
|
17
17
|
export const SectionDataListLayout = ({
|
|
18
18
|
galleryItems,
|
|
@@ -1,78 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import './sectionGallery.css';
|
|
4
|
-
import { SectionGalleryToolbar } from "./sectionGalleryToolbar";
|
|
5
|
-
import { SectionGalleryLayout } from "./sectionGalleryLayout";
|
|
6
|
-
import { SectionDataListLayout } from "./sectionDataListLayout";
|
|
7
|
-
import { SectionGalleryWrapper } from "./sectionGalleryWrapper";
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Helper component returns gallery of items with search toolbar and switchable gallery/data list views.
|
|
11
|
-
* @param {Object} illustrations - Object of preview images mapped to their snake_case item display name
|
|
12
|
-
* @param {string} section - Name of the navigation section to create the gallery within
|
|
13
|
-
* @param {Object} galleryItemsData - Object containing the image location & summary text mapped to the gallery item's hyphenated-name
|
|
14
|
-
* @param {string} [placeholderText=Search by name] - Optional text to be displayed as placeholder for SearchInput
|
|
15
|
-
* @param {string} [countText= items] - Optional text to be displayed after the number of search results
|
|
16
|
-
* @param {string} [initialLayout=grid] - Optional text to indicate whether to default to grid or list layout
|
|
17
|
-
* @param {Boolean} [hasGridText=false] - Optional boolean to toggle text on grid layout cards
|
|
18
|
-
* @param {Boolean} [hasGridImages=false] - Optional boolean to toggle images on grid layout cards
|
|
19
|
-
* @param {Boolean} [hasListText=false] - Optional boolean to toggle text on list layout rows
|
|
20
|
-
* @param {Boolean} [hasListImages=false] - Optional boolean to toggle images on list layout rows
|
|
21
|
-
* @param {Boolean} [isFullWidth=true] - Optional boolean to disable component from exceeding default max-width for page
|
|
22
|
-
*/
|
|
23
|
-
|
|
24
|
-
export const SectionGallery = ({
|
|
25
|
-
illustrations,
|
|
26
|
-
section,
|
|
27
|
-
subsection = null,
|
|
28
|
-
includeSubsections = false,
|
|
29
|
-
parseSubsections = false,
|
|
30
|
-
galleryItemsData,
|
|
31
|
-
placeholderText,
|
|
32
|
-
countText,
|
|
33
|
-
initialLayout = "grid",
|
|
34
|
-
hasGridText = false,
|
|
35
|
-
hasGridImages = true,
|
|
36
|
-
hasListText = true,
|
|
37
|
-
hasListImages = true,
|
|
38
|
-
isFullWidth = true,
|
|
39
|
-
onlyShowInGalleryData = false
|
|
40
|
-
}) => (
|
|
41
|
-
<SectionGalleryWrapper
|
|
42
|
-
illustrations={illustrations}
|
|
43
|
-
section={section}
|
|
44
|
-
subsection={subsection}
|
|
45
|
-
includeSubsections={includeSubsections}
|
|
46
|
-
parseSubsections={parseSubsections}
|
|
47
|
-
galleryItemsData={galleryItemsData}
|
|
48
|
-
initialLayout={initialLayout}
|
|
49
|
-
isFullWidth={isFullWidth}
|
|
50
|
-
onlyShowInGalleryData={onlyShowInGalleryData}
|
|
51
|
-
>
|
|
52
|
-
{(sectionGalleryItems, searchTerm, setSearchTerm, layoutView, setLayoutView) => (
|
|
53
|
-
<>
|
|
54
|
-
<SectionGalleryToolbar
|
|
55
|
-
galleryItems={sectionGalleryItems}
|
|
56
|
-
searchTerm={searchTerm}
|
|
57
|
-
setSearchTerm={setSearchTerm}
|
|
58
|
-
layoutView={layoutView}
|
|
59
|
-
setLayoutView={setLayoutView}
|
|
60
|
-
placeholderText={placeholderText}
|
|
61
|
-
countText={countText}
|
|
62
|
-
/>
|
|
63
|
-
<SectionGalleryLayout
|
|
64
|
-
galleryItems={sectionGalleryItems}
|
|
65
|
-
layoutView={layoutView}
|
|
66
|
-
hasGridText={hasGridText}
|
|
67
|
-
hasGridImages={hasGridImages}
|
|
68
|
-
/>
|
|
69
|
-
<SectionDataListLayout
|
|
70
|
-
galleryItems={sectionGalleryItems}
|
|
71
|
-
layoutView={layoutView}
|
|
72
|
-
hasListText={hasListText}
|
|
73
|
-
hasListImages={hasListImages}
|
|
74
|
-
/>
|
|
75
|
-
</>
|
|
76
|
-
)}
|
|
77
|
-
</SectionGalleryWrapper>
|
|
78
|
-
);
|
|
1
|
+
export * from './sectionGallery.jsx';
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
|
|
3
|
+
import './sectionGallery.css';
|
|
4
|
+
import { SectionGalleryToolbar } from "./sectionGalleryToolbar.jsx";
|
|
5
|
+
import { SectionGalleryLayout } from "./sectionGalleryLayout.jsx";
|
|
6
|
+
import { SectionDataListLayout } from "./sectionDataListLayout.jsx";
|
|
7
|
+
import { SectionGalleryWrapper } from "./sectionGalleryWrapper.jsx";
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Helper component returns gallery of items with search toolbar and switchable gallery/data list views.
|
|
11
|
+
* @param {Object} illustrations - Object of preview images mapped to their snake_case item display name
|
|
12
|
+
* @param {string} section - Name of the navigation section to create the gallery within
|
|
13
|
+
* @param {Object} galleryItemsData - Object containing the image location & summary text mapped to the gallery item's hyphenated-name
|
|
14
|
+
* @param {string} [placeholderText=Search by name] - Optional text to be displayed as placeholder for SearchInput
|
|
15
|
+
* @param {string} [countText= items] - Optional text to be displayed after the number of search results
|
|
16
|
+
* @param {string} [initialLayout=grid] - Optional text to indicate whether to default to grid or list layout
|
|
17
|
+
* @param {Boolean} [hasGridText=false] - Optional boolean to toggle text on grid layout cards
|
|
18
|
+
* @param {Boolean} [hasGridImages=false] - Optional boolean to toggle images on grid layout cards
|
|
19
|
+
* @param {Boolean} [hasListText=false] - Optional boolean to toggle text on list layout rows
|
|
20
|
+
* @param {Boolean} [hasListImages=false] - Optional boolean to toggle images on list layout rows
|
|
21
|
+
* @param {Boolean} [isFullWidth=true] - Optional boolean to disable component from exceeding default max-width for page
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
export const SectionGallery = ({
|
|
25
|
+
illustrations,
|
|
26
|
+
section,
|
|
27
|
+
subsection = null,
|
|
28
|
+
includeSubsections = false,
|
|
29
|
+
parseSubsections = false,
|
|
30
|
+
galleryItemsData,
|
|
31
|
+
placeholderText,
|
|
32
|
+
countText,
|
|
33
|
+
initialLayout = "grid",
|
|
34
|
+
hasGridText = false,
|
|
35
|
+
hasGridImages = true,
|
|
36
|
+
hasListText = true,
|
|
37
|
+
hasListImages = true,
|
|
38
|
+
isFullWidth = true,
|
|
39
|
+
onlyShowInGalleryData = false
|
|
40
|
+
}) => (
|
|
41
|
+
<SectionGalleryWrapper
|
|
42
|
+
illustrations={illustrations}
|
|
43
|
+
section={section}
|
|
44
|
+
subsection={subsection}
|
|
45
|
+
includeSubsections={includeSubsections}
|
|
46
|
+
parseSubsections={parseSubsections}
|
|
47
|
+
galleryItemsData={galleryItemsData}
|
|
48
|
+
initialLayout={initialLayout}
|
|
49
|
+
isFullWidth={isFullWidth}
|
|
50
|
+
onlyShowInGalleryData={onlyShowInGalleryData}
|
|
51
|
+
>
|
|
52
|
+
{(sectionGalleryItems, searchTerm, setSearchTerm, layoutView, setLayoutView) => (
|
|
53
|
+
<>
|
|
54
|
+
<SectionGalleryToolbar
|
|
55
|
+
galleryItems={sectionGalleryItems}
|
|
56
|
+
searchTerm={searchTerm}
|
|
57
|
+
setSearchTerm={setSearchTerm}
|
|
58
|
+
layoutView={layoutView}
|
|
59
|
+
setLayoutView={setLayoutView}
|
|
60
|
+
placeholderText={placeholderText}
|
|
61
|
+
countText={countText}
|
|
62
|
+
/>
|
|
63
|
+
<SectionGalleryLayout
|
|
64
|
+
galleryItems={sectionGalleryItems}
|
|
65
|
+
layoutView={layoutView}
|
|
66
|
+
hasGridText={hasGridText}
|
|
67
|
+
hasGridImages={hasGridImages}
|
|
68
|
+
/>
|
|
69
|
+
<SectionDataListLayout
|
|
70
|
+
galleryItems={sectionGalleryItems}
|
|
71
|
+
layoutView={layoutView}
|
|
72
|
+
hasListText={hasListText}
|
|
73
|
+
hasListImages={hasListImages}
|
|
74
|
+
/>
|
|
75
|
+
</>
|
|
76
|
+
)}
|
|
77
|
+
</SectionGalleryWrapper>
|
|
78
|
+
);
|
|
@@ -10,7 +10,7 @@ import {
|
|
|
10
10
|
Label,
|
|
11
11
|
} from '@patternfly/react-core';
|
|
12
12
|
import { navigate } from '@reach/router';
|
|
13
|
-
import { TextSummary } from './TextSummary';
|
|
13
|
+
import { TextSummary } from './TextSummary.jsx';
|
|
14
14
|
|
|
15
15
|
export const SectionGalleryLayout = ({
|
|
16
16
|
galleryItems,
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@patternfly/documentation-framework",
|
|
3
3
|
"description": "A framework to build documentation for PatternFly.",
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.38.1",
|
|
5
5
|
"author": "Red Hat",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"bin": {
|
|
@@ -92,5 +92,5 @@
|
|
|
92
92
|
"http-cache-semantics": ">=4.1.1",
|
|
93
93
|
"nanoid": "3.3.8"
|
|
94
94
|
},
|
|
95
|
-
"gitHead": "
|
|
95
|
+
"gitHead": "ce8427732d86a746488e6207697193dd3e7de9e8"
|
|
96
96
|
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|