Skip to content

Commit ee0eeca

Browse files
wise-king-sullymanwise-king-sullyman
authored
Merge pull request #4 from wise-king-sullyman/utilize-tertiary-nav
feat(docs): utilize tertiary nav to organize docs
2 parents ae74518 + c4664a2 commit ee0eeca

File tree

20 files changed

+1376
-30
lines changed

20 files changed

+1376
-30
lines changed

‎packages/module/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"react-dom": "^16.8 || ^17 || ^18"
5454
},
5555
"devDependencies": {
56-
"@patternfly/documentation-framework": "^1.2.55",
56+
"@patternfly/documentation-framework": "^1.3.0",
5757
"@patternfly/react-table": "^4.111.4",
5858
"@patternfly/react-code-editor": "^4.82.26",
5959
"rimraf": "^2.6.2",

‎packages/module/patternfly-docs/content/examples/CatalogItemHeader.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: Catalog view item header
2+
id: Catalog item header
33
section: extensions
4+
subsection: Catalog view
45
source: react
56
propComponents: ['CatalogItemHeader']
67
---

‎packages/module/patternfly-docs/content/examples/CatalogTile.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: Catalog view tile
2+
id: Catalog tile
33
section: extensions
4+
subsection: Catalog view
45
source: react
56
propComponents: ['CatalogTile']
67
---

‎packages/module/patternfly-docs/content/examples/FilterSidePanel.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: Catalog view filter side panel
2+
id: Filter side panel
33
section: extensions
4+
subsection: Catalog view
45
source: react
56
propComponents: ['FilterSidePanel', 'FilterSidePanelCategory', 'FilterSidePanelCategoryItem']
67
---

‎packages/module/patternfly-docs/content/examples/PropertiesSidePanel.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: Catalog view properties side panel
2+
id: Properties side panel
33
section: extensions
4+
subsection: Catalog view
45
source: react
56
propComponents: ['PropertiesSidePanel', 'PropertyItem']
67
---

‎packages/module/patternfly-docs/content/examples/VerticalTabs.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: Catalog view vertical tabs
2+
id: Vertical tabs
33
section: extensions
4+
subsection: Catalog view
45
source: react
56
propComponents: ['VerticalTabs', 'VerticalTabsTab']
67
---

‎packages/module/patternfly-docs/generated/extensions/catalog-item-header/catalog-view-item-header/react.js‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
import React from 'react';
2+
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3+
import { CatalogItemHeader } from '@ausuliv/react-catalog-view-extension';
4+
import pfLogo2 from '../../../../content/examples/./pfLogo2.svg';
5+
import '../../../../content/examples/./catalogItemHeader.css';
6+
const pageData = {
7+
"id": "Catalog view item header",
8+
"section": "extensions",
9+
"subsection": "Catalog item header",
10+
"source": "react",
11+
"slug": "/extensions/catalog-item-header/catalog-view-item-header/react",
12+
"sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/module/patternfly-docs/content/examples/CatalogItemHeader.md",
13+
"propComponents": [
14+
{
15+
"name": "CatalogItemHeader",
16+
"description": "",
17+
"props": [
18+
{
19+
"name": "className",
20+
"type": "string",
21+
"description": "Additional css classes",
22+
"defaultValue": "''"
23+
},
24+
{
25+
"name": "iconClass",
26+
"type": "string",
27+
"description": "Class for the image when an icon is to be used (exclusive from iconImg)",
28+
"defaultValue": "null"
29+
},
30+
{
31+
"name": "iconImg",
32+
"type": "string",
33+
"description": "URL of an image for the item's icon",
34+
"defaultValue": "null"
35+
},
36+
{
37+
"name": "title",
38+
"type": "string | React.ReactNode",
39+
"description": "Tile for the catalog item",
40+
"required": true
41+
},
42+
{
43+
"name": "vendor",
44+
"type": "string | React.ReactNode",
45+
"description": "Vendor for the catalog item",
46+
"defaultValue": "null"
47+
}
48+
]
49+
}
50+
],
51+
"examples": [
52+
"Basic",
53+
"With vendor description"
54+
]
55+
};
56+
pageData.liveContext = {
57+
CatalogItemHeader,
58+
pfLogo2
59+
};
60+
pageData.relativeImports = {
61+
62+
};
63+
pageData.examples = {
64+
'Basic': props =>
65+
<Example {...pageData} {...props} {...{"code":"import React from 'react';\nimport { CatalogItemHeader } from '@ausuliv/react-catalog-view-extension';\nimport pfLogo2 from './examples/pfLogo2.svg';\n\nconst Basic = () => (\n <CatalogItemHeader\n iconImg={pfLogo2}\n title=\"PatternFly\"\n />\n)","title":"Basic","lang":"js"}}>
66+
67+
</Example>,
68+
'With vendor description': props =>
69+
<Example {...pageData} {...props} {...{"code":"import React from 'react';\nimport { CatalogItemHeader } from '@ausuliv/react-catalog-view-extension';\nimport pfLogo2 from './examples/pfLogo2.svg';\n\nconst WithVendorDescription = () => (\n <CatalogItemHeader\n iconImg={pfLogo2}\n title=\"Patternfly-React\"\n vendor={\n <span>\n provided by <a href=\"http://redhat.com\">Red Hat</a>\n </span>\n }\n />\n)","title":"With vendor description","lang":"js"}}>
70+
71+
</Example>
72+
};
73+
74+
const Component = () => (
75+
<React.Fragment>
76+
<AutoLinkHeader {...{"id":"introduction","size":"h2","className":"ws-title ws-h2"}}>
77+
{`Introduction`}
78+
</AutoLinkHeader>
79+
<p {...{"className":"ws-p"}}>
80+
{`Note: Catalog item header lives in its own package at `}
81+
<PatternflyThemeLink {...{"to":"https://www.npmjs.com/package/@ausuliv/react-catalog-view-extension"}}>
82+
<code {...{"className":"ws-code"}}>
83+
{`@ausuliv/react-catalog-view-extension`}
84+
</code>
85+
</PatternflyThemeLink>
86+
{`!`}
87+
</p>
88+
<p {...{"className":"ws-p"}}>
89+
{`This package is currently an extension. Extension components do not undergo the same rigorous design or coding review process as core PatternFly components. If enough members of the community find them useful, we will work to move them into our core PatternFly system by starting the design process for the idea.`}
90+
</p>
91+
<AutoLinkHeader {...{"id":"examples","size":"h2","className":"ws-title ws-h2"}}>
92+
{`Examples`}
93+
</AutoLinkHeader>
94+
{React.createElement(pageData.examples["Basic"])}
95+
{React.createElement(pageData.examples["With vendor description"])}
96+
</React.Fragment>
97+
);
98+
Component.displayName = 'ExtensionsCatalogItemHeaderCatalogViewItemHeaderReactDocs';
99+
Component.pageData = pageData;
100+
101+
export default Component;

‎packages/module/patternfly-docs/generated/extensions/catalog-item-header/catalog-view/react.js‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
import React from 'react';
2+
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3+
import { CatalogItemHeader } from '@ausuliv/react-catalog-view-extension';
4+
import pfLogo2 from '../../../../content/examples/./pfLogo2.svg';
5+
import '../../../../content/examples/./catalogItemHeader.css';
6+
const pageData = {
7+
"id": "Catalog view",
8+
"section": "extensions",
9+
"subsection": "Catalog item header",
10+
"source": "react",
11+
"slug": "/extensions/catalog-item-header/catalog-view/react",
12+
"sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/module/patternfly-docs/content/examples/CatalogItemHeader.md",
13+
"propComponents": [
14+
{
15+
"name": "CatalogItemHeader",
16+
"description": "",
17+
"props": [
18+
{
19+
"name": "className",
20+
"type": "string",
21+
"description": "Additional css classes",
22+
"defaultValue": "''"
23+
},
24+
{
25+
"name": "iconClass",
26+
"type": "string",
27+
"description": "Class for the image when an icon is to be used (exclusive from iconImg)",
28+
"defaultValue": "null"
29+
},
30+
{
31+
"name": "iconImg",
32+
"type": "string",
33+
"description": "URL of an image for the item's icon",
34+
"defaultValue": "null"
35+
},
36+
{
37+
"name": "title",
38+
"type": "string | React.ReactNode",
39+
"description": "Tile for the catalog item",
40+
"required": true
41+
},
42+
{
43+
"name": "vendor",
44+
"type": "string | React.ReactNode",
45+
"description": "Vendor for the catalog item",
46+
"defaultValue": "null"
47+
}
48+
]
49+
}
50+
],
51+
"examples": [
52+
"Basic",
53+
"With vendor description"
54+
]
55+
};
56+
pageData.liveContext = {
57+
CatalogItemHeader,
58+
pfLogo2
59+
};
60+
pageData.relativeImports = {
61+
62+
};
63+
pageData.examples = {
64+
'Basic': props =>
65+
<Example {...pageData} {...props} {...{"code":"import React from 'react';\nimport { CatalogItemHeader } from '@ausuliv/react-catalog-view-extension';\nimport pfLogo2 from './examples/pfLogo2.svg';\n\nconst Basic = () => (\n <CatalogItemHeader\n iconImg={pfLogo2}\n title=\"PatternFly\"\n />\n)","title":"Basic","lang":"js"}}>
66+
67+
</Example>,
68+
'With vendor description': props =>
69+
<Example {...pageData} {...props} {...{"code":"import React from 'react';\nimport { CatalogItemHeader } from '@ausuliv/react-catalog-view-extension';\nimport pfLogo2 from './examples/pfLogo2.svg';\n\nconst WithVendorDescription = () => (\n <CatalogItemHeader\n iconImg={pfLogo2}\n title=\"Patternfly-React\"\n vendor={\n <span>\n provided by <a href=\"http://redhat.com\">Red Hat</a>\n </span>\n }\n />\n)","title":"With vendor description","lang":"js"}}>
70+
71+
</Example>
72+
};
73+
74+
const Component = () => (
75+
<React.Fragment>
76+
<AutoLinkHeader {...{"id":"introduction","size":"h2","className":"ws-title ws-h2"}}>
77+
{`Introduction`}
78+
</AutoLinkHeader>
79+
<p {...{"className":"ws-p"}}>
80+
{`Note: Catalog item header lives in its own package at `}
81+
<PatternflyThemeLink {...{"to":"https://www.npmjs.com/package/@ausuliv/react-catalog-view-extension"}}>
82+
<code {...{"className":"ws-code"}}>
83+
{`@ausuliv/react-catalog-view-extension`}
84+
</code>
85+
</PatternflyThemeLink>
86+
{`!`}
87+
</p>
88+
<p {...{"className":"ws-p"}}>
89+
{`This package is currently an extension. Extension components do not undergo the same rigorous design or coding review process as core PatternFly components. If enough members of the community find them useful, we will work to move them into our core PatternFly system by starting the design process for the idea.`}
90+
</p>
91+
<AutoLinkHeader {...{"id":"examples","size":"h2","className":"ws-title ws-h2"}}>
92+
{`Examples`}
93+
</AutoLinkHeader>
94+
{React.createElement(pageData.examples["Basic"])}
95+
{React.createElement(pageData.examples["With vendor description"])}
96+
</React.Fragment>
97+
);
98+
Component.displayName = 'ExtensionsCatalogItemHeaderCatalogViewReactDocs';
99+
Component.pageData = pageData;
100+
101+
export default Component;

0 commit comments

Comments
 (0)