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

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 +4 -0
  2. package/package.json +12 -13
  3. package/patternfly-docs/generated/components/about-modal/react.js +149 -0
  4. package/patternfly-docs/generated/components/accordion/react.js +262 -0
  5. package/patternfly-docs/generated/components/action-list/react.js +144 -0
  6. package/patternfly-docs/generated/components/alert/react-demos.js +56 -0
  7. package/patternfly-docs/generated/components/alert/react.js +1433 -0
  8. package/patternfly-docs/generated/components/avatar/react.js +166 -0
  9. package/patternfly-docs/generated/components/back-to-top/react-demos.js +60 -0
  10. package/patternfly-docs/generated/components/back-to-top/react.js +77 -0
  11. package/patternfly-docs/generated/components/backdrop/react.js +64 -0
  12. package/patternfly-docs/generated/components/background-image/react.js +62 -0
  13. package/patternfly-docs/generated/components/badge/react.js +97 -0
  14. package/patternfly-docs/generated/components/banner/react-demos.js +57 -0
  15. package/patternfly-docs/generated/components/banner/react.js +148 -0
  16. package/patternfly-docs/generated/components/brand/react.js +142 -0
  17. package/patternfly-docs/generated/components/breadcrumb/react.js +206 -0
  18. package/patternfly-docs/generated/components/button/react-demos.js +57 -0
  19. package/patternfly-docs/generated/components/button/react.js +826 -0
  20. package/patternfly-docs/generated/components/card/react-demos.js +201 -0
  21. package/patternfly-docs/generated/components/card/react.js +1015 -0
  22. package/patternfly-docs/generated/components/charts/area-chart/-Victory.js +1350 -0
  23. package/patternfly-docs/generated/components/charts/bar-chart/-Victory.js +1334 -0
  24. package/patternfly-docs/generated/components/charts/box-plot-chart/-Victory.js +1282 -0
  25. package/patternfly-docs/generated/components/charts/bullet-chart/-Victory.js +848 -0
  26. package/patternfly-docs/generated/components/charts/colors-for-charts/-Victory.js +192 -0
  27. package/patternfly-docs/generated/components/charts/donut-chart/-Victory.js +426 -0
  28. package/patternfly-docs/generated/components/charts/donut-utilization-chart/-Victory.js +804 -0
  29. package/patternfly-docs/generated/components/charts/legends/-Victory.js +3230 -0
  30. package/patternfly-docs/generated/components/charts/line-chart/-Victory.js +1178 -0
  31. package/patternfly-docs/generated/components/charts/line-chart/ECharts.js +525 -0
  32. package/patternfly-docs/generated/components/charts/patterns/-Victory.js +3382 -0
  33. package/patternfly-docs/generated/components/charts/pie-chart/-Victory.js +377 -0
  34. package/patternfly-docs/generated/components/charts/resize-observer/-Victory.js +2475 -0
  35. package/patternfly-docs/generated/components/charts/sankey-chart/ECharts.js +538 -0
  36. package/patternfly-docs/generated/components/charts/scatter-chart/-Victory.js +1551 -0
  37. package/patternfly-docs/generated/components/charts/skeletons/-Victory.js +4115 -0
  38. package/patternfly-docs/generated/components/charts/sparkline-chart/-Victory.js +955 -0
  39. package/patternfly-docs/generated/components/charts/stack-chart/-Victory.js +1173 -0
  40. package/patternfly-docs/generated/components/charts/threshold-chart/-Victory.js +1166 -0
  41. package/patternfly-docs/generated/components/charts/tooltips/-Victory.js +413 -0
  42. package/patternfly-docs/generated/components/chip/react-deprecated.js +323 -0
  43. package/patternfly-docs/generated/components/clipboard-copy/react.js +373 -0
  44. package/patternfly-docs/generated/components/code-block/react.js +148 -0
  45. package/patternfly-docs/generated/components/code-editor/react.js +659 -0
  46. package/patternfly-docs/generated/components/compass/react-demos.js +147 -0
  47. package/patternfly-docs/generated/components/compass/react.js +440 -0
  48. package/patternfly-docs/generated/components/content/react.js +248 -0
  49. package/patternfly-docs/generated/components/data-list/react-demos.js +90 -0
  50. package/patternfly-docs/generated/components/data-list/react.js +709 -0
  51. package/patternfly-docs/generated/components/date-and-time/calendar-month/react.js +283 -0
  52. package/patternfly-docs/generated/components/date-and-time/date-and-time-picker/react-demos.js +64 -0
  53. package/patternfly-docs/generated/components/date-and-time/date-picker/react-demos.js +83 -0
  54. package/patternfly-docs/generated/components/date-and-time/date-picker/react.js +395 -0
  55. package/patternfly-docs/generated/components/date-and-time/time-picker/react.js +241 -0
  56. package/patternfly-docs/generated/components/description-list/react-demos.js +58 -0
  57. package/patternfly-docs/generated/components/description-list/react.js +743 -0
  58. package/patternfly-docs/generated/components/divider/react.js +126 -0
  59. package/patternfly-docs/generated/components/drag-and-drop/react-demos.js +351 -0
  60. package/patternfly-docs/generated/components/drag-and-drop/react-deprecated.js +184 -0
  61. package/patternfly-docs/generated/components/drag-and-drop/react.js +137 -0
  62. package/patternfly-docs/generated/components/drawer/react.js +598 -0
  63. package/patternfly-docs/generated/components/dual-list-selector/react-deprecated.js +772 -0
  64. package/patternfly-docs/generated/components/dual-list-selector/react.js +594 -0
  65. package/patternfly-docs/generated/components/empty-state/react.js +199 -0
  66. package/patternfly-docs/generated/components/expandable-section/react-demos.js +65 -0
  67. package/patternfly-docs/generated/components/expandable-section/react.js +408 -0
  68. package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react-demos.js +52 -0
  69. package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react.js +398 -0
  70. package/patternfly-docs/generated/components/file-upload/simple-file-upload/react.js +749 -0
  71. package/patternfly-docs/generated/components/forms/checkbox/react.js +222 -0
  72. package/patternfly-docs/generated/components/forms/form/react.js +1106 -0
  73. package/patternfly-docs/generated/components/forms/form-select/react.js +208 -0
  74. package/patternfly-docs/generated/components/forms/radio/react.js +212 -0
  75. package/patternfly-docs/generated/components/forms/text-area/react.js +160 -0
  76. package/patternfly-docs/generated/components/forms/text-input/react.js +216 -0
  77. package/patternfly-docs/generated/components/helper-text/react-demos.js +180 -0
  78. package/patternfly-docs/generated/components/helper-text/react.js +164 -0
  79. package/patternfly-docs/generated/components/hero/react.js +88 -0
  80. package/patternfly-docs/generated/components/hint/react.js +169 -0
  81. package/patternfly-docs/generated/components/icon/react.js +215 -0
  82. package/patternfly-docs/generated/components/input-group/react.js +182 -0
  83. package/patternfly-docs/generated/components/jump-links/react-demos.js +154 -0
  84. package/patternfly-docs/generated/components/jump-links/react.js +212 -0
  85. package/patternfly-docs/generated/components/label/react-demos.js +57 -0
  86. package/patternfly-docs/generated/components/label/react.js +417 -0
  87. package/patternfly-docs/generated/components/list/react.js +175 -0
  88. package/patternfly-docs/generated/components/login-page/react.js +587 -0
  89. package/patternfly-docs/generated/components/masthead/react-demos.js +79 -0
  90. package/patternfly-docs/generated/components/masthead/react.js +291 -0
  91. package/patternfly-docs/generated/components/menus/application-launcher/react-demos.js +769 -0
  92. package/patternfly-docs/generated/components/menus/context-selector/react-demos.js +665 -0
  93. package/patternfly-docs/generated/components/menus/custom-menus/react-demos.js +187 -0
  94. package/patternfly-docs/generated/components/menus/dropdown/react-templates.js +163 -0
  95. package/patternfly-docs/generated/components/menus/dropdown/react.js +998 -0
  96. package/patternfly-docs/generated/components/menus/menu/react.js +1540 -0
  97. package/patternfly-docs/generated/components/menus/menu-toggle/react.js +747 -0
  98. package/patternfly-docs/generated/components/menus/options-menu/react-demos.js +508 -0
  99. package/patternfly-docs/generated/components/menus/select/react-templates.js +257 -0
  100. package/patternfly-docs/generated/components/menus/select/react.js +998 -0
  101. package/patternfly-docs/generated/components/modal/react-deprecated.js +554 -0
  102. package/patternfly-docs/generated/components/modal/react.js +597 -0
  103. package/patternfly-docs/generated/components/navigation/react-demos.js +356 -0
  104. package/patternfly-docs/generated/components/navigation/react.js +409 -0
  105. package/patternfly-docs/generated/components/notification-badge/react.js +196 -0
  106. package/patternfly-docs/generated/components/notification-drawer/react-demos.js +107 -0
  107. package/patternfly-docs/generated/components/notification-drawer/react.js +394 -0
  108. package/patternfly-docs/generated/components/number-input/react.js +210 -0
  109. package/patternfly-docs/generated/components/overflow-menu/react.js +274 -0
  110. package/patternfly-docs/generated/components/page/react-demos.js +149 -0
  111. package/patternfly-docs/generated/components/page/react.js +1352 -0
  112. package/patternfly-docs/generated/components/pagination/react.js +492 -0
  113. package/patternfly-docs/generated/components/panel/react.js +236 -0
  114. package/patternfly-docs/generated/components/popover/react.js +390 -0
  115. package/patternfly-docs/generated/components/progress/react-demos.js +59 -0
  116. package/patternfly-docs/generated/components/progress/react.js +283 -0
  117. package/patternfly-docs/generated/components/progress-stepper/react-demos.js +45 -0
  118. package/patternfly-docs/generated/components/progress-stepper/react.js +219 -0
  119. package/patternfly-docs/generated/components/search-input/react-demos.js +113 -0
  120. package/patternfly-docs/generated/components/search-input/react.js +263 -0
  121. package/patternfly-docs/generated/components/sidebar/react.js +236 -0
  122. package/patternfly-docs/generated/components/simple-list/react.js +200 -0
  123. package/patternfly-docs/generated/components/skeleton/react-demos.js +44 -0
  124. package/patternfly-docs/generated/components/skeleton/react.js +122 -0
  125. package/patternfly-docs/generated/components/skip-to-content/react.js +73 -0
  126. package/patternfly-docs/generated/components/slider/react.js +309 -0
  127. package/patternfly-docs/generated/components/spinner/react.js +111 -0
  128. package/patternfly-docs/generated/components/switch/react.js +163 -0
  129. package/patternfly-docs/generated/components/table/react-demos.js +355 -0
  130. package/patternfly-docs/generated/components/table/react-deprecated.js +1350 -0
  131. package/patternfly-docs/generated/components/table/react.js +3241 -0
  132. package/patternfly-docs/generated/components/tabs/react-demos.js +108 -0
  133. package/patternfly-docs/generated/components/tabs/react.js +1359 -0
  134. package/patternfly-docs/generated/components/text-input-group/react-demos.js +152 -0
  135. package/patternfly-docs/generated/components/text-input-group/react.js +278 -0
  136. package/patternfly-docs/generated/components/tile/react-deprecated.js +242 -0
  137. package/patternfly-docs/generated/components/timestamp/react.js +283 -0
  138. package/patternfly-docs/generated/components/title/react.js +94 -0
  139. package/patternfly-docs/generated/components/toggle-group/react.js +299 -0
  140. package/patternfly-docs/generated/components/toolbar/react-demos.js +66 -0
  141. package/patternfly-docs/generated/components/toolbar/react.js +932 -0
  142. package/patternfly-docs/generated/components/tooltip/react.js +241 -0
  143. package/patternfly-docs/generated/components/tree-view/react.js +429 -0
  144. package/patternfly-docs/generated/components/truncate/react.js +211 -0
  145. package/patternfly-docs/generated/components/wizard/react-demos.js +87 -0
  146. package/patternfly-docs/generated/components/wizard/react-deprecated.js +788 -0
  147. package/patternfly-docs/generated/components/wizard/react.js +986 -0
  148. package/patternfly-docs/generated/developer-guides/open-ui-automation/react.js +285 -0
  149. package/patternfly-docs/generated/foundations-and-styles/layouts/bullseye/react.js +70 -0
  150. package/patternfly-docs/generated/foundations-and-styles/layouts/flex/react.js +506 -0
  151. package/patternfly-docs/generated/foundations-and-styles/layouts/gallery/react.js +94 -0
  152. package/patternfly-docs/generated/foundations-and-styles/layouts/grid/react.js +272 -0
  153. package/patternfly-docs/generated/foundations-and-styles/layouts/level/react.js +87 -0
  154. package/patternfly-docs/generated/foundations-and-styles/layouts/split/react.js +124 -0
  155. package/patternfly-docs/generated/foundations-and-styles/layouts/stack/react.js +112 -0
  156. package/patternfly-docs/generated/index.js +1769 -0
  157. package/patternfly-docs/generated/patterns/card-view/react-demos.js +78 -0
  158. package/patternfly-docs/generated/patterns/filters/react-demos.js +141 -0
  159. package/patternfly-docs/generated/patterns/password-generator/react-demos.js +51 -0
  160. package/patternfly-docs/generated/patterns/password-strength/react-demos.js +61 -0
  161. package/patternfly-docs/generated/patterns/primary-detail/react-demos.js +124 -0
  162. package/patternfly-docs/generated/patterns/right-to-left/react-demos.js +81 -0
  163. package/LICENSE +0 -21
@@ -0,0 +1,182 @@
1
+ import React from 'react';
2
+ import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
+ import { Fragment, useRef, useState } from 'react';
4
+ import AtIcon from '@patternfly/react-icons/dist/esm/icons/at-icon';
5
+ import DollarSignIcon from '@patternfly/react-icons/dist/esm/icons/dollar-sign-icon';
6
+ import RhUiQuestionMarkCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-question-mark-circle-fill-icon';
7
+ const pageData = {
8
+ "id": "Input group",
9
+ "section": "components",
10
+ "subsection": "",
11
+ "deprecated": false,
12
+ "template": false,
13
+ "beta": false,
14
+ "demo": false,
15
+ "newImplementationLink": false,
16
+ "source": "react",
17
+ "tabName": null,
18
+ "slug": "/components/input-group/react",
19
+ "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/InputGroup/examples/InputGroup.md",
20
+ "relPath": "packages/react-core/src/components/InputGroup/examples/InputGroup.md",
21
+ "propComponents": [
22
+ {
23
+ "name": "InputGroup",
24
+ "description": "",
25
+ "props": [
26
+ {
27
+ "name": "children",
28
+ "type": "React.ReactNode",
29
+ "description": "Content rendered inside the input group.",
30
+ "required": true
31
+ },
32
+ {
33
+ "name": "className",
34
+ "type": "string",
35
+ "description": "Additional classes added to the input group."
36
+ }
37
+ ]
38
+ },
39
+ {
40
+ "name": "InputGroupItem",
41
+ "description": "",
42
+ "props": [
43
+ {
44
+ "name": "children",
45
+ "type": "React.ReactNode",
46
+ "description": "Content rendered inside the input group item.",
47
+ "required": true
48
+ },
49
+ {
50
+ "name": "className",
51
+ "type": "string",
52
+ "description": "Additional classes added to the input group item."
53
+ },
54
+ {
55
+ "name": "isBox",
56
+ "type": "boolean",
57
+ "description": "Enables box styling to the input group item",
58
+ "defaultValue": "false"
59
+ },
60
+ {
61
+ "name": "isDisabled",
62
+ "type": "boolean",
63
+ "description": "Flag to indicate if the input group item is disabled."
64
+ },
65
+ {
66
+ "name": "isFill",
67
+ "type": "boolean",
68
+ "description": "Flag to indicate if the input group item should fill the available horizontal space",
69
+ "defaultValue": "false"
70
+ },
71
+ {
72
+ "name": "isPlain",
73
+ "type": "boolean",
74
+ "description": "Flag to indicate if the input group item is plain."
75
+ }
76
+ ]
77
+ },
78
+ {
79
+ "name": "InputGroupText",
80
+ "description": "",
81
+ "props": [
82
+ {
83
+ "name": "children",
84
+ "type": "React.ReactNode",
85
+ "description": "Content rendered inside the input group text.",
86
+ "required": true
87
+ },
88
+ {
89
+ "name": "className",
90
+ "type": "string",
91
+ "description": "Additional classes added to the input group text."
92
+ },
93
+ {
94
+ "name": "component",
95
+ "type": "React.ReactNode",
96
+ "description": "Component that wraps the input group text.",
97
+ "defaultValue": "'span'"
98
+ },
99
+ {
100
+ "name": "isDisabled",
101
+ "type": "boolean",
102
+ "description": "Flag to indicate if the input group text is disabled."
103
+ },
104
+ {
105
+ "name": "isPlain",
106
+ "type": "boolean",
107
+ "description": "Flag to to indicate if the input group item is plain."
108
+ }
109
+ ]
110
+ }
111
+ ],
112
+ "cssPrefix": [
113
+ "pf-v6-c-input-group"
114
+ ],
115
+ "examples": [
116
+ "Basic",
117
+ "With textarea",
118
+ "With dropdown",
119
+ "With popover",
120
+ "With multiple group siblings"
121
+ ]
122
+ };
123
+ pageData.liveContext = {
124
+ Fragment,
125
+ useRef,
126
+ useState,
127
+ AtIcon,
128
+ DollarSignIcon,
129
+ RhUiQuestionMarkCircleFillIcon
130
+ };
131
+ pageData.examples = {
132
+ 'Basic': props =>
133
+ <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport AtIcon from '@patternfly/react-icons/dist/esm/icons/at-icon';\nimport { InputGroup, InputGroupText, InputGroupItem, TextInput, ValidatedOptions } from '@patternfly/react-core';\n\nexport const InputGroupBasic: React.FunctionComponent = () => (\n <Fragment>\n <InputGroup>\n <InputGroupItem isFill>\n <TextInput id=\"textInput-basic-1\" type=\"email\" aria-label=\"email input field\" />\n </InputGroupItem>\n <InputGroupText id=\"email-example\">@example.com</InputGroupText>\n </InputGroup>\n <br />\n <InputGroup>\n <InputGroupText id=\"username\">\n <AtIcon />\n </InputGroupText>\n <InputGroupItem isFill>\n <TextInput\n validated={ValidatedOptions.error}\n id=\"textInput-basic-2\"\n type=\"email\"\n aria-label=\"Error state username example\"\n />\n </InputGroupItem>\n </InputGroup>\n <br />\n <InputGroup>\n <InputGroupItem isFill>\n <TextInput name=\"textInput-basic-3\" id=\"textInput-basic-3\" type=\"text\" aria-label=\"percentage\" />\n </InputGroupItem>\n <InputGroupText id=\"plain-example\" isPlain>\n %\n </InputGroupText>\n </InputGroup>\n </Fragment>\n);\n","title":"Basic","lang":"ts","className":""}}>
134
+
135
+ </Example>,
136
+ 'With textarea': props =>
137
+ <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport { Button, TextArea, InputGroup, InputGroupItem } from '@patternfly/react-core';\n\nexport const InputGroupWithTextarea: React.FunctionComponent = () => (\n <Fragment>\n <InputGroup>\n <InputGroupItem isFill>\n <TextArea name=\"inputGroup-with-textarea\" id=\"inputGroup-with-textarea\" aria-label=\"textarea with button\" />\n </InputGroupItem>\n <InputGroupItem>\n <Button id=\"textAreaButton2\" variant=\"control\">\n Button\n </Button>\n </InputGroupItem>\n </InputGroup>\n </Fragment>\n);\n","title":"With textarea","lang":"ts","className":""}}>
138
+
139
+ </Example>,
140
+ 'With dropdown': props =>
141
+ <Example {...pageData} {...props} {...{"code":"import { Fragment, useState } from 'react';\nimport {\n Button,\n InputGroup,\n InputGroupItem,\n TextInput,\n Dropdown,\n DropdownList,\n DropdownItem,\n MenuToggle,\n MenuToggleElement\n} from '@patternfly/react-core';\n\nexport const InputGroupWithDropdown: React.FunctionComponent = () => {\n const [isOpen, setIsOpen] = useState<boolean>(false);\n\n const onToggle = () => {\n setIsOpen(!isOpen);\n };\n\n const onSelect = () => {\n setIsOpen(false);\n };\n\n return (\n <Fragment>\n <InputGroup>\n <InputGroupItem>\n <Dropdown\n isOpen={isOpen}\n onSelect={onSelect}\n onOpenChange={(isOpen: boolean) => setIsOpen(isOpen)}\n toggle={(toggleRef: React.Ref<MenuToggleElement>) => (\n <MenuToggle ref={toggleRef} onClick={onToggle} isExpanded={isOpen}>\n Dropdown\n </MenuToggle>\n )}\n >\n <DropdownList>\n <DropdownItem value={0} key=\"option1\">\n Option 1\n </DropdownItem>\n <DropdownItem value={1} key=\"option2\">\n Option 2\n </DropdownItem>\n <DropdownItem value={2} key=\"option3\">\n Option 3\n </DropdownItem>\n </DropdownList>\n </Dropdown>\n </InputGroupItem>\n <InputGroupItem isFill>\n <TextInput id=\"textInput-with-dropdown\" aria-label=\"input with dropdown and button\" />\n </InputGroupItem>\n <InputGroupItem>\n <Button id=\"inputDropdownButton1\" variant=\"control\">\n Button\n </Button>\n </InputGroupItem>\n </InputGroup>\n </Fragment>\n );\n};\n","title":"With dropdown","lang":"ts","className":""}}>
142
+
143
+ </Example>,
144
+ 'With popover': props =>
145
+ <Example {...pageData} {...props} {...{"code":"import { Fragment, useRef } from 'react';\nimport RhUiQuestionMarkCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-question-mark-circle-fill-icon';\nimport { Button, InputGroup, InputGroupItem, TextInput, Popover, PopoverPosition } from '@patternfly/react-core';\n\nexport const InputGroupWithPopover: React.FunctionComponent = () => {\n const inputGroupRef1 = useRef(null);\n const inputGroupRef2 = useRef(null);\n return (\n <Fragment>\n <InputGroup ref={inputGroupRef1}>\n <InputGroupItem isFill>\n <TextInput\n name=\"textInput-with-popover-1\"\n id=\"textInput-with-popover-1\"\n type=\"text\"\n aria-label=\"first input example with popover\"\n />\n </InputGroupItem>\n <InputGroupItem>\n <Popover\n aria-label=\"popover example\"\n position={PopoverPosition.top}\n bodyContent=\"This field is an example of an input group with a popover.\"\n appendTo={() => inputGroupRef1.current}\n >\n <Button variant=\"control\" aria-label=\"popover for input\" icon={<RhUiQuestionMarkCircleFillIcon />} />\n </Popover>\n </InputGroupItem>\n </InputGroup>\n <br />\n <InputGroup ref={inputGroupRef2}>\n <InputGroupItem isFill>\n <TextInput\n name=\"textInput-with-popover-2\"\n id=\"textInput-with-popover-2\"\n type=\"text\"\n aria-label=\"second input example with popover\"\n />\n </InputGroupItem>\n <InputGroupItem>\n <Popover\n aria-label=\"popover example\"\n position={PopoverPosition.top}\n bodyContent=\"This field is an example of an input group with a popover.\"\n appendTo={() => inputGroupRef2.current}\n >\n <Button variant=\"plain\" aria-label=\"Popover for input\" icon={<RhUiQuestionMarkCircleFillIcon />} />\n </Popover>\n </InputGroupItem>\n </InputGroup>\n </Fragment>\n );\n};\n","title":"With popover","lang":"ts","className":""}}>
146
+
147
+ <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
148
+ {`using `}
149
+
150
+ <code {...{"className":"ws-code "}}>
151
+ {`appendTo`}
152
+ </code>
153
+ {` with ref to the `}
154
+
155
+ <code {...{"className":"ws-code "}}>
156
+ {`InputGroup`}
157
+ </code>
158
+ {` for the Popover so that the popover width will depend on the whole input group`}
159
+ </p>
160
+ </Example>,
161
+ 'With multiple group siblings': props =>
162
+ <Example {...pageData} {...props} {...{"code":"import { Fragment } from 'react';\nimport DollarSignIcon from '@patternfly/react-icons/dist/esm/icons/dollar-sign-icon';\nimport { Button, TextArea, InputGroup, InputGroupText, InputGroupItem, TextInput } from '@patternfly/react-core';\n\nexport const InputGroupWithSiblings: React.FunctionComponent = () => (\n <Fragment>\n <InputGroup>\n <InputGroupItem>\n <Button id=\"textAreaButton1\" variant=\"control\">\n Button\n </Button>\n </InputGroupItem>\n <InputGroupItem isFill>\n <TextArea name=\"textarea1\" id=\"textarea1\" aria-label=\"textarea with buttons\" />\n </InputGroupItem>\n <InputGroupItem>\n <Button variant=\"control\">Button</Button>\n </InputGroupItem>\n </InputGroup>\n <br />\n <InputGroup>\n <InputGroupItem>\n <Button id=\"textAreaButton3\" variant=\"control\">\n Button\n </Button>\n </InputGroupItem>\n <InputGroupItem>\n <Button variant=\"control\">Button</Button>\n </InputGroupItem>\n <InputGroupItem isFill>\n <TextArea name=\"textarea2\" id=\"textarea2\" aria-label=\"textarea with 3 buttons\" />\n </InputGroupItem>\n <InputGroupItem>\n <Button variant=\"control\">Button</Button>\n </InputGroupItem>\n </InputGroup>\n <br />\n <InputGroup>\n <InputGroupText>\n <DollarSignIcon />\n </InputGroupText>\n <InputGroupItem isFill>\n <TextInput\n id=\"textInput-with-siblings\"\n name=\"textInput-with-siblings\"\n type=\"number\"\n aria-label=\"Dollar amount input example\"\n />\n </InputGroupItem>\n <InputGroupText>.00</InputGroupText>\n </InputGroup>\n </Fragment>\n);\n","title":"With multiple group siblings","lang":"ts","className":""}}>
163
+
164
+ </Example>
165
+ };
166
+
167
+ const Component = () => (
168
+ <React.Fragment>
169
+ <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
170
+ {`Examples`}
171
+ </AutoLinkHeader>
172
+ {React.createElement(pageData.examples["Basic"])}
173
+ {React.createElement(pageData.examples["With textarea"])}
174
+ {React.createElement(pageData.examples["With dropdown"])}
175
+ {React.createElement(pageData.examples["With popover"])}
176
+ {React.createElement(pageData.examples["With multiple group siblings"])}
177
+ </React.Fragment>
178
+ );
179
+ Component.displayName = 'ComponentsInputGroupReactDocs';
180
+ Component.pageData = pageData;
181
+
182
+ export default Component;
@@ -0,0 +1,154 @@
1
+ import React from 'react';
2
+ import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
+ import { useContext, useEffect, useRef, useState } from 'react';
4
+ import mastheadStyles from '@patternfly/react-styles/css/components/Masthead/masthead';
5
+ import breadcrumbStyles from '@patternfly/react-styles/css/components/Breadcrumb/breadcrumb';
6
+ import { DashboardWrapper } from '@patternfly/react-core/dist/js/demos/DashboardWrapper';
7
+ import srcImportscrollspywithsubsections from './react-demos/scrollspy-with-subsections.png';
8
+ import srcImportwithdrawer from './react-demos/with-drawer.png';
9
+ const pageData = {
10
+ "id": "Jump links",
11
+ "section": "components",
12
+ "subsection": "",
13
+ "deprecated": false,
14
+ "template": false,
15
+ "beta": false,
16
+ "demo": false,
17
+ "newImplementationLink": false,
18
+ "source": "react-demos",
19
+ "tabName": null,
20
+ "slug": "/components/jump-links/react-demos",
21
+ "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/demos/JumpLinks.md",
22
+ "relPath": "packages/react-core/src/demos/JumpLinks.md",
23
+ "fullscreenExamples": [
24
+ "Scrollspy with subsections",
25
+ "With drawer"
26
+ ]
27
+ };
28
+ pageData.liveContext = {
29
+ useContext,
30
+ useEffect,
31
+ useRef,
32
+ useState,
33
+ mastheadStyles,
34
+ breadcrumbStyles,
35
+ DashboardWrapper
36
+ };
37
+ pageData.examples = {
38
+ 'Scrollspy with subsections': props =>
39
+ <Example {...pageData} {...props} thumbnail={srcImportscrollspywithsubsections} {...{"code":"import { useEffect, useState } from 'react';\nimport {\n PageSection,\n JumpLinks,\n JumpLinksItem,\n JumpLinksList,\n Sidebar,\n SidebarContent,\n SidebarPanel,\n Switch,\n Title,\n Content,\n getResizeObserver\n} from '@patternfly/react-core';\nimport { DashboardWrapper } from '@patternfly/react-core/dist/js/demos/DashboardWrapper';\nimport mastheadStyles from '@patternfly/react-styles/css/components/Masthead/masthead';\n\nexport const JumpLinksScrollspy: React.FunctionComponent = () => {\n const headings = [1, 2, 3, 4, 5];\n\n const [isVertical, setIsVertical] = useState(true);\n const [offsetHeight, setOffsetHeight] = useState(10);\n const offsetForPadding = 10;\n\n // Update offset based on the masthead and jump links nav heights.\n useEffect(() => {\n const masthead = document.getElementsByClassName(mastheadStyles.masthead)[0];\n\n if (isVertical) {\n setOffsetHeight(masthead.offsetHeight + offsetForPadding);\n } else {\n // Append jump links nav height to the masthead height when value exists.\n const jumpLinksHeaderHeight = document.getElementsByClassName('pf-m-sticky')[0].offsetHeight;\n jumpLinksHeaderHeight && setOffsetHeight(masthead.offsetHeight + jumpLinksHeaderHeight + offsetForPadding);\n }\n\n const observer = getResizeObserver(\n document.getElementsByClassName(mastheadStyles.masthead)[0],\n () => {\n if (isVertical) {\n setOffsetHeight(masthead.offsetHeight + offsetForPadding);\n } else {\n // Append jump links nav height to the masthead height when value exists.\n const jumpLinksHeaderHeight = document.getElementsByClassName('pf-m-sticky')[0].offsetHeight;\n jumpLinksHeaderHeight && setOffsetHeight(masthead.offsetHeight + jumpLinksHeaderHeight + offsetForPadding);\n }\n },\n true\n );\n\n return () => observer();\n }, [isVertical]);\n\n return (\n <DashboardWrapper breadcrumb={null} mainContainerId=\"scrollable-element\">\n <PageSection aria-labelledby=\"main-title\">\n <Title headingLevel=\"h1\" size=\"2xl\" id=\"main-title\">\n Main title\n </Title>\n <Switch\n id=\"is-vertical\"\n label=\"Vertical jump links\"\n isChecked={isVertical}\n onChange={(_event, check) => setIsVertical(check)}\n />\n </PageSection>\n <PageSection padding={{ default: 'noPadding' }}>\n <Sidebar hasGutter orientation={!isVertical && 'stack'}>\n <SidebarPanel variant=\"sticky\">\n <PageSection aria-label=\"Jump links navigation\">\n <JumpLinks\n isVertical={isVertical}\n isCentered={!isVertical}\n label=\"Jump to section\"\n scrollableSelector=\".pf-v6-c-page__main-container\"\n offset={offsetHeight}\n expandable={{ default: isVertical ? 'expandable' : 'nonExpandable', md: 'nonExpandable' }}\n isExpanded\n >\n {headings.map((i) => (\n <JumpLinksItem key={i} href={`#heading-${i}`}>\n {`Heading ${i}`}\n <JumpLinksList></JumpLinksList>\n </JumpLinksItem>\n ))}\n </JumpLinks>\n </PageSection>\n </SidebarPanel>\n <SidebarContent hasNoBackground>\n <PageSection aria-label=\"Main content\">\n <Content>\n {headings.map((i) => (\n <div key={i} style={{ maxWidth: '800px', marginBottom: '32px' }}>\n <h2 id={`heading-${i}`} tabIndex={-1}>\n {`Heading ${i}`}\n </h2>\n <p>\n Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut\n labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris\n nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit\n esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt\n in culpa qui officia deserunt mollit anim id est laborum.\n </p>\n <br />\n <p>\n At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum\n deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non\n provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum\n fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta\n nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus,\n omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis\n debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non\n recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus\n maiores alias consequatur aut perferendis doloribus asperiores repellat.\n </p>\n </div>\n ))}\n </Content>\n </PageSection>\n </SidebarContent>\n </Sidebar>\n </PageSection>\n </DashboardWrapper>\n );\n};\n","title":"Scrollspy with subsections","lang":"ts","isFullscreen":true,"className":""}}>
40
+
41
+ <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
42
+ {`This demo expands on the previous to show the JumpLinks in a vertical layout with subsections. It scrolls the `}
43
+
44
+ <PatternflyThemeLink {...{"to":"/components/page","className":""}}>
45
+ {`Page`}
46
+ </PatternflyThemeLink>
47
+ {`'s `}
48
+
49
+ <code {...{"className":"ws-code "}}>
50
+ {`mainContainerId`}
51
+ </code>
52
+ {` with an `}
53
+
54
+ <code {...{"className":"ws-code "}}>
55
+ {`offset`}
56
+ </code>
57
+ {` calculated based on the height of the masthead and the nav list when it appears above the content. The headings are given a tab index to allow the jump links to focus on them.`}
58
+ </p>
59
+ </Example>,
60
+ 'With drawer': props =>
61
+ <Example {...pageData} {...props} thumbnail={srcImportwithdrawer} {...{"code":"import { useContext, useRef, useState } from 'react';\nimport {\n Button,\n Content,\n Drawer,\n DrawerPanelContent,\n DrawerContent,\n DrawerContentBody,\n DrawerHead,\n DrawerActions,\n DrawerCloseButton,\n JumpLinks,\n JumpLinksItem,\n JumpLinksList,\n PageSection,\n Sidebar,\n SidebarContent,\n SidebarPanel,\n DrawerContext\n} from '@patternfly/react-core';\nimport { DashboardWrapper } from '@patternfly/react-core/dist/js/demos/DashboardWrapper';\n\nconst JumpLinksWrapper = ({ headings }) => {\n const { drawerContentRef } = useContext(DrawerContext);\n\n return (\n <JumpLinks\n isVertical={true}\n label=\"Jump to section\"\n scrollableRef={drawerContentRef}\n expandable={{ default: 'expandable', md: 'nonExpandable' }}\n >\n {headings.map((heading) => (\n <JumpLinksItem key={heading} href={`#jump-links-drawer-jump-links-${heading.toLowerCase()}`}>\n {`${heading} section`}\n <JumpLinksList></JumpLinksList>\n </JumpLinksItem>\n ))}\n </JumpLinks>\n );\n};\n\nexport const JumpLinksWithDrawer: React.FunctionComponent = () => {\n const headings = ['First', 'Second', 'Third', 'Fourth', 'Fifth'];\n\n const [isExpanded, setIsExpanded] = useState(false);\n const drawerRef = useRef(undefined);\n\n const onCloseClick = () => {\n setIsExpanded(false);\n };\n\n const onToggleClick = () => {\n setIsExpanded(!isExpanded);\n };\n\n const panelContent = (\n <DrawerPanelContent>\n <DrawerHead>\n <span tabIndex={isExpanded ? 0 : -1} ref={drawerRef}>\n drawer-panel\n </span>\n <DrawerActions>\n <DrawerCloseButton onClick={onCloseClick} />\n </DrawerActions>\n </DrawerHead>\n </DrawerPanelContent>\n );\n\n return (\n <DashboardWrapper breadcrumb={null} mainContainerId=\"scrollable-element\">\n <Drawer isExpanded={isExpanded}>\n <DrawerContent panelContent={panelContent}>\n <DrawerContentBody>\n <Sidebar>\n <SidebarPanel variant=\"sticky\">\n <PageSection>\n <JumpLinksWrapper headings={headings} />\n </PageSection>\n </SidebarPanel>\n <SidebarContent>\n <PageSection id=\"drawer-toggle\" stickyOnBreakpoint={{ default: 'top' }}>\n <Button onClick={onToggleClick}>Toggle drawer</Button>\n </PageSection>\n <PageSection hasOverflowScroll>\n <Content>\n {headings.map((heading) => (\n <div key={heading} style={{ maxWidth: '800px', marginBottom: '32px' }}>\n <h2 id={`jump-links-drawer-jump-links-${heading.toLowerCase()}`} tabIndex={-1}>\n {`${heading} section`}\n </h2>\n <p>\n Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas sed dui ullamcorper,\n dignissim purus eu, mattis leo. Curabitur eleifend turpis ipsum, aliquam pretium risus\n efficitur vel. Etiam eget enim vitae quam facilisis pharetra at eget diam. Suspendisse ut\n vulputate magna. Nunc viverra posuere orci sit amet pulvinar. Quisque dui justo, egestas ac\n accumsan suscipit, tristique eu risus. In aliquet libero ante, ac pulvinar lectus pretium in.\n Ut enim tellus, vulputate et lorem et, hendrerit rutrum diam. Cras pharetra dapibus elit vitae\n ullamcorper. Nulla facilisis euismod diam, at sodales sem laoreet hendrerit. Curabitur\n porttitor ex nulla. Proin ligula leo, egestas ac nibh a, pellentesque mollis augue. Donec nec\n augue vehicula eros pulvinar vehicula eget rutrum neque. Duis sit amet interdum lorem. Vivamus\n porttitor nec quam a accumsan. Nam pretium vitae leo vitae rhoncus.\n </p>\n <p>\n At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium\n voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati\n cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est\n laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero\n tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime\n placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus\n autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et\n voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a\n sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis\n doloribus asperiores repellat.\n </p>\n </div>\n ))}\n </Content>\n </PageSection>\n </SidebarContent>\n </Sidebar>\n </DrawerContentBody>\n </DrawerContent>\n </Drawer>\n </DashboardWrapper>\n );\n};\n","title":"With drawer","lang":"ts","isFullscreen":true,"className":""}}>
62
+
63
+ <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
64
+ {`This demo shows how jump links can be used in combination with a drawer.`}
65
+ </p>
66
+
67
+ <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
68
+ {`This demo uses a `}
69
+
70
+ <code {...{"className":"ws-code "}}>
71
+ {`scrollableRef`}
72
+ </code>
73
+ {` prop on the JumpLinks component, which is a React ref to the `}
74
+
75
+ <code {...{"className":"ws-code "}}>
76
+ {`DrawerContent`}
77
+ </code>
78
+ {` component.`}
79
+ </p>
80
+ </Example>
81
+ };
82
+
83
+ const Component = () => (
84
+ <React.Fragment>
85
+ <AutoLinkHeader {...{"id":"demos","headingLevel":"h2","className":"ws-title ws-h2"}}>
86
+ {`Demos`}
87
+ </AutoLinkHeader>
88
+ <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
89
+ {`JumpLinks has a scrollspy built-in to make your implementation easier. When implementing JumpLinks be sure to:`}
90
+ </p>
91
+ <ol {...{"className":"pf-v6-c-content--ol pf-m-editorial ws-ol "}}>
92
+ <li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
93
+ {`Find the correct scrollable element for your page via `}
94
+ <PatternflyThemeLink {...{"to":"https://developer.mozilla.org/en-US/docs/Tools/Page_Inspector/How_to/Debug_Scrollable_Overflow","className":""}}>
95
+ {`Firefox's debugging scrollable overflow`}
96
+ </PatternflyThemeLink>
97
+ {` or by adding `}
98
+ <code {...{"className":"ws-code "}}>
99
+ {`hasOverflowScroll`}
100
+ </code>
101
+ {` to a `}
102
+ <PatternflyThemeLink {...{"to":"/components/page#pagesection","className":""}}>
103
+ {`PageSection`}
104
+ </PatternflyThemeLink>
105
+ {` or `}
106
+ <PatternflyThemeLink {...{"to":"/components/page#pagegroup","className":""}}>
107
+ {`PageGroup`}
108
+ </PatternflyThemeLink>
109
+ {`.`}
110
+ <ul {...{"className":"pf-v6-c-content--ul pf-m-editorial ws-ul "}}>
111
+ <li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
112
+ {`If you add `}
113
+ <code {...{"className":"ws-code "}}>
114
+ {`hasOverflowScroll`}
115
+ </code>
116
+ {` to a Page sub-component you should also add a relevant aria-label to that component as well.`}
117
+ </li>
118
+ </ul>
119
+ </li>
120
+ <li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
121
+ {`Provide a reference to the scrollable element to `}
122
+ <code {...{"className":"ws-code "}}>
123
+ {`scrollableRef`}
124
+ </code>
125
+ {` prop or a CSS selector of the scrollable element to `}
126
+ <code {...{"className":"ws-code "}}>
127
+ {`scrollableSelector`}
128
+ </code>
129
+ {` prop.`}
130
+ </li>
131
+ <li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
132
+ {`Provide `}
133
+ <code {...{"className":"ws-code "}}>
134
+ {`href`}
135
+ </code>
136
+ {`s to your JumpLinksItems which match the `}
137
+ <code {...{"className":"ws-code "}}>
138
+ {`id`}
139
+ </code>
140
+ {` of elements you want to spy on. If you wish to scroll to a different item than you're linking to use the `}
141
+ <code {...{"className":"ws-code "}}>
142
+ {`node`}
143
+ </code>
144
+ {` prop.`}
145
+ </li>
146
+ </ol>
147
+ {React.createElement(pageData.examples["Scrollspy with subsections"])}
148
+ {React.createElement(pageData.examples["With drawer"])}
149
+ </React.Fragment>
150
+ );
151
+ Component.displayName = 'ComponentsJumpLinksReactDemosDocs';
152
+ Component.pageData = pageData;
153
+
154
+ export default Component;
@@ -0,0 +1,212 @@
1
+ import React from 'react';
2
+ import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3
+
4
+ const pageData = {
5
+ "id": "Jump links",
6
+ "section": "components",
7
+ "subsection": "",
8
+ "deprecated": false,
9
+ "template": false,
10
+ "beta": false,
11
+ "demo": false,
12
+ "newImplementationLink": false,
13
+ "source": "react",
14
+ "tabName": null,
15
+ "slug": "/components/jump-links/react",
16
+ "sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/JumpLinks/examples/JumpLinks.md",
17
+ "relPath": "packages/react-core/src/components/JumpLinks/examples/JumpLinks.md",
18
+ "propComponents": [
19
+ {
20
+ "name": "JumpLinks",
21
+ "description": "",
22
+ "props": [
23
+ {
24
+ "name": "activeIndex",
25
+ "type": "number",
26
+ "description": "The index of the child Jump link to make active.",
27
+ "defaultValue": "0"
28
+ },
29
+ {
30
+ "name": "alwaysShowLabel",
31
+ "type": "boolean",
32
+ "description": "Flag to always show the label when using `expandable`",
33
+ "defaultValue": "true"
34
+ },
35
+ {
36
+ "name": "aria-label",
37
+ "type": "string",
38
+ "description": "Adds an accessible label to the internal nav element. Defaults to the value of the label prop.",
39
+ "defaultValue": "typeof label === 'string' ? label : null"
40
+ },
41
+ {
42
+ "name": "children",
43
+ "type": "React.ReactNode",
44
+ "description": "Children nodes"
45
+ },
46
+ {
47
+ "name": "className",
48
+ "type": "string",
49
+ "description": "Class for nav"
50
+ },
51
+ {
52
+ "name": "expandable",
53
+ "type": "{\n default?: 'expandable' | 'nonExpandable';\n sm?: 'expandable' | 'nonExpandable';\n md?: 'expandable' | 'nonExpandable';\n lg?: 'expandable' | 'nonExpandable';\n xl?: 'expandable' | 'nonExpandable';\n '2xl'?: 'expandable' | 'nonExpandable';\n}",
54
+ "description": "When to collapse/expand at different breakpoints"
55
+ },
56
+ {
57
+ "name": "isCentered",
58
+ "type": "boolean",
59
+ "description": "Whether to center children."
60
+ },
61
+ {
62
+ "name": "isExpanded",
63
+ "type": "boolean",
64
+ "description": "On mobile whether or not the JumpLinks starts out expanded",
65
+ "defaultValue": "false"
66
+ },
67
+ {
68
+ "name": "isVertical",
69
+ "type": "boolean",
70
+ "description": "Whether the layout of children is vertical or horizontal."
71
+ },
72
+ {
73
+ "name": "label",
74
+ "type": "React.ReactNode",
75
+ "description": "Label to add to nav element."
76
+ },
77
+ {
78
+ "name": "labelId",
79
+ "type": "string",
80
+ "description": "Custom ID applied to label if alwaysShowLabel is applied, or expandable toggle. This is used for internal logic related to aria-label and aria-labelledby"
81
+ },
82
+ {
83
+ "name": "offset",
84
+ "type": "number",
85
+ "description": "Offset to add to `scrollPosition`, potentially for a masthead which content scrolls under.",
86
+ "defaultValue": "0"
87
+ },
88
+ {
89
+ "name": "scrollableRef",
90
+ "type": "HTMLElement | (() => HTMLElement) | React.RefObject<HTMLElement | null>",
91
+ "description": "Reference to the scrollable element to spy on. Takes precedence over scrollableSelector. Not passing a scrollableRef or scrollableSelector disables spying."
92
+ },
93
+ {
94
+ "name": "scrollableSelector",
95
+ "type": "string",
96
+ "description": "Selector for the scrollable element to spy on. Not passing a scrollableSelector or scrollableRef disables spying."
97
+ },
98
+ {
99
+ "name": "shouldReplaceNavHistory",
100
+ "type": "boolean",
101
+ "description": "Whether the current entry in the navigation history should be replaced when a JumpLinksItem is clicked. By default a new entry will be pushed to the navigation history.",
102
+ "defaultValue": "false"
103
+ },
104
+ {
105
+ "name": "toggleAriaLabel",
106
+ "type": "string",
107
+ "description": "Aria label for expandable toggle",
108
+ "defaultValue": "'Toggle jump links'"
109
+ }
110
+ ]
111
+ },
112
+ {
113
+ "name": "JumpLinksItem",
114
+ "description": "",
115
+ "props": [
116
+ {
117
+ "name": "children",
118
+ "type": "React.ReactNode",
119
+ "description": "Text to be rendered inside span"
120
+ },
121
+ {
122
+ "name": "className",
123
+ "type": "string",
124
+ "description": "Class to add to li"
125
+ },
126
+ {
127
+ "name": "href",
128
+ "type": "string",
129
+ "description": "Href for this link",
130
+ "required": true
131
+ },
132
+ {
133
+ "name": "isActive",
134
+ "type": "boolean",
135
+ "description": "Whether this item is active. Parent JumpLinks component sets this when passed a `scrollableSelector`."
136
+ },
137
+ {
138
+ "name": "node",
139
+ "type": "string | HTMLElement",
140
+ "description": "Selector or HTMLElement to spy on"
141
+ },
142
+ {
143
+ "name": "onClick",
144
+ "type": "(ev: React.MouseEvent) => void",
145
+ "description": "Click handler for anchor tag. Parent JumpLinks components tap into this."
146
+ }
147
+ ]
148
+ }
149
+ ],
150
+ "cssPrefix": [
151
+ "pf-v6-c-jump-links"
152
+ ],
153
+ "examples": [
154
+ "Basic",
155
+ "With centered list",
156
+ "With label",
157
+ "Vertical",
158
+ "Vertical with label",
159
+ "Expandable vertical with subsection"
160
+ ]
161
+ };
162
+ pageData.examples = {
163
+ 'Basic': props =>
164
+ <Example {...pageData} {...props} {...{"code":"import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';\n\nexport const JumpLinksBasic: React.FunctionComponent = () => (\n <JumpLinks aria-label=\"Jump to basic example sections\">\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\" isActive>\n Active section\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n);\n","title":"Basic","lang":"ts","className":""}}>
165
+
166
+ </Example>,
167
+ 'With centered list': props =>
168
+ <Example {...pageData} {...props} {...{"code":"import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';\n\nexport const JumpLinksWithCenteredList: React.FunctionComponent = () => (\n <JumpLinks isCentered aria-label=\"Jump to centered example sections\">\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\" isActive>\n Active section\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n);\n","title":"With centered list","lang":"ts","className":""}}>
169
+
170
+ </Example>,
171
+ 'With label': props =>
172
+ <Example {...pageData} {...props} {...{"code":"import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';\n\nexport const JumpLinksWithLabel: React.FunctionComponent = () => (\n <>\n <JumpLinks label=\"Jump to first section in jump links with label example\">\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\" isActive>\n Active section\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n <JumpLinks isCentered label=\"Jump to second section in jump links with label example\">\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\" isActive>\n Active section\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n </>\n);\n","title":"With label","lang":"ts","className":""}}>
173
+
174
+ </Example>,
175
+ 'Vertical': props =>
176
+ <Example {...pageData} {...props} {...{"code":"import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';\n\nexport const JumpLinksVertical: React.FunctionComponent = () => (\n <JumpLinks isVertical aria-label=\"Jump to vertical example sections\">\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\" isActive>\n Active section\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n);\n","title":"Vertical","lang":"ts","className":""}}>
177
+
178
+ </Example>,
179
+ 'Vertical with label': props =>
180
+ <Example {...pageData} {...props} {...{"code":"import { JumpLinks, JumpLinksItem } from '@patternfly/react-core';\n\nexport const JumpLinksVerticalWithLabel: React.FunctionComponent = () => (\n <JumpLinks isVertical label=\"Jump to vertical example sections with labels\">\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\" isActive>\n Active section\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n);\n","title":"Vertical with label","lang":"ts","className":""}}>
181
+
182
+ </Example>,
183
+ 'Expandable vertical with subsection': props =>
184
+ <Example {...pageData} {...props} {...{"code":"import { JumpLinks, JumpLinksItem, JumpLinksList } from '@patternfly/react-core';\n\nexport const JumpLinksExpandableVerticalWithSubsection: React.FunctionComponent = () => (\n <JumpLinks isVertical label=\"Jump to expandable vertical section\" expandable={{ default: 'expandable' }}>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\">\n Section with active subsection\n <JumpLinksList aria-label=\"Expandable vertical section subsection\">\n <JumpLinksItem href=\"#\" isActive>\n Active subsection\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive subsection</JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive subsection</JumpLinksItem>\n </JumpLinksList>\n </JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n <JumpLinksItem href=\"#\">Inactive section</JumpLinksItem>\n </JumpLinks>\n);\n","title":"Expandable vertical with subsection","lang":"ts","className":""}}>
185
+
186
+ </Example>
187
+ };
188
+
189
+ const Component = () => (
190
+ <React.Fragment>
191
+ <AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
192
+ {`Examples`}
193
+ </AutoLinkHeader>
194
+ <p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
195
+ {`These examples are static because they have no element to scroll spy on that makes sense. Check out the `}
196
+ <PatternflyThemeLink {...{"to":"./react-demos","className":""}}>
197
+ {`React demos`}
198
+ </PatternflyThemeLink>
199
+ {` to see scroll spying in action!`}
200
+ </p>
201
+ {React.createElement(pageData.examples["Basic"])}
202
+ {React.createElement(pageData.examples["With centered list"])}
203
+ {React.createElement(pageData.examples["With label"])}
204
+ {React.createElement(pageData.examples["Vertical"])}
205
+ {React.createElement(pageData.examples["Vertical with label"])}
206
+ {React.createElement(pageData.examples["Expandable vertical with subsection"])}
207
+ </React.Fragment>
208
+ );
209
+ Component.displayName = 'ComponentsJumpLinksReactDocs';
210
+ Component.pageData = pageData;
211
+
212
+ export default Component;