@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.
- package/CHANGELOG.md +4 -0
- package/package.json +12 -13
- package/patternfly-docs/generated/components/about-modal/react.js +149 -0
- package/patternfly-docs/generated/components/accordion/react.js +262 -0
- package/patternfly-docs/generated/components/action-list/react.js +144 -0
- package/patternfly-docs/generated/components/alert/react-demos.js +56 -0
- package/patternfly-docs/generated/components/alert/react.js +1433 -0
- package/patternfly-docs/generated/components/avatar/react.js +166 -0
- package/patternfly-docs/generated/components/back-to-top/react-demos.js +60 -0
- package/patternfly-docs/generated/components/back-to-top/react.js +77 -0
- package/patternfly-docs/generated/components/backdrop/react.js +64 -0
- package/patternfly-docs/generated/components/background-image/react.js +62 -0
- package/patternfly-docs/generated/components/badge/react.js +97 -0
- package/patternfly-docs/generated/components/banner/react-demos.js +57 -0
- package/patternfly-docs/generated/components/banner/react.js +148 -0
- package/patternfly-docs/generated/components/brand/react.js +142 -0
- package/patternfly-docs/generated/components/breadcrumb/react.js +206 -0
- package/patternfly-docs/generated/components/button/react-demos.js +57 -0
- package/patternfly-docs/generated/components/button/react.js +826 -0
- package/patternfly-docs/generated/components/card/react-demos.js +201 -0
- package/patternfly-docs/generated/components/card/react.js +1015 -0
- package/patternfly-docs/generated/components/charts/area-chart/-Victory.js +1350 -0
- package/patternfly-docs/generated/components/charts/bar-chart/-Victory.js +1334 -0
- package/patternfly-docs/generated/components/charts/box-plot-chart/-Victory.js +1282 -0
- package/patternfly-docs/generated/components/charts/bullet-chart/-Victory.js +848 -0
- package/patternfly-docs/generated/components/charts/colors-for-charts/-Victory.js +192 -0
- package/patternfly-docs/generated/components/charts/donut-chart/-Victory.js +426 -0
- package/patternfly-docs/generated/components/charts/donut-utilization-chart/-Victory.js +804 -0
- package/patternfly-docs/generated/components/charts/legends/-Victory.js +3230 -0
- package/patternfly-docs/generated/components/charts/line-chart/-Victory.js +1178 -0
- package/patternfly-docs/generated/components/charts/line-chart/ECharts.js +525 -0
- package/patternfly-docs/generated/components/charts/patterns/-Victory.js +3382 -0
- package/patternfly-docs/generated/components/charts/pie-chart/-Victory.js +377 -0
- package/patternfly-docs/generated/components/charts/resize-observer/-Victory.js +2475 -0
- package/patternfly-docs/generated/components/charts/sankey-chart/ECharts.js +538 -0
- package/patternfly-docs/generated/components/charts/scatter-chart/-Victory.js +1551 -0
- package/patternfly-docs/generated/components/charts/skeletons/-Victory.js +4115 -0
- package/patternfly-docs/generated/components/charts/sparkline-chart/-Victory.js +955 -0
- package/patternfly-docs/generated/components/charts/stack-chart/-Victory.js +1173 -0
- package/patternfly-docs/generated/components/charts/threshold-chart/-Victory.js +1166 -0
- package/patternfly-docs/generated/components/charts/tooltips/-Victory.js +413 -0
- package/patternfly-docs/generated/components/chip/react-deprecated.js +323 -0
- package/patternfly-docs/generated/components/clipboard-copy/react.js +373 -0
- package/patternfly-docs/generated/components/code-block/react.js +148 -0
- package/patternfly-docs/generated/components/code-editor/react.js +659 -0
- package/patternfly-docs/generated/components/compass/react-demos.js +147 -0
- package/patternfly-docs/generated/components/compass/react.js +440 -0
- package/patternfly-docs/generated/components/content/react.js +248 -0
- package/patternfly-docs/generated/components/data-list/react-demos.js +90 -0
- package/patternfly-docs/generated/components/data-list/react.js +709 -0
- package/patternfly-docs/generated/components/date-and-time/calendar-month/react.js +283 -0
- package/patternfly-docs/generated/components/date-and-time/date-and-time-picker/react-demos.js +64 -0
- package/patternfly-docs/generated/components/date-and-time/date-picker/react-demos.js +83 -0
- package/patternfly-docs/generated/components/date-and-time/date-picker/react.js +395 -0
- package/patternfly-docs/generated/components/date-and-time/time-picker/react.js +241 -0
- package/patternfly-docs/generated/components/description-list/react-demos.js +58 -0
- package/patternfly-docs/generated/components/description-list/react.js +743 -0
- package/patternfly-docs/generated/components/divider/react.js +126 -0
- package/patternfly-docs/generated/components/drag-and-drop/react-demos.js +351 -0
- package/patternfly-docs/generated/components/drag-and-drop/react-deprecated.js +184 -0
- package/patternfly-docs/generated/components/drag-and-drop/react.js +137 -0
- package/patternfly-docs/generated/components/drawer/react.js +598 -0
- package/patternfly-docs/generated/components/dual-list-selector/react-deprecated.js +772 -0
- package/patternfly-docs/generated/components/dual-list-selector/react.js +594 -0
- package/patternfly-docs/generated/components/empty-state/react.js +199 -0
- package/patternfly-docs/generated/components/expandable-section/react-demos.js +65 -0
- package/patternfly-docs/generated/components/expandable-section/react.js +408 -0
- package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react-demos.js +52 -0
- package/patternfly-docs/generated/components/file-upload/multiple-file-upload/react.js +398 -0
- package/patternfly-docs/generated/components/file-upload/simple-file-upload/react.js +749 -0
- package/patternfly-docs/generated/components/forms/checkbox/react.js +222 -0
- package/patternfly-docs/generated/components/forms/form/react.js +1106 -0
- package/patternfly-docs/generated/components/forms/form-select/react.js +208 -0
- package/patternfly-docs/generated/components/forms/radio/react.js +212 -0
- package/patternfly-docs/generated/components/forms/text-area/react.js +160 -0
- package/patternfly-docs/generated/components/forms/text-input/react.js +216 -0
- package/patternfly-docs/generated/components/helper-text/react-demos.js +180 -0
- package/patternfly-docs/generated/components/helper-text/react.js +164 -0
- package/patternfly-docs/generated/components/hero/react.js +88 -0
- package/patternfly-docs/generated/components/hint/react.js +169 -0
- package/patternfly-docs/generated/components/icon/react.js +215 -0
- package/patternfly-docs/generated/components/input-group/react.js +182 -0
- package/patternfly-docs/generated/components/jump-links/react-demos.js +154 -0
- package/patternfly-docs/generated/components/jump-links/react.js +212 -0
- package/patternfly-docs/generated/components/label/react-demos.js +57 -0
- package/patternfly-docs/generated/components/label/react.js +417 -0
- package/patternfly-docs/generated/components/list/react.js +175 -0
- package/patternfly-docs/generated/components/login-page/react.js +587 -0
- package/patternfly-docs/generated/components/masthead/react-demos.js +79 -0
- package/patternfly-docs/generated/components/masthead/react.js +291 -0
- package/patternfly-docs/generated/components/menus/application-launcher/react-demos.js +769 -0
- package/patternfly-docs/generated/components/menus/context-selector/react-demos.js +665 -0
- package/patternfly-docs/generated/components/menus/custom-menus/react-demos.js +187 -0
- package/patternfly-docs/generated/components/menus/dropdown/react-templates.js +163 -0
- package/patternfly-docs/generated/components/menus/dropdown/react.js +998 -0
- package/patternfly-docs/generated/components/menus/menu/react.js +1540 -0
- package/patternfly-docs/generated/components/menus/menu-toggle/react.js +747 -0
- package/patternfly-docs/generated/components/menus/options-menu/react-demos.js +508 -0
- package/patternfly-docs/generated/components/menus/select/react-templates.js +257 -0
- package/patternfly-docs/generated/components/menus/select/react.js +998 -0
- package/patternfly-docs/generated/components/modal/react-deprecated.js +554 -0
- package/patternfly-docs/generated/components/modal/react.js +597 -0
- package/patternfly-docs/generated/components/navigation/react-demos.js +356 -0
- package/patternfly-docs/generated/components/navigation/react.js +409 -0
- package/patternfly-docs/generated/components/notification-badge/react.js +196 -0
- package/patternfly-docs/generated/components/notification-drawer/react-demos.js +107 -0
- package/patternfly-docs/generated/components/notification-drawer/react.js +394 -0
- package/patternfly-docs/generated/components/number-input/react.js +210 -0
- package/patternfly-docs/generated/components/overflow-menu/react.js +274 -0
- package/patternfly-docs/generated/components/page/react-demos.js +149 -0
- package/patternfly-docs/generated/components/page/react.js +1352 -0
- package/patternfly-docs/generated/components/pagination/react.js +492 -0
- package/patternfly-docs/generated/components/panel/react.js +236 -0
- package/patternfly-docs/generated/components/popover/react.js +390 -0
- package/patternfly-docs/generated/components/progress/react-demos.js +59 -0
- package/patternfly-docs/generated/components/progress/react.js +283 -0
- package/patternfly-docs/generated/components/progress-stepper/react-demos.js +45 -0
- package/patternfly-docs/generated/components/progress-stepper/react.js +219 -0
- package/patternfly-docs/generated/components/search-input/react-demos.js +113 -0
- package/patternfly-docs/generated/components/search-input/react.js +263 -0
- package/patternfly-docs/generated/components/sidebar/react.js +236 -0
- package/patternfly-docs/generated/components/simple-list/react.js +200 -0
- package/patternfly-docs/generated/components/skeleton/react-demos.js +44 -0
- package/patternfly-docs/generated/components/skeleton/react.js +122 -0
- package/patternfly-docs/generated/components/skip-to-content/react.js +73 -0
- package/patternfly-docs/generated/components/slider/react.js +309 -0
- package/patternfly-docs/generated/components/spinner/react.js +111 -0
- package/patternfly-docs/generated/components/switch/react.js +163 -0
- package/patternfly-docs/generated/components/table/react-demos.js +355 -0
- package/patternfly-docs/generated/components/table/react-deprecated.js +1350 -0
- package/patternfly-docs/generated/components/table/react.js +3241 -0
- package/patternfly-docs/generated/components/tabs/react-demos.js +108 -0
- package/patternfly-docs/generated/components/tabs/react.js +1359 -0
- package/patternfly-docs/generated/components/text-input-group/react-demos.js +152 -0
- package/patternfly-docs/generated/components/text-input-group/react.js +278 -0
- package/patternfly-docs/generated/components/tile/react-deprecated.js +242 -0
- package/patternfly-docs/generated/components/timestamp/react.js +283 -0
- package/patternfly-docs/generated/components/title/react.js +94 -0
- package/patternfly-docs/generated/components/toggle-group/react.js +299 -0
- package/patternfly-docs/generated/components/toolbar/react-demos.js +66 -0
- package/patternfly-docs/generated/components/toolbar/react.js +932 -0
- package/patternfly-docs/generated/components/tooltip/react.js +241 -0
- package/patternfly-docs/generated/components/tree-view/react.js +429 -0
- package/patternfly-docs/generated/components/truncate/react.js +211 -0
- package/patternfly-docs/generated/components/wizard/react-demos.js +87 -0
- package/patternfly-docs/generated/components/wizard/react-deprecated.js +788 -0
- package/patternfly-docs/generated/components/wizard/react.js +986 -0
- package/patternfly-docs/generated/developer-guides/open-ui-automation/react.js +285 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/bullseye/react.js +70 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/flex/react.js +506 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/gallery/react.js +94 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/grid/react.js +272 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/level/react.js +87 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/split/react.js +124 -0
- package/patternfly-docs/generated/foundations-and-styles/layouts/stack/react.js +112 -0
- package/patternfly-docs/generated/index.js +1769 -0
- package/patternfly-docs/generated/patterns/card-view/react-demos.js +78 -0
- package/patternfly-docs/generated/patterns/filters/react-demos.js +141 -0
- package/patternfly-docs/generated/patterns/password-generator/react-demos.js +51 -0
- package/patternfly-docs/generated/patterns/password-strength/react-demos.js +61 -0
- package/patternfly-docs/generated/patterns/primary-detail/react-demos.js +124 -0
- package/patternfly-docs/generated/patterns/right-to-left/react-demos.js +81 -0
- package/LICENSE +0 -21
|
@@ -0,0 +1,743 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
|
|
3
|
+
import { useState } from 'react';
|
|
4
|
+
import { Button, DescriptionList, DescriptionListTerm, DescriptionListDescription, DescriptionListGroup, DescriptionListTermHelpText, DescriptionListTermHelpTextButton, Popover, Checkbox, Card } from '@patternfly/react-core';
|
|
5
|
+
import RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';
|
|
6
|
+
import CubeIcon from '@patternfly/react-icons/dist/esm/icons/cube-icon';
|
|
7
|
+
import BookIcon from '@patternfly/react-icons/dist/esm/icons/book-icon';
|
|
8
|
+
import KeyIcon from '@patternfly/react-icons/dist/esm/icons/key-icon';
|
|
9
|
+
import RhUiFlagFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-flag-fill-icon';
|
|
10
|
+
import RhUiLanguageFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-language-fill-icon';
|
|
11
|
+
const pageData = {
|
|
12
|
+
"id": "Description list",
|
|
13
|
+
"section": "components",
|
|
14
|
+
"subsection": "",
|
|
15
|
+
"deprecated": false,
|
|
16
|
+
"template": false,
|
|
17
|
+
"beta": false,
|
|
18
|
+
"demo": false,
|
|
19
|
+
"newImplementationLink": false,
|
|
20
|
+
"source": "react",
|
|
21
|
+
"tabName": null,
|
|
22
|
+
"slug": "/components/description-list/react",
|
|
23
|
+
"sourceLink": "https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/DescriptionList/examples/DescriptionList.md",
|
|
24
|
+
"relPath": "packages/react-core/src/components/DescriptionList/examples/DescriptionList.md",
|
|
25
|
+
"propComponents": [
|
|
26
|
+
{
|
|
27
|
+
"name": "DescriptionList",
|
|
28
|
+
"description": "",
|
|
29
|
+
"props": [
|
|
30
|
+
{
|
|
31
|
+
"name": "autoFitMinModifier",
|
|
32
|
+
"type": "{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}",
|
|
33
|
+
"description": "Sets the minimum column size for the auto-fit (isAutoFit) layout at various breakpoints."
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "children",
|
|
37
|
+
"type": "React.ReactNode",
|
|
38
|
+
"description": "Anything that can be rendered inside of the list",
|
|
39
|
+
"defaultValue": "null"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"name": "className",
|
|
43
|
+
"type": "string",
|
|
44
|
+
"description": "Additional classes added to the list",
|
|
45
|
+
"defaultValue": "''"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "columnModifier",
|
|
49
|
+
"type": "{\n default?: '1Col' | '2Col' | '3Col';\n sm?: '1Col' | '2Col' | '3Col';\n md?: '1Col' | '2Col' | '3Col';\n lg?: '1Col' | '2Col' | '3Col';\n xl?: '1Col' | '2Col' | '3Col';\n '2xl'?: '1Col' | '2Col' | '3Col';\n}",
|
|
50
|
+
"description": "Sets the number of columns on the description list at various breakpoints"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "displaySize",
|
|
54
|
+
"type": "'default' | 'lg' | '2xl'",
|
|
55
|
+
"description": "Sets the display size of the descriptions in the description list.",
|
|
56
|
+
"defaultValue": "'default'"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "horizontalTermWidthModifier",
|
|
60
|
+
"type": "{\n default?: string;\n sm?: string;\n md?: string;\n lg?: string;\n xl?: string;\n '2xl'?: string;\n}",
|
|
61
|
+
"description": "Sets the horizontal description list's term column width at various breakpoints."
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "isAutoColumnWidths",
|
|
65
|
+
"type": "boolean",
|
|
66
|
+
"description": "Sets the description list to format automatically."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "isAutoFit",
|
|
70
|
+
"type": "boolean",
|
|
71
|
+
"description": "Sets the description list to auto fit."
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"name": "isCompact",
|
|
75
|
+
"type": "boolean",
|
|
76
|
+
"description": "Sets the description list to compact styling."
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "isFillColumns",
|
|
80
|
+
"type": "boolean",
|
|
81
|
+
"description": "Sets the the default placement of description list groups to fill from top to bottom."
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"name": "isFluid",
|
|
85
|
+
"type": "boolean",
|
|
86
|
+
"description": "Sets a horizontal description list to have fluid styling."
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "isHorizontal",
|
|
90
|
+
"type": "boolean",
|
|
91
|
+
"description": "Sets the description list component term and description pair to a horizontal layout.",
|
|
92
|
+
"defaultValue": "false"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "isInlineGrid",
|
|
96
|
+
"type": "boolean",
|
|
97
|
+
"description": "Modifies the description list display to inline-grid."
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "orientation",
|
|
101
|
+
"type": "{\n sm?: 'vertical' | 'horizontal';\n md?: 'vertical' | 'horizontal';\n lg?: 'vertical' | 'horizontal';\n xl?: 'vertical' | 'horizontal';\n '2xl'?: 'vertical' | 'horizontal';\n}",
|
|
102
|
+
"description": "Indicates how the menu will align at various breakpoints."
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "termWidth",
|
|
106
|
+
"type": "string",
|
|
107
|
+
"description": "Sets the description list's term column width."
|
|
108
|
+
}
|
|
109
|
+
]
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"name": "DescriptionListDescription",
|
|
113
|
+
"description": "",
|
|
114
|
+
"props": [
|
|
115
|
+
{
|
|
116
|
+
"name": "children",
|
|
117
|
+
"type": "React.ReactNode",
|
|
118
|
+
"description": "Anything that can be rendered inside of list description",
|
|
119
|
+
"defaultValue": "null"
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
"name": "className",
|
|
123
|
+
"type": "string",
|
|
124
|
+
"description": "Additional classes added to the DescriptionListDescription"
|
|
125
|
+
}
|
|
126
|
+
]
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "DescriptionListGroup",
|
|
130
|
+
"description": "",
|
|
131
|
+
"props": [
|
|
132
|
+
{
|
|
133
|
+
"name": "children",
|
|
134
|
+
"type": "any",
|
|
135
|
+
"description": "Any elements that can be rendered in the list group"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"name": "className",
|
|
139
|
+
"type": "string",
|
|
140
|
+
"description": "Additional classes added to the DescriptionListGroup"
|
|
141
|
+
}
|
|
142
|
+
]
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "DescriptionListTerm",
|
|
146
|
+
"description": "",
|
|
147
|
+
"props": [
|
|
148
|
+
{
|
|
149
|
+
"name": "children",
|
|
150
|
+
"type": "React.ReactNode",
|
|
151
|
+
"description": "Anything that can be rendered inside of list term",
|
|
152
|
+
"required": true
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"name": "className",
|
|
156
|
+
"type": "string",
|
|
157
|
+
"description": "Additional classes added to the DescriptionListTerm"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "icon",
|
|
161
|
+
"type": "React.ReactNode",
|
|
162
|
+
"description": "Icon that is rendered inside of list term to the left side of the children"
|
|
163
|
+
}
|
|
164
|
+
]
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "DescriptionListTermHelpText",
|
|
168
|
+
"description": "",
|
|
169
|
+
"props": [
|
|
170
|
+
{
|
|
171
|
+
"name": "children",
|
|
172
|
+
"type": "React.ReactNode",
|
|
173
|
+
"description": "Anything that can be rendered inside of list term",
|
|
174
|
+
"required": true
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "className",
|
|
178
|
+
"type": "string",
|
|
179
|
+
"description": "Additional classes added to the DescriptionListTermHelpText"
|
|
180
|
+
}
|
|
181
|
+
]
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "DescriptionListTermHelpTextButton",
|
|
185
|
+
"description": "",
|
|
186
|
+
"props": [
|
|
187
|
+
{
|
|
188
|
+
"name": "children",
|
|
189
|
+
"type": "React.ReactNode",
|
|
190
|
+
"description": "Anything that can be rendered inside of list term",
|
|
191
|
+
"required": true
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"name": "className",
|
|
195
|
+
"type": "string",
|
|
196
|
+
"description": "Additional classes added to the DescriptionListTerm"
|
|
197
|
+
}
|
|
198
|
+
]
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "Popover",
|
|
202
|
+
"description": "The main popover component. The following properties can also be passed into another component\nthat has a property specifically for passing in popover properties.",
|
|
203
|
+
"props": [
|
|
204
|
+
{
|
|
205
|
+
"name": "alertSeverityScreenReaderText",
|
|
206
|
+
"type": "string",
|
|
207
|
+
"description": "Text announced by screen reader when alert severity variant is set to indicate\nseverity level."
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"name": "alertSeverityVariant",
|
|
211
|
+
"type": "'custom' | 'info' | 'warning' | 'success' | 'danger'",
|
|
212
|
+
"description": "Severity variants for an alert popover. This modifies the color of the header to\nmatch the severity."
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "animationDuration",
|
|
216
|
+
"type": "number",
|
|
217
|
+
"description": "The duration of the CSS fade transition animation.",
|
|
218
|
+
"defaultValue": "300"
|
|
219
|
+
},
|
|
220
|
+
{
|
|
221
|
+
"name": "appendTo",
|
|
222
|
+
"type": "HTMLElement | ((ref?: HTMLElement) => HTMLElement) | 'inline'",
|
|
223
|
+
"description": "The element to append the popover to. Defaults to \"inline\".",
|
|
224
|
+
"defaultValue": "() => document.body"
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "aria-label",
|
|
228
|
+
"type": "string",
|
|
229
|
+
"description": "Accessible label for the popover, required when header is not present.",
|
|
230
|
+
"defaultValue": "''"
|
|
231
|
+
},
|
|
232
|
+
{
|
|
233
|
+
"name": "bodyContent",
|
|
234
|
+
"type": "React.ReactNode | ((hide: () => void) => React.ReactNode)",
|
|
235
|
+
"description": "Body content of the popover. If you want to close the popover after an action within the\nbody content, you can use the isVisible prop for manual control, or you can provide a\nfunction which will receive a callback as an argument to hide the popover, i.e.\nbodyContent={hide => <Button onClick={() => hide()}>Close</Button>}",
|
|
236
|
+
"required": true
|
|
237
|
+
},
|
|
238
|
+
{
|
|
239
|
+
"name": "children",
|
|
240
|
+
"type": "ReactElement<any>",
|
|
241
|
+
"description": "The trigger reference element to which the popover is relatively placed to. If you cannot wrap\nthe element with the Popover, you can use the triggerRef prop instead.\nUsage: <Popover><Button>Reference</Button></Popover>"
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "className",
|
|
245
|
+
"type": "string",
|
|
246
|
+
"description": "Additional classes added to the popover.",
|
|
247
|
+
"defaultValue": "''"
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"name": "closeBtnAriaLabel",
|
|
251
|
+
"type": "string",
|
|
252
|
+
"description": "Accessible label for the close button.",
|
|
253
|
+
"defaultValue": "'Close'"
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "distance",
|
|
257
|
+
"type": "number",
|
|
258
|
+
"description": "Distance of the popover to its target. Defaults to 25.",
|
|
259
|
+
"defaultValue": "25"
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"name": "elementToFocus",
|
|
263
|
+
"type": "HTMLElement | SVGElement | string",
|
|
264
|
+
"description": "The element to focus when the popover becomes visible. By default the first\nfocusable element will receive focus."
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"name": "enableFlip",
|
|
268
|
+
"type": "boolean",
|
|
269
|
+
"description": "If true, tries to keep the popover in view by flipping it if necessary.\nIf the position is set to 'auto', this prop is ignored.",
|
|
270
|
+
"defaultValue": "true"
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "flipBehavior",
|
|
274
|
+
"type": "| 'flip'\n| (\n | 'top'\n | 'bottom'\n | 'left'\n | 'right'\n | 'top-start'\n | 'top-end'\n | 'bottom-start'\n | 'bottom-end'\n | 'left-start'\n | 'left-end'\n | 'right-start'\n | 'right-end'\n )[]",
|
|
275
|
+
"description": "The desired position to flip the popover to if the initial position is not possible.\nBy setting this prop to 'flip' it attempts to flip the popover to the opposite side if\nthere is no space.\nYou can also pass an array of positions that determines the flip order. It should contain\nthe initial position followed by alternative positions if that position is unavailable.\nExample: Initial position is 'top'. Button with popover is in the top right corner.\n'flipBehavior' is set to ['top', 'right', 'left']. Since there is no space to the top, it\nchecks if right is available. There's also no space to the right, so it finally shows the\npopover on the left.",
|
|
276
|
+
"defaultValue": "[\n 'top',\n 'bottom',\n 'left',\n 'right',\n 'top-start',\n 'top-end',\n 'bottom-start',\n 'bottom-end',\n 'left-start',\n 'left-end',\n 'right-start',\n 'right-end'\n]"
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "footerContent",
|
|
280
|
+
"type": "React.ReactNode | ((hide: () => void) => React.ReactNode)",
|
|
281
|
+
"description": "Footer content of the popover. If you want to close the popover after an action within the\nfooter content, you can use the isVisible prop for manual control, or you can provide a\nfunction which will receive a callback as an argument to hide the popover, i.e.\nfooterContent={hide => <Button onClick={() => hide()}>Close</Button>}",
|
|
282
|
+
"defaultValue": "null"
|
|
283
|
+
},
|
|
284
|
+
{
|
|
285
|
+
"name": "hasAutoWidth",
|
|
286
|
+
"type": "boolean",
|
|
287
|
+
"description": "Removes fixed-width and allows width to be defined by contents.",
|
|
288
|
+
"defaultValue": "false"
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"name": "hasNoPadding",
|
|
292
|
+
"type": "boolean",
|
|
293
|
+
"description": "Allows content to touch edges of popover container.",
|
|
294
|
+
"defaultValue": "false"
|
|
295
|
+
},
|
|
296
|
+
{
|
|
297
|
+
"name": "headerComponent",
|
|
298
|
+
"type": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6'",
|
|
299
|
+
"description": "Sets the heading level to use for the popover header. Defaults to h6.",
|
|
300
|
+
"defaultValue": "'h6'"
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"name": "headerContent",
|
|
304
|
+
"type": "React.ReactNode | ((hide: () => void) => React.ReactNode)",
|
|
305
|
+
"description": "Simple header content to be placed within a title. If you want to close the popover after\nan action within the header content, you can use the isVisible prop for manual control,\nor you can provide a function which will receive a callback as an argument to hide the\npopover, i.e. headerContent={hide => <Button onClick={() => hide()}>Close</Button>}",
|
|
306
|
+
"defaultValue": "null"
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"name": "headerIcon",
|
|
310
|
+
"type": "React.ReactNode",
|
|
311
|
+
"description": "Icon to be displayed in the popover header. *",
|
|
312
|
+
"defaultValue": "null"
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "hideOnOutsideClick",
|
|
316
|
+
"type": "boolean",
|
|
317
|
+
"description": "Hides the popover when a click occurs outside (only works if isVisible is not controlled\nby the user).",
|
|
318
|
+
"defaultValue": "true"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"name": "id",
|
|
322
|
+
"type": "string",
|
|
323
|
+
"description": "Id used as part of the various popover elements (popover-${id}-header/body/footer)."
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"name": "isVisible",
|
|
327
|
+
"type": "boolean",
|
|
328
|
+
"description": "True to show the popover programmatically. Used in conjunction with the shouldClose prop.\nBy default, the popover child element handles click events automatically. If you want to\ncontrol this programmatically, the popover will not auto-close if the close button is\nclicked, the escape key is used, or if a click occurs outside the popover. Instead, the\nconsumer is responsible for closing the popover themselves by adding a callback listener\nfor the shouldClose prop.",
|
|
329
|
+
"defaultValue": "null"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "maxWidth",
|
|
333
|
+
"type": "string",
|
|
334
|
+
"description": "Maximum width of the popover (default 18.75rem).",
|
|
335
|
+
"defaultValue": "popoverMaxWidth && popoverMaxWidth.value"
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "minWidth",
|
|
339
|
+
"type": "string",
|
|
340
|
+
"description": "Minimum width of the popover (default 6.25rem).",
|
|
341
|
+
"defaultValue": "popoverMinWidth && popoverMinWidth.value"
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "onHidden",
|
|
345
|
+
"type": "() => void",
|
|
346
|
+
"description": "Lifecycle function invoked when the popover has fully transitioned out.",
|
|
347
|
+
"defaultValue": "(): void => null"
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
"name": "onHide",
|
|
351
|
+
"type": "(event: MouseEvent | KeyboardEvent) => void",
|
|
352
|
+
"description": "Lifecycle function invoked when the popover begins to transition out.",
|
|
353
|
+
"defaultValue": "(): void => null"
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"name": "onMount",
|
|
357
|
+
"type": "() => void",
|
|
358
|
+
"description": "Lifecycle function invoked when the popover has been mounted to the DOM.",
|
|
359
|
+
"defaultValue": "(): void => null"
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"name": "onShow",
|
|
363
|
+
"type": "(event: MouseEvent | KeyboardEvent) => void",
|
|
364
|
+
"description": "Lifecycle function invoked when the popover begins to transition in.",
|
|
365
|
+
"defaultValue": "(): void => null"
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "onShown",
|
|
369
|
+
"type": "() => void",
|
|
370
|
+
"description": "Lifecycle function invoked when the popover has fully transitioned in.",
|
|
371
|
+
"defaultValue": "(): void => null"
|
|
372
|
+
},
|
|
373
|
+
{
|
|
374
|
+
"name": "position",
|
|
375
|
+
"type": "| PopoverPosition\n| 'auto'\n| 'top'\n| 'bottom'\n| 'left'\n| 'right'\n| 'top-start'\n| 'top-end'\n| 'bottom-start'\n| 'bottom-end'\n| 'left-start'\n| 'left-end'\n| 'right-start'\n| 'right-end'",
|
|
376
|
+
"description": "Popover position. Note: With the enableFlip property set to true, it will change the\nposition if there is not enough space for the starting position. The behavior of where it\nflips to can be controlled through the flipBehavior property.",
|
|
377
|
+
"defaultValue": "'top'"
|
|
378
|
+
},
|
|
379
|
+
{
|
|
380
|
+
"name": "shouldClose",
|
|
381
|
+
"type": "(event: MouseEvent | KeyboardEvent, hideFunction?: () => void) => void",
|
|
382
|
+
"description": "Callback function that is only invoked when isVisible is also controlled. Called when the\npopover close button is clicked, the enter key was used on it, or the escape key is used.",
|
|
383
|
+
"defaultValue": "(): void => null"
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"name": "shouldOpen",
|
|
387
|
+
"type": "(event: MouseEvent | KeyboardEvent, showFunction?: () => void) => void",
|
|
388
|
+
"description": "Callback function that is only invoked when isVisible is also controlled. Called when the\nenter key is used on the focused trigger.",
|
|
389
|
+
"defaultValue": "(): void => null"
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"name": "showClose",
|
|
393
|
+
"type": "boolean",
|
|
394
|
+
"description": "Flag indicating whether the close button should be shown.",
|
|
395
|
+
"defaultValue": "true"
|
|
396
|
+
},
|
|
397
|
+
{
|
|
398
|
+
"name": "triggerAction",
|
|
399
|
+
"type": "'click' | 'hover'",
|
|
400
|
+
"description": "Sets an interaction to open popover, defaults to \"click\"",
|
|
401
|
+
"defaultValue": "'click'"
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "triggerRef",
|
|
405
|
+
"type": "HTMLElement | (() => HTMLElement) | React.RefObject<any>",
|
|
406
|
+
"description": "The trigger reference element to which the popover is relatively placed to. If you can wrap the\nelement with the popover, you can use the children prop instead, or both props together.\nWhen passed along with the trigger prop, the div element that wraps the trigger will be removed.\nUsage: <Popover triggerRef={() => document.getElementById('reference-element')} />"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
"name": "withFocusTrap",
|
|
410
|
+
"type": "boolean",
|
|
411
|
+
"description": "Whether to trap focus in the popover."
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "zIndex",
|
|
415
|
+
"type": "number",
|
|
416
|
+
"description": "The z-index of the popover.",
|
|
417
|
+
"defaultValue": "9999"
|
|
418
|
+
}
|
|
419
|
+
]
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "Card",
|
|
423
|
+
"description": "",
|
|
424
|
+
"props": [
|
|
425
|
+
{
|
|
426
|
+
"name": "children",
|
|
427
|
+
"type": "React.ReactNode",
|
|
428
|
+
"description": "Content rendered inside the Card"
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "className",
|
|
432
|
+
"type": "string",
|
|
433
|
+
"description": "Additional classes added to the Card"
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
"name": "component",
|
|
437
|
+
"type": "React.JSX.IntrinsicElements",
|
|
438
|
+
"description": "Sets the base component to render. defaults to div"
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
"name": "id",
|
|
442
|
+
"type": "string",
|
|
443
|
+
"description": "ID of the Card. Also passed back in the CardHeader onExpand callback."
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"name": "isClickable",
|
|
447
|
+
"type": "boolean",
|
|
448
|
+
"description": "Flag indicating that the card is clickable and contains some action that triggers on click."
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
"name": "isClicked",
|
|
452
|
+
"type": "boolean",
|
|
453
|
+
"description": "Flag indicating whether a card that is either only clickable or that is both clickable and selectable\nis currently clicked and has clicked styling."
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"name": "isCompact",
|
|
457
|
+
"type": "boolean",
|
|
458
|
+
"description": "Modifies the card to include compact styling. Should not be used with isLarge."
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"name": "isDisabled",
|
|
462
|
+
"type": "boolean",
|
|
463
|
+
"description": "Flag indicating that a clickable or selectable card is disabled."
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "isExpanded",
|
|
467
|
+
"type": "boolean",
|
|
468
|
+
"description": "Flag indicating if a card is expanded. Modifies the card to be expandable."
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "isFullHeight",
|
|
472
|
+
"type": "boolean",
|
|
473
|
+
"description": "Cause component to consume the available height of its container"
|
|
474
|
+
},
|
|
475
|
+
{
|
|
476
|
+
"name": "isGlass",
|
|
477
|
+
"type": "boolean",
|
|
478
|
+
"description": "Modifies the card to include glass styling when glass theme is enabled"
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"name": "isLarge",
|
|
482
|
+
"type": "boolean",
|
|
483
|
+
"description": "Modifies the card to be large. Should not be used with isCompact."
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "isPlain",
|
|
487
|
+
"type": "boolean",
|
|
488
|
+
"description": "Modifies the card to include plain styling; this removes border and background"
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"name": "isSelectable",
|
|
492
|
+
"type": "boolean",
|
|
493
|
+
"description": "Flag indicating that the card is selectable."
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "isSelected",
|
|
497
|
+
"type": "boolean",
|
|
498
|
+
"description": "Flag indicating whether a card that is either selectable only or both clickable and selectable is\ncurrently selected and has selected styling."
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
"name": "ouiaId",
|
|
502
|
+
"type": "number | string",
|
|
503
|
+
"description": "Value to overwrite the randomly generated data-ouia-component-id."
|
|
504
|
+
},
|
|
505
|
+
{
|
|
506
|
+
"name": "ouiaSafe",
|
|
507
|
+
"type": "boolean",
|
|
508
|
+
"description": "Set the value of data-ouia-safe. Only set to true when the component is in a static state, i.e. no animations are occurring. At all other times, this value must be false."
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"name": "variant",
|
|
512
|
+
"type": "'default' | 'secondary'",
|
|
513
|
+
"description": "Card background color variant"
|
|
514
|
+
}
|
|
515
|
+
]
|
|
516
|
+
}
|
|
517
|
+
],
|
|
518
|
+
"cssPrefix": [
|
|
519
|
+
"pf-v6-c-description-list"
|
|
520
|
+
],
|
|
521
|
+
"examples": [
|
|
522
|
+
"Basic",
|
|
523
|
+
"Term help text",
|
|
524
|
+
"Default 2 col",
|
|
525
|
+
"Default 3 col on lg",
|
|
526
|
+
"Horizontal",
|
|
527
|
+
"Horizontal using custom term width modifier",
|
|
528
|
+
"Horizontal 2 col",
|
|
529
|
+
"Horizontal 3 col on lg",
|
|
530
|
+
"Compact",
|
|
531
|
+
"Compact horizontal",
|
|
532
|
+
"Fluid horizontal",
|
|
533
|
+
"Column fill",
|
|
534
|
+
"Large display size",
|
|
535
|
+
"Default responsive columns",
|
|
536
|
+
"Horizontal responsive columns",
|
|
537
|
+
"Responsive horizontal, vertical group layout",
|
|
538
|
+
"Default auto column width",
|
|
539
|
+
"Horizontal auto column width",
|
|
540
|
+
"Default inline grid",
|
|
541
|
+
"Description list with card",
|
|
542
|
+
"Description list with large display size and card",
|
|
543
|
+
"Display size with card, three column on large breakpoint",
|
|
544
|
+
"Display size with card, horizontal, modified term width",
|
|
545
|
+
"Auto-fit basic",
|
|
546
|
+
"Auto-fit, min width modified grid template columns",
|
|
547
|
+
"Auto-fit, min width modified, responsive grid template columns",
|
|
548
|
+
"Icons on terms"
|
|
549
|
+
]
|
|
550
|
+
};
|
|
551
|
+
pageData.liveContext = {
|
|
552
|
+
useState,
|
|
553
|
+
Button,
|
|
554
|
+
DescriptionList,
|
|
555
|
+
DescriptionListTerm,
|
|
556
|
+
DescriptionListDescription,
|
|
557
|
+
DescriptionListGroup,
|
|
558
|
+
DescriptionListTermHelpText,
|
|
559
|
+
DescriptionListTermHelpTextButton,
|
|
560
|
+
Popover,
|
|
561
|
+
Checkbox,
|
|
562
|
+
Card,
|
|
563
|
+
RhUiAddCircleFillIcon,
|
|
564
|
+
CubeIcon,
|
|
565
|
+
BookIcon,
|
|
566
|
+
KeyIcon,
|
|
567
|
+
RhUiFlagFillIcon,
|
|
568
|
+
RhUiLanguageFillIcon
|
|
569
|
+
};
|
|
570
|
+
pageData.examples = {
|
|
571
|
+
'Basic': props =>
|
|
572
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListBasic: React.FunctionComponent = () => (\n <DescriptionList aria-label=\"Basic example\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Basic","lang":"ts","className":""}}>
|
|
573
|
+
|
|
574
|
+
</Example>,
|
|
575
|
+
'Term help text': props =>
|
|
576
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListGroup,\n DescriptionListDescription,\n DescriptionListTermHelpText,\n DescriptionListTermHelpTextButton,\n Popover\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListWithTermHelpText: React.FunctionComponent = () => (\n <DescriptionList aria-label=\"Term help text\">\n <DescriptionListGroup>\n <DescriptionListTermHelpText>\n <Popover headerContent={<div>Name</div>} bodyContent={<div>Additional name info</div>}>\n <DescriptionListTermHelpTextButton> Name </DescriptionListTermHelpTextButton>\n </Popover>\n </DescriptionListTermHelpText>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTermHelpText>\n <Popover headerContent={<div>Namespace</div>} bodyContent={<div>Additional namespace info</div>}>\n <DescriptionListTermHelpTextButton> Namespace </DescriptionListTermHelpTextButton>\n </Popover>\n </DescriptionListTermHelpText>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTermHelpText>\n <Popover headerContent={<div>Labels</div>} bodyContent={<div>Additional labels info</div>}>\n <DescriptionListTermHelpTextButton> Labels </DescriptionListTermHelpTextButton>\n </Popover>\n </DescriptionListTermHelpText>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTermHelpText>\n <Popover headerContent={<div>Pod selector</div>} bodyContent={<div>Additional pod selector info</div>}>\n <DescriptionListTermHelpTextButton> Pod selector </DescriptionListTermHelpTextButton>\n </Popover>\n </DescriptionListTermHelpText>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTermHelpText>\n <Popover headerContent={<div>Annotation</div>} bodyContent={<div>Additional annotation info</div>}>\n <DescriptionListTermHelpTextButton> Annotation </DescriptionListTermHelpTextButton>\n </Popover>\n </DescriptionListTermHelpText>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Term help text","lang":"ts","className":""}}>
|
|
577
|
+
|
|
578
|
+
</Example>,
|
|
579
|
+
'Default 2 col': props =>
|
|
580
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDefaultTwoCol: React.FunctionComponent = () => (\n <DescriptionList\n columnModifier={{\n default: '2Col'\n }}\n aria-label=\"Two-column\"\n >\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Default 2 col","lang":"ts","className":""}}>
|
|
581
|
+
|
|
582
|
+
</Example>,
|
|
583
|
+
'Default 3 col on lg': props =>
|
|
584
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDefaultThreeColLg: React.FunctionComponent = () => (\n <DescriptionList columnModifier={{ lg: '3Col' }} aria-label=\"Three-column on large screens\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Default 3 col on lg","lang":"ts","className":""}}>
|
|
585
|
+
|
|
586
|
+
</Example>,
|
|
587
|
+
'Horizontal': props =>
|
|
588
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListHorizontal: React.FunctionComponent = () => (\n <DescriptionList isHorizontal aria-label=\"Horizontal\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Horizontal","lang":"ts","className":""}}>
|
|
589
|
+
|
|
590
|
+
</Example>,
|
|
591
|
+
'Horizontal using custom term width modifier': props =>
|
|
592
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListHorizontalCustomTermWidth: React.FunctionComponent = () => (\n <DescriptionList\n isHorizontal\n horizontalTermWidthModifier={{\n default: '12ch',\n sm: '15ch',\n md: '20ch',\n lg: '28ch',\n xl: '30ch',\n '2xl': '35ch'\n }}\n aria-label=\"Horizontal with custom term width modifier\"\n >\n <DescriptionListGroup>\n <DescriptionListTerm>Name longer than the default term width</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Horizontal using custom term width modifier","lang":"ts","className":""}}>
|
|
593
|
+
|
|
594
|
+
</Example>,
|
|
595
|
+
'Horizontal 2 col': props =>
|
|
596
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListHorizontalTwoCol: React.FunctionComponent = () => (\n <DescriptionList isHorizontal columnModifier={{ default: '2Col' }} aria-label=\"Two-column horizontal\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Horizontal 2 col","lang":"ts","className":""}}>
|
|
597
|
+
|
|
598
|
+
</Example>,
|
|
599
|
+
'Horizontal 3 col on lg': props =>
|
|
600
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListHorizontalThreeColLg: React.FunctionComponent = () => (\n <DescriptionList isHorizontal columnModifier={{ lg: '3Col' }} aria-label=\"Three-columns horizontal on large screens\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Horizontal 3 col on lg","lang":"ts","className":""}}>
|
|
601
|
+
|
|
602
|
+
</Example>,
|
|
603
|
+
'Compact': props =>
|
|
604
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListCompact: React.FunctionComponent = () => (\n <DescriptionList isCompact aria-label=\"Compact example\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Compact","lang":"ts","className":""}}>
|
|
605
|
+
|
|
606
|
+
</Example>,
|
|
607
|
+
'Compact horizontal': props =>
|
|
608
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListCompactHorizontal: React.FunctionComponent = () => (\n <DescriptionList isCompact isHorizontal aria-label=\"Compact horizontal\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Compact horizontal","lang":"ts","className":""}}>
|
|
609
|
+
|
|
610
|
+
</Example>,
|
|
611
|
+
'Fluid horizontal': props =>
|
|
612
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListFluidHorizontal: React.FunctionComponent = () => (\n <DescriptionList isHorizontal isFluid aria-label=\"Fluid horizontal\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Fluid horizontal","lang":"ts","className":""}}>
|
|
613
|
+
|
|
614
|
+
</Example>,
|
|
615
|
+
'Column fill': props =>
|
|
616
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListColumnFill: React.FunctionComponent = () => (\n <DescriptionList isFillColumns columnModifier={{ default: '2Col', lg: '3Col' }} aria-label=\"Column fill enabled\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>\n This is a long description that should wrap to multiple lines in a multi-column layout.\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Column fill","lang":"ts","className":""}}>
|
|
617
|
+
|
|
618
|
+
</Example>,
|
|
619
|
+
'Large display size': props =>
|
|
620
|
+
<Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription,\n Checkbox\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListWithLargeDisplaySize: React.FunctionComponent = () => {\n const [isChecked, setIsChecked] = useState<boolean>(false);\n const [displaySize, setDisplaySize] = useState<'lg' | '2xl'>('lg');\n\n const toggleDisplaySize = (checked: boolean) => {\n setDisplaySize(checked ? '2xl' : 'lg');\n setIsChecked(checked);\n };\n\n return (\n <>\n <div style={{ marginBottom: '12px' }}>\n <Checkbox\n label=\"displaySize 2xl\"\n isChecked={isChecked}\n onChange={(_event, checked) => toggleDisplaySize(checked)}\n aria-label=\"set display size 2xl\"\n id=\"toggle-display-size\"\n name=\"toggle-display-size\"\n />\n </div>\n <DescriptionList displaySize={displaySize} columnModifier={{ lg: '2Col' }} aria-label=\"Large display size\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n </>\n );\n};\n","title":"Large display size","lang":"ts","className":""}}>
|
|
621
|
+
|
|
622
|
+
</Example>,
|
|
623
|
+
'Default responsive columns': props =>
|
|
624
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDefaultResponsiveColumns: React.FunctionComponent = () => (\n <DescriptionList columnModifier={{ lg: '2Col', xl: '3Col' }} aria-label=\"Default responsive columns\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Default responsive columns","lang":"ts","className":""}}>
|
|
625
|
+
|
|
626
|
+
</Example>,
|
|
627
|
+
'Horizontal responsive columns': props =>
|
|
628
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListHorizontalResponsiveColumns: React.FunctionComponent = () => (\n <DescriptionList isHorizontal columnModifier={{ lg: '2Col', xl: '3Col' }} aria-label=\"Horizontal responsive columns\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Horizontal responsive columns","lang":"ts","className":""}}>
|
|
629
|
+
|
|
630
|
+
</Example>,
|
|
631
|
+
'Responsive horizontal, vertical group layout': props =>
|
|
632
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListResponsiveHoriVertGroup: React.FunctionComponent = () => (\n <DescriptionList\n isHorizontal\n orientation={{\n md: 'vertical',\n lg: 'horizontal',\n xl: 'vertical',\n '2xl': 'horizontal'\n }}\n aria-label=\"Responsive orientation\"\n >\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Responsive horizontal, vertical group layout","lang":"ts","className":""}}>
|
|
633
|
+
|
|
634
|
+
</Example>,
|
|
635
|
+
'Default auto column width': props =>
|
|
636
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDefaultAutoColumn: React.FunctionComponent = () => (\n <DescriptionList isAutoColumnWidths columnModifier={{ default: '3Col' }} aria-label=\"Default auto column width\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Default auto column width","lang":"ts","className":""}}>
|
|
637
|
+
|
|
638
|
+
</Example>,
|
|
639
|
+
'Horizontal auto column width': props =>
|
|
640
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListHorizontalAutoColumn: React.FunctionComponent = () => (\n <DescriptionList\n isHorizontal\n isAutoColumnWidths\n columnModifier={{ lg: '2Col' }}\n aria-label=\"Horizontal auto column width\"\n >\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Horizontal auto column width","lang":"ts","className":""}}>
|
|
641
|
+
|
|
642
|
+
</Example>,
|
|
643
|
+
'Default inline grid': props =>
|
|
644
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDefaultInlineGrid: React.FunctionComponent = () => (\n <DescriptionList columnModifier={{ default: '3Col' }} isInlineGrid aria-label=\"Default inline grid\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Default inline grid","lang":"ts","className":""}}>
|
|
645
|
+
|
|
646
|
+
</Example>,
|
|
647
|
+
'Description list with card': props =>
|
|
648
|
+
<Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListDescription,\n Card,\n Checkbox\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListWithCard: React.FunctionComponent = () => {\n const [isChecked, setIsChecked] = useState<boolean>(false);\n const [isSelectable, setSelectable] = useState<boolean>(false);\n\n const toggleSelectable = (checked: boolean) => {\n setSelectable(checked ? true : false);\n setIsChecked(checked);\n };\n return (\n <>\n <div style={{ marginBottom: '12px' }}>\n <Checkbox\n label=\"isSelectable\"\n isChecked={isChecked}\n onChange={(_event, checked) => toggleSelectable(checked)}\n aria-label=\"set isSelectable\"\n id=\"toggle-isSelectable\"\n name=\"toggle-isSelectable\"\n />\n </div>\n <DescriptionList columnModifier={{ lg: '2Col' }} aria-label=\"With card example\">\n <Card component=\"div\" isSelectable={isSelectable}>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </Card>\n <Card component=\"div\" isSelectable={isSelectable}>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\" isSelectable={isSelectable}>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </Card>\n <Card component=\"div\" isSelectable={isSelectable}>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\" isSelectable={isSelectable}>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </Card>\n </DescriptionList>\n </>\n );\n};\n","title":"Description list with card","lang":"ts","className":""}}>
|
|
649
|
+
|
|
650
|
+
</Example>,
|
|
651
|
+
'Description list with large display size and card': props =>
|
|
652
|
+
<Example {...pageData} {...props} {...{"code":"import { useState } from 'react';\nimport {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListDescription,\n Card,\n Checkbox\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListWithLargeDisplaySizeAndCard: React.FunctionComponent = () => {\n const [isChecked, setIsChecked] = useState<boolean>(false);\n const [displaySize, setDisplaySize] = useState<'lg' | '2xl'>('lg');\n\n const toggleDisplaySize = (checked: boolean) => {\n setDisplaySize(checked ? '2xl' : 'lg');\n setIsChecked(checked);\n };\n\n return (\n <>\n <div style={{ marginBottom: '12px' }}>\n <Checkbox\n label=\"displaySize 2xl\"\n isChecked={isChecked}\n onChange={(_event, checked) => toggleDisplaySize(checked)}\n aria-label=\"set display size 2xl\"\n id=\"toggle-display-size-with-card\"\n name=\"toggle-display-size-with-card\"\n />\n </div>\n <DescriptionList\n displaySize={displaySize}\n columnModifier={{ lg: '2Col' }}\n aria-label=\"With large display size and card\"\n >\n <Card component=\"div\">\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </Card>\n </DescriptionList>\n </>\n );\n};\n","title":"Description list with large display size and card","lang":"ts","className":""}}>
|
|
653
|
+
|
|
654
|
+
</Example>,
|
|
655
|
+
'Display size with card, three column on large breakpoint': props =>
|
|
656
|
+
<Example {...pageData} {...props} {...{"code":"import { Button, DescriptionList, DescriptionListTerm, DescriptionListDescription, Card } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDisplayLgAndCardThreeColumn: React.FunctionComponent = () => (\n <DescriptionList\n displaySize=\"lg\"\n columnModifier={{ lg: '3Col' }}\n aria-label=\"Display size with card and three column on large breakpoint\"\n >\n <Card component=\"div\">\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </Card>\n </DescriptionList>\n);\n","title":"Display size with card, three column on large breakpoint","lang":"ts","className":""}}>
|
|
657
|
+
|
|
658
|
+
</Example>,
|
|
659
|
+
'Display size with card, horizontal, modified term width': props =>
|
|
660
|
+
<Example {...pageData} {...props} {...{"code":"import { Button, DescriptionList, DescriptionListTerm, DescriptionListDescription, Card } from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListDisplaySizeAndCardHorizontalTermWidth: React.FunctionComponent = () => (\n <DescriptionList\n displaySize=\"lg\"\n isHorizontal\n columnModifier={{ lg: '2Col' }}\n termWidth=\"10ch\"\n aria-label=\"Display size with card, horizontal and modified term width\"\n >\n <Card component=\"div\">\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </Card>\n <Card component=\"div\">\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </Card>\n </DescriptionList>\n);\n","title":"Display size with card, horizontal, modified term width","lang":"ts","className":""}}>
|
|
661
|
+
|
|
662
|
+
</Example>,
|
|
663
|
+
'Auto-fit basic': props =>
|
|
664
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListAutoFitBasic: React.FunctionComponent = () => (\n <DescriptionList isAutoFit aria-label=\"Basic auto-fit\">\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Auto-fit basic","lang":"ts","className":""}}>
|
|
665
|
+
|
|
666
|
+
</Example>,
|
|
667
|
+
'Auto-fit, min width modified grid template columns': props =>
|
|
668
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListAutoFitMinWidthModified: React.FunctionComponent = () => (\n <DescriptionList\n isAutoFit\n autoFitMinModifier={{ default: '200px' }}\n aria-label=\"Auto-fit grid with minimum width modification\"\n >\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Auto-fit, min width modified grid template columns","lang":"ts","className":""}}>
|
|
669
|
+
|
|
670
|
+
</Example>,
|
|
671
|
+
'Auto-fit, min width modified, responsive grid template columns': props =>
|
|
672
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\n\nexport const DescriptionListAutoFitMinWidthResponsive: React.FunctionComponent = () => (\n <DescriptionList\n isAutoFit\n autoFitMinModifier={{ md: '100px', lg: '150px', xl: '200px', '2xl': '300px' }}\n aria-label=\"Responsive auto-fit grid with minimum width\"\n >\n <DescriptionListGroup>\n <DescriptionListTerm>Name</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Auto-fit, min width modified, responsive grid template columns","lang":"ts","className":""}}>
|
|
673
|
+
|
|
674
|
+
</Example>,
|
|
675
|
+
'Icons on terms': props =>
|
|
676
|
+
<Example {...pageData} {...props} {...{"code":"import {\n Button,\n DescriptionList,\n DescriptionListTerm,\n DescriptionListGroup,\n DescriptionListDescription\n} from '@patternfly/react-core';\nimport RhUiAddCircleFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-add-circle-fill-icon';\nimport CubeIcon from '@patternfly/react-icons/dist/esm/icons/cube-icon';\nimport BookIcon from '@patternfly/react-icons/dist/esm/icons/book-icon';\nimport KeyIcon from '@patternfly/react-icons/dist/esm/icons/key-icon';\nimport RhUiFlagFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-flag-fill-icon';\nimport RhUiLanguageFillIcon from '@patternfly/react-icons/dist/esm/icons/rh-ui-language-fill-icon';\n\nexport const DescriptionListIconsOnTerms: React.FunctionComponent = () => (\n <DescriptionList aria-label=\"With icons examples\">\n <DescriptionListGroup>\n <DescriptionListTerm icon={<CubeIcon />}>Name</DescriptionListTerm>\n <DescriptionListDescription>Example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm icon={<BookIcon />}>Namespace</DescriptionListTerm>\n <DescriptionListDescription>\n <a href=\"#\">mary-test</a>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm icon={<KeyIcon />}>Labels</DescriptionListTerm>\n <DescriptionListDescription>example</DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm icon={<RhUiLanguageFillIcon />}>Pod selector</DescriptionListTerm>\n <DescriptionListDescription>\n <Button variant=\"link\" isInline icon={<RhUiAddCircleFillIcon />}>\n app=MyApp\n </Button>\n </DescriptionListDescription>\n </DescriptionListGroup>\n <DescriptionListGroup>\n <DescriptionListTerm icon={<RhUiFlagFillIcon />}>Annotation</DescriptionListTerm>\n <DescriptionListDescription>2 Annotations</DescriptionListDescription>\n </DescriptionListGroup>\n </DescriptionList>\n);\n","title":"Icons on terms","lang":"ts","className":""}}>
|
|
677
|
+
|
|
678
|
+
</Example>
|
|
679
|
+
};
|
|
680
|
+
|
|
681
|
+
const Component = () => (
|
|
682
|
+
<React.Fragment>
|
|
683
|
+
<AutoLinkHeader {...{"id":"examples","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
684
|
+
{`Examples`}
|
|
685
|
+
</AutoLinkHeader>
|
|
686
|
+
{React.createElement(pageData.examples["Basic"])}
|
|
687
|
+
{React.createElement(pageData.examples["Term help text"])}
|
|
688
|
+
{React.createElement(pageData.examples["Default 2 col"])}
|
|
689
|
+
{React.createElement(pageData.examples["Default 3 col on lg"])}
|
|
690
|
+
{React.createElement(pageData.examples["Horizontal"])}
|
|
691
|
+
{React.createElement(pageData.examples["Horizontal using custom term width modifier"])}
|
|
692
|
+
{React.createElement(pageData.examples["Horizontal 2 col"])}
|
|
693
|
+
{React.createElement(pageData.examples["Horizontal 3 col on lg"])}
|
|
694
|
+
{React.createElement(pageData.examples["Compact"])}
|
|
695
|
+
{React.createElement(pageData.examples["Compact horizontal"])}
|
|
696
|
+
{React.createElement(pageData.examples["Fluid horizontal"])}
|
|
697
|
+
{React.createElement(pageData.examples["Column fill"])}
|
|
698
|
+
{React.createElement(pageData.examples["Large display size"])}
|
|
699
|
+
<AutoLinkHeader {...{"id":"responsive-column-definitions","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
700
|
+
{`Responsive column definitions`}
|
|
701
|
+
</AutoLinkHeader>
|
|
702
|
+
{React.createElement(pageData.examples["Default responsive columns"])}
|
|
703
|
+
{React.createElement(pageData.examples["Horizontal responsive columns"])}
|
|
704
|
+
{React.createElement(pageData.examples["Responsive horizontal, vertical group layout"])}
|
|
705
|
+
<AutoLinkHeader {...{"id":"auto-column-width","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
706
|
+
{`Auto-column-width`}
|
|
707
|
+
</AutoLinkHeader>
|
|
708
|
+
{React.createElement(pageData.examples["Default auto column width"])}
|
|
709
|
+
{React.createElement(pageData.examples["Horizontal auto column width"])}
|
|
710
|
+
<AutoLinkHeader {...{"id":"inline-grid","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
711
|
+
{`Inline grid`}
|
|
712
|
+
</AutoLinkHeader>
|
|
713
|
+
{React.createElement(pageData.examples["Default inline grid"])}
|
|
714
|
+
<AutoLinkHeader {...{"id":"card-variants","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
715
|
+
{`Card variants`}
|
|
716
|
+
</AutoLinkHeader>
|
|
717
|
+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
|
|
718
|
+
{`A `}
|
|
719
|
+
<PatternflyThemeLink {...{"to":"/components/card","className":""}}>
|
|
720
|
+
{`card component`}
|
|
721
|
+
</PatternflyThemeLink>
|
|
722
|
+
{` can be used in place of a description list group.`}
|
|
723
|
+
</p>
|
|
724
|
+
{React.createElement(pageData.examples["Description list with card"])}
|
|
725
|
+
{React.createElement(pageData.examples["Description list with large display size and card"])}
|
|
726
|
+
{React.createElement(pageData.examples["Display size with card, three column on large breakpoint"])}
|
|
727
|
+
{React.createElement(pageData.examples["Display size with card, horizontal, modified term width"])}
|
|
728
|
+
<AutoLinkHeader {...{"id":"auto-fit","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
729
|
+
{`Auto fit`}
|
|
730
|
+
</AutoLinkHeader>
|
|
731
|
+
{React.createElement(pageData.examples["Auto-fit basic"])}
|
|
732
|
+
{React.createElement(pageData.examples["Auto-fit, min width modified grid template columns"])}
|
|
733
|
+
{React.createElement(pageData.examples["Auto-fit, min width modified, responsive grid template columns"])}
|
|
734
|
+
<AutoLinkHeader {...{"id":"with-icons","headingLevel":"h2","className":"ws-title ws-h2"}}>
|
|
735
|
+
{`With icons`}
|
|
736
|
+
</AutoLinkHeader>
|
|
737
|
+
{React.createElement(pageData.examples["Icons on terms"])}
|
|
738
|
+
</React.Fragment>
|
|
739
|
+
);
|
|
740
|
+
Component.displayName = 'ComponentsDescriptionListReactDocs';
|
|
741
|
+
Component.pageData = pageData;
|
|
742
|
+
|
|
743
|
+
export default Component;
|