@patternfly/react-docs 7.6.0-prerelease.8 → 7.6.0-prerelease.9

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.
Files changed (163) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/LICENSE +21 -0
  3. package/package.json +12 -11
  4. package/patternfly-docs/generated/components/about-modal/react.js +0 -149
  5. package/patternfly-docs/generated/components/accordion/react.js +0 -262
  6. package/patternfly-docs/generated/components/action-list/react.js +0 -144
  7. package/patternfly-docs/generated/components/alert/react-demos.js +0 -56
  8. package/patternfly-docs/generated/components/alert/react.js +0 -1433
  9. package/patternfly-docs/generated/components/avatar/react.js +0 -166
  10. package/patternfly-docs/generated/components/back-to-top/react-demos.js +0 -60
  11. package/patternfly-docs/generated/components/back-to-top/react.js +0 -77
  12. package/patternfly-docs/generated/components/backdrop/react.js +0 -64
  13. package/patternfly-docs/generated/components/background-image/react.js +0 -62
  14. package/patternfly-docs/generated/components/badge/react.js +0 -97
  15. package/patternfly-docs/generated/components/banner/react-demos.js +0 -57
  16. package/patternfly-docs/generated/components/banner/react.js +0 -148
  17. package/patternfly-docs/generated/components/brand/react.js +0 -142
  18. package/patternfly-docs/generated/components/breadcrumb/react.js +0 -206
  19. package/patternfly-docs/generated/components/button/react-demos.js +0 -57
  20. package/patternfly-docs/generated/components/button/react.js +0 -826
  21. package/patternfly-docs/generated/components/card/react-demos.js +0 -201
  22. package/patternfly-docs/generated/components/card/react.js +0 -1015
  23. package/patternfly-docs/generated/components/charts/area-chart/-Victory.js +0 -1350
  24. package/patternfly-docs/generated/components/charts/bar-chart/-Victory.js +0 -1334
  25. package/patternfly-docs/generated/components/charts/box-plot-chart/-Victory.js +0 -1282
  26. package/patternfly-docs/generated/components/charts/bullet-chart/-Victory.js +0 -848
  27. package/patternfly-docs/generated/components/charts/colors-for-charts/-Victory.js +0 -192
  28. package/patternfly-docs/generated/components/charts/donut-chart/-Victory.js +0 -426
  29. package/patternfly-docs/generated/components/charts/donut-utilization-chart/-Victory.js +0 -804
  30. package/patternfly-docs/generated/components/charts/legends/-Victory.js +0 -3230
  31. package/patternfly-docs/generated/components/charts/line-chart/-Victory.js +0 -1178
  32. package/patternfly-docs/generated/components/charts/line-chart/ECharts.js +0 -525
  33. package/patternfly-docs/generated/components/charts/patterns/-Victory.js +0 -3382
  34. package/patternfly-docs/generated/components/charts/pie-chart/-Victory.js +0 -377
  35. package/patternfly-docs/generated/components/charts/resize-observer/-Victory.js +0 -2475
  36. package/patternfly-docs/generated/components/charts/sankey-chart/ECharts.js +0 -538
  37. package/patternfly-docs/generated/components/charts/scatter-chart/-Victory.js +0 -1551
  38. package/patternfly-docs/generated/components/charts/skeletons/-Victory.js +0 -4115
  39. package/patternfly-docs/generated/components/charts/sparkline-chart/-Victory.js +0 -955
  40. package/patternfly-docs/generated/components/charts/stack-chart/-Victory.js +0 -1173
  41. package/patternfly-docs/generated/components/charts/threshold-chart/-Victory.js +0 -1166
  42. package/patternfly-docs/generated/components/charts/tooltips/-Victory.js +0 -413
  43. package/patternfly-docs/generated/components/chip/react-deprecated.js +0 -323
  44. package/patternfly-docs/generated/components/clipboard-copy/react.js +0 -373
  45. package/patternfly-docs/generated/components/code-block/react.js +0 -148
  46. package/patternfly-docs/generated/components/code-editor/react.js +0 -659
  47. package/patternfly-docs/generated/components/compass/react-demos.js +0 -147
  48. package/patternfly-docs/generated/components/compass/react.js +0 -440
  49. package/patternfly-docs/generated/components/content/react.js +0 -248
  50. package/patternfly-docs/generated/components/data-list/react-demos.js +0 -90
  51. package/patternfly-docs/generated/components/data-list/react.js +0 -709
  52. package/patternfly-docs/generated/components/date-and-time/calendar-month/react.js +0 -283
  53. package/patternfly-docs/generated/components/date-and-time/date-and-time-picker/react-demos.js +0 -64
  54. package/patternfly-docs/generated/components/date-and-time/date-picker/react-demos.js +0 -83
  55. package/patternfly-docs/generated/components/date-and-time/date-picker/react.js +0 -395
  56. package/patternfly-docs/generated/components/date-and-time/time-picker/react.js +0 -241
  57. package/patternfly-docs/generated/components/description-list/react-demos.js +0 -58
  58. package/patternfly-docs/generated/components/description-list/react.js +0 -743
  59. package/patternfly-docs/generated/components/divider/react.js +0 -126
  60. package/patternfly-docs/generated/components/drag-and-drop/react-demos.js +0 -351
  61. package/patternfly-docs/generated/components/drag-and-drop/react-deprecated.js +0 -184
  62. package/patternfly-docs/generated/components/drag-and-drop/react.js +0 -137
  63. package/patternfly-docs/generated/components/drawer/react.js +0 -598
  64. package/patternfly-docs/generated/components/dual-list-selector/react-deprecated.js +0 -772
  65. package/patternfly-docs/generated/components/dual-list-selector/react.js +0 -594
  66. package/patternfly-docs/generated/components/empty-state/react.js +0 -199
  67. package/patternfly-docs/generated/components/expandable-section/react-demos.js +0 -65
  68. package/patternfly-docs/generated/components/expandable-section/react.js +0 -408
  69. package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react-demos.js +0 -52
  70. package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react.js +0 -398
  71. package/patternfly-docs/generated/components/file-upload/simple-file-upload/react.js +0 -749
  72. package/patternfly-docs/generated/components/forms/checkbox/react.js +0 -222
  73. package/patternfly-docs/generated/components/forms/form/react.js +0 -1106
  74. package/patternfly-docs/generated/components/forms/form-select/react.js +0 -208
  75. package/patternfly-docs/generated/components/forms/radio/react.js +0 -212
  76. package/patternfly-docs/generated/components/forms/text-area/react.js +0 -160
  77. package/patternfly-docs/generated/components/forms/text-input/react.js +0 -216
  78. package/patternfly-docs/generated/components/helper-text/react-demos.js +0 -180
  79. package/patternfly-docs/generated/components/helper-text/react.js +0 -164
  80. package/patternfly-docs/generated/components/hero/react.js +0 -88
  81. package/patternfly-docs/generated/components/hint/react.js +0 -169
  82. package/patternfly-docs/generated/components/icon/react.js +0 -215
  83. package/patternfly-docs/generated/components/input-group/react.js +0 -182
  84. package/patternfly-docs/generated/components/jump-links/react-demos.js +0 -154
  85. package/patternfly-docs/generated/components/jump-links/react.js +0 -212
  86. package/patternfly-docs/generated/components/label/react-demos.js +0 -57
  87. package/patternfly-docs/generated/components/label/react.js +0 -417
  88. package/patternfly-docs/generated/components/list/react.js +0 -175
  89. package/patternfly-docs/generated/components/login-page/react.js +0 -587
  90. package/patternfly-docs/generated/components/masthead/react-demos.js +0 -79
  91. package/patternfly-docs/generated/components/masthead/react.js +0 -291
  92. package/patternfly-docs/generated/components/menus/application-launcher/react-demos.js +0 -769
  93. package/patternfly-docs/generated/components/menus/context-selector/react-demos.js +0 -665
  94. package/patternfly-docs/generated/components/menus/custom-menus/react-demos.js +0 -187
  95. package/patternfly-docs/generated/components/menus/dropdown/react-templates.js +0 -163
  96. package/patternfly-docs/generated/components/menus/dropdown/react.js +0 -998
  97. package/patternfly-docs/generated/components/menus/menu/react.js +0 -1540
  98. package/patternfly-docs/generated/components/menus/menu-toggle/react.js +0 -747
  99. package/patternfly-docs/generated/components/menus/options-menu/react-demos.js +0 -508
  100. package/patternfly-docs/generated/components/menus/select/react-templates.js +0 -257
  101. package/patternfly-docs/generated/components/menus/select/react.js +0 -998
  102. package/patternfly-docs/generated/components/modal/react-deprecated.js +0 -554
  103. package/patternfly-docs/generated/components/modal/react.js +0 -597
  104. package/patternfly-docs/generated/components/navigation/react-demos.js +0 -356
  105. package/patternfly-docs/generated/components/navigation/react.js +0 -409
  106. package/patternfly-docs/generated/components/notification-badge/react.js +0 -196
  107. package/patternfly-docs/generated/components/notification-drawer/react-demos.js +0 -107
  108. package/patternfly-docs/generated/components/notification-drawer/react.js +0 -394
  109. package/patternfly-docs/generated/components/number-input/react.js +0 -210
  110. package/patternfly-docs/generated/components/overflow-menu/react.js +0 -274
  111. package/patternfly-docs/generated/components/page/react-demos.js +0 -149
  112. package/patternfly-docs/generated/components/page/react.js +0 -1352
  113. package/patternfly-docs/generated/components/pagination/react.js +0 -492
  114. package/patternfly-docs/generated/components/panel/react.js +0 -236
  115. package/patternfly-docs/generated/components/popover/react.js +0 -390
  116. package/patternfly-docs/generated/components/progress/react-demos.js +0 -59
  117. package/patternfly-docs/generated/components/progress/react.js +0 -283
  118. package/patternfly-docs/generated/components/progress-stepper/react-demos.js +0 -45
  119. package/patternfly-docs/generated/components/progress-stepper/react.js +0 -219
  120. package/patternfly-docs/generated/components/search-input/react-demos.js +0 -113
  121. package/patternfly-docs/generated/components/search-input/react.js +0 -263
  122. package/patternfly-docs/generated/components/sidebar/react.js +0 -236
  123. package/patternfly-docs/generated/components/simple-list/react.js +0 -200
  124. package/patternfly-docs/generated/components/skeleton/react-demos.js +0 -44
  125. package/patternfly-docs/generated/components/skeleton/react.js +0 -122
  126. package/patternfly-docs/generated/components/skip-to-content/react.js +0 -73
  127. package/patternfly-docs/generated/components/slider/react.js +0 -309
  128. package/patternfly-docs/generated/components/spinner/react.js +0 -111
  129. package/patternfly-docs/generated/components/switch/react.js +0 -163
  130. package/patternfly-docs/generated/components/table/react-demos.js +0 -355
  131. package/patternfly-docs/generated/components/table/react-deprecated.js +0 -1350
  132. package/patternfly-docs/generated/components/table/react.js +0 -3241
  133. package/patternfly-docs/generated/components/tabs/react-demos.js +0 -108
  134. package/patternfly-docs/generated/components/tabs/react.js +0 -1359
  135. package/patternfly-docs/generated/components/text-input-group/react-demos.js +0 -152
  136. package/patternfly-docs/generated/components/text-input-group/react.js +0 -278
  137. package/patternfly-docs/generated/components/tile/react-deprecated.js +0 -242
  138. package/patternfly-docs/generated/components/timestamp/react.js +0 -283
  139. package/patternfly-docs/generated/components/title/react.js +0 -94
  140. package/patternfly-docs/generated/components/toggle-group/react.js +0 -299
  141. package/patternfly-docs/generated/components/toolbar/react-demos.js +0 -66
  142. package/patternfly-docs/generated/components/toolbar/react.js +0 -932
  143. package/patternfly-docs/generated/components/tooltip/react.js +0 -241
  144. package/patternfly-docs/generated/components/tree-view/react.js +0 -429
  145. package/patternfly-docs/generated/components/truncate/react.js +0 -211
  146. package/patternfly-docs/generated/components/wizard/react-demos.js +0 -87
  147. package/patternfly-docs/generated/components/wizard/react-deprecated.js +0 -788
  148. package/patternfly-docs/generated/components/wizard/react.js +0 -986
  149. package/patternfly-docs/generated/developer-guides/open-ui-automation/react.js +0 -285
  150. package/patternfly-docs/generated/foundations-and-styles/layouts/bullseye/react.js +0 -70
  151. package/patternfly-docs/generated/foundations-and-styles/layouts/flex/react.js +0 -506
  152. package/patternfly-docs/generated/foundations-and-styles/layouts/gallery/react.js +0 -94
  153. package/patternfly-docs/generated/foundations-and-styles/layouts/grid/react.js +0 -272
  154. package/patternfly-docs/generated/foundations-and-styles/layouts/level/react.js +0 -87
  155. package/patternfly-docs/generated/foundations-and-styles/layouts/split/react.js +0 -124
  156. package/patternfly-docs/generated/foundations-and-styles/layouts/stack/react.js +0 -112
  157. package/patternfly-docs/generated/index.js +0 -1769
  158. package/patternfly-docs/generated/patterns/card-view/react-demos.js +0 -78
  159. package/patternfly-docs/generated/patterns/filters/react-demos.js +0 -141
  160. package/patternfly-docs/generated/patterns/password-generator/react-demos.js +0 -51
  161. package/patternfly-docs/generated/patterns/password-strength/react-demos.js +0 -61
  162. package/patternfly-docs/generated/patterns/primary-detail/react-demos.js +0 -124
  163. package/patternfly-docs/generated/patterns/right-to-left/react-demos.js +0 -81
@@ -1,88 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
-
4
- const pageData = {
5
- "id": "Hero",
6
- "section": "components",
7
- "subsection": "",
8
- "deprecated": false,
9
- "template": false,
10
- "beta": true,
11
- "demo": false,
12
- "newImplementationLink": false,
13
- "source": "react",
14
- "tabName": null,
15
- "slug": "/components/hero/react",
16
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Hero/examples/Hero.md",
17
- "relPath": "packages/react-core/src/components/Hero/examples/Hero.md",
18
- "propComponents": [
19
- {
20
- "name": "Hero",
21
- "description": "The main Hero component that allows adjusting of its background images and gradients in different color modes (such as light and dark).",
22
- "props": [
23
- {
24
- "name": "isGlass",
25
- "type": "No type info",
26
- "defaultValue": "false"
27
- }
28
- ]
29
- }
30
- ],
31
- "cssPrefix": [
32
- "pf-v6-c-hero"
33
- ],
34
- "examples": [
35
- "Basic"
36
- ]
37
- };
38
- pageData.examples = {
39
- 'Basic': props =>
40
- <Example {...pageData} {...props} {...{"code":"import { Hero } from '@patternfly/react-core';\n\nexport const HeroBasic: React.FunctionComponent = () => <Hero>Basic hero content</Hero>;\n","title":"Basic","lang":"ts","className":""}}>
41
-
42
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
43
- {`If you need finer control over the placement of text content within the `}
44
-
45
- <code {...{"className":"ws-code "}}>
46
- {`<Hero>`}
47
- </code>
48
- {`, such as when you omit a background image, adjust the `}
49
-
50
- <code {...{"className":"ws-code "}}>
51
- {`bodyWidth`}
52
- </code>
53
- {` and `}
54
-
55
- <code {...{"className":"ws-code "}}>
56
- {`bodyMaxWidth`}
57
- </code>
58
- {` properties. Be mindful of using these properties when a background image is still present and ensure there is sufficient contrast between text and any part of the image that it overlaps.`}
59
- </p>
60
-
61
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
62
- {`When using `}
63
-
64
- <code {...{"className":"ws-code "}}>
65
- {`gradientLight`}
66
- </code>
67
- {` or `}
68
-
69
- <code {...{"className":"ws-code "}}>
70
- {`gradientDark`}
71
- </code>
72
- {` to apply gradient backgrounds, check the color contrast to ensure proper accessibility.`}
73
- </p>
74
- </Example>
75
- };
76
-
77
- const Component = () => (
78
- <React.Fragment>
79
- <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
80
- {`Examples`}
81
- </AutoLinkHeader>
82
- {React.createElement(pageData.examples["Basic"])}
83
- </React.Fragment>
84
- );
85
- Component.displayName = 'ComponentsHeroReactDocs';
86
- Component.pageData = pageData;
87
-
88
- export default Component;
@@ -1,169 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
- import { Fragment, useState } from 'react';
4
- import RhUiEllipsisVerticalFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-ellipsis-vertical-fill-icon';
5
- const pageData = {
6
- "id": "Hint",
7
- "section": "components",
8
- "subsection": "",
9
- "deprecated": false,
10
- "template": false,
11
- "beta": false,
12
- "demo": false,
13
- "newImplementationLink": false,
14
- "source": "react",
15
- "tabName": null,
16
- "slug": "/components/hint/react",
17
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Hint/examples/Hint.md",
18
- "relPath": "packages/react-core/src/components/Hint/examples/Hint.md",
19
- "propComponents": [
20
- {
21
- "name": "Hint",
22
- "description": "",
23
- "props": [
24
- {
25
- "name": "actions",
26
- "type": "React.ReactNode",
27
- "description": "Actions of the hint."
28
- },
29
- {
30
- "name": "children",
31
- "type": "React.ReactNode",
32
- "description": "Content rendered inside the hint."
33
- },
34
- {
35
- "name": "className",
36
- "type": "string",
37
- "description": "Additional classes applied to the hint."
38
- },
39
- {
40
- "name": "hasNoActionsOffset",
41
- "type": "boolean",
42
- "description": "Flag indicating that the actions have no offset",
43
- "defaultValue": "false"
44
- }
45
- ]
46
- },
47
- {
48
- "name": "HintTitle",
49
- "description": "",
50
- "props": [
51
- {
52
- "name": "children",
53
- "type": "React.ReactNode",
54
- "description": "Content rendered inside the hint title."
55
- },
56
- {
57
- "name": "className",
58
- "type": "string",
59
- "description": "Additional classes applied to the hint title."
60
- }
61
- ]
62
- },
63
- {
64
- "name": "HintBody",
65
- "description": "",
66
- "props": [
67
- {
68
- "name": "children",
69
- "type": "React.ReactNode",
70
- "description": "Content rendered inside the hint body."
71
- },
72
- {
73
- "name": "className",
74
- "type": "string",
75
- "description": "Additional classes applied to the hint body."
76
- }
77
- ]
78
- },
79
- {
80
- "name": "HintFooter",
81
- "description": "",
82
- "props": [
83
- {
84
- "name": "children",
85
- "type": "React.ReactNode",
86
- "description": "Content rendered inside the hint footer."
87
- },
88
- {
89
- "name": "className",
90
- "type": "string",
91
- "description": "Additional classes applied to the hint footer."
92
- }
93
- ]
94
- }
95
- ],
96
- "cssPrefix": [
97
- "pf-v6-c-hint"
98
- ],
99
- "examples": [
100
- "Basic with title",
101
- "Basic without title",
102
- "With actions"
103
- ]
104
- };
105
- pageData.liveContext = {
106
- Fragment,
107
- useState,
108
- RhUiEllipsisVerticalFillIcon
109
- };
110
- pageData.examples = {
111
- 'Basic with title': props =>
112
- <Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport {\n Hint,\n HintTitle,\n HintBody,\n HintFooter,\n Button,\n Dropdown,\n DropdownList,\n DropdownItem,\n Divider,\n MenuToggle,\n MenuToggleElement\n} from '@patternfly/react-core';\nimport RhUiEllipsisVerticalFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-ellipsis-vertical-fill-icon';\n\nexport const HintBasicWithTitle: React.FunctionComponent = () => {\n const [isOpen, setIsOpen] = useState<boolean>(false);\n\n const onToggle = () => {\n setIsOpen(!isOpen);\n };\n\n const onSelect = () => {\n setIsOpen(!isOpen);\n };\n\n const actions = (\n <Dropdown\n isOpen={isOpen}\n onSelect={onSelect}\n onOpenChange={(isOpen: boolean) => setIsOpen(isOpen)}\n toggle={(toggleRef: React.Ref<MenuToggleElement>) => (\n <MenuToggle\n ref={toggleRef}\n aria-label=\"With title example kebab toggle\"\n variant=\"plain\"\n onClick={onToggle}\n isExpanded={isOpen}\n icon={<RhUiEllipsisVerticalFillIcon />}\n />\n )}\n >\n <DropdownList>\n <DropdownItem value={0} key=\"action\">\n Action\n </DropdownItem>\n <DropdownItem\n value={1}\n key=\"link\"\n to=\"#default-link2\"\n // Prevent the default onClick functionality for example purposes\n onClick={(ev: any) => ev.preventDefault()}\n >\n Link\n </DropdownItem>\n <DropdownItem value={2} isDisabled key=\"disabled action\">\n Disabled Action\n </DropdownItem>\n <DropdownItem value={3} isDisabled key=\"disabled link\" to=\"#default-link4\">\n Disabled Link\n </DropdownItem>\n <Divider component=\"li\" key=\"separator\" />\n <DropdownItem value={4} key=\"separated action\">\n Separated Action\n </DropdownItem>\n <DropdownItem value={5} key=\"separated link\" to=\"#default-link6\" onClick={(ev) => ev.preventDefault()}>\n Separated Link\n </DropdownItem>\n </DropdownList>\n </Dropdown>\n );\n return (\n <Hint actions={actions}>\n <HintTitle>Do more with Find it Fix it capabilities</HintTitle>\n <HintBody>\n Upgrade to Red Hat Smart Management to remediate all your systems across regions and geographies.\n </HintBody>\n <HintFooter>\n <Button variant=\"link\" isInline>\n Try it for 90 days\n </Button>\n </HintFooter>\n </Hint>\n );\n};\n","title":"Basic with title","lang":"ts","className":""}}>
113
-
114
- </Example>,
115
- 'Basic without title': props =>
116
- <Example {...pageData} {...props} {...{"code":"import { Fragment, useState } from 'react';\nimport {\n Hint,\n HintBody,\n HintFooter,\n Button,\n Dropdown,\n DropdownList,\n DropdownItem,\n Divider,\n MenuToggle,\n MenuToggleElement\n} from '@patternfly/react-core';\nimport RhUiEllipsisVerticalFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-ellipsis-vertical-fill-icon';\n\nexport const HintBasicWithoutTitle: React.FunctionComponent = () => {\n const [isOpen, setIsOpen] = useState<boolean>(false);\n\n const onToggle = () => {\n setIsOpen(!isOpen);\n };\n\n const onSelect = () => {\n setIsOpen(!isOpen);\n };\n\n const actions = (\n <Dropdown\n isOpen={isOpen}\n onSelect={onSelect}\n onOpenChange={(isOpen: boolean) => setIsOpen(isOpen)}\n toggle={(toggleRef: React.Ref<MenuToggleElement>) => (\n <MenuToggle\n ref={toggleRef}\n aria-label=\"Without title example kebab toggle\"\n variant=\"plain\"\n onClick={onToggle}\n isExpanded={isOpen}\n icon={<RhUiEllipsisVerticalFillIcon />}\n />\n )}\n >\n <DropdownList>\n <DropdownItem value={0} key=\"action\">\n Action\n </DropdownItem>\n <DropdownItem\n value={1}\n key=\"link\"\n to=\"#default-link2\"\n // Prevent the default onClick functionality for example purposes\n onClick={(ev: any) => ev.preventDefault()}\n >\n Link\n </DropdownItem>\n <DropdownItem value={2} isDisabled key=\"disabled action\">\n Disabled Action\n </DropdownItem>\n <DropdownItem value={3} isDisabled key=\"disabled link\" to=\"#default-link4\">\n Disabled Link\n </DropdownItem>\n <Divider component=\"li\" key=\"separator\" />\n <DropdownItem value={4} key=\"separated action\">\n Separated Action\n </DropdownItem>\n <DropdownItem value={5} key=\"separated link\" to=\"#default-link6\" onClick={(ev) => ev.preventDefault()}>\n Separated Link\n </DropdownItem>\n </DropdownList>\n </Dropdown>\n );\n return (\n <Fragment>\n <Hint>\n <HintBody>\n Welcome to the new documentation experience.\n <Button variant=\"link\" isInline>\n Learn more about the improved features.\n </Button>\n </HintBody>\n </Hint>\n <br />\n <Hint actions={actions}>\n <HintBody>\n Upgrade to Red Hat Smart Management to remediate all your systems across regions and geographies.\n </HintBody>\n <HintFooter>\n <Button variant=\"link\" isInline>\n Try it for 90 days\n </Button>\n </HintFooter>\n </Hint>\n </Fragment>\n );\n};\n","title":"Basic without title","lang":"ts","className":""}}>
117
-
118
- </Example>,
119
- 'With actions': props =>
120
- <Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport { Hint, HintTitle, HintBody, Button, Checkbox } from '@patternfly/react-core';\n\nexport const HintActionsWithNoOffset: React.FunctionComponent = () => {\n const [hasNoActionsOffset, setHasNoActionsOffset] = useState<boolean>(false);\n\n const toggleOffset = (checked: boolean) => {\n setHasNoActionsOffset(checked);\n };\n\n const actions = <Button variant=\"primary\">Action</Button>;\n return (\n <>\n <Checkbox\n label=\"actions hasNoOffset\"\n isChecked={hasNoActionsOffset}\n onChange={(_event, checked) => toggleOffset(checked)}\n aria-label=\"remove actions offset\"\n id=\"toggle-actions-offset\"\n name=\"toggle-actions-offset\"\n />\n <div style={{ marginTop: '15px' }}>\n <Hint actions={actions} hasNoActionsOffset={hasNoActionsOffset}>\n <HintTitle>Do more with Find it Fix it capabilities</HintTitle>\n <HintBody>\n Upgrade to Red Hat Smart Management to remediate all your systems across regions and geographies.\n </HintBody>\n </Hint>\n </div>\n </>\n );\n};\n","title":"With actions","lang":"ts","className":""}}>
121
-
122
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
123
- {`You can add actions to a hint to allow users to respond to suggestions and initiate any related processes.`}
124
- </p>
125
-
126
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
127
- {`When a `}
128
-
129
- <code {...{"className":"ws-code "}}>
130
- {`<Hint>`}
131
- </code>
132
- {` contains `}
133
-
134
- <code {...{"className":"ws-code "}}>
135
- {`actions`}
136
- </code>
137
- {`, a negative margin is applied to the actions so that they are better aligned with the hint title. For larger-sized titles or non-plain actions (such as a button), remove this negative margin by setting `}
138
-
139
- <code {...{"className":"ws-code "}}>
140
- {`hasNoActionsOffset`}
141
- </code>
142
- {` to `}
143
-
144
- <code {...{"className":"ws-code "}}>
145
- {`true`}
146
- </code>
147
- {`.`}
148
- </p>
149
-
150
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
151
- {`To illustrate this behavior, select the "actions hasNoActionsOffset" checkbox in the following example.`}
152
- </p>
153
- </Example>
154
- };
155
-
156
- const Component = () => (
157
- <React.Fragment>
158
- <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
159
- {`Examples`}
160
- </AutoLinkHeader>
161
- {React.createElement(pageData.examples["Basic with title"])}
162
- {React.createElement(pageData.examples["Basic without title"])}
163
- {React.createElement(pageData.examples["With actions"])}
164
- </React.Fragment>
165
- );
166
- Component.displayName = 'ComponentsHintReactDocs';
167
- Component.pageData = pageData;
168
-
169
- export default Component;
@@ -1,215 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
- import { Fragment, useState } from 'react';
4
- import LongArrowAltDownIcon from '@patternfly/react-icons/dist/esm/icons/long-arrow-alt-down-icon';
5
- import RhMicronsCaretRightIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-right-icon';
6
- import RhMicronsCaretDownIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-down-icon';
7
- import RhUiSettingsFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-settings-fill-icon';
8
- import RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';
9
- import RhUiErrorFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-error-fill-icon';
10
- import RhUiWarningFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-warning-fill-icon';
11
- import RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';
12
- import RhUiInformationFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-information-fill-icon';
13
- import RhUiNotificationFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-notification-fill-icon';
14
- const pageData = {
15
- "id": "Icon",
16
- "section": "components",
17
- "subsection": "",
18
- "deprecated": false,
19
- "template": false,
20
- "beta": false,
21
- "demo": false,
22
- "newImplementationLink": false,
23
- "source": "react",
24
- "tabName": null,
25
- "slug": "/components/icon/react",
26
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Icon/examples/Icon.md",
27
- "relPath": "packages/react-core/src/components/Icon/examples/Icon.md",
28
- "propComponents": [
29
- {
30
- "name": "Icon",
31
- "description": "",
32
- "props": [
33
- {
34
- "name": "children",
35
- "type": "React.ReactNode",
36
- "description": "Icon content"
37
- },
38
- {
39
- "name": "className",
40
- "type": "string",
41
- "description": "Additional classes applied to the icon container"
42
- },
43
- {
44
- "name": "defaultProgressArialabel",
45
- "type": "string",
46
- "description": "Aria-label for the default progress icon",
47
- "defaultValue": "'Loading...'"
48
- },
49
- {
50
- "name": "iconSize",
51
- "type": "| 'sm'\n| 'md'\n| 'lg'\n| 'xl'\n| '2xl'\n| '3xl'\n| 'headingSm'\n| 'headingMd'\n| 'headingLg'\n| 'headingXl'\n| 'heading_2xl'\n| 'heading_3xl'\n| 'bodySm'\n| 'bodyDefault'\n| 'bodyLg'",
52
- "description": "Size of icon. Overrides the icon size set by the size property."
53
- },
54
- {
55
- "name": "isInline",
56
- "type": "boolean",
57
- "description": "Indicates the icon is inline and should inherit the text font size and color. Overriden by size and iconSize properties.",
58
- "defaultValue": "false"
59
- },
60
- {
61
- "name": "isInProgress",
62
- "type": "boolean",
63
- "description": "Indicates the icon is in progress. Setting this property to true will swap the icon with the progressIcon.",
64
- "defaultValue": "false"
65
- },
66
- {
67
- "name": "progressIcon",
68
- "type": "React.ReactNode",
69
- "description": "Icon when isInProgress is set to true. Defaults to a 1em spinner."
70
- },
71
- {
72
- "name": "progressIconSize",
73
- "type": "| 'sm'\n| 'md'\n| 'lg'\n| 'xl'\n| '2xl'\n| '3xl'\n| 'headingSm'\n| 'headingMd'\n| 'headingLg'\n| 'headingXl'\n| 'heading_2xl'\n| 'heading_3xl'\n| 'bodySm'\n| 'bodyDefault'\n| 'bodyLg'",
74
- "description": "Size of progress icon. Overrides the icon size set by the size property."
75
- },
76
- {
77
- "name": "shouldMirrorRTL",
78
- "type": "boolean",
79
- "description": "Flag indicating whether the icon passed as children should be mirrored for\nright to left (RTL) languages. This will not mirror the icon passed to progressIcon.",
80
- "defaultValue": "false"
81
- },
82
- {
83
- "name": "size",
84
- "type": "| 'sm'\n| 'md'\n| 'lg'\n| 'xl'\n| '2xl'\n| '3xl'\n| 'headingSm'\n| 'headingMd'\n| 'headingLg'\n| 'headingXl'\n| 'heading_2xl'\n| 'heading_3xl'\n| 'bodySm'\n| 'bodyDefault'\n| 'bodyLg'",
85
- "description": "Size of the icon component container and icon."
86
- },
87
- {
88
- "name": "status",
89
- "type": "'custom' | 'info' | 'success' | 'warning' | 'danger'",
90
- "description": "Status color of the icon"
91
- }
92
- ]
93
- }
94
- ],
95
- "cssPrefix": [
96
- "pf-v6-c-icon"
97
- ],
98
- "examples": [
99
- "Basic",
100
- "Standalone icon sizes",
101
- "Body sizes",
102
- "Heading sizes",
103
- "Status colors",
104
- "Sizing an icon within the icon container",
105
- "Inline",
106
- "In progress",
107
- "Custom in progress icon"
108
- ]
109
- };
110
- pageData.liveContext = {
111
- Fragment,
112
- useState,
113
- LongArrowAltDownIcon,
114
- RhMicronsCaretRightIcon,
115
- RhMicronsCaretDownIcon,
116
- RhUiSettingsFillIcon,
117
- RhUiAddCircleFillIcon,
118
- RhUiErrorFillIcon,
119
- RhUiWarningFillIcon,
120
- RhUiCheckCircleFillIcon,
121
- RhUiInformationFillIcon,
122
- RhUiNotificationFillIcon
123
- };
124
- pageData.examples = {
125
- 'Basic': props =>
126
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon } from '@patternfly/react-core';\nimport LongArrowAltDownIcon from '@patternfly/react-icons/dist/esm/icons/long-arrow-alt-down-icon';\nimport RhMicronsCaretRightIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-right-icon';\nimport RhMicronsCaretDownIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-down-icon';\nimport RhUiSettingsFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-settings-fill-icon';\n\nexport const IconBasic: React.FunctionComponent = () => (\n <Fragment>\n <Icon>\n <LongArrowAltDownIcon />\n </Icon>{' '}\n <Icon>\n <RhMicronsCaretRightIcon />\n </Icon>{' '}\n <Icon>\n <RhMicronsCaretDownIcon />\n </Icon>{' '}\n <Icon>\n <RhUiSettingsFillIcon />\n </Icon>\n </Fragment>\n);\n","title":"Basic","lang":"ts","className":""}}>
127
-
128
- </Example>,
129
- 'Standalone icon sizes': props =>
130
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const StandaloneIconSizes: React.FunctionComponent = () => (\n <Fragment>\n <Icon size=\"sm\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"md\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"lg\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"xl\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"2xl\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"3xl\">\n <RhUiAddCircleFillIcon />\n </Icon>\n </Fragment>\n);\n","title":"Standalone icon sizes","lang":"ts","className":""}}>
131
-
132
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
133
- {`These are the standard options for sizing icons.`}
134
- </p>
135
- </Example>,
136
- 'Body sizes': props =>
137
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const BodyIconSizes: React.FunctionComponent = () => (\n <Fragment>\n <Icon size=\"bodySm\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"bodyDefault\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"bodyLg\">\n <RhUiAddCircleFillIcon />\n </Icon>\n </Fragment>\n);\n","title":"Body sizes","lang":"ts","className":""}}>
138
-
139
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
140
- {`These size options are meant to make icons match the size of body text.`}
141
- </p>
142
- </Example>,
143
- 'Heading sizes': props =>
144
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const HeadingIconSizes: React.FunctionComponent = () => (\n <Fragment>\n <Icon size=\"headingSm\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"headingMd\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"headingLg\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"headingXl\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"heading_2xl\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"heading_3xl\">\n <RhUiAddCircleFillIcon />\n </Icon>\n </Fragment>\n);\n","title":"Heading sizes","lang":"ts","className":""}}>
145
-
146
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
147
- {`These size options are meant to make icons match the size of heading text.`}
148
- </p>
149
- </Example>,
150
- 'Status colors': props =>
151
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon } from '@patternfly/react-core';\nimport RhUiErrorFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-error-fill-icon';\nimport RhUiWarningFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-warning-fill-icon';\nimport RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';\nimport RhUiInformationFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-information-fill-icon';\nimport RhUiNotificationFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-notification-fill-icon';\n\nexport const IconStatus: React.FunctionComponent = () => (\n <Fragment>\n <Icon status=\"danger\">\n <RhUiErrorFillIcon />\n </Icon>{' '}\n <Icon status=\"warning\">\n <RhUiWarningFillIcon />\n </Icon>{' '}\n <Icon status=\"success\">\n <RhUiCheckCircleFillIcon />\n </Icon>{' '}\n <Icon status=\"info\">\n <RhUiInformationFillIcon />\n </Icon>{' '}\n <Icon status=\"custom\">\n <RhUiNotificationFillIcon />\n </Icon>\n </Fragment>\n);\n","title":"Status colors","lang":"ts","className":""}}>
152
-
153
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
154
- {`The following example demonstrates the various status variants of an icon. Keep in mind that these icons are displayed out of a typical context, and that you should not rely on color alone to convey status to users.`}
155
- </p>
156
- </Example>,
157
- 'Sizing an icon within the icon container': props =>
158
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const IconContentSizes: React.FunctionComponent = () => (\n <Fragment>\n <Icon size=\"3xl\" iconSize=\"lg\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"3xl\" iconSize=\"xl\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"3xl\" iconSize=\"2xl\">\n <RhUiAddCircleFillIcon />\n </Icon>{' '}\n <Icon size=\"3xl\">\n <RhUiAddCircleFillIcon />\n </Icon>\n </Fragment>\n);\n","title":"Sizing an icon within the icon container","lang":"ts","className":""}}>
159
-
160
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
161
- {`Providing both size and iconSize properties allows the icon container to maintain a consistent size, even if the icon changes in size.`}
162
- </p>
163
- </Example>,
164
- 'Inline': props =>
165
- <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Icon, Content } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const IconInline: React.FunctionComponent = () => (\n <Fragment>\n <Content>\n <h1>\n Heading\n <Icon isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n </h1>\n <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit Sed hendrerit nisi in cursus maximus.</p>\n <h2>\n Second level\n <Icon isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n </h2>\n <p>\n <Icon isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n Curabitur accumsan turpis pharetra\n <strong>\n augue tincidunt\n <Icon isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n </strong>\n blandit. Quisque condimentum maximus mi, sit amet commodo arcu rutrum id. Proin pretium urna vel cursus\n venenatis. Suspendisse potenti.\n </p>\n <small>\n Sometimes you need small text\n <Icon isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n </small>\n Inline with size specified:\n <Icon size=\"sm\" isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n small,\n <Icon size=\"md\" isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n medium,\n <Icon size=\"lg\" isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n large,\n <Icon size=\"xl\" isInline>\n <RhUiAddCircleFillIcon />\n </Icon>\n extra large\n </Content>\n </Fragment>\n);\n","title":"Inline","lang":"ts","className":""}}>
166
-
167
- </Example>,
168
- 'In progress': props =>
169
- <Example {...pageData} {...props} {...{"code":"import { Fragment, useState } from 'react';\nimport { Icon, Checkbox } from '@patternfly/react-core';\nimport RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';\n\nexport const IconProgress: React.FunctionComponent = () => {\n const [isInProgress, setIsInProgress] = useState<boolean>(false);\n return (\n <Fragment>\n <div style={{ marginBottom: '12px' }}>\n <Checkbox\n label=\"Toggle in progress state\"\n isChecked={isInProgress}\n onChange={(_event, checked) => setIsInProgress(checked)}\n aria-label=\"Set icon progress state\"\n id=\"toggle-icon-progress\"\n name=\"toggle-icon-progress\"\n />\n </div>\n <Icon isInProgress={isInProgress}>\n <RhUiCheckCircleFillIcon />\n </Icon>\n </Fragment>\n );\n};\n","title":"In progress","lang":"ts","className":""}}>
170
-
171
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
172
- {`Passing the `}
173
-
174
- <code {...{"className":"ws-code "}}>
175
- {`isInProgress`}
176
- </code>
177
- {` property will swap the icon to a progress icon. By default this progress icon will be a `}
178
-
179
- <code {...{"className":"ws-code "}}>
180
- {`Spinner`}
181
- </code>
182
- {` but may be customized or overriden using the `}
183
-
184
- <code {...{"className":"ws-code "}}>
185
- {`progressIcon`}
186
- </code>
187
- {` property.`}
188
- </p>
189
- </Example>,
190
- 'Custom in progress icon': props =>
191
- <Example {...pageData} {...props} {...{"code":"import { Fragment, useState } from 'react';\nimport { Icon, Spinner, Checkbox } from '@patternfly/react-core';\nimport RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';\n\nexport const IconProgress: React.FunctionComponent = () => {\n const [isInProgress, setIsInProgress] = useState<boolean>(false);\n return (\n <Fragment>\n <div style={{ marginBottom: '12px' }}>\n <Checkbox\n label=\"Toggle in progress state\"\n isChecked={isInProgress}\n onChange={(_event, checked) => setIsInProgress(checked)}\n aria-label=\"Set icon progress state\"\n id=\"toggle-icon-progress-custom\"\n name=\"toggle-icon-progress-custom\"\n />\n </div>\n <Icon isInProgress={isInProgress} progressIcon={<Spinner diameter=\"2em\" aria-label=\"Loading...\" />}>\n <RhUiCheckCircleFillIcon />\n </Icon>\n </Fragment>\n );\n};\n","title":"Custom in progress icon","lang":"ts","className":""}}>
192
-
193
- </Example>
194
- };
195
-
196
- const Component = () => (
197
- <React.Fragment>
198
- <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
199
- {`Examples`}
200
- </AutoLinkHeader>
201
- {React.createElement(pageData.examples["Basic"])}
202
- {React.createElement(pageData.examples["Standalone icon sizes"])}
203
- {React.createElement(pageData.examples["Body sizes"])}
204
- {React.createElement(pageData.examples["Heading sizes"])}
205
- {React.createElement(pageData.examples["Status colors"])}
206
- {React.createElement(pageData.examples["Sizing an icon within the icon container"])}
207
- {React.createElement(pageData.examples["Inline"])}
208
- {React.createElement(pageData.examples["In progress"])}
209
- {React.createElement(pageData.examples["Custom in progress icon"])}
210
- </React.Fragment>
211
- );
212
- Component.displayName = 'ComponentsIconReactDocs';
213
- Component.pageData = pageData;
214
-
215
- export default Component;