@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,148 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
- import RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';
4
- import RhUiErrorFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-error-fill-icon';
5
- import RhUiWarningFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-warning-fill-icon';
6
- import RhUiInformationFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-information-fill-icon';
7
- import RhUiNotificationFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-notification-fill-icon';
8
- const pageData = {
9
- "id": "Banner",
10
- "section": "components",
11
- "subsection": "",
12
- "deprecated": false,
13
- "template": false,
14
- "beta": false,
15
- "demo": false,
16
- "newImplementationLink": false,
17
- "source": "react",
18
- "tabName": null,
19
- "slug": "/components/banner/react",
20
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Banner/examples/Banner.md",
21
- "relPath": "packages/react-core/src/components/Banner/examples/Banner.md",
22
- "propComponents": [
23
- {
24
- "name": "Banner",
25
- "description": "",
26
- "props": [
27
- {
28
- "name": "children",
29
- "type": "React.ReactNode",
30
- "description": "Content rendered inside the banner."
31
- },
32
- {
33
- "name": "className",
34
- "type": "string",
35
- "description": "Additional classes added to the banner."
36
- },
37
- {
38
- "name": "color",
39
- "type": "'red' | 'orangered' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'purple'",
40
- "description": "Color options for the banner, will be overwritten by any applied using the status prop."
41
- },
42
- {
43
- "name": "isPill",
44
- "type": "boolean",
45
- "description": "If set to true, the banner will have a pill shape",
46
- "defaultValue": "false"
47
- },
48
- {
49
- "name": "isSticky",
50
- "type": "boolean",
51
- "description": "If set to true, the banner sticks to the top of its container",
52
- "defaultValue": "false"
53
- },
54
- {
55
- "name": "screenReaderText",
56
- "type": "string",
57
- "description": "Text announced by screen readers to indicate the type of banner. This prop should only\nbe passed in when the banner conveys status/severity."
58
- },
59
- {
60
- "name": "status",
61
- "type": "'success' | 'warning' | 'danger' | 'info' | 'custom'",
62
- "description": "Status style options for the banner, will overwrite any color applied using the color prop."
63
- }
64
- ]
65
- }
66
- ],
67
- "cssPrefix": [
68
- "pf-v6-c-banner"
69
- ],
70
- "examples": [
71
- "Basic",
72
- "Status",
73
- "Pill"
74
- ]
75
- };
76
- pageData.liveContext = {
77
- RhUiCheckCircleFillIcon,
78
- RhUiErrorFillIcon,
79
- RhUiWarningFillIcon,
80
- RhUiInformationFillIcon,
81
- RhUiNotificationFillIcon
82
- };
83
- pageData.examples = {
84
- 'Basic': props =>
85
- <Example {...pageData} {...props} {...{"code":"import { Banner } from '@patternfly/react-core';\n\nexport const BannerBasic: React.FunctionComponent = () => (\n <>\n <Banner>Default banner</Banner>\n <br />\n <Banner color=\"red\">Red banner</Banner>\n <br />\n <Banner color=\"orangered\">Orangered banner</Banner>\n <br />\n <Banner color=\"orange\">Orange banner</Banner>\n <br />\n <Banner color=\"yellow\">Yellow banner</Banner>\n <br />\n <Banner color=\"green\">Green banner</Banner>\n <br />\n <Banner color=\"teal\">Teal banner</Banner>\n <br />\n <Banner color=\"blue\">Blue banner</Banner>\n <br />\n <Banner color=\"purple\">Purple banner</Banner>\n </>\n);\n","title":"Basic","lang":"ts","className":""}}>
86
-
87
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
88
- {`Banners can be styled with one of 9 different colors using the `}
89
-
90
- <code {...{"className":"ws-code "}}>
91
- {`color`}
92
- </code>
93
- {` prop. A basic banner should only be used when the banner color does not represent status or severity.`}
94
- </p>
95
- </Example>,
96
- 'Status': props =>
97
- <Example {...pageData} {...props} {...{"code":"import { Banner, Flex, FlexItem } from '@patternfly/react-core';\nimport RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';\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 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 BannerStatus: React.FunctionComponent = () => (\n <>\n <Banner screenReaderText=\"Success banner\" status=\"success\">\n <Flex spaceItems={{ default: 'spaceItemsSm' }}>\n <FlexItem>\n <RhUiCheckCircleFillIcon />\n </FlexItem>\n <FlexItem>Success banner</FlexItem>\n </Flex>\n </Banner>\n <br />\n <Banner screenReaderText=\"Warning banner\" status=\"warning\">\n <Flex spaceItems={{ default: 'spaceItemsSm' }}>\n <FlexItem>\n <RhUiWarningFillIcon />\n </FlexItem>\n <FlexItem>Warning banner</FlexItem>\n </Flex>\n </Banner>\n <br />\n <Banner screenReaderText=\"Danger banner\" status=\"danger\">\n <Flex spaceItems={{ default: 'spaceItemsSm' }}>\n <FlexItem>\n <RhUiErrorFillIcon />\n </FlexItem>\n <FlexItem>Danger banner</FlexItem>\n </Flex>\n </Banner>\n <br />\n <Banner screenReaderText=\"Info banner\" status=\"info\">\n <Flex spaceItems={{ default: 'spaceItemsSm' }}>\n <FlexItem>\n <RhUiInformationFillIcon />\n </FlexItem>\n <FlexItem>Info banner</FlexItem>\n </Flex>\n </Banner>\n <br />\n <Banner screenReaderText=\"Custom banner\" status=\"custom\">\n <Flex spaceItems={{ default: 'spaceItemsSm' }}>\n <FlexItem>\n <RhUiNotificationFillIcon />\n </FlexItem>\n <FlexItem>Custom banner</FlexItem>\n </Flex>\n </Banner>\n </>\n);\n","title":"Status","lang":"ts","className":""}}>
98
-
99
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
100
- {`When a banner is used to convey status it should be styled using the `}
101
-
102
- <code {...{"className":"ws-code "}}>
103
- {`status`}
104
- </code>
105
- {` prop. Additionally, it is advised to pass an icon inside the banner to convey the status in a way besides just color.`}
106
- </p>
107
-
108
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
109
- {`The `}
110
-
111
- <code {...{"className":"ws-code "}}>
112
- {`screenReaderText`}
113
- </code>
114
- {` prop should also be passed in to convey the status/severity of the banner to users of certain assistive technologies such as screen readers.`}
115
- </p>
116
-
117
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
118
- {`In the following example, a flex layout is used inside the banner content to show one possible way to create spacing between the icons and banner text.`}
119
- </p>
120
- </Example>,
121
- 'Pill': props =>
122
- <Example {...pageData} {...props} {...{"code":"import { Banner, Flex, FlexItem } from '@patternfly/react-core';\nimport RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';\n\nexport const BannerPill: React.FunctionComponent = () => (\n <>\n <Banner isPill>Default pill banner</Banner>\n <br />\n <Banner color=\"red\" isPill>\n Red pill banner\n </Banner>\n <br />\n <Banner isPill screenReaderText=\"Success pill banner\" status=\"success\">\n <Flex spaceItems={{ default: 'spaceItemsSm' }}>\n <FlexItem>\n <RhUiCheckCircleFillIcon />\n </FlexItem>\n <FlexItem>Success pill banner</FlexItem>\n </Flex>\n </Banner>\n </>\n);\n","title":"Pill","lang":"ts","className":""}}>
123
-
124
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
125
- {`Banners may also have a rounded pill style by passing the `}
126
-
127
- <code {...{"className":"ws-code "}}>
128
- {`isPill`}
129
- </code>
130
- {` prop.`}
131
- </p>
132
- </Example>
133
- };
134
-
135
- const Component = () => (
136
- <React.Fragment>
137
- <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
138
- {`Examples`}
139
- </AutoLinkHeader>
140
- {React.createElement(pageData.examples["Basic"])}
141
- {React.createElement(pageData.examples["Status"])}
142
- {React.createElement(pageData.examples["Pill"])}
143
- </React.Fragment>
144
- );
145
- Component.displayName = 'ComponentsBannerReactDocs';
146
- Component.pageData = pageData;
147
-
148
- export default Component;
@@ -1,142 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
- import '../../../../../react-core/src/components/Brand/examples/./Brand.css';
4
- import pfLogo from '../../../../../react-core/src/components/Brand/examples/../../assets/PF-HorizontalLogo-Color.svg';
5
- import pfLogoDark from '../../../../../react-core/src/components/Brand/examples/../../assets/PF-HorizontalLogo-Reverse.svg';
6
- import pfLogoSm from '../../../../../react-core/src/components/Brand/examples/../../assets/PF-IconLogo-color.svg';
7
- import pfLogoSmDark from '../../../../../react-core/src/components/Brand/examples/../../assets/PF-IconLogo-Reverse.svg';
8
- const pageData = {
9
- "id": "Brand",
10
- "section": "components",
11
- "subsection": "",
12
- "deprecated": false,
13
- "template": false,
14
- "beta": false,
15
- "demo": false,
16
- "newImplementationLink": false,
17
- "source": "react",
18
- "tabName": null,
19
- "slug": "/components/brand/react",
20
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Brand/examples/Brand.md",
21
- "relPath": "packages/react-core/src/components/Brand/examples/Brand.md",
22
- "propComponents": [
23
- {
24
- "name": "Brand",
25
- "description": "",
26
- "props": [
27
- {
28
- "name": "alt",
29
- "type": "string",
30
- "description": "Attribute that specifies the alt text of a <img> Brand. For a <picture> Brand this specifies the fallback <img> alt text.",
31
- "required": true
32
- },
33
- {
34
- "name": "children",
35
- "type": "React.ReactNode",
36
- "description": "Transforms the Brand into a <picture> element from an <img> element. Container for <source> child elements."
37
- },
38
- {
39
- "name": "className",
40
- "type": "string",
41
- "description": "Additional classes added to the either type of Brand.",
42
- "defaultValue": "''"
43
- },
44
- {
45
- "name": "heights",
46
- "type": "{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}",
47
- "description": "Heights at various breakpoints for a <picture> Brand."
48
- },
49
- {
50
- "name": "src",
51
- "type": "string",
52
- "description": "Attribute that specifies the URL of a <img> Brand. For a <picture> Brand this specifies the fallback <img> URL.",
53
- "defaultValue": "''"
54
- },
55
- {
56
- "name": "widths",
57
- "type": "{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}",
58
- "description": "Widths at various breakpoints for a <picture> Brand."
59
- }
60
- ]
61
- }
62
- ],
63
- "examples": [
64
- "Basic",
65
- "Responsive"
66
- ]
67
- };
68
- pageData.liveContext = {
69
- pfLogo,
70
- pfLogoDark,
71
- pfLogoSm,
72
- pfLogoSmDark
73
- };
74
- pageData.relativeImports = "import 'react-core/src/components/Brand/examples/./Brand.css';"
75
- pageData.examples = {
76
- 'Basic': props =>
77
- <Example {...pageData} {...props} {...{"code":"import { Brand } from '@patternfly/react-core';\nimport pfLogo from '../../assets/PF-HorizontalLogo-Color.svg';\nimport pfLogoDark from '../../assets/PF-HorizontalLogo-Reverse.svg';\n\nexport const BrandBasic: React.FunctionComponent = () => (\n <>\n <div className=\"show-light\">\n <Brand src={pfLogo} alt=\"Patternfly\" widths={{ default: '200px', md: '400px', xl: '600px' }} />\n </div>\n <div className=\"show-dark\">\n <Brand src={pfLogoDark} alt=\"Patternfly\" widths={{ default: '200px', md: '400px', xl: '600px' }} />\n </div>\n </>\n);\n","title":"Basic","lang":"ts","className":""}}>
78
-
79
- </Example>,
80
- 'Responsive': props =>
81
- <Example {...pageData} {...props} {...{"code":"import { Brand } from '@patternfly/react-core';\n\nimport pfLogo from '../../assets/PF-HorizontalLogo-Color.svg';\nimport pfLogoDark from '../../assets/PF-HorizontalLogo-Reverse.svg';\nimport pfLogoSm from '../../assets/PF-IconLogo-color.svg';\nimport pfLogoSmDark from '../../assets/PF-IconLogo-Reverse.svg';\n\nexport const BrandBasic: React.FunctionComponent = () => (\n <>\n <div className=\"show-light\">\n <Brand src={pfLogo} alt=\"Patternfly\" widths={{ default: '40px', sm: '60px', md: '220px' }}>\n <source media=\"(min-width: 1200px)\" srcSet={pfLogo} />\n <source media=\"(min-width: 992px)\" srcSet={pfLogo} />\n <source media=\"(min-width: 768px)\" srcSet={pfLogo} />\n <source media=\"(min-width: 576px)\" srcSet={pfLogoSm} />\n <source media=\"(min-width: 320px)\" srcSet={pfLogoSm} />\n <source srcSet={pfLogo} />\n </Brand>\n </div>\n <div className=\"show-dark\">\n <Brand src={pfLogoDark} alt=\"Patternfly\" widths={{ default: '40px', sm: '60px', md: '220px' }}>\n <source media=\"(min-width: 1200px)\" srcSet={pfLogoDark} />\n <source media=\"(min-width: 992px)\" srcSet={pfLogoDark} />\n <source media=\"(min-width: 768px)\" srcSet={pfLogoDark} />\n <source media=\"(min-width: 576px)\" srcSet={pfLogoSmDark} />\n <source media=\"(min-width: 320px)\" srcSet={pfLogoSmDark} />\n <source srcSet={pfLogoDark} />\n </Brand>\n </div>\n </>\n);\n","title":"Responsive","lang":"ts","className":""}}>
82
-
83
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
84
- {`Passing `}
85
-
86
- <code {...{"className":"ws-code "}}>
87
- {`<source>`}
88
- </code>
89
- {` elements as children to `}
90
-
91
- <code {...{"className":"ws-code "}}>
92
- {`Brand`}
93
- </code>
94
- {` will change the component from an `}
95
-
96
- <code {...{"className":"ws-code "}}>
97
- {`<img>`}
98
- </code>
99
- {` to a `}
100
-
101
- <code {...{"className":"ws-code "}}>
102
- {`<picture>`}
103
- </code>
104
- {` element. The `}
105
-
106
- <code {...{"className":"ws-code "}}>
107
- {`src`}
108
- </code>
109
- {` and `}
110
-
111
- <code {...{"className":"ws-code "}}>
112
- {`alt`}
113
- </code>
114
- {` properties should still be passed to populate the fallback `}
115
-
116
- <code {...{"className":"ws-code "}}>
117
- {`img`}
118
- </code>
119
- {` of the brand.`}
120
- </p>
121
- </Example>
122
- };
123
-
124
- const Component = () => (
125
- <React.Fragment>
126
- <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
127
- {`Examples`}
128
- </AutoLinkHeader>
129
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
130
- {`The brand component does not have any built-in theme support. If a brand should be dynamically styled, you must manually set up the necessary logic on your own.`}
131
- </p>
132
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
133
- {`These examples adjust styling when the PatternFly website is toggled between the light and dark theme.`}
134
- </p>
135
- {React.createElement(pageData.examples["Basic"])}
136
- {React.createElement(pageData.examples["Responsive"])}
137
- </React.Fragment>
138
- );
139
- Component.displayName = 'ComponentsBrandReactDocs';
140
- Component.pageData = pageData;
141
-
142
- export default Component;
@@ -1,206 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
- import { useRef, useState } from 'react';
4
- import RhMicronsCaretLeftIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-left-icon';
5
- import RhMicronsCaretDownIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-down-icon';
6
- const pageData = {
7
- "id": "Breadcrumb",
8
- "section": "components",
9
- "subsection": "",
10
- "deprecated": false,
11
- "template": false,
12
- "beta": false,
13
- "demo": false,
14
- "newImplementationLink": false,
15
- "source": "react",
16
- "tabName": null,
17
- "slug": "/components/breadcrumb/react",
18
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Breadcrumb/examples/Breadcrumb.md",
19
- "relPath": "packages/react-core/src/components/Breadcrumb/examples/Breadcrumb.md",
20
- "propComponents": [
21
- {
22
- "name": "Breadcrumb",
23
- "description": "",
24
- "props": [
25
- {
26
- "name": "aria-label",
27
- "type": "string",
28
- "description": "Aria label added to the breadcrumb nav.",
29
- "defaultValue": "'Breadcrumb'"
30
- },
31
- {
32
- "name": "children",
33
- "type": "React.ReactNode",
34
- "description": "Children nodes be rendered to the BreadCrumb. Should be of type BreadCrumbItem.",
35
- "defaultValue": "null"
36
- },
37
- {
38
- "name": "className",
39
- "type": "string",
40
- "description": "Additional classes added to the breadcrumb nav.",
41
- "defaultValue": "''"
42
- },
43
- {
44
- "name": "ouiaId",
45
- "type": "number | string",
46
- "description": "Value to overwrite the randomly generated data-ouia-component-id."
47
- },
48
- {
49
- "name": "ouiaSafe",
50
- "type": "boolean",
51
- "description": "Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false.",
52
- "defaultValue": "true"
53
- }
54
- ]
55
- },
56
- {
57
- "name": "BreadcrumbItem",
58
- "description": "",
59
- "props": [
60
- {
61
- "name": "children",
62
- "type": "React.ReactNode",
63
- "description": "Content rendered inside the breadcrumb item.",
64
- "defaultValue": "null"
65
- },
66
- {
67
- "name": "className",
68
- "type": "string",
69
- "description": "Additional classes added to the breadcrumb item.",
70
- "defaultValue": "''"
71
- },
72
- {
73
- "name": "component",
74
- "type": "React.ElementType",
75
- "description": "Sets the base component to render. Defaults to <a>",
76
- "defaultValue": "'a'"
77
- },
78
- {
79
- "name": "isActive",
80
- "type": "boolean",
81
- "description": "Flag indicating whether the item is active.",
82
- "defaultValue": "false"
83
- },
84
- {
85
- "name": "isDropdown",
86
- "type": "boolean",
87
- "description": "Flag indicating whether the item contains a dropdown.",
88
- "defaultValue": "false"
89
- },
90
- {
91
- "name": "render",
92
- "type": "(props: BreadcrumbItemRenderArgs) => React.ReactNode",
93
- "description": "A render function to render the component inside the breadcrumb item.",
94
- "defaultValue": "undefined"
95
- },
96
- {
97
- "name": "showDivider",
98
- "type": "boolean",
99
- "description": "Internal prop set by Breadcrumb on all but the first crumb"
100
- },
101
- {
102
- "name": "target",
103
- "type": "string",
104
- "description": "Target for breadcrumb link.",
105
- "defaultValue": "undefined"
106
- },
107
- {
108
- "name": "to",
109
- "type": "string",
110
- "description": "HREF for breadcrumb link.",
111
- "defaultValue": "undefined"
112
- }
113
- ]
114
- },
115
- {
116
- "name": "BreadcrumbHeading",
117
- "description": "",
118
- "props": [
119
- {
120
- "name": "children",
121
- "type": "React.ReactNode",
122
- "description": "Content rendered inside the breadcrumb title.",
123
- "defaultValue": "null"
124
- },
125
- {
126
- "name": "className",
127
- "type": "string",
128
- "description": "Additional classes added to the breadcrumb item.",
129
- "defaultValue": "''"
130
- },
131
- {
132
- "name": "component",
133
- "type": "React.ReactNode",
134
- "description": "Sets the base component to render. Defaults to <a>",
135
- "defaultValue": "'a'"
136
- },
137
- {
138
- "name": "showDivider",
139
- "type": "boolean",
140
- "description": "Internal prop set by Breadcrumb on all but the first crumb"
141
- },
142
- {
143
- "name": "target",
144
- "type": "string",
145
- "description": "Target for breadcrumb link.",
146
- "defaultValue": "undefined"
147
- },
148
- {
149
- "name": "to",
150
- "type": "string",
151
- "description": "HREF for breadcrumb link.",
152
- "defaultValue": "undefined"
153
- }
154
- ]
155
- }
156
- ],
157
- "cssPrefix": [
158
- "pf-v6-c-breadcrumb"
159
- ],
160
- "examples": [
161
- "Basic",
162
- "Without home link",
163
- "With heading",
164
- "With dropdown"
165
- ]
166
- };
167
- pageData.liveContext = {
168
- useRef,
169
- useState,
170
- RhMicronsCaretLeftIcon,
171
- RhMicronsCaretDownIcon
172
- };
173
- pageData.examples = {
174
- 'Basic': props =>
175
- <Example {...pageData} {...props} {...{"code":"import { Breadcrumb, BreadcrumbItem } from '@patternfly/react-core';\n\nexport const BreadcrumbBasic: React.FunctionComponent = () => (\n <Breadcrumb ouiaId=\"BasicBreadcrumb\">\n <BreadcrumbItem to=\"#\">Section home</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\" isActive>\n Section landing\n </BreadcrumbItem>\n </Breadcrumb>\n);\n","title":"Basic","lang":"ts","className":""}}>
176
-
177
- </Example>,
178
- 'Without home link': props =>
179
- <Example {...pageData} {...props} {...{"code":"import { Breadcrumb, BreadcrumbItem } from '@patternfly/react-core';\n\nexport const BreadcrumbHomeLink: React.FunctionComponent = () => (\n <Breadcrumb>\n <BreadcrumbItem>Section Home</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\" isActive>\n Section landing\n </BreadcrumbItem>\n </Breadcrumb>\n);\n","title":"Without home link","lang":"ts","className":""}}>
180
-
181
- </Example>,
182
- 'With heading': props =>
183
- <Example {...pageData} {...props} {...{"code":"import { Breadcrumb, BreadcrumbItem, BreadcrumbHeading } from '@patternfly/react-core';\n\nexport const BreadcrumbWithHeading: React.FunctionComponent = () => (\n <Breadcrumb>\n <BreadcrumbItem to=\"#\">Section home</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbItem to=\"#\">Section title</BreadcrumbItem>\n <BreadcrumbHeading to=\"#\">Section title</BreadcrumbHeading>\n </Breadcrumb>\n);\n","title":"With heading","lang":"ts","className":""}}>
184
-
185
- </Example>,
186
- 'With dropdown': props =>
187
- <Example {...pageData} {...props} {...{"code":"import { useRef, useState } from 'react';\nimport {\n Breadcrumb,\n BreadcrumbItem,\n BreadcrumbHeading,\n Badge,\n Dropdown,\n DropdownList,\n DropdownItem,\n Icon,\n MenuToggle,\n MenuToggleElement\n} from '@patternfly/react-core';\nimport RhMicronsCaretLeftIcon from '@patternfly/react-icons/dist/esm/icons/rh-microns-caret-left-icon';\n\nconst dropdownItems = [\n <DropdownItem\n icon={\n <Icon shouldMirrorRTL>\n <RhMicronsCaretLeftIcon />\n </Icon>\n }\n key=\"edit\"\n >\n Edit\n </DropdownItem>,\n <DropdownItem\n icon={\n <Icon shouldMirrorRTL>\n <RhMicronsCaretLeftIcon />\n </Icon>\n }\n key=\"action\"\n >\n Deployment\n </DropdownItem>,\n <DropdownItem\n icon={\n <Icon shouldMirrorRTL>\n <RhMicronsCaretLeftIcon />\n </Icon>\n }\n key=\"apps\"\n >\n Applications\n </DropdownItem>\n];\n\nexport const BreadcrumbDropdown: React.FunctionComponent = () => {\n const [isOpen, setIsOpen] = useState(false);\n const badgeToggleRef = useRef<HTMLButtonElement>(undefined);\n\n const onToggle = () => setIsOpen(!isOpen);\n\n const onSelect = () => {\n setIsOpen((prevIsOpen: boolean) => !prevIsOpen);\n badgeToggleRef?.current?.focus();\n };\n\n return (\n <Breadcrumb>\n <BreadcrumbItem component=\"button\">Section home</BreadcrumbItem>\n <BreadcrumbItem isDropdown>\n <Dropdown\n onSelect={onSelect}\n onOpenChange={(isOpen: boolean) => setIsOpen(isOpen)}\n toggle={(toggleRef: React.Ref<MenuToggleElement>) => (\n <MenuToggle\n size=\"sm\"\n badge={\n <Badge isRead screenReaderText=\"additional items\">\n {dropdownItems.length}\n </Badge>\n }\n ref={toggleRef}\n onClick={onToggle}\n isExpanded={isOpen}\n variant=\"plainText\"\n />\n )}\n isOpen={isOpen}\n >\n <DropdownList>{dropdownItems.map((dropdownItem) => dropdownItem)}</DropdownList>\n </Dropdown>\n </BreadcrumbItem>\n <BreadcrumbHeading component=\"button\">Section title</BreadcrumbHeading>\n </Breadcrumb>\n );\n};\n","title":"With dropdown","lang":"ts","className":""}}>
188
-
189
- </Example>
190
- };
191
-
192
- const Component = () => (
193
- <React.Fragment>
194
- <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
195
- {`Examples`}
196
- </AutoLinkHeader>
197
- {React.createElement(pageData.examples["Basic"])}
198
- {React.createElement(pageData.examples["Without home link"])}
199
- {React.createElement(pageData.examples["With heading"])}
200
- {React.createElement(pageData.examples["With dropdown"])}
201
- </React.Fragment>
202
- );
203
- Component.displayName = 'ComponentsBreadcrumbReactDocs';
204
- Component.pageData = pageData;
205
-
206
- export default Component;
@@ -1,57 +0,0 @@
1
- import React from 'react';
2
- import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
- import { useState } from 'react';
4
- import RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';
5
- const pageData = {
6
- "id": "Button",
7
- "section": "components",
8
- "subsection": "",
9
- "deprecated": false,
10
- "template": false,
11
- "beta": false,
12
- "demo": false,
13
- "newImplementationLink": false,
14
- "source": "react-demos",
15
- "tabName": null,
16
- "slug": "/components/button/react-demos",
17
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/demos/Button/Button.md",
18
- "relPath": "packages/react-core/src/demos/Button/Button.md",
19
- "examples": [
20
- "Progress button"
21
- ]
22
- };
23
- pageData.liveContext = {
24
- useState,
25
- RhUiCheckCircleFillIcon
26
- };
27
- pageData.examples = {
28
- 'Progress button': props =>
29
- <Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport { Form, FormGroup, ActionGroup, TextInput, Button } from '@patternfly/react-core';\nimport RhUiCheckCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-check-circle-fill-icon';\n\nexport const ButtonProgress: React.FunctionComponent = () => {\n const [loginState, setLoginState] = useState<'notLoggedIn' | 'loading' | 'loggedIn'>('notLoggedIn');\n\n return (\n <Form>\n <FormGroup label=\"Username\" isRequired fieldId=\"progress-button-initial-login\">\n <TextInput\n isRequired\n type=\"text\"\n id=\"progress-button-initial-login\"\n name=\"progress-button-initial-login\"\n value=\"johndoe\"\n aria-label=\"username input\"\n />\n </FormGroup>\n <FormGroup label=\"Password\" isRequired fieldId=\"progress-button-initial-password\">\n <TextInput\n isRequired\n type=\"password\"\n value=\"p@ssw0rd\"\n id=\"progress-button-initial-password\"\n name=\"progress-button-initial-password\"\n aria-label=\"password input\"\n />\n </FormGroup>\n <ActionGroup>\n <Button\n variant=\"primary\"\n onClick={\n loginState === 'notLoggedIn'\n ? () => {\n setLoginState('loading');\n setTimeout(() => {\n setLoginState('loggedIn');\n }, 3000);\n }\n : null\n }\n isLoading={loginState === 'loading'}\n icon={loginState === 'loggedIn' ? <RhUiCheckCircleFillIcon /> : null}\n spinnerAriaValueText=\"Loading...\"\n >\n {loginState === 'notLoggedIn' && 'Link account and log in'}\n {loginState === 'loading' && 'Linking account'}\n {loginState === 'loggedIn' && 'Logged in'}\n </Button>\n </ActionGroup>\n </Form>\n );\n};\n","title":"Progress button","lang":"ts","className":""}}>
30
-
31
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
32
- {`The following demo shows the intended flow for a button that visually indicates progress. This example demonstrates a login process, which updates the button label based on the `}
33
-
34
- <code {...{"className":"ws-code "}}>
35
- {`loginState`}
36
- </code>
37
- {`.`}
38
- </p>
39
-
40
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
41
- {`Please note that only the button can be interacted with in this example. The username and password input fields cannot be edited as the focus is on the button behavior.`}
42
- </p>
43
- </Example>
44
- };
45
-
46
- const Component = () => (
47
- <React.Fragment>
48
- <AutoLinkHeader {...{"id":"demos","headingLevel":"h2","className":"ws-title ws-h2"}}>
49
- {`Demos`}
50
- </AutoLinkHeader>
51
- {React.createElement(pageData.examples["Progress button"])}
52
- </React.Fragment>
53
- );
54
- Component.displayName = 'ComponentsButtonReactDemosDocs';
55
- Component.pageData = pageData;
56
-
57
- export default Component;