@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,665 +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 SearchIcon from '@patternfly/react-icons/dist/esm/icons/search-icon';
5
- const pageData = {
6
- "id": "Context selector",
7
- "section": "components",
8
- "subsection": "menus",
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/menus/context-selector/react-demos",
17
- "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/demos/CustomMenus/ContextSelector.md",
18
- "relPath": "packages/react-core/src/demos/CustomMenus/ContextSelector.md",
19
- "propComponents": [
20
- {
21
- "name": "MenuToggle",
22
- "description": "",
23
- "props": [
24
- {
25
- "name": "badge",
26
- "type": "BadgeProps | React.ReactNode",
27
- "description": "Optional badge rendered inside the toggle, after the children content"
28
- },
29
- {
30
- "name": "children",
31
- "type": "React.ReactNode",
32
- "description": "Content rendered inside the toggle"
33
- },
34
- {
35
- "name": "className",
36
- "type": "string",
37
- "description": "Additional classes added to the toggle"
38
- },
39
- {
40
- "name": "icon",
41
- "type": "React.ReactNode",
42
- "description": "Optional icon or image rendered inside the toggle, before the children content. It is\nrecommended to wrap most basic icons in our icon component."
43
- },
44
- {
45
- "name": "isCircle",
46
- "type": "boolean",
47
- "description": "Flag indicating the toggle has circular styling. Can only be applied to plain toggles.",
48
- "beta": true
49
- },
50
- {
51
- "name": "isDisabled",
52
- "type": "boolean",
53
- "description": "Flag indicating the toggle is disabled"
54
- },
55
- {
56
- "name": "isDocked",
57
- "type": "boolean",
58
- "description": "Flag indicating the menu toggle is a docked variant. For use in docked navigation.",
59
- "beta": true
60
- },
61
- {
62
- "name": "isExpanded",
63
- "type": "boolean",
64
- "description": "Flag indicating the toggle has expanded styling"
65
- },
66
- {
67
- "name": "isFullHeight",
68
- "type": "boolean",
69
- "description": "Flag indicating the toggle is full height"
70
- },
71
- {
72
- "name": "isFullWidth",
73
- "type": "boolean",
74
- "description": "Flag indicating the toggle takes up the full width of its parent"
75
- },
76
- {
77
- "name": "isInForm",
78
- "type": "boolean",
79
- "description": "Flag indicating the toggle is placed inside a form",
80
- "beta": true
81
- },
82
- {
83
- "name": "isPlaceholder",
84
- "type": "boolean",
85
- "description": "Flag indicating the toggle contains placeholder text"
86
- },
87
- {
88
- "name": "isSettings",
89
- "type": "boolean",
90
- "description": "Flag indicating whether the toggle is a settings toggle. This will override the icon property"
91
- },
92
- {
93
- "name": "isTextExpanded",
94
- "type": "boolean",
95
- "description": "Flag indicating the docked toggle should display text. Only applies when isDocked is true.",
96
- "beta": true
97
- },
98
- {
99
- "name": "ouiaId",
100
- "type": "number | string",
101
- "description": "Value to overwrite the randomly generated data-ouia-component-id. It will always target the toggle button."
102
- },
103
- {
104
- "name": "ouiaSafe",
105
- "type": "boolean",
106
- "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."
107
- },
108
- {
109
- "name": "size",
110
- "type": "'default' | 'sm'",
111
- "description": "Adds styling which affects the size of the menu toggle"
112
- },
113
- {
114
- "name": "splitButtonItems",
115
- "type": "React.ReactNode[]",
116
- "description": "Elements to display before the toggle button. When included, renders the menu toggle as a split button."
117
- },
118
- {
119
- "name": "status",
120
- "type": "'success' | 'warning' | 'danger'",
121
- "description": "Status styles of the menu toggle"
122
- },
123
- {
124
- "name": "statusIcon",
125
- "type": "React.ReactNode",
126
- "description": "Overrides the status icon"
127
- },
128
- {
129
- "name": "variant",
130
- "type": "'default' | 'plain' | 'primary' | 'plainText' | 'secondary' | 'typeahead'",
131
- "description": "Variant styles of the menu toggle"
132
- }
133
- ]
134
- },
135
- {
136
- "name": "MenuFooter",
137
- "description": "",
138
- "props": [
139
- {
140
- "name": "children",
141
- "type": "React.ReactNode",
142
- "description": "Content rendered inside the footer"
143
- },
144
- {
145
- "name": "className",
146
- "type": "string",
147
- "description": "Additional classes added to the footer",
148
- "defaultValue": "''"
149
- }
150
- ]
151
- },
152
- {
153
- "name": "MenuSearch",
154
- "description": "",
155
- "props": [
156
- {
157
- "name": "children",
158
- "type": "React.ReactNode",
159
- "description": "Items within search"
160
- }
161
- ]
162
- },
163
- {
164
- "name": "MenuSearchInput",
165
- "description": "",
166
- "props": [
167
- {
168
- "name": "children",
169
- "type": "React.ReactNode",
170
- "description": "Items within input"
171
- }
172
- ]
173
- },
174
- {
175
- "name": "Divider",
176
- "description": "",
177
- "props": [
178
- {
179
- "name": "className",
180
- "type": "string",
181
- "description": "Additional classes added to the divider"
182
- },
183
- {
184
- "name": "component",
185
- "type": "'hr' | 'li' | 'div'",
186
- "description": "The component type to use",
187
- "defaultValue": "DividerVariant.hr"
188
- },
189
- {
190
- "name": "inset",
191
- "type": "{\n default?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n sm?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n md?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n lg?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n xl?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n '2xl'?: 'insetNone' | 'insetXs' | 'insetSm' | 'insetMd' | 'insetLg' | 'insetXl' | 'inset2xl' | 'inset3xl';\n}",
192
- "description": "Insets at various breakpoints."
193
- },
194
- {
195
- "name": "orientation",
196
- "type": "{\n default?: 'vertical' | 'horizontal';\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n}",
197
- "description": "Indicates how the divider will display at various breakpoints. Vertical divider must be in a flex layout."
198
- },
199
- {
200
- "name": "role",
201
- "type": "'separator' | 'presentation'",
202
- "description": "The ARIA role of the divider when the component property has a value other than \"hr\".",
203
- "defaultValue": "'separator'"
204
- }
205
- ]
206
- },
207
- {
208
- "name": "InputGroup",
209
- "description": "",
210
- "props": [
211
- {
212
- "name": "children",
213
- "type": "React.ReactNode",
214
- "description": "Content rendered inside the input group.",
215
- "required": true
216
- },
217
- {
218
- "name": "className",
219
- "type": "string",
220
- "description": "Additional classes added to the input group."
221
- }
222
- ]
223
- },
224
- {
225
- "name": "SearchInput",
226
- "description": "",
227
- "props": [
228
- {
229
- "name": "advancedSearchDelimiter",
230
- "type": "string",
231
- "description": "Delimiter in the query string for pairing attributes with search values.\nRequired whenever attributes are passed as props."
232
- },
233
- {
234
- "name": "attributes",
235
- "type": "string[] | SearchInputSearchAttribute[]",
236
- "description": "Array of attribute values used for dynamically generated advanced search.",
237
- "defaultValue": "[]"
238
- },
239
- {
240
- "name": "className",
241
- "type": "string",
242
- "description": "Additional classes added to the advanced search menu."
243
- },
244
- {
245
- "name": "formAdditionalItems",
246
- "type": "React.ReactNode",
247
- "description": ""
248
- },
249
- {
250
- "name": "getAttrValueMap",
251
- "type": "() => { [key: string]: string }",
252
- "description": "Function which builds an attribute-value map by parsing the value in the search input."
253
- },
254
- {
255
- "name": "hasWordsAttrLabel",
256
- "type": "React.ReactNode",
257
- "description": "Attribute label for strings unassociated with one of the provided listed attributes.",
258
- "defaultValue": "'Has words'"
259
- },
260
- {
261
- "name": "isSearchMenuOpen",
262
- "type": "boolean",
263
- "description": "Flag for toggling the open/close state of the advanced search menu."
264
- },
265
- {
266
- "name": "onChange",
267
- "type": "(event: React.FormEvent<HTMLInputElement>, value: string) => void",
268
- "description": "A callback for when the input value changes."
269
- },
270
- {
271
- "name": "onClear",
272
- "type": "(event: React.SyntheticEvent<HTMLButtonElement>) => void",
273
- "description": "A callback for when the user clicks the clear button."
274
- },
275
- {
276
- "name": "onSearch",
277
- "type": "(\n event: React.SyntheticEvent<HTMLButtonElement>,\n value: string,\n attrValueMap: { [key: string]: string }\n) => void",
278
- "description": "A callback for when the search button is clicked."
279
- },
280
- {
281
- "name": "onToggleAdvancedMenu",
282
- "type": "(e: React.SyntheticEvent<HTMLButtonElement>) => void",
283
- "description": "A callback for when the open advanced search button is clicked."
284
- },
285
- {
286
- "name": "parentInputRef",
287
- "type": "React.RefObject<any>",
288
- "description": "Ref of the input element within the search input."
289
- },
290
- {
291
- "name": "parentRef",
292
- "type": "React.RefObject<any>",
293
- "description": "Ref of the div wrapping the whole search input."
294
- },
295
- {
296
- "name": "resetButtonLabel",
297
- "type": "string",
298
- "description": "Label for the button which resets the advanced search form and clears the search input.",
299
- "defaultValue": "'Reset'"
300
- },
301
- {
302
- "name": "submitSearchButtonLabel",
303
- "type": "string",
304
- "description": "Label for the button which calls the onSearch event handler.",
305
- "defaultValue": "'Search'"
306
- },
307
- {
308
- "name": "value",
309
- "type": "string",
310
- "description": "Value of the search input.",
311
- "defaultValue": "''"
312
- }
313
- ]
314
- },
315
- {
316
- "name": "Dropdown",
317
- "description": "See the Menu documentation for additional props that may be passed.",
318
- "props": [
319
- {
320
- "name": "activeItemId",
321
- "type": "string | number",
322
- "description": "itemId of the currently active item. You can also specify isActive on the MenuItem."
323
- },
324
- {
325
- "name": "activeMenu",
326
- "type": "string",
327
- "description": "ID of the currently active menu for the drilldown variant"
328
- },
329
- {
330
- "name": "children",
331
- "type": "React.ReactNode",
332
- "description": "Anything that can be rendered inside of the Menu"
333
- },
334
- {
335
- "name": "className",
336
- "type": "string",
337
- "description": "Additional classes added to the Menu"
338
- },
339
- {
340
- "name": "containerComponent",
341
- "type": "React.ReactNode",
342
- "description": "Sets the base component to render for the container. Defaults to <span>"
343
- },
344
- {
345
- "name": "containerOuiaId",
346
- "type": "number | string",
347
- "description": "When applied, wraps dropdown in a container with a data-ouia-component-id."
348
- },
349
- {
350
- "name": "containerOuiaSafe",
351
- "type": "boolean",
352
- "description": "Set the value of data-ouia-safe for the container when containerOuiaId is applied. 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."
353
- },
354
- {
355
- "name": "containsDrilldown",
356
- "type": "boolean",
357
- "description": "Indicates if menu contains a drilldown menu"
358
- },
359
- {
360
- "name": "containsFlyout",
361
- "type": "boolean",
362
- "description": "Indicates if menu contains a flyout menu"
363
- },
364
- {
365
- "name": "drilldownItemPath",
366
- "type": "string[]",
367
- "description": "Indicates the path of drilled in menu itemIds"
368
- },
369
- {
370
- "name": "drilledInMenus",
371
- "type": "string[]",
372
- "description": "Array of menus that are drilled in"
373
- },
374
- {
375
- "name": "focusTimeoutDelay",
376
- "type": "number",
377
- "description": "Time in ms to wait before firing the toggles' focus event. Defaults to 0"
378
- },
379
- {
380
- "name": "id",
381
- "type": "string",
382
- "description": "ID of the menu"
383
- },
384
- {
385
- "name": "isMenuDrilledIn",
386
- "type": "boolean",
387
- "description": "Indicates if a menu is drilled into"
388
- },
389
- {
390
- "name": "isNavFlyout",
391
- "type": "boolean",
392
- "description": "Indicating that the menu should have nav flyout styling"
393
- },
394
- {
395
- "name": "isOpen",
396
- "type": "boolean",
397
- "description": "Flag to indicate if menu is opened."
398
- },
399
- {
400
- "name": "isPlain",
401
- "type": "boolean",
402
- "description": "Indicates if the menu should be without the outer box-shadow"
403
- },
404
- {
405
- "name": "isRootMenu",
406
- "type": "boolean",
407
- "description": "Internal flag indicating if the Menu is the root of a menu tree"
408
- },
409
- {
410
- "name": "isScrollable",
411
- "type": "boolean",
412
- "description": "Indicates if the menu should be srollable"
413
- },
414
- {
415
- "name": "maxMenuHeight",
416
- "type": "string",
417
- "description": "Maximum height of dropdown menu"
418
- },
419
- {
420
- "name": "menuHeight",
421
- "type": "string",
422
- "description": "Height of the dropdown menu"
423
- },
424
- {
425
- "name": "onActionClick",
426
- "type": "(event?: any, itemId?: any, actionId?: any) => void",
427
- "description": "Callback called when an MenuItems's action button is clicked. You can also specify it within a MenuItemAction."
428
- },
429
- {
430
- "name": "onDrillIn",
431
- "type": "(\n event: React.KeyboardEvent | React.MouseEvent,\n fromItemId: string,\n toItemId: string,\n itemId: string\n) => void",
432
- "description": "Callback for drilling into a submenu"
433
- },
434
- {
435
- "name": "onDrillOut",
436
- "type": "(event: React.KeyboardEvent | React.MouseEvent, toItemId: string, itemId: string) => void",
437
- "description": "Callback for drilling out of a submenu"
438
- },
439
- {
440
- "name": "onGetMenuHeight",
441
- "type": "(menuId: string, height: number) => void",
442
- "description": "Callback for collecting menu heights"
443
- },
444
- {
445
- "name": "onOpenChange",
446
- "type": "(isOpen: boolean) => void",
447
- "description": "Callback to allow the dropdown component to change the open state of the menu.\nTriggered by clicking outside of the menu, or by pressing any keys specified in onOpenChangeKeys."
448
- },
449
- {
450
- "name": "onOpenChangeKeys",
451
- "type": "string[]",
452
- "description": "Keys that trigger onOpenChange, defaults to tab and escape. It is highly recommended to include Escape in the array, while Tab may be omitted if the menu contains non-menu items that are focusable."
453
- },
454
- {
455
- "name": "onSelect",
456
- "type": "(event?: React.MouseEvent<Element, MouseEvent>, value?: DropdownItemProps['value']) => void",
457
- "description": "Callback for updating when item selection changes. You can also specify onClick on the MenuItem."
458
- },
459
- {
460
- "name": "onToggleKeydown",
461
- "type": "(event: KeyboardEvent) => void",
462
- "description": "Callback to override the toggle keydown behavior. By default, when the toggle has focus and the menu is open, pressing the up/down arrow keys will focus a valid non-disabled menu item - the first item for the down arrow key and last item for the up arrow key."
463
- },
464
- {
465
- "name": "ouiaId",
466
- "type": "number | string",
467
- "description": "Value to overwrite the randomly generated data-ouia-component-id."
468
- },
469
- {
470
- "name": "ouiaSafe",
471
- "type": "boolean",
472
- "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."
473
- },
474
- {
475
- "name": "parentMenu",
476
- "type": "string",
477
- "description": "ID of parent menu for drilldown menus"
478
- },
479
- {
480
- "name": "popperProps",
481
- "type": "PopperOptions",
482
- "description": "Additional properties to pass to the Popper"
483
- },
484
- {
485
- "name": "role",
486
- "type": "string",
487
- "description": "Determines the accessible role of the menu. For a non-checkbox menu that can have\none or more items selected, pass in \"listbox\"."
488
- },
489
- {
490
- "name": "selected",
491
- "type": "any | any[]",
492
- "description": "Single itemId for single select menus, or array of itemIds for multi select. You can also specify isSelected on the MenuItem."
493
- },
494
- {
495
- "name": "shouldFocusFirstItemOnOpen",
496
- "type": "boolean",
497
- "description": "Flag indicating the first menu item should be focused after opening the dropdown.",
498
- "beta": true
499
- },
500
- {
501
- "name": "shouldFocusToggleOnSelect",
502
- "type": "boolean",
503
- "description": "Flag indicating the toggle should be focused after a selection. If this use case is too restrictive, the optional toggleRef property with a node toggle may be used to control focus."
504
- },
505
- {
506
- "name": "shouldPreventScrollOnItemFocus",
507
- "type": "boolean",
508
- "description": "Flag indicating if scroll on focus of the first menu item should occur."
509
- },
510
- {
511
- "name": "toggle",
512
- "type": "DropdownToggleProps | ((toggleRef: React.RefObject<any>) => React.ReactNode)",
513
- "description": "Dropdown toggle. The toggle should either be a renderer function which forwards the given toggle ref, or a direct ReactNode that should be passed along with the toggleRef property.",
514
- "required": true
515
- },
516
- {
517
- "name": "zIndex",
518
- "type": "number",
519
- "description": "z-index of the dropdown menu"
520
- }
521
- ]
522
- },
523
- {
524
- "name": "DropdownGroup",
525
- "description": "See the MenuGroup section of the Menu documentation for additional props that may be passed.",
526
- "props": [
527
- {
528
- "name": "children",
529
- "type": "React.ReactNode",
530
- "description": "Anything which can be rendered in a dropdown group.",
531
- "required": true
532
- },
533
- {
534
- "name": "className",
535
- "type": "string",
536
- "description": "Classes applied to root element of dropdown group"
537
- },
538
- {
539
- "name": "label",
540
- "type": "React.ReactNode",
541
- "description": "Label of the dropdown group"
542
- },
543
- {
544
- "name": "labelHeadingLevel",
545
- "type": "No type info",
546
- "defaultValue": "'h1'"
547
- }
548
- ]
549
- },
550
- {
551
- "name": "DropdownList",
552
- "description": "",
553
- "props": [
554
- {
555
- "name": "aria-label",
556
- "type": "string",
557
- "description": "Adds an accessible name to the menu."
558
- },
559
- {
560
- "name": "children",
561
- "type": "React.ReactNode",
562
- "description": "Anything that can be rendered inside of menu list",
563
- "required": true
564
- },
565
- {
566
- "name": "className",
567
- "type": "string",
568
- "description": "Additional classes added to the menu list"
569
- },
570
- {
571
- "name": "isAriaMultiselectable",
572
- "type": "boolean",
573
- "description": "Indicates to assistive technologies whether more than one item can be selected\nfor a non-checkbox menu. Only applies when the menu's role is \"listbox\"."
574
- }
575
- ]
576
- },
577
- {
578
- "name": "DropdownItem",
579
- "description": "See the MenuItem section of the Menu documentation for additional props that may be passed.",
580
- "props": [
581
- {
582
- "name": "children",
583
- "type": "React.ReactNode",
584
- "description": "Anything which can be rendered in a dropdown item"
585
- },
586
- {
587
- "name": "className",
588
- "type": "string",
589
- "description": "Classes applied to root element of dropdown item"
590
- },
591
- {
592
- "name": "description",
593
- "type": "React.ReactNode",
594
- "description": "Description of the dropdown item"
595
- },
596
- {
597
- "name": "isAriaDisabled",
598
- "type": "boolean",
599
- "description": "Render item as aria-disabled option"
600
- },
601
- {
602
- "name": "isDisabled",
603
- "type": "boolean",
604
- "description": "Render item as disabled option"
605
- },
606
- {
607
- "name": "onClick",
608
- "type": "(event?: any) => void",
609
- "description": "Callback for item click"
610
- },
611
- {
612
- "name": "ouiaId",
613
- "type": "number | string",
614
- "description": "Value to overwrite the randomly generated data-ouia-component-id."
615
- },
616
- {
617
- "name": "ouiaSafe",
618
- "type": "boolean",
619
- "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."
620
- },
621
- {
622
- "name": "tooltipProps",
623
- "type": "TooltipProps",
624
- "description": "Props for adding a tooltip to a menu item"
625
- },
626
- {
627
- "name": "value",
628
- "type": "any",
629
- "description": "Identifies the component in the dropdown onSelect callback"
630
- }
631
- ]
632
- }
633
- ],
634
- "examples": [
635
- "Context selector menu"
636
- ]
637
- };
638
- pageData.liveContext = {
639
- useRef,
640
- useState,
641
- SearchIcon
642
- };
643
- pageData.examples = {
644
- 'Context selector menu': props =>
645
- <Example {...pageData} {...props} {...{"code":"import { useRef, useState } from 'react';\nimport {\n MenuToggle,\n MenuFooter,\n MenuSearch,\n MenuSearchInput,\n Divider,\n InputGroup,\n InputGroupItem,\n Button,\n ButtonVariant,\n SearchInput,\n Dropdown,\n DropdownList,\n DropdownItem\n} from '@patternfly/react-core';\nimport SearchIcon from '@patternfly/react-icons/dist/esm/icons/search-icon';\n\ninterface ItemData {\n text: string;\n href?: string;\n isDisabled?: boolean | undefined;\n}\n\ntype ItemArrayType = (ItemData | string)[];\n\nexport const ContextSelectorDemo: React.FunctionComponent = () => {\n const items: ItemArrayType = [\n {\n text: 'Action'\n },\n {\n text: 'Link',\n href: '#'\n },\n {\n text: 'Disabled action',\n isDisabled: true\n },\n {\n text: 'Disabled link',\n href: '#',\n isDisabled: true\n },\n 'My project',\n 'OpenShift cluster',\n 'Production Ansible',\n 'AWS',\n 'Azure',\n 'My project 2',\n 'OpenShift cluster ',\n 'Production Ansible 2 ',\n 'AWS 2',\n 'Azure 2'\n ];\n const [isOpen, setIsOpen] = useState<boolean>(false);\n const [selected, setSelected] = useState(typeof items[0] === 'string' ? items[0] : items[0].text);\n const [filteredItems, setFilteredItems] = useState<ItemArrayType>(items);\n const [searchInputValue, setSearchInputValue] = useState<string>('');\n const menuRef = useRef<HTMLDivElement>(null);\n const menuFooterBtnRef = useRef<HTMLButtonElement>(null);\n\n const onToggleClick = () => {\n setIsOpen(!isOpen);\n };\n\n const onSelect = (ev: React.MouseEvent<Element, MouseEvent> | undefined, itemId: string | number | undefined) => {\n if (typeof itemId === 'number' || typeof itemId === 'undefined') {\n return;\n }\n setSelected(itemId.toString());\n setIsOpen(!isOpen);\n };\n\n const onSearchInputChange = (value: string) => {\n setSearchInputValue(value);\n };\n\n const onSearchButtonClick = () => {\n const filtered =\n searchInputValue === ''\n ? items\n : items.filter((item) => {\n const str = typeof item === 'string' ? item : item.text;\n return str.toLowerCase().indexOf(searchInputValue.toLowerCase()) !== -1;\n });\n\n setFilteredItems(filtered || []);\n setIsOpen(true); // Keep menu open after search executed\n };\n\n const onEnterPressed = (event: React.KeyboardEvent) => {\n if (event.key === 'Enter') {\n onSearchButtonClick();\n }\n };\n\n return (\n <Dropdown\n isOpen={isOpen}\n onOpenChange={(isOpen) => setIsOpen(isOpen)}\n onOpenChangeKeys={['Escape']}\n toggle={(toggleRef) => (\n <MenuToggle ref={toggleRef} onClick={onToggleClick} isExpanded={isOpen}>\n {selected}\n </MenuToggle>\n )}\n ref={menuRef}\n id=\"context-selector\"\n onSelect={onSelect}\n isScrollable\n >\n <MenuSearch>\n <MenuSearchInput>\n <InputGroup>\n <InputGroupItem isFill>\n <SearchInput\n value={searchInputValue}\n placeholder=\"Search\"\n onChange={(_event, value) => onSearchInputChange(value)}\n onKeyPress={onEnterPressed}\n aria-labelledby=\"pf-v6-context-selector-search-button-id-1\"\n />\n </InputGroupItem>\n <InputGroupItem>\n <Button\n variant={ButtonVariant.control}\n aria-label=\"Search menu items\"\n id=\"pf-v6-context-selector-search-button-id-1\"\n onClick={onSearchButtonClick}\n icon={<SearchIcon />}\n />\n </InputGroupItem>\n </InputGroup>\n </MenuSearchInput>\n </MenuSearch>\n <Divider />\n <DropdownList>\n {filteredItems.map((item, index) => {\n const [itemText, isDisabled, href] =\n typeof item === 'string' ? [item, null, null] : [item.text, item.isDisabled || null, item.href || null];\n return (\n <DropdownItem\n itemId={itemText}\n key={index}\n isDisabled={isDisabled as boolean | undefined}\n to={href as string | undefined}\n >\n {itemText}\n </DropdownItem>\n );\n })}\n </DropdownList>\n <MenuFooter>\n <Button ref={menuFooterBtnRef} variant=\"link\" isInline>\n Action\n </Button>\n </MenuFooter>\n </Dropdown>\n );\n};\n","title":"Context selector menu","lang":"ts","className":""}}>
646
-
647
- </Example>
648
- };
649
-
650
- const Component = () => (
651
- <React.Fragment>
652
- <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
653
- {`As the context selector component is now deprecated, a context selector may now be built using the new suite of menu components. This is showcased in the following demo, which uses the new `}
654
- <PatternflyThemeLink {...{"to":"/components/menus/dropdown","className":""}}>
655
- {`dropdown`}
656
- </PatternflyThemeLink>
657
- {` component that is built off of menu.`}
658
- </p>
659
- {React.createElement(pageData.examples["Context selector menu"])}
660
- </React.Fragment>
661
- );
662
- Component.displayName = 'ComponentsMenusContextSelectorReactDemosDocs';
663
- Component.pageData = pageData;
664
-
665
- export default Component;