@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.
- package/CHANGELOG.md +6 -0
- package/LICENSE +21 -0
- package/package.json +12 -11
- package/patternfly-docs/generated/components/about-modal/react.js +0 -149
- package/patternfly-docs/generated/components/accordion/react.js +0 -262
- package/patternfly-docs/generated/components/action-list/react.js +0 -144
- package/patternfly-docs/generated/components/alert/react-demos.js +0 -56
- package/patternfly-docs/generated/components/alert/react.js +0 -1433
- package/patternfly-docs/generated/components/avatar/react.js +0 -166
- package/patternfly-docs/generated/components/back-to-top/react-demos.js +0 -60
- package/patternfly-docs/generated/components/back-to-top/react.js +0 -77
- package/patternfly-docs/generated/components/backdrop/react.js +0 -64
- package/patternfly-docs/generated/components/background-image/react.js +0 -62
- package/patternfly-docs/generated/components/badge/react.js +0 -97
- package/patternfly-docs/generated/components/banner/react-demos.js +0 -57
- package/patternfly-docs/generated/components/banner/react.js +0 -148
- package/patternfly-docs/generated/components/brand/react.js +0 -142
- package/patternfly-docs/generated/components/breadcrumb/react.js +0 -206
- package/patternfly-docs/generated/components/button/react-demos.js +0 -57
- package/patternfly-docs/generated/components/button/react.js +0 -826
- package/patternfly-docs/generated/components/card/react-demos.js +0 -201
- package/patternfly-docs/generated/components/card/react.js +0 -1015
- package/patternfly-docs/generated/components/charts/area-chart/-Victory.js +0 -1350
- package/patternfly-docs/generated/components/charts/bar-chart/-Victory.js +0 -1334
- package/patternfly-docs/generated/components/charts/box-plot-chart/-Victory.js +0 -1282
- package/patternfly-docs/generated/components/charts/bullet-chart/-Victory.js +0 -848
- package/patternfly-docs/generated/components/charts/colors-for-charts/-Victory.js +0 -192
- package/patternfly-docs/generated/components/charts/donut-chart/-Victory.js +0 -426
- package/patternfly-docs/generated/components/charts/donut-utilization-chart/-Victory.js +0 -804
- package/patternfly-docs/generated/components/charts/legends/-Victory.js +0 -3230
- package/patternfly-docs/generated/components/charts/line-chart/-Victory.js +0 -1178
- package/patternfly-docs/generated/components/charts/line-chart/ECharts.js +0 -525
- package/patternfly-docs/generated/components/charts/patterns/-Victory.js +0 -3382
- package/patternfly-docs/generated/components/charts/pie-chart/-Victory.js +0 -377
- package/patternfly-docs/generated/components/charts/resize-observer/-Victory.js +0 -2475
- package/patternfly-docs/generated/components/charts/sankey-chart/ECharts.js +0 -538
- package/patternfly-docs/generated/components/charts/scatter-chart/-Victory.js +0 -1551
- package/patternfly-docs/generated/components/charts/skeletons/-Victory.js +0 -4115
- package/patternfly-docs/generated/components/charts/sparkline-chart/-Victory.js +0 -955
- package/patternfly-docs/generated/components/charts/stack-chart/-Victory.js +0 -1173
- package/patternfly-docs/generated/components/charts/threshold-chart/-Victory.js +0 -1166
- package/patternfly-docs/generated/components/charts/tooltips/-Victory.js +0 -413
- package/patternfly-docs/generated/components/chip/react-deprecated.js +0 -323
- package/patternfly-docs/generated/components/clipboard-copy/react.js +0 -373
- package/patternfly-docs/generated/components/code-block/react.js +0 -148
- package/patternfly-docs/generated/components/code-editor/react.js +0 -659
- package/patternfly-docs/generated/components/compass/react-demos.js +0 -147
- package/patternfly-docs/generated/components/compass/react.js +0 -440
- package/patternfly-docs/generated/components/content/react.js +0 -248
- package/patternfly-docs/generated/components/data-list/react-demos.js +0 -90
- package/patternfly-docs/generated/components/data-list/react.js +0 -709
- package/patternfly-docs/generated/components/date-and-time/calendar-month/react.js +0 -283
- package/patternfly-docs/generated/components/date-and-time/date-and-time-picker/react-demos.js +0 -64
- package/patternfly-docs/generated/components/date-and-time/date-picker/react-demos.js +0 -83
- package/patternfly-docs/generated/components/date-and-time/date-picker/react.js +0 -395
- package/patternfly-docs/generated/components/date-and-time/time-picker/react.js +0 -241
- package/patternfly-docs/generated/components/description-list/react-demos.js +0 -58
- package/patternfly-docs/generated/components/description-list/react.js +0 -743
- package/patternfly-docs/generated/components/divider/react.js +0 -126
- package/patternfly-docs/generated/components/drag-and-drop/react-demos.js +0 -351
- package/patternfly-docs/generated/components/drag-and-drop/react-deprecated.js +0 -184
- package/patternfly-docs/generated/components/drag-and-drop/react.js +0 -137
- package/patternfly-docs/generated/components/drawer/react.js +0 -598
- package/patternfly-docs/generated/components/dual-list-selector/react-deprecated.js +0 -772
- package/patternfly-docs/generated/components/dual-list-selector/react.js +0 -594
- package/patternfly-docs/generated/components/empty-state/react.js +0 -199
- package/patternfly-docs/generated/components/expandable-section/react-demos.js +0 -65
- package/patternfly-docs/generated/components/expandable-section/react.js +0 -408
- package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react-demos.js +0 -52
- package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react.js +0 -398
- package/patternfly-docs/generated/components/file-upload/simple-file-upload/react.js +0 -749
- package/patternfly-docs/generated/components/forms/checkbox/react.js +0 -222
- package/patternfly-docs/generated/components/forms/form/react.js +0 -1106
- package/patternfly-docs/generated/components/forms/form-select/react.js +0 -208
- package/patternfly-docs/generated/components/forms/radio/react.js +0 -212
- package/patternfly-docs/generated/components/forms/text-area/react.js +0 -160
- package/patternfly-docs/generated/components/forms/text-input/react.js +0 -216
- package/patternfly-docs/generated/components/helper-text/react-demos.js +0 -180
- package/patternfly-docs/generated/components/helper-text/react.js +0 -164
- package/patternfly-docs/generated/components/hero/react.js +0 -88
- package/patternfly-docs/generated/components/hint/react.js +0 -169
- package/patternfly-docs/generated/components/icon/react.js +0 -215
- package/patternfly-docs/generated/components/input-group/react.js +0 -182
- package/patternfly-docs/generated/components/jump-links/react-demos.js +0 -154
- package/patternfly-docs/generated/components/jump-links/react.js +0 -212
- package/patternfly-docs/generated/components/label/react-demos.js +0 -57
- package/patternfly-docs/generated/components/label/react.js +0 -417
- package/patternfly-docs/generated/components/list/react.js +0 -175
- package/patternfly-docs/generated/components/login-page/react.js +0 -587
- package/patternfly-docs/generated/components/masthead/react-demos.js +0 -79
- package/patternfly-docs/generated/components/masthead/react.js +0 -291
- package/patternfly-docs/generated/components/menus/application-launcher/react-demos.js +0 -769
- package/patternfly-docs/generated/components/menus/context-selector/react-demos.js +0 -665
- package/patternfly-docs/generated/components/menus/custom-menus/react-demos.js +0 -187
- package/patternfly-docs/generated/components/menus/dropdown/react-templates.js +0 -163
- package/patternfly-docs/generated/components/menus/dropdown/react.js +0 -998
- package/patternfly-docs/generated/components/menus/menu/react.js +0 -1540
- package/patternfly-docs/generated/components/menus/menu-toggle/react.js +0 -747
- package/patternfly-docs/generated/components/menus/options-menu/react-demos.js +0 -508
- package/patternfly-docs/generated/components/menus/select/react-templates.js +0 -257
- package/patternfly-docs/generated/components/menus/select/react.js +0 -998
- package/patternfly-docs/generated/components/modal/react-deprecated.js +0 -554
- package/patternfly-docs/generated/components/modal/react.js +0 -597
- package/patternfly-docs/generated/components/navigation/react-demos.js +0 -356
- package/patternfly-docs/generated/components/navigation/react.js +0 -409
- package/patternfly-docs/generated/components/notification-badge/react.js +0 -196
- package/patternfly-docs/generated/components/notification-drawer/react-demos.js +0 -107
- package/patternfly-docs/generated/components/notification-drawer/react.js +0 -394
- package/patternfly-docs/generated/components/number-input/react.js +0 -210
- package/patternfly-docs/generated/components/overflow-menu/react.js +0 -274
- package/patternfly-docs/generated/components/page/react-demos.js +0 -149
- package/patternfly-docs/generated/components/page/react.js +0 -1352
- package/patternfly-docs/generated/components/pagination/react.js +0 -492
- package/patternfly-docs/generated/components/panel/react.js +0 -236
- package/patternfly-docs/generated/components/popover/react.js +0 -390
- package/patternfly-docs/generated/components/progress/react-demos.js +0 -59
- package/patternfly-docs/generated/components/progress/react.js +0 -283
- package/patternfly-docs/generated/components/progress-stepper/react-demos.js +0 -45
- package/patternfly-docs/generated/components/progress-stepper/react.js +0 -219
- package/patternfly-docs/generated/components/search-input/react-demos.js +0 -113
- package/patternfly-docs/generated/components/search-input/react.js +0 -263
- package/patternfly-docs/generated/components/sidebar/react.js +0 -236
- package/patternfly-docs/generated/components/simple-list/react.js +0 -200
- package/patternfly-docs/generated/components/skeleton/react-demos.js +0 -44
- package/patternfly-docs/generated/components/skeleton/react.js +0 -122
- package/patternfly-docs/generated/components/skip-to-content/react.js +0 -73
- package/patternfly-docs/generated/components/slider/react.js +0 -309
- package/patternfly-docs/generated/components/spinner/react.js +0 -111
- package/patternfly-docs/generated/components/switch/react.js +0 -163
- package/patternfly-docs/generated/components/table/react-demos.js +0 -355
- package/patternfly-docs/generated/components/table/react-deprecated.js +0 -1350
- package/patternfly-docs/generated/components/table/react.js +0 -3241
- package/patternfly-docs/generated/components/tabs/react-demos.js +0 -108
- package/patternfly-docs/generated/components/tabs/react.js +0 -1359
- package/patternfly-docs/generated/components/text-input-group/react-demos.js +0 -152
- package/patternfly-docs/generated/components/text-input-group/react.js +0 -278
- package/patternfly-docs/generated/components/tile/react-deprecated.js +0 -242
- package/patternfly-docs/generated/components/timestamp/react.js +0 -283
- package/patternfly-docs/generated/components/title/react.js +0 -94
- package/patternfly-docs/generated/components/toggle-group/react.js +0 -299
- package/patternfly-docs/generated/components/toolbar/react-demos.js +0 -66
- package/patternfly-docs/generated/components/toolbar/react.js +0 -932
- package/patternfly-docs/generated/components/tooltip/react.js +0 -241
- package/patternfly-docs/generated/components/tree-view/react.js +0 -429
- package/patternfly-docs/generated/components/truncate/react.js +0 -211
- package/patternfly-docs/generated/components/wizard/react-demos.js +0 -87
- package/patternfly-docs/generated/components/wizard/react-deprecated.js +0 -788
- package/patternfly-docs/generated/components/wizard/react.js +0 -986
- package/patternfly-docs/generated/developer-guides/open-ui-automation/react.js +0 -285
- package/patternfly-docs/generated/foundations-and-styles/layouts/bullseye/react.js +0 -70
- package/patternfly-docs/generated/foundations-and-styles/layouts/flex/react.js +0 -506
- package/patternfly-docs/generated/foundations-and-styles/layouts/gallery/react.js +0 -94
- package/patternfly-docs/generated/foundations-and-styles/layouts/grid/react.js +0 -272
- package/patternfly-docs/generated/foundations-and-styles/layouts/level/react.js +0 -87
- package/patternfly-docs/generated/foundations-and-styles/layouts/split/react.js +0 -124
- package/patternfly-docs/generated/foundations-and-styles/layouts/stack/react.js +0 -112
- package/patternfly-docs/generated/index.js +0 -1769
- package/patternfly-docs/generated/patterns/card-view/react-demos.js +0 -78
- package/patternfly-docs/generated/patterns/filters/react-demos.js +0 -141
- package/patternfly-docs/generated/patterns/password-generator/react-demos.js +0 -51
- package/patternfly-docs/generated/patterns/password-strength/react-demos.js +0 -61
- package/patternfly-docs/generated/patterns/primary-detail/react-demos.js +0 -124
- package/patternfly-docs/generated/patterns/right-to-left/react-demos.js +0 -81
|
@@ -1,283 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
|
|
3
|
-
import { useState } from 'react';
|
|
4
|
-
const pageData = {
|
|
5
|
-
"id": "Progress",
|
|
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/progress/react",
|
|
16
|
-
"sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Progress/examples/Progress.md",
|
|
17
|
-
"relPath": "packages/react-core/src/components/Progress/examples/Progress.md",
|
|
18
|
-
"propComponents": [
|
|
19
|
-
{
|
|
20
|
-
"name": "Progress",
|
|
21
|
-
"description": "",
|
|
22
|
-
"props": [
|
|
23
|
-
{
|
|
24
|
-
"name": "aria-describedby",
|
|
25
|
-
"type": "string",
|
|
26
|
-
"description": "Adds an accessible description to the ProgressBar via space separated list of ids. Required when helperText is passed in.",
|
|
27
|
-
"defaultValue": "null"
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
"name": "aria-label",
|
|
31
|
-
"type": "string",
|
|
32
|
-
"description": "Adds accessible text to the ProgressBar. Required when title not used and there is not any label associated with the progress bar",
|
|
33
|
-
"defaultValue": "null"
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"name": "aria-labelledby",
|
|
37
|
-
"type": "string",
|
|
38
|
-
"description": "Associates the ProgressBar with it's label for accessibility purposes. Required when title not used",
|
|
39
|
-
"defaultValue": "null"
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
"name": "className",
|
|
43
|
-
"type": "string",
|
|
44
|
-
"description": "Classname for progress component.",
|
|
45
|
-
"defaultValue": "''"
|
|
46
|
-
},
|
|
47
|
-
{
|
|
48
|
-
"name": "helperText",
|
|
49
|
-
"type": "React.ReactNode",
|
|
50
|
-
"description": "Content which can be used to convey additional information about the progress component.\nWe recommend the helper text component as it was designed for this purpose."
|
|
51
|
-
},
|
|
52
|
-
{
|
|
53
|
-
"name": "hideStatusIcon",
|
|
54
|
-
"type": "boolean",
|
|
55
|
-
"description": "Flag indicating whether the status icon should be hidden, helpful when space is limited (such as within table cells). When set to true, you must ensure the context of the status is provided in another way, such as via the progress measure."
|
|
56
|
-
},
|
|
57
|
-
{
|
|
58
|
-
"name": "id",
|
|
59
|
-
"type": "string",
|
|
60
|
-
"description": "DOM id for progress component.",
|
|
61
|
-
"defaultValue": "''"
|
|
62
|
-
},
|
|
63
|
-
{
|
|
64
|
-
"name": "isTitleTruncated",
|
|
65
|
-
"type": "boolean",
|
|
66
|
-
"description": "Indicate whether to truncate the string title",
|
|
67
|
-
"defaultValue": "false"
|
|
68
|
-
},
|
|
69
|
-
{
|
|
70
|
-
"name": "label",
|
|
71
|
-
"type": "React.ReactNode",
|
|
72
|
-
"description": "Text description of current progress value to display instead of percentage.",
|
|
73
|
-
"defaultValue": "null"
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
"name": "max",
|
|
77
|
-
"type": "number",
|
|
78
|
-
"description": "Maximum value of progress.",
|
|
79
|
-
"defaultValue": "100"
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
"name": "measureLocation",
|
|
83
|
-
"type": "'outside' | 'inside' | 'top' | 'none'",
|
|
84
|
-
"description": "Where the measure percent will be located.",
|
|
85
|
-
"defaultValue": "ProgressMeasureLocation.top"
|
|
86
|
-
},
|
|
87
|
-
{
|
|
88
|
-
"name": "min",
|
|
89
|
-
"type": "number",
|
|
90
|
-
"description": "Minimal value of progress.",
|
|
91
|
-
"defaultValue": "0"
|
|
92
|
-
},
|
|
93
|
-
{
|
|
94
|
-
"name": "size",
|
|
95
|
-
"type": "'sm' | 'md' | 'lg'",
|
|
96
|
-
"description": "Size variant of progress.",
|
|
97
|
-
"defaultValue": "null"
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"name": "title",
|
|
101
|
-
"type": "React.ReactNode",
|
|
102
|
-
"description": "Title above progress. The isTitleTruncated property will only affect string titles. Node title truncation must be handled manually.",
|
|
103
|
-
"defaultValue": "''"
|
|
104
|
-
},
|
|
105
|
-
{
|
|
106
|
-
"name": "tooltipPosition",
|
|
107
|
-
"type": "'auto' | 'top' | 'bottom' | 'left' | 'right'",
|
|
108
|
-
"description": "Position of the tooltip which is displayed if title is truncated",
|
|
109
|
-
"defaultValue": "'top'"
|
|
110
|
-
},
|
|
111
|
-
{
|
|
112
|
-
"name": "value",
|
|
113
|
-
"type": "number",
|
|
114
|
-
"description": "Actual value of progress.",
|
|
115
|
-
"defaultValue": "0"
|
|
116
|
-
},
|
|
117
|
-
{
|
|
118
|
-
"name": "valueText",
|
|
119
|
-
"type": "string",
|
|
120
|
-
"description": "Accessible text description of current progress value, for when value is not a percentage. Use with label.",
|
|
121
|
-
"defaultValue": "null"
|
|
122
|
-
},
|
|
123
|
-
{
|
|
124
|
-
"name": "variant",
|
|
125
|
-
"type": "'danger' | 'success' | 'warning'",
|
|
126
|
-
"description": "Status variant of progress.",
|
|
127
|
-
"defaultValue": "null"
|
|
128
|
-
}
|
|
129
|
-
]
|
|
130
|
-
}
|
|
131
|
-
],
|
|
132
|
-
"cssPrefix": [
|
|
133
|
-
"pf-v6-c-progress"
|
|
134
|
-
],
|
|
135
|
-
"examples": [
|
|
136
|
-
"Basic",
|
|
137
|
-
"Small",
|
|
138
|
-
"Large",
|
|
139
|
-
"Outside",
|
|
140
|
-
"Inside",
|
|
141
|
-
"Single line",
|
|
142
|
-
"Without measure",
|
|
143
|
-
"Finite step",
|
|
144
|
-
"Progress with step instructions",
|
|
145
|
-
"Truncate title",
|
|
146
|
-
"Title outside of progress bar",
|
|
147
|
-
"Helper text",
|
|
148
|
-
"Success",
|
|
149
|
-
"Failure",
|
|
150
|
-
"Warning",
|
|
151
|
-
"Interactive status icon and measure location"
|
|
152
|
-
]
|
|
153
|
-
};
|
|
154
|
-
pageData.liveContext = {
|
|
155
|
-
useState
|
|
156
|
-
};
|
|
157
|
-
pageData.examples = {
|
|
158
|
-
'Basic': props =>
|
|
159
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress } from '@patternfly/react-core';\n\nexport const ProgressBasic: React.FunctionComponent = () => <Progress value={33} title=\"Title\" />;\n","title":"Basic","lang":"ts","className":""}}>
|
|
160
|
-
|
|
161
|
-
</Example>,
|
|
162
|
-
'Small': props =>
|
|
163
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressSize } from '@patternfly/react-core';\n\nexport const ProgressSmall: React.FunctionComponent = () => (\n <Progress value={33} title=\"Title\" size={ProgressSize.sm} />\n);\n","title":"Small","lang":"ts","className":""}}>
|
|
164
|
-
|
|
165
|
-
</Example>,
|
|
166
|
-
'Large': props =>
|
|
167
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressSize } from '@patternfly/react-core';\n\nexport const ProgressLarge: React.FunctionComponent = () => (\n <Progress value={33} title=\"Title\" size={ProgressSize.lg} />\n);\n","title":"Large","lang":"ts","className":""}}>
|
|
168
|
-
|
|
169
|
-
</Example>,
|
|
170
|
-
'Outside': props =>
|
|
171
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressMeasureLocation } from '@patternfly/react-core';\n\nexport const ProgressOutside: React.FunctionComponent = () => (\n <Progress value={33} title=\"Title\" measureLocation={ProgressMeasureLocation.outside} />\n);\n","title":"Outside","lang":"ts","className":""}}>
|
|
172
|
-
|
|
173
|
-
</Example>,
|
|
174
|
-
'Inside': props =>
|
|
175
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressMeasureLocation } from '@patternfly/react-core';\n\nexport const ProgressInside: React.FunctionComponent = () => (\n <Progress value={33} title=\"Title\" measureLocation={ProgressMeasureLocation.inside} />\n);\n","title":"Inside","lang":"ts","className":""}}>
|
|
176
|
-
|
|
177
|
-
</Example>,
|
|
178
|
-
'Single line': props =>
|
|
179
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressMeasureLocation } from '@patternfly/react-core';\n\nexport const ProgressSingleLine: React.FunctionComponent = () => (\n <Progress value={33} measureLocation={ProgressMeasureLocation.outside} aria-label=\"Title\" />\n);\n","title":"Single line","lang":"ts","className":""}}>
|
|
180
|
-
|
|
181
|
-
</Example>,
|
|
182
|
-
'Without measure': props =>
|
|
183
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressMeasureLocation } from '@patternfly/react-core';\n\nexport const ProgressWithoutMeasure: React.FunctionComponent = () => (\n <Progress value={33} title=\"Title\" measureLocation={ProgressMeasureLocation.none} />\n);\n","title":"Without measure","lang":"ts","className":""}}>
|
|
184
|
-
|
|
185
|
-
</Example>,
|
|
186
|
-
'Finite step': props =>
|
|
187
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressMeasureLocation } from '@patternfly/react-core';\n\nexport const ProgressFiniteStep: React.FunctionComponent = () => (\n <Progress\n value={2}\n min={0}\n max={5}\n title=\"Title\"\n measureLocation={ProgressMeasureLocation.top}\n label=\"2 of 5\"\n valueText=\"2 of 5\"\n />\n);\n","title":"Finite step","lang":"ts","className":""}}>
|
|
188
|
-
|
|
189
|
-
</Example>,
|
|
190
|
-
'Progress with step instructions': props =>
|
|
191
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress } from '@patternfly/react-core';\n\nexport const ProgressStepInstruction: React.FunctionComponent = () => (\n <Progress value={2} title=\"Title\" min={0} max={5} label=\"Step 2: Copying files\" valueText=\"Step 2: Copying files\" />\n);\n","title":"Progress with step instructions","lang":"ts","className":""}}>
|
|
192
|
-
|
|
193
|
-
</Example>,
|
|
194
|
-
'Truncate title': props =>
|
|
195
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress } from '@patternfly/react-core';\n\nexport const ProgressTruncateTitle: React.FunctionComponent = () => (\n <Progress\n value={33}\n title=\"Very very very very very very very very very very very long title which should be truncated if it does not fit onto one line above the progress bar\"\n isTitleTruncated\n />\n);\n","title":"Truncate title","lang":"ts","className":""}}>
|
|
196
|
-
|
|
197
|
-
</Example>,
|
|
198
|
-
'Title outside of progress bar': props =>
|
|
199
|
-
<Example {...pageData} {...props} {...{"code":"import {\n DescriptionList,\n DescriptionListGroup,\n DescriptionListTerm,\n DescriptionListDescription,\n Progress,\n ProgressMeasureLocation\n} from '@patternfly/react-core';\n\nexport const ProgressTitleOutsideOfProgressBar: React.FunctionComponent = () => (\n <DescriptionList aria-label=\"Progress Title outside of progress bar\">\n <DescriptionListGroup>\n <DescriptionListTerm id=\"title-outside-progress-example-label\">Title outside of progress bar</DescriptionListTerm>\n <DescriptionListDescription>\n <Progress\n value={33}\n measureLocation={ProgressMeasureLocation.outside}\n aria-labelledby=\"title-outside-progress-example-label\"\n />\n </DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Title outside of progress bar","lang":"ts","className":""}}>
|
|
200
|
-
|
|
201
|
-
</Example>,
|
|
202
|
-
'Helper text': props =>
|
|
203
|
-
<Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport { Progress, ProgressProps, HelperText, HelperTextItem, Radio } from '@patternfly/react-core';\n\nexport const ProgressHelperText: React.FunctionComponent = () => {\n type ProgressVariant = ProgressProps['variant'];\n\n const [selectedVariant, setSelectedVariant] = useState<ProgressVariant>(undefined);\n\n const progressVariants: ProgressVariant[] = [undefined, 'success', 'warning', 'danger'];\n\n const capitalize = (input: string) => input[0].toUpperCase() + input.substring(1);\n const formatVariantName = (variant: ProgressVariant) => (variant ? capitalize(variant) : 'Default');\n\n const variantOptions = progressVariants.map((variant) => (\n <Radio\n id={`progress-helper-text-${variant}-selector`}\n label={`${formatVariantName(variant)} variant`}\n isChecked={variant === selectedVariant}\n onChange={() => setSelectedVariant(variant)}\n key={formatVariantName(variant)}\n name=\"Progress variant options\"\n />\n ));\n\n const helperTextVariant = selectedVariant === 'danger' ? 'error' : selectedVariant;\n\n const helperText = (\n <HelperText id=\"progress-helper-text-example-help-text\">\n <HelperTextItem variant={helperTextVariant}>\n {`${formatVariantName(selectedVariant)} variant is being displayed`}\n </HelperTextItem>\n </HelperText>\n );\n\n return (\n <>\n {variantOptions}\n <br />\n <Progress\n aria-describedby=\"progress-helper-text-example-help-text\"\n value={33}\n title=\"Title\"\n helperText={helperText}\n variant={selectedVariant}\n />\n </>\n );\n};\n","title":"Helper text","lang":"ts","className":""}}>
|
|
204
|
-
|
|
205
|
-
</Example>,
|
|
206
|
-
'Success': props =>
|
|
207
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressVariant } from '@patternfly/react-core';\n\nexport const ProgressSuccess: React.FunctionComponent = () => (\n <Progress value={100} title=\"Title\" variant={ProgressVariant.success} />\n);\n","title":"Success","lang":"ts","className":""}}>
|
|
208
|
-
|
|
209
|
-
</Example>,
|
|
210
|
-
'Failure': props =>
|
|
211
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressVariant } from '@patternfly/react-core';\n\nexport const ProgressFailure: React.FunctionComponent = () => (\n <Progress value={33} title=\"Title\" variant={ProgressVariant.danger} />\n);\n","title":"Failure","lang":"ts","className":""}}>
|
|
212
|
-
|
|
213
|
-
</Example>,
|
|
214
|
-
'Warning': props =>
|
|
215
|
-
<Example {...pageData} {...props} {...{"code":"import { Progress, ProgressVariant } from '@patternfly/react-core';\n\nexport const ProgressWarning: React.FunctionComponent = () => (\n <Progress value={90} title=\"Title\" variant={ProgressVariant.warning} />\n);\n","title":"Warning","lang":"ts","className":""}}>
|
|
216
|
-
|
|
217
|
-
</Example>,
|
|
218
|
-
'Interactive status icon and measure location': props =>
|
|
219
|
-
<Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport {\n Progress,\n ProgressMeasureLocation,\n ProgressVariant,\n Radio,\n Checkbox,\n Form,\n FormGroup\n} from '@patternfly/react-core';\n\nexport const ProgressInteractiveFailure: React.FunctionComponent = () => {\n const [measureLocation, setMeasureLocation] = useState<ProgressMeasureLocation>(ProgressMeasureLocation.inside);\n const [hideStatusIcon, setHideStatusIcon] = useState<boolean>(false);\n\n const measureLocationOptions = [\n { value: ProgressMeasureLocation.inside, label: 'Inside' },\n { value: ProgressMeasureLocation.outside, label: 'Outside' },\n { value: ProgressMeasureLocation.top, label: 'Top' },\n { value: ProgressMeasureLocation.none, label: 'None' }\n ];\n\n return (\n <Form>\n <FormGroup fieldId=\"measure-location\" label=\"Measure location\">\n {measureLocationOptions.map((option) => (\n <Radio\n key={option.value}\n id={`measure-location-${option.value}`}\n name=\"measure-location\"\n label={option.label}\n value={option.value}\n isChecked={measureLocation === option.value}\n onChange={() => setMeasureLocation(option.value)}\n />\n ))}\n </FormGroup>\n <FormGroup fieldId=\"hide-status-icon\">\n <Checkbox\n id=\"hide-status-icon\"\n label=\"Hide status icon\"\n isChecked={hideStatusIcon}\n onChange={(_, checked) => setHideStatusIcon(checked)}\n />\n </FormGroup>\n <Progress\n value={33}\n title=\"Title\"\n measureLocation={measureLocation}\n variant={ProgressVariant.danger}\n hideStatusIcon={hideStatusIcon}\n />\n </Form>\n );\n};\n","title":"Interactive status icon and measure location","lang":"ts","className":""}}>
|
|
220
|
-
|
|
221
|
-
</Example>
|
|
222
|
-
};
|
|
223
|
-
|
|
224
|
-
const Component = () => (
|
|
225
|
-
<React.Fragment>
|
|
226
|
-
<AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
227
|
-
{`Examples`}
|
|
228
|
-
</AutoLinkHeader>
|
|
229
|
-
{React.createElement(pageData.examples["Basic"])}
|
|
230
|
-
{React.createElement(pageData.examples["Small"])}
|
|
231
|
-
{React.createElement(pageData.examples["Large"])}
|
|
232
|
-
{React.createElement(pageData.examples["Outside"])}
|
|
233
|
-
{React.createElement(pageData.examples["Inside"])}
|
|
234
|
-
{React.createElement(pageData.examples["Single line"])}
|
|
235
|
-
{React.createElement(pageData.examples["Without measure"])}
|
|
236
|
-
{React.createElement(pageData.examples["Finite step"])}
|
|
237
|
-
{React.createElement(pageData.examples["Progress with step instructions"])}
|
|
238
|
-
{React.createElement(pageData.examples["Truncate title"])}
|
|
239
|
-
{React.createElement(pageData.examples["Title outside of progress bar"])}
|
|
240
|
-
{React.createElement(pageData.examples["Helper text"])}
|
|
241
|
-
<AutoLinkHeader {...{"id":"status-examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
242
|
-
{`Status examples`}
|
|
243
|
-
</AutoLinkHeader>
|
|
244
|
-
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
|
|
245
|
-
{`When conveying status, you should ensure:`}
|
|
246
|
-
</p>
|
|
247
|
-
<ul {...{"className":"pf-v6-c-content--ul pf-m-editorial ws-ul "}}>
|
|
248
|
-
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
|
|
249
|
-
{`There is visible helper text that explains the status.`}
|
|
250
|
-
</li>
|
|
251
|
-
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
|
|
252
|
-
{`The helper text includes the status icon, as seen in our `}
|
|
253
|
-
<PatternflyThemeLink {...{"to":"/components/helper-text#basic","className":""}}>
|
|
254
|
-
{`basic helper text example`}
|
|
255
|
-
</PatternflyThemeLink>
|
|
256
|
-
{`.`}
|
|
257
|
-
</li>
|
|
258
|
-
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
|
|
259
|
-
{`The helper text is linked to the `}
|
|
260
|
-
<code {...{"className":"ws-code "}}>
|
|
261
|
-
{`<Progress>`}
|
|
262
|
-
</code>
|
|
263
|
-
{` component via the `}
|
|
264
|
-
<code {...{"className":"ws-code "}}>
|
|
265
|
-
{`aria-describedby`}
|
|
266
|
-
</code>
|
|
267
|
-
{` property, as seen in the `}
|
|
268
|
-
<PatternflyThemeLink {...{"to":"#helper-text","className":""}}>
|
|
269
|
-
{`progress helper text example`}
|
|
270
|
-
</PatternflyThemeLink>
|
|
271
|
-
{`.`}
|
|
272
|
-
</li>
|
|
273
|
-
</ul>
|
|
274
|
-
{React.createElement(pageData.examples["Success"])}
|
|
275
|
-
{React.createElement(pageData.examples["Failure"])}
|
|
276
|
-
{React.createElement(pageData.examples["Warning"])}
|
|
277
|
-
{React.createElement(pageData.examples["Interactive status icon and measure location"])}
|
|
278
|
-
</React.Fragment>
|
|
279
|
-
);
|
|
280
|
-
Component.displayName = 'ComponentsProgressReactDocs';
|
|
281
|
-
Component.pageData = pageData;
|
|
282
|
-
|
|
283
|
-
export default Component;
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
|
|
3
|
-
import { useState } from 'react';
|
|
4
|
-
import accessibilityStyles from '@patternfly/react-styles/css/utilities/Accessibility/accessibility';
|
|
5
|
-
const pageData = {
|
|
6
|
-
"id": "Progress stepper",
|
|
7
|
-
"section": "components",
|
|
8
|
-
"subsection": "",
|
|
9
|
-
"deprecated": false,
|
|
10
|
-
"template": false,
|
|
11
|
-
"beta": false,
|
|
12
|
-
"demo": false,
|
|
13
|
-
"newImplementationLink": false,
|
|
14
|
-
"source": "react-demos",
|
|
15
|
-
"tabName": null,
|
|
16
|
-
"slug": "/components/progress-stepper/react-demos",
|
|
17
|
-
"sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/demos/ProgressStepperDemo.md",
|
|
18
|
-
"relPath": "packages/react-core/src/demos/ProgressStepperDemo.md",
|
|
19
|
-
"examples": [
|
|
20
|
-
"Basic"
|
|
21
|
-
]
|
|
22
|
-
};
|
|
23
|
-
pageData.liveContext = {
|
|
24
|
-
useState,
|
|
25
|
-
accessibilityStyles
|
|
26
|
-
};
|
|
27
|
-
pageData.examples = {
|
|
28
|
-
'Basic': props =>
|
|
29
|
-
<Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport { ProgressStepper, ProgressStep, Button, Stack, StackItem } from '@patternfly/react-core';\nimport accessibilityStyles from '@patternfly/react-styles/css/utilities/Accessibility/accessibility';\n\nexport const ProgressStepperBasic: React.FunctionComponent = () => {\n const [currentStep, setCurrentStep] = useState(0);\n\n const steps = [\n { title: 'First step', id: 'step1' },\n { title: 'Second step', id: 'step2' },\n { title: 'Third step', id: 'step3' },\n { title: 'Fourth step', id: 'step4' },\n { title: 'Fifth step', id: 'step5' }\n ];\n\n const onStepForward = (_event) => {\n const next = currentStep + 1;\n setCurrentStep(next <= 5 ? next : 4);\n };\n\n const onStepBack = (_event) => {\n const next = currentStep - 1;\n setCurrentStep(next > 0 ? next : 0);\n };\n\n return (\n <Stack>\n <StackItem>\n <Button onClick={onStepBack} isDisabled={currentStep === 0}>\n Step back\n </Button>{' '}\n <Button onClick={onStepForward} isDisabled={currentStep === 5}>\n Step forward\n </Button>\n <br />\n <br />\n </StackItem>\n <StackItem>\n <div className={accessibilityStyles.screenReader} aria-live=\"polite\">\n {steps[currentStep] && `On ${steps[currentStep].title}.`}\n {steps[currentStep - 1] && `${steps[currentStep - 1].title} was successful.`}\n </div>\n <ProgressStepper>\n {steps.map((step, index) => {\n let variant = 'pending';\n let ariaLabel = 'pending step';\n if (index < currentStep) {\n variant = 'success';\n ariaLabel = 'completed step, step with success';\n } else if (index === currentStep) {\n variant = 'info';\n ariaLabel = 'current step';\n }\n\n return (\n <ProgressStep\n id={index}\n titleId={step.id}\n key={index}\n variant={variant}\n isCurrent={index === currentStep}\n aria-label={ariaLabel}\n >\n {step.title}\n </ProgressStep>\n );\n })}\n </ProgressStepper>\n </StackItem>\n </Stack>\n );\n};\n","title":"Basic","lang":"ts","className":""}}>
|
|
30
|
-
|
|
31
|
-
</Example>
|
|
32
|
-
};
|
|
33
|
-
|
|
34
|
-
const Component = () => (
|
|
35
|
-
<React.Fragment>
|
|
36
|
-
<AutoLinkHeader {...{"id":"demos","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
37
|
-
{`Demos`}
|
|
38
|
-
</AutoLinkHeader>
|
|
39
|
-
{React.createElement(pageData.examples["Basic"])}
|
|
40
|
-
</React.Fragment>
|
|
41
|
-
);
|
|
42
|
-
Component.displayName = 'ComponentsProgressStepperReactDemosDocs';
|
|
43
|
-
Component.pageData = pageData;
|
|
44
|
-
|
|
45
|
-
export default Component;
|
|
@@ -1,219 +0,0 @@
|
|
|
1
|
-
import React from 'react';
|
|
2
|
-
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
|
|
3
|
-
import { Fragment, useState } from 'react';
|
|
4
|
-
import RhUiInProgressIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-in-progress-icon';
|
|
5
|
-
import RhUiPendingIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-pending-icon';
|
|
6
|
-
const pageData = {
|
|
7
|
-
"id": "Progress stepper",
|
|
8
|
-
"section": "components",
|
|
9
|
-
"subsection": "",
|
|
10
|
-
"deprecated": false,
|
|
11
|
-
"template": false,
|
|
12
|
-
"beta": false,
|
|
13
|
-
"demo": false,
|
|
14
|
-
"newImplementationLink": false,
|
|
15
|
-
"source": "react",
|
|
16
|
-
"tabName": null,
|
|
17
|
-
"slug": "/components/progress-stepper/react",
|
|
18
|
-
"sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/ProgressStepper/examples/ProgressStepper.md",
|
|
19
|
-
"relPath": "packages/react-core/src/components/ProgressStepper/examples/ProgressStepper.md",
|
|
20
|
-
"propComponents": [
|
|
21
|
-
{
|
|
22
|
-
"name": "ProgressStepper",
|
|
23
|
-
"description": "",
|
|
24
|
-
"props": [
|
|
25
|
-
{
|
|
26
|
-
"name": "aria-label",
|
|
27
|
-
"type": "string",
|
|
28
|
-
"description": "Adds an accessible label to the progress stepper."
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
"name": "children",
|
|
32
|
-
"type": "React.ReactNode",
|
|
33
|
-
"description": "Content rendered inside the progress stepper."
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"name": "className",
|
|
37
|
-
"type": "string",
|
|
38
|
-
"description": "Additional classes applied to the progress stepper container."
|
|
39
|
-
},
|
|
40
|
-
{
|
|
41
|
-
"name": "isCenterAligned",
|
|
42
|
-
"type": "boolean",
|
|
43
|
-
"description": "Flag indicating the progress stepper should be centered."
|
|
44
|
-
},
|
|
45
|
-
{
|
|
46
|
-
"name": "isCompact",
|
|
47
|
-
"type": "boolean",
|
|
48
|
-
"description": "Flag indicating the progress stepper should be rendered compactly."
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"name": "isVertical",
|
|
52
|
-
"type": "boolean",
|
|
53
|
-
"description": "Flag indicating the progress stepper has a vertical layout."
|
|
54
|
-
}
|
|
55
|
-
]
|
|
56
|
-
},
|
|
57
|
-
{
|
|
58
|
-
"name": "ProgressStep",
|
|
59
|
-
"description": "",
|
|
60
|
-
"props": [
|
|
61
|
-
{
|
|
62
|
-
"name": "aria-label",
|
|
63
|
-
"type": "string",
|
|
64
|
-
"description": "Accessible label for the progress step. Should communicate all information being communicated by the progress\nstep's icon, including the variant and the completed status."
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
"name": "children",
|
|
68
|
-
"type": "React.ReactNode",
|
|
69
|
-
"description": "Content rendered inside the progress step."
|
|
70
|
-
},
|
|
71
|
-
{
|
|
72
|
-
"name": "className",
|
|
73
|
-
"type": "string",
|
|
74
|
-
"description": "Additional classes applied to the progress step container."
|
|
75
|
-
},
|
|
76
|
-
{
|
|
77
|
-
"name": "description",
|
|
78
|
-
"type": "React.ReactNode",
|
|
79
|
-
"description": "Description text of a progress step."
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
"name": "icon",
|
|
83
|
-
"type": "React.ReactNode",
|
|
84
|
-
"description": "Custom icon of a progress step. Will override default icons provided by the variant."
|
|
85
|
-
},
|
|
86
|
-
{
|
|
87
|
-
"name": "isCurrent",
|
|
88
|
-
"type": "boolean",
|
|
89
|
-
"description": "Flag indicating the progress step is the current step."
|
|
90
|
-
},
|
|
91
|
-
{
|
|
92
|
-
"name": "popoverRender",
|
|
93
|
-
"type": "(stepRef: React.RefObject<any>) => React.ReactNode",
|
|
94
|
-
"description": "Forwards the step ref to rendered function. Use this prop to add a popover to the step."
|
|
95
|
-
},
|
|
96
|
-
{
|
|
97
|
-
"name": "titleId",
|
|
98
|
-
"type": "string",
|
|
99
|
-
"description": "ID of the title of the progress step."
|
|
100
|
-
},
|
|
101
|
-
{
|
|
102
|
-
"name": "variant",
|
|
103
|
-
"type": "'default' | 'success' | 'info' | 'pending' | 'warning' | 'danger'",
|
|
104
|
-
"description": "Variant of the progress step. Each variant has a default icon."
|
|
105
|
-
}
|
|
106
|
-
]
|
|
107
|
-
}
|
|
108
|
-
],
|
|
109
|
-
"cssPrefix": [
|
|
110
|
-
"pf-v6-c-progress-stepper"
|
|
111
|
-
],
|
|
112
|
-
"examples": [
|
|
113
|
-
"Basic",
|
|
114
|
-
"With step descriptions",
|
|
115
|
-
"With alignment",
|
|
116
|
-
"Compact",
|
|
117
|
-
"With an issue",
|
|
118
|
-
"With a failure",
|
|
119
|
-
"With custom icons",
|
|
120
|
-
"With help popover"
|
|
121
|
-
]
|
|
122
|
-
};
|
|
123
|
-
pageData.liveContext = {
|
|
124
|
-
Fragment,
|
|
125
|
-
useState,
|
|
126
|
-
RhUiInProgressIcon,
|
|
127
|
-
RhUiPendingIcon
|
|
128
|
-
};
|
|
129
|
-
pageData.examples = {
|
|
130
|
-
'Basic': props =>
|
|
131
|
-
<Example {...pageData} {...props} {...{"code":"import { ProgressStepper, ProgressStep } from '@patternfly/react-core';\n\nexport const ProgressStepperBasic: React.FunctionComponent = () => (\n <ProgressStepper aria-label=\"Basic progress stepper\">\n <ProgressStep\n variant=\"success\"\n id=\"basic-step1\"\n titleId=\"basic-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n First step\n </ProgressStep>\n <ProgressStep variant=\"info\" isCurrent id=\"basic-step2\" titleId=\"basic-step2-title\" aria-label=\"step with info\">\n Second step\n </ProgressStep>\n <ProgressStep variant=\"pending\" id=\"basic-step3\" titleId=\"basic-step3-title\" aria-label=\"pending step\">\n Third step\n </ProgressStep>\n </ProgressStepper>\n);\n","title":"Basic","lang":"ts","className":""}}>
|
|
132
|
-
|
|
133
|
-
</Example>,
|
|
134
|
-
'With step descriptions': props =>
|
|
135
|
-
<Example {...pageData} {...props} {...{"code":"import { ProgressStepper, ProgressStep } from '@patternfly/react-core';\n\nexport const ProgressStepperBasicWithDescription: React.FunctionComponent = () => (\n <ProgressStepper aria-label=\"Basic progress stepper with description\">\n <ProgressStep\n variant=\"success\"\n description=\"This is the first thing to happen\"\n id=\"basic-desc-step1\"\n titleId=\"basic-desc-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n First step\n </ProgressStep>\n <ProgressStep\n variant=\"info\"\n isCurrent\n description=\"This is the second thing to happen\"\n id=\"basic-desc-step2\"\n titleId=\"basic-desc-step2-title\"\n aria-label=\"step with info\"\n >\n Second step\n </ProgressStep>\n <ProgressStep\n variant=\"pending\"\n description=\"This is the last thing to happen\"\n id=\"basic-desc-step3\"\n titleId=\"basic-desc-step3-title\"\n aria-label=\"pending step\"\n >\n Third step\n </ProgressStep>\n </ProgressStepper>\n);\n","title":"With step descriptions","lang":"ts","className":""}}>
|
|
136
|
-
|
|
137
|
-
</Example>,
|
|
138
|
-
'With alignment': props =>
|
|
139
|
-
<Example {...pageData} {...props} {...{"code":"import { Fragment, useState } from 'react';\nimport { ProgressStepper, ProgressStep, Checkbox } from '@patternfly/react-core';\n\nexport const ProgressStepperBasicWithAlignment: React.FunctionComponent = () => {\n const [isVertical, setIsVertical] = useState(false);\n const [isCenterAligned, setIsCenterAligned] = useState(false);\n\n return (\n <Fragment>\n <Checkbox\n label=\"Vertical alignment\"\n isChecked={isVertical}\n onChange={(_event, checked) => setIsVertical(checked)}\n aria-label=\"Toggle vertical alignment\"\n id=\"toggle-vertical\"\n name=\"toggle-vertical\"\n />\n <Checkbox\n label=\"Center alignment\"\n isChecked={isCenterAligned}\n onChange={(_event, checked) => setIsCenterAligned(checked)}\n aria-label=\"Toggle center alignment\"\n id=\"toggle-center\"\n name=\"toggle-center\"\n />\n <br />\n <ProgressStepper\n isVertical={isVertical}\n isCenterAligned={isCenterAligned}\n aria-label=\"Basic progress stepper with alignment\"\n >\n <ProgressStep\n variant=\"success\"\n description=\"This is the first thing to happen\"\n id=\"basic-alignment-step1\"\n titleId=\"basic-alignment-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n First step\n </ProgressStep>\n <ProgressStep\n variant=\"info\"\n isCurrent\n description=\"This is the second thing to happen\"\n id=\"basic-alignment-step2\"\n titleId=\"basic-alignment-step2-title\"\n aria-label=\"step with info\"\n >\n Second step\n </ProgressStep>\n <ProgressStep\n variant=\"pending\"\n description=\"This is the last thing to happen\"\n id=\"basic-alignment-step3\"\n titleId=\"basic-alignment-step3-title\"\n aria-label=\"pending step\"\n >\n Third step\n </ProgressStep>\n </ProgressStepper>\n </Fragment>\n );\n};\n","title":"With alignment","lang":"ts","className":""}}>
|
|
140
|
-
|
|
141
|
-
</Example>,
|
|
142
|
-
'Compact': props =>
|
|
143
|
-
<Example {...pageData} {...props} {...{"code":"import { Fragment, useState } from 'react';\nimport { ProgressStepper, ProgressStep, Checkbox } from '@patternfly/react-core';\n\nexport const ProgressStepperCompact: React.FunctionComponent = () => {\n const [isVertical, setIsVertical] = useState(false);\n const [isCenterAligned, setIsCenterAligned] = useState(false);\n\n return (\n <Fragment>\n <Checkbox\n label=\"Vertical alignment\"\n isChecked={isVertical}\n onChange={(_event, checked) => setIsVertical(checked)}\n aria-label=\"Toggle compact vertical alignment\"\n id=\"toggle-compact-vertical\"\n name=\"toggle-compact-vertical\"\n />\n <Checkbox\n label=\"Center alignment\"\n isChecked={isCenterAligned}\n onChange={(_event, checked) => setIsCenterAligned(checked)}\n aria-label=\"Toggle compact center alignment\"\n id=\"toggle-compact-center\"\n name=\"toggle-compact-center\"\n />\n <br />\n <ProgressStepper isCompact isVertical={isVertical} isCenterAligned={isCenterAligned}>\n <ProgressStep\n variant=\"success\"\n id=\"compact-step1\"\n titleId=\"compact-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n First step\n </ProgressStep>\n <ProgressStep\n variant=\"info\"\n isCurrent\n id=\"compact-step2\"\n titleId=\"compact-step2-title\"\n aria-label=\"step with info\"\n >\n Second step\n </ProgressStep>\n <ProgressStep variant=\"pending\" id=\"compact-step3\" titleId=\"compact-step3-title\" aria-label=\"pending step\">\n Third step\n </ProgressStep>\n </ProgressStepper>\n </Fragment>\n );\n};\n","title":"Compact","lang":"ts","className":""}}>
|
|
144
|
-
|
|
145
|
-
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
|
|
146
|
-
{`Compact progress steppers will only display the current step's `}
|
|
147
|
-
|
|
148
|
-
<code {...{"className":"ws-code "}}>
|
|
149
|
-
{`title`}
|
|
150
|
-
</code>
|
|
151
|
-
{`, and will not display any steps' `}
|
|
152
|
-
|
|
153
|
-
<code {...{"className":"ws-code "}}>
|
|
154
|
-
{`description`}
|
|
155
|
-
</code>
|
|
156
|
-
{` texts.`}
|
|
157
|
-
</p>
|
|
158
|
-
</Example>,
|
|
159
|
-
'With an issue': props =>
|
|
160
|
-
<Example {...pageData} {...props} {...{"code":"import { ProgressStepper, ProgressStep } from '@patternfly/react-core';\n\nexport const ProgressStepperBasicIssue: React.FunctionComponent = () => (\n <ProgressStepper aria-label=\"Basic progress stepper with issue\">\n <ProgressStep\n variant=\"success\"\n id=\"basic-with-issue-step1\"\n titleId=\"basic-with-issue-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n First step\n </ProgressStep>\n <ProgressStep\n variant=\"success\"\n id=\"basic-with-issue-step2\"\n titleId=\"basic-with-issue-step2-title\"\n aria-label=\"completed step, step with success\"\n >\n Second step\n </ProgressStep>\n <ProgressStep\n variant=\"warning\"\n id=\"basic-with-issue-step3\"\n titleId=\"basic-with-issue-step3-title\"\n aria-label=\"completed step, step with warning\"\n >\n Third step\n </ProgressStep>\n <ProgressStep\n variant=\"info\"\n isCurrent\n id=\"basic-with-issue-step4\"\n titleId=\"basic-with-issue-step4-title\"\n aria-label=\"step with info\"\n >\n Fourth step\n </ProgressStep>\n <ProgressStep\n variant=\"pending\"\n id=\"basic-with-issue-step5\"\n titleId=\"basic-with-issue-step5-title\"\n aria-label=\"pending step\"\n >\n Fifth step\n </ProgressStep>\n </ProgressStepper>\n);\n","title":"With an issue","lang":"ts","className":""}}>
|
|
161
|
-
|
|
162
|
-
</Example>,
|
|
163
|
-
'With a failure': props =>
|
|
164
|
-
<Example {...pageData} {...props} {...{"code":"import { ProgressStepper, ProgressStep } from '@patternfly/react-core';\n\nexport const ProgressStepperBasicFailure: React.FunctionComponent = () => (\n <ProgressStepper aria-label=\"Basic progress stepper with failure\">\n <ProgressStep\n variant=\"success\"\n id=\"basic-with-failure-step1\"\n titleId=\"basic-with-failure-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n First step\n </ProgressStep>\n <ProgressStep\n variant=\"success\"\n id=\"basic-with-failure-step2\"\n titleId=\"basic-with-failure-step2-title\"\n aria-label=\"completed step, step with success\"\n >\n Second step\n </ProgressStep>\n <ProgressStep\n variant=\"success\"\n id=\"basic-with-failure-step3\"\n titleId=\"basic-with-failure-step3-title\"\n aria-label=\"completed step, step with success\"\n >\n Third step\n </ProgressStep>\n <ProgressStep\n variant=\"danger\"\n isCurrent\n id=\"basic-with-failure-step4\"\n titleId=\"basic-with-failure-step4-title\"\n aria-label=\"step with danger\"\n >\n Fourth step\n </ProgressStep>\n <ProgressStep\n variant=\"pending\"\n id=\"basic-with-failure-step5\"\n titleId=\"basic-with-failure-step5-title\"\n aria-label=\"pending step\"\n >\n Fifth step\n </ProgressStep>\n </ProgressStepper>\n);\n","title":"With a failure","lang":"ts","className":""}}>
|
|
165
|
-
|
|
166
|
-
</Example>,
|
|
167
|
-
'With custom icons': props =>
|
|
168
|
-
<Example {...pageData} {...props} {...{"code":"import { ProgressStepper, ProgressStep } from '@patternfly/react-core';\nimport RhUiInProgressIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-in-progress-icon';\nimport RhUiPendingIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-pending-icon';\n\nexport const ProgressStepperCustomIcons: React.FunctionComponent = () => (\n <ProgressStepper aria-label=\"Progress stepper with custom icons\">\n <ProgressStep\n variant=\"success\"\n id=\"custom-step1\"\n titleId=\"custom-step1-title\"\n aria-label=\"completed step, step with success\"\n >\n Successful completion\n </ProgressStep>\n <ProgressStep\n isCurrent\n icon={<RhUiInProgressIcon />}\n id=\"custom-step2\"\n titleId=\"custom-step2-title\"\n aria-label=\"in progress\"\n >\n In process\n </ProgressStep>\n <ProgressStep\n variant=\"pending\"\n icon={<RhUiPendingIcon />}\n id=\"custom-step3\"\n titleId=\"custom-step3-title\"\n aria-label=\"pending step\"\n >\n Pending\n </ProgressStep>\n </ProgressStepper>\n);\n","title":"With custom icons","lang":"ts","className":""}}>
|
|
169
|
-
|
|
170
|
-
</Example>,
|
|
171
|
-
'With help popover': props =>
|
|
172
|
-
<Example {...pageData} {...props} {...{"code":"import { ProgressStepper, ProgressStep, Popover } from '@patternfly/react-core';\n\nexport const PopoverProgressStep = () => (\n <ProgressStepper aria-label=\"Progress stepper with help popover\">\n <ProgressStep\n variant=\"success\"\n id=\"popover-step1\"\n titleId=\"popover-step1-title\"\n aria-label=\"completed step with popover, step with success\"\n popoverRender={(stepRef) => (\n <Popover\n aria-label=\"First step help\"\n headerContent={<div>First step popover</div>}\n bodyContent={<div>Additional info or help text content.</div>}\n triggerRef={stepRef}\n position=\"right\"\n />\n )}\n >\n First step\n </ProgressStep>\n <ProgressStep\n variant=\"danger\"\n id=\"popover-step2\"\n titleId=\"popover-step2-title\"\n aria-label=\"completed step with popover, step with danger\"\n popoverRender={(stepRef) => (\n <Popover\n aria-label=\"Second step help\"\n headerContent={<div>Second step popover</div>}\n bodyContent={<div>Additional info or help text content.</div>}\n triggerRef={stepRef}\n position=\"right\"\n />\n )}\n >\n Second step\n </ProgressStep>\n <ProgressStep\n variant=\"info\"\n id=\"popover-step3\"\n titleId=\"popover-step3-title\"\n aria-label=\"step with popover\"\n popoverRender={(stepRef) => (\n <Popover\n aria-label=\"Third step help\"\n headerContent={<div>Third step popover</div>}\n bodyContent={<div>Additional info or help text content.</div>}\n triggerRef={stepRef}\n position=\"right\"\n />\n )}\n isCurrent\n >\n Third step\n </ProgressStep>\n <ProgressStep variant=\"pending\" id=\"popover-step4\" titleId=\"popover-step4-title\" aria-label=\"pending step\">\n Fourth step\n </ProgressStep>\n </ProgressStepper>\n);\n","title":"With help popover","lang":"ts","className":""}}>
|
|
173
|
-
|
|
174
|
-
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
|
|
175
|
-
{`To add a popover to a progress step, set the `}
|
|
176
|
-
|
|
177
|
-
<code {...{"className":"ws-code "}}>
|
|
178
|
-
{`popoverRender`}
|
|
179
|
-
</code>
|
|
180
|
-
{` properties on the `}
|
|
181
|
-
|
|
182
|
-
<code {...{"className":"ws-code "}}>
|
|
183
|
-
{`ProgressStep`}
|
|
184
|
-
</code>
|
|
185
|
-
{` component.`}
|
|
186
|
-
</p>
|
|
187
|
-
</Example>
|
|
188
|
-
};
|
|
189
|
-
|
|
190
|
-
const Component = () => (
|
|
191
|
-
<React.Fragment>
|
|
192
|
-
<AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
193
|
-
{`Examples`}
|
|
194
|
-
</AutoLinkHeader>
|
|
195
|
-
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
|
|
196
|
-
{`Progress steppers have default icons associated with the `}
|
|
197
|
-
<code {...{"className":"ws-code "}}>
|
|
198
|
-
{`variant`}
|
|
199
|
-
</code>
|
|
200
|
-
{` property, and may be overriden and customized using the `}
|
|
201
|
-
<code {...{"className":"ws-code "}}>
|
|
202
|
-
{`icon`}
|
|
203
|
-
</code>
|
|
204
|
-
{` property.`}
|
|
205
|
-
</p>
|
|
206
|
-
{React.createElement(pageData.examples["Basic"])}
|
|
207
|
-
{React.createElement(pageData.examples["With step descriptions"])}
|
|
208
|
-
{React.createElement(pageData.examples["With alignment"])}
|
|
209
|
-
{React.createElement(pageData.examples["Compact"])}
|
|
210
|
-
{React.createElement(pageData.examples["With an issue"])}
|
|
211
|
-
{React.createElement(pageData.examples["With a failure"])}
|
|
212
|
-
{React.createElement(pageData.examples["With custom icons"])}
|
|
213
|
-
{React.createElement(pageData.examples["With help popover"])}
|
|
214
|
-
</React.Fragment>
|
|
215
|
-
);
|
|
216
|
-
Component.displayName = 'ComponentsProgressStepperReactDocs';
|
|
217
|
-
Component.pageData = pageData;
|
|
218
|
-
|
|
219
|
-
export default Component;
|