@patternfly/patternfly-doc-core 1.6.0 → 1.8.0
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/.astro/collections/examples.schema.json +19 -0
- package/.astro/collections/textContent.schema.json +19 -0
- package/.astro/content-modules.mjs +1 -0
- package/dist/client/_astro/{PageContext.D1pNBMhh.js → Button.IBWho7ny.js} +2 -2
- package/dist/client/_astro/CSSTable.V4xaGXjj.js +1185 -0
- package/dist/client/_astro/Content.Dv9vgAns.js +1 -0
- package/dist/client/_astro/DropdownGroup.DmTizX-Q.js +1 -0
- package/dist/client/_astro/DropdownList.BUcpBUVP.js +1 -0
- package/dist/client/_astro/LiveExample.CiM2pGMB.js +18 -0
- package/dist/client/_astro/Navigation.CnvE1VCH.js +1 -0
- package/dist/client/_astro/PageContext.ipir86Hm.js +1 -0
- package/dist/client/_astro/PageSidebarBody.vGxFk_DU.js +1 -0
- package/dist/client/_astro/PageToggle.C6_rp-Bm.js +1 -0
- package/dist/client/_astro/PageToggleButton.CagcouJB.js +1 -0
- package/dist/client/_astro/SearchInput.BwWsXfyf.js +1 -0
- package/dist/client/_astro/SectionGallery.DqD5bUWQ.js +1 -0
- package/dist/client/_astro/Toolbar.BmilfRHR.js +1 -0
- package/dist/client/_astro/ToolbarContent.Cd-kqxku.js +1 -0
- package/dist/client/_astro/_page_.BWicMEzd.css +1 -0
- package/dist/client/_astro/_page_.Chv_bGyU.css +1 -0
- package/dist/client/_astro/angle-left-icon.C3MzYN3k.js +1 -0
- package/dist/client/_astro/{client.CTJTt880.js → client.zs76E0tG.js} +1 -1
- package/dist/client/_astro/divider.O4WEhuBq.js +1 -0
- package/dist/client/_astro/help-icon.Du6t7nyh.js +8 -0
- package/dist/client/_astro/{index.Dhi-S4Ah.js → index.BQFV5hT1.js} +1 -1
- package/dist/client/_astro/index.BkswdOFP.js +16 -0
- package/dist/client/_astro/index.CAChmxYj.js +1 -0
- package/dist/client/_astro/{index.Dkaqzkgy.js → index.eCxJ45ll.js} +2 -2
- package/dist/client/_astro/page.BTC3Kf3x.js +1 -0
- package/dist/client/components/accordion/index.html +42 -17
- package/dist/client/components/accordion/react/index.html +110 -0
- package/dist/client/components/all-components/index.html +97 -0
- package/dist/client/design-foundations/typography/index.html +36 -9
- package/dist/client/design-foundations/usage-and-behavior/index.html +36 -9
- package/dist/client/get-started/contribute/index.html +36 -9
- package/dist/client/index.html +3 -4
- package/dist/server/chunks/Button_DVSwQ8oX.mjs +639 -0
- package/dist/server/chunks/CSSTable_CG80uW98.mjs +740 -0
- package/dist/server/chunks/CSSTable_Dj2CroFz.mjs +4 -0
- package/dist/server/chunks/{PropsTables_IgCNCQTX.mjs → PropsTables_DUo7F9VR.mjs} +36 -47
- package/dist/server/chunks/Stack_Xm3fJVbK.mjs +22 -0
- package/dist/server/chunks/_astro_data-layer-content_D4Ib_RjR.mjs +1 -0
- package/dist/server/chunks/{angle-down-icon_C5YQ7k8s.mjs → angle-down-icon_DtGGiMR5.mjs} +5 -637
- package/dist/server/chunks/content-modules_fX1c2JRG.mjs +1 -0
- package/dist/server/entry.mjs +3 -2
- package/dist/server/{manifest_DoNTQyvZ.mjs → manifest_CXkcH4VT.mjs} +1 -1
- package/jest.config.ts +1 -1
- package/package.json +1 -1
- package/src/components/AutoLinkHeader.tsx +56 -0
- package/src/components/CSSSearch.tsx +33 -0
- package/src/components/CSSTable.astro +33 -0
- package/src/components/CSSTable.tsx +268 -0
- package/src/components/NavEntry.tsx +3 -0
- package/src/components/Navigation.astro +16 -9
- package/src/components/section-gallery/SectionGallery.astro +19 -0
- package/src/components/section-gallery/SectionGallery.css +20 -0
- package/src/components/section-gallery/SectionGallery.tsx +111 -0
- package/src/components/section-gallery/SectionGalleryGridLayout.tsx +97 -0
- package/src/components/section-gallery/SectionGalleryListLayout.tsx +108 -0
- package/src/components/section-gallery/SectionGalleryToolbar.tsx +93 -0
- package/src/content.config.ts +11 -3
- package/src/layouts/Main.astro +12 -8
- package/src/pages/[section]/[...page].astro +20 -6
- package/src/pages/[section]/[page]/[...tab].astro +29 -23
- package/src/pages/index.astro +0 -1
- package/src/styles/global.scss +47 -1
- package/src/utils/index.ts +1 -0
- package/src/utils/slugger.ts +14 -0
- package/textContent/AllComponents.mdx +16 -0
- package/textContent/components-data.js +476 -0
- package/textContent/contribute.md +19 -13
- package/textContent/examples/Accordion/Accordion.mdx +1 -0
- package/dist/client/_astro/LiveExample.Df-EUsee.js +0 -40
- package/dist/client/_astro/Navigation.CabjIYg4.js +0 -1
- package/dist/client/_astro/PageSidebarBody.Y-7d6zQM.js +0 -1
- package/dist/client/_astro/PageToggle.CbfM9bJB.js +0 -1
- package/dist/client/_astro/PageToggleButton.CZ3xPbcc.js +0 -1
- package/dist/client/_astro/Toolbar.9-YSFh3P.js +0 -1
- package/dist/client/_astro/ToolbarContent.BXdFKbs9.js +0 -1
- package/dist/client/_astro/_page_.B8cBYNKa.css +0 -1
- package/dist/client/_astro/_tab_.YrfmckTJ.css +0 -1
- package/dist/client/_astro/divider.DjbDHO_6.js +0 -1
- package/dist/client/_astro/page.CDtWFZb5.js +0 -1
- /package/dist/client/_astro/{_tab_.DxJDkZPc.css → _page_.DxJDkZPc.css} +0 -0
- /package/dist/server/chunks/{Accordion_CGgMUho2.mjs → Accordion_BJka4Qvb.mjs} +0 -0
- /package/dist/server/chunks/{Accordion_DlM2LvlF.mjs → Accordion_BQIphkaZ.mjs} +0 -0
- /package/dist/server/chunks/{_astro_data-layer-content_Ni7IDnLe.mjs → AllComponents_CRhgTsiT.mjs} +0 -0
- /package/dist/server/chunks/{content-modules_BzUEG69n.mjs → AllComponents_CjOtwUH6.mjs} +0 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import React from 'react'
|
|
2
|
+
|
|
3
|
+
// Should produce valid URLs and valid CSS ids
|
|
4
|
+
export const slugger = (children: React.ReactNode) => {
|
|
5
|
+
const value = React.Children.toArray(children)
|
|
6
|
+
.filter((child) => typeof child === 'string' || typeof child === 'number')
|
|
7
|
+
.join('')
|
|
8
|
+
return value
|
|
9
|
+
.toLowerCase()
|
|
10
|
+
.trim()
|
|
11
|
+
.replace(/index$/, '')
|
|
12
|
+
.replace(/\s/g, '-')
|
|
13
|
+
.replace(/[^A-Za-z0-9.\-~]/g, '')
|
|
14
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: All components
|
|
3
|
+
title: All components
|
|
4
|
+
section: components
|
|
5
|
+
sortValue: 1
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import { componentsData } from './components-data.js'
|
|
9
|
+
|
|
10
|
+
<SectionGallery
|
|
11
|
+
section="components"
|
|
12
|
+
galleryItemsData={componentsData}
|
|
13
|
+
placeholderText="Search components by name"
|
|
14
|
+
hasGridText
|
|
15
|
+
hasListText
|
|
16
|
+
/>
|
|
@@ -0,0 +1,476 @@
|
|
|
1
|
+
// Updated format for section gallery component data. Now is an object containing JSX, to avoid having to parse JSON into JSX
|
|
2
|
+
// Added the label & a optional fields
|
|
3
|
+
// illustration field may not be necessary now
|
|
4
|
+
export const componentsData = {
|
|
5
|
+
'about-modal': {
|
|
6
|
+
illustration: './images/component-illustrations/about-modal.png',
|
|
7
|
+
summary:
|
|
8
|
+
'An <b>about modal</b> displays information about an application, like product version numbers and any appropriate legal text.',
|
|
9
|
+
},
|
|
10
|
+
accordion: {
|
|
11
|
+
illustration: './images/component-illustrations/accordion.png',
|
|
12
|
+
summary:
|
|
13
|
+
'An <b>accordion</b> is a vertically stacked list that can be expanded and collapsed to reveal and hide nested content.',
|
|
14
|
+
},
|
|
15
|
+
'action-list': {
|
|
16
|
+
illustration: './images/component-illustrations/action-list.png',
|
|
17
|
+
summary:
|
|
18
|
+
'An <b>action list</b> is a group of actions, controls, or buttons with built-in spacing.',
|
|
19
|
+
},
|
|
20
|
+
alert: {
|
|
21
|
+
illustration: './images/component-illustrations/alert.png',
|
|
22
|
+
summary:
|
|
23
|
+
'An <b>alert</b> is a non-intrusive notification that shares brief, important messages with users.',
|
|
24
|
+
},
|
|
25
|
+
'application-launcher': {
|
|
26
|
+
illustration: './images/component-illustrations/application-launcher.png',
|
|
27
|
+
summary:
|
|
28
|
+
'An <b>application launcher</b> is a menu that allows users to launch a separate web application in a new browser window.',
|
|
29
|
+
label: 'demo',
|
|
30
|
+
},
|
|
31
|
+
avatar: {
|
|
32
|
+
illustration: './images/component-illustrations/avatar.png',
|
|
33
|
+
summary:
|
|
34
|
+
'An <b>avatar</b> is a visual representation of a user, which can contain an image or placeholder graphic.',
|
|
35
|
+
},
|
|
36
|
+
'back-to-top': {
|
|
37
|
+
illustration: './images/component-illustrations/back-to-top.png',
|
|
38
|
+
summary:
|
|
39
|
+
'The <b>back to top</b> component is a shortcut that allows users to quickly navigate to the top of a page via a button.',
|
|
40
|
+
},
|
|
41
|
+
backdrop: {
|
|
42
|
+
illustration: './images/component-illustrations/backdrop.png',
|
|
43
|
+
summary:
|
|
44
|
+
'A <b>backdrop</b> is a screen that covers the main content of a page when a modal is opened, to prevent page interaction until the modal is dismissed.',
|
|
45
|
+
},
|
|
46
|
+
'background-image': {
|
|
47
|
+
illustration: './images/component-illustrations/background-image.png',
|
|
48
|
+
summary:
|
|
49
|
+
'A <b>background image</b> is an image that fills the background of a page.',
|
|
50
|
+
},
|
|
51
|
+
badge: {
|
|
52
|
+
illustration: './images/component-illustrations/badge.png',
|
|
53
|
+
summary: 'A <b>badge</b> is an annotation that displays a numeric value.',
|
|
54
|
+
},
|
|
55
|
+
banner: {
|
|
56
|
+
illustration: './images/component-illustrations/banner.png',
|
|
57
|
+
summary:
|
|
58
|
+
'A <b>banner</b> is a short message that is shared with users in an unobtrusive, full-width container that cannot be dismissed.',
|
|
59
|
+
},
|
|
60
|
+
brand: {
|
|
61
|
+
illustration: './images/component-illustrations/brand.png',
|
|
62
|
+
summary:
|
|
63
|
+
'A <b>brand</b> is a visual representation of a product—typically its logo.',
|
|
64
|
+
},
|
|
65
|
+
breadcrumb: {
|
|
66
|
+
illustration: './images/component-illustrations/breadcrumb.png',
|
|
67
|
+
summary:
|
|
68
|
+
'A <b>breadcrumb</b> is a secondary navigation method that shows where users are in an application, to help them navigate more efficiently.',
|
|
69
|
+
},
|
|
70
|
+
button: {
|
|
71
|
+
illustration: './images/component-illustrations/button.png',
|
|
72
|
+
summary:
|
|
73
|
+
'A <b>button</b> is an object that communicates and triggers an action when it is clicked or selected.',
|
|
74
|
+
},
|
|
75
|
+
'calendar-month': {
|
|
76
|
+
illustration: './images/component-illustrations/calendar-month.png',
|
|
77
|
+
summary:
|
|
78
|
+
'A <b>calendar month</b> component allows users to select and navigate between days, months, and years.',
|
|
79
|
+
},
|
|
80
|
+
card: {
|
|
81
|
+
illustration: './images/component-illustrations/card.png',
|
|
82
|
+
summary:
|
|
83
|
+
'A <b>card</b> is a content container that displays entry-level information—typically within dashboards, galleries, and catalogs.',
|
|
84
|
+
},
|
|
85
|
+
checkbox: {
|
|
86
|
+
illustration: './images/component-illustrations/checkbox.png',
|
|
87
|
+
summary:
|
|
88
|
+
'A <b>checkbox</b> is an input control that allows users to select a single item or multiple items from a list.',
|
|
89
|
+
},
|
|
90
|
+
chip: {
|
|
91
|
+
illustration: './images/component-illustrations/chip.png',
|
|
92
|
+
summary:
|
|
93
|
+
"A <b>chip</b> is used to communicate a value or a set of attribute-value pairs within workflows that involve filtering a set of objects.<br /><br /><b>Note:</b> The chip component has been deprecated. Our new recommendation is to use <a href='/components/label'>the label component</a> instead.",
|
|
94
|
+
label: 'deprecated',
|
|
95
|
+
},
|
|
96
|
+
'clipboard-copy': {
|
|
97
|
+
illustration: './images/component-illustrations/clipboard-copy.png',
|
|
98
|
+
summary:
|
|
99
|
+
'The <b>clipboard copy</b> component allows users to quickly and easily copy content to their clipboard.',
|
|
100
|
+
},
|
|
101
|
+
'code-block': {
|
|
102
|
+
illustration: './images/component-illustrations/code-block.png',
|
|
103
|
+
summary:
|
|
104
|
+
"A <b>code block</b> contains 2 or more lines of read-only code, which can be copied to a user's clipboard.",
|
|
105
|
+
},
|
|
106
|
+
'code-editor': {
|
|
107
|
+
illustration: './images/component-illustrations/code-editor.png',
|
|
108
|
+
summary:
|
|
109
|
+
"A <b>code editor</b> is a versatile <a href='https://microsoft.github.io/monaco-editor/'>Monaco-based</a> text editor that supports various programming languages.",
|
|
110
|
+
},
|
|
111
|
+
content: {
|
|
112
|
+
illustration: './images/component-illustrations/context-selector.png',
|
|
113
|
+
summary:
|
|
114
|
+
'A <b>content</b> component contains a block of styled HTML content.',
|
|
115
|
+
},
|
|
116
|
+
'context-selector': {
|
|
117
|
+
illustration: './images/component-illustrations/context-selector.png',
|
|
118
|
+
summary:
|
|
119
|
+
"A <b>context selector</b> is a dropdown menu placed in the global navigation, which allows you to switch a user's application context to display relevant data and resources.",
|
|
120
|
+
label: 'demo',
|
|
121
|
+
},
|
|
122
|
+
'custom-menus': {
|
|
123
|
+
illustration: './images/component-illustrations/custom-menus.png',
|
|
124
|
+
summary:
|
|
125
|
+
"<b>Custom menus</b> can be created to address a variety of unique use cases, by combining <a href='/components/menus/menu'>menus</a> and <a href='/components/menus/menu-toggle'>menu toggles.</a>",
|
|
126
|
+
label: 'demo',
|
|
127
|
+
},
|
|
128
|
+
'data-list': {
|
|
129
|
+
illustration: './images/component-illustrations/data-list.png',
|
|
130
|
+
summary:
|
|
131
|
+
'A <b>data list</b> displays large data sets and interactive content in a flexible layout.',
|
|
132
|
+
},
|
|
133
|
+
'date-picker': {
|
|
134
|
+
illustration: './images/component-illustrations/date-picker.png',
|
|
135
|
+
summary:
|
|
136
|
+
'A <b>date picker</b> allows users to either manually enter a date or select a date from a calendar.',
|
|
137
|
+
},
|
|
138
|
+
'date-and-time-picker': {
|
|
139
|
+
illustration: './images/component-illustrations/date-and-time-picker.png',
|
|
140
|
+
summary:
|
|
141
|
+
"A <b>date and time picker</b> allows users to select both a specific date and a time, by combining <a href='/components/date-and-time/date-picker'>date picker</a> and <a href='/components/date-and-time/time-picker'>time picker</a> components.",
|
|
142
|
+
label: 'demo',
|
|
143
|
+
},
|
|
144
|
+
'description-list': {
|
|
145
|
+
illustration: './images/component-illustrations/description-list.png',
|
|
146
|
+
summary:
|
|
147
|
+
'A <b>description list</b> displays terms and their corresponding descriptions.',
|
|
148
|
+
},
|
|
149
|
+
divider: {
|
|
150
|
+
illustration: './images/component-illustrations/divider.png',
|
|
151
|
+
summary:
|
|
152
|
+
'A <b>divider</b> is a horizontal or vertical line that is placed between screen elements to create visual divisions and content groupings.',
|
|
153
|
+
},
|
|
154
|
+
'drag-and-drop': {
|
|
155
|
+
illustration: './images/component-illustrations/drag-and-drop.png',
|
|
156
|
+
summary:
|
|
157
|
+
'The <b>drag and drop</b> component allows users to reposition, rearrange, and group items into more relevant and appropriate layouts.',
|
|
158
|
+
},
|
|
159
|
+
drawer: {
|
|
160
|
+
illustration: './images/component-illustrations/drawer.png',
|
|
161
|
+
summary:
|
|
162
|
+
'A <b>drawer</b> is a sliding panel that enters from outside of the viewport, which can be configured to either overlay content or create a sidebar by pushing content.',
|
|
163
|
+
},
|
|
164
|
+
dropdown: {
|
|
165
|
+
illustration: './images/component-illustrations/dropdown.png',
|
|
166
|
+
summary:
|
|
167
|
+
'A <b>dropdown</b> displays a menu of actions that trigger a process and as that navigate to a new location.',
|
|
168
|
+
label: 'beta',
|
|
169
|
+
},
|
|
170
|
+
'dual-list-selector': {
|
|
171
|
+
illustration: './images/component-illustrations/dual-list-selector.png',
|
|
172
|
+
summary:
|
|
173
|
+
'A <b>dual list selector</b> displays 2 interactive lists: a list of selected items and a list of available, selectable items. Users can move items between the lists.',
|
|
174
|
+
},
|
|
175
|
+
'empty-state': {
|
|
176
|
+
illustration: './images/component-illustrations/empty-state.png',
|
|
177
|
+
summary:
|
|
178
|
+
'An <b>empty state</b> is a screen that is not yet populated with data or information—typically containing a short message and next steps for users.',
|
|
179
|
+
},
|
|
180
|
+
'expandable-section': {
|
|
181
|
+
illustration: './images/component-illustrations/expandable-section.png',
|
|
182
|
+
summary:
|
|
183
|
+
'An <b>expandable section</b> is a content section with a text toggle that reveals content that is hidden by default.',
|
|
184
|
+
},
|
|
185
|
+
'multiple-file-upload': {
|
|
186
|
+
illustration: './images/component-illustrations/file-upload-multiple.png',
|
|
187
|
+
summary:
|
|
188
|
+
'A <b>multiple file upload</b> component allows users to select and upload multiple files to a specific location.',
|
|
189
|
+
},
|
|
190
|
+
'simple-file-upload': {
|
|
191
|
+
illustration: './images/component-illustrations/file-upload.png',
|
|
192
|
+
summary:
|
|
193
|
+
'A <b>simple file upload</b> component allows users to select and upload a single file to a specific location.',
|
|
194
|
+
},
|
|
195
|
+
'form-control': {
|
|
196
|
+
illustration: './images/component-illustrations/form-control.png',
|
|
197
|
+
summary:
|
|
198
|
+
'A <b>form control</b> is a form element that guides users and accepts user input, such as text areas and selection menus.',
|
|
199
|
+
},
|
|
200
|
+
form: {
|
|
201
|
+
illustration: './images/component-illustrations/form.png',
|
|
202
|
+
summary:
|
|
203
|
+
'A <b>form</b> is a group of related elements that allow users to provide data and configure options in a variety of contexts, such as within modals, wizards, and pages.',
|
|
204
|
+
},
|
|
205
|
+
'form-select': {
|
|
206
|
+
illustration: './images/component-illustrations/form-select.png',
|
|
207
|
+
summary:
|
|
208
|
+
'A <b>form select</b> is a form element that embeds browser-native menus.',
|
|
209
|
+
},
|
|
210
|
+
'helper-text': {
|
|
211
|
+
illustration: './images/component-illustrations/helper-text.png',
|
|
212
|
+
summary:
|
|
213
|
+
'<b>Helper text</b> is a text-based support method that adds additional context to field inputs.',
|
|
214
|
+
},
|
|
215
|
+
hint: {
|
|
216
|
+
illustration: './images/component-illustrations/hint.png',
|
|
217
|
+
summary:
|
|
218
|
+
'A <b>hint</b> is an in-app message that shares reminders, explanations, or calls to action within a page or modal.',
|
|
219
|
+
},
|
|
220
|
+
icon: {
|
|
221
|
+
illustration: './images/component-illustrations/icon.png',
|
|
222
|
+
summary:
|
|
223
|
+
"An <b>icon</b> component is a container that supports <a href='/design-foundations/icons#all-icons'>icons</a> of varying dimensions and styles, as well as <a href='/components/spinner'>spinners.</a>",
|
|
224
|
+
},
|
|
225
|
+
'inline-edit': {
|
|
226
|
+
illustration: './images/component-illustrations/inline-edit.png',
|
|
227
|
+
summary:
|
|
228
|
+
'An <b>inline edit</b> component allows users to switch between read-only and edits views of description lists, page text elements, or tables—within the context of their current view.',
|
|
229
|
+
},
|
|
230
|
+
'input-group': {
|
|
231
|
+
illustration: './images/component-illustrations/input-group.png',
|
|
232
|
+
summary:
|
|
233
|
+
'An <b>input group</b> combines multiple related controls or inputs to appear as a single control.',
|
|
234
|
+
},
|
|
235
|
+
'jump-links': {
|
|
236
|
+
illustration: './images/component-illustrations/jump-links.png',
|
|
237
|
+
summary:
|
|
238
|
+
'When clicked, <b>jump links</b> allow users to navigate to sections within a page without scrolling.',
|
|
239
|
+
},
|
|
240
|
+
label: {
|
|
241
|
+
illustration: './images/component-illustrations/label.png',
|
|
242
|
+
summary:
|
|
243
|
+
'A <b>label</b> is a descriptive annotation that adds context to an element for clarity and convenience.',
|
|
244
|
+
},
|
|
245
|
+
list: {
|
|
246
|
+
illustration: './images/component-illustrations/list.png',
|
|
247
|
+
summary:
|
|
248
|
+
'A <b>list</b> component embeds a formatted list—bulleted or numbered—into page content.',
|
|
249
|
+
},
|
|
250
|
+
'login-page': {
|
|
251
|
+
illustration: './images/component-illustrations/login-page.png',
|
|
252
|
+
summary:
|
|
253
|
+
'A <b>login page</b> allows a user to access an application by entering a username and password, or by authenticating using a social media login.',
|
|
254
|
+
},
|
|
255
|
+
masthead: {
|
|
256
|
+
illustration: './images/component-illustrations/masthead.png',
|
|
257
|
+
summary:
|
|
258
|
+
'A <b>masthead</b> contains and organizes global properties like a logo, navigation, and settings for easy and consistent access across all pages of an application.',
|
|
259
|
+
},
|
|
260
|
+
'menu-toggle': {
|
|
261
|
+
illustration: './images/component-illustrations/menu-toggle.png',
|
|
262
|
+
summary:
|
|
263
|
+
'A <b>menu toggle</b> is a selectable control that opens and closes a menu.',
|
|
264
|
+
},
|
|
265
|
+
menu: {
|
|
266
|
+
illustration: './images/component-illustrations/menu.png',
|
|
267
|
+
summary:
|
|
268
|
+
'A <b>menu</b> is a list of options or actions that users can choose from.',
|
|
269
|
+
},
|
|
270
|
+
modal: {
|
|
271
|
+
illustration: './images/component-illustrations/modal.png',
|
|
272
|
+
summary:
|
|
273
|
+
'A <b>modal</b> is a window that overlays a page to display important information, without requiring users to navigate to a new page.',
|
|
274
|
+
},
|
|
275
|
+
navigation: {
|
|
276
|
+
illustration: './images/component-illustrations/navigation.png',
|
|
277
|
+
summary:
|
|
278
|
+
"A <b>navigation</b> component organizes and communicates an application's structure and content in a central location, making it easy to find information and accomplish tasks.",
|
|
279
|
+
},
|
|
280
|
+
'notification-badge': {
|
|
281
|
+
illustration: './images/component-illustrations/notification-badge.png',
|
|
282
|
+
summary:
|
|
283
|
+
'A <b>notification badge</b> is a visual indicator that alerts users about incoming notifications.',
|
|
284
|
+
},
|
|
285
|
+
'notification-drawer': {
|
|
286
|
+
illustration: './images/component-illustrations/notification-drawer.png',
|
|
287
|
+
summary:
|
|
288
|
+
"A <b>notification drawer</b> contains an application's notifications, which users can view and manage without having to navigate to a new screen.",
|
|
289
|
+
},
|
|
290
|
+
'number-input': {
|
|
291
|
+
illustration: './images/component-illustrations/number-input.png',
|
|
292
|
+
summary:
|
|
293
|
+
'A <b>number input</b> combines a text input field with buttons to provide users with a quick and effective way to enter and modify a numeric value.',
|
|
294
|
+
},
|
|
295
|
+
'options-menu': {
|
|
296
|
+
illustration: './images/component-illustrations/options-menu.png',
|
|
297
|
+
summary: 'An <b>options menu</b> contains a set of optional settings.',
|
|
298
|
+
label: 'demo',
|
|
299
|
+
},
|
|
300
|
+
'overflow-menu': {
|
|
301
|
+
illustration: './images/component-illustrations/overflow-menu.png',
|
|
302
|
+
summary:
|
|
303
|
+
'An <b>overflow menu</b> groups a set of actions into a responsive horizontal list to help declutter the UI.',
|
|
304
|
+
},
|
|
305
|
+
page: {
|
|
306
|
+
illustration: './images/component-illustrations/page.png',
|
|
307
|
+
summary:
|
|
308
|
+
'A <b>page</b> component defines the basic layout of a page, with either vertical or horizontal navigation.',
|
|
309
|
+
},
|
|
310
|
+
pagination: {
|
|
311
|
+
illustration: './images/component-illustrations/pagination.png',
|
|
312
|
+
summary:
|
|
313
|
+
'A <b>pagination</b> component allows users to navigate through large content views that have been split across multiple pages.',
|
|
314
|
+
},
|
|
315
|
+
panel: {
|
|
316
|
+
illustration: './images/component-illustrations/panel.png',
|
|
317
|
+
summary:
|
|
318
|
+
'A <b>panel</b> is a customizable container that can contain other components in flexible content layouts.',
|
|
319
|
+
},
|
|
320
|
+
'password-generator': {
|
|
321
|
+
illustration: './images/component-illustrations/password-generator.png',
|
|
322
|
+
summary:
|
|
323
|
+
'This demo demonstrates how to create an input field that generates unique passwords.',
|
|
324
|
+
label: 'demo',
|
|
325
|
+
},
|
|
326
|
+
'password-strength': {
|
|
327
|
+
illustration: './images/component-illustrations/password-strength.png',
|
|
328
|
+
summary:
|
|
329
|
+
'This demo demonstrates how to validate and display feedback about password strength.',
|
|
330
|
+
label: 'demo',
|
|
331
|
+
},
|
|
332
|
+
popover: {
|
|
333
|
+
illustration: './images/component-illustrations/popover.png',
|
|
334
|
+
summary:
|
|
335
|
+
'A <b>popover</b> is a small overlay window that provides additional information about an on-screen element.',
|
|
336
|
+
},
|
|
337
|
+
'progress-stepper': {
|
|
338
|
+
illustration: './images/component-illustrations/progress-stepper.png',
|
|
339
|
+
summary:
|
|
340
|
+
"A <b>progress stepper</b> displays a timeline of tasks in a workflow and tracks a user's progress through the workflow.",
|
|
341
|
+
},
|
|
342
|
+
progress: {
|
|
343
|
+
illustration: './images/component-illustrations/progress.png',
|
|
344
|
+
summary:
|
|
345
|
+
'A <b>progress</b> component is a horizontal bar that indicates the completion status of an ongoing process or task.',
|
|
346
|
+
},
|
|
347
|
+
radio: {
|
|
348
|
+
illustration: './images/component-illustrations/radio.png',
|
|
349
|
+
summary:
|
|
350
|
+
"A <b>radio</b> is a button that's used to present users with mutually exclusive choices.",
|
|
351
|
+
},
|
|
352
|
+
'search-input': {
|
|
353
|
+
illustration: './images/component-illustrations/search-input.png',
|
|
354
|
+
summary:
|
|
355
|
+
'A <b>search input</b> is a type of input field that can be used to search, find, or filter.',
|
|
356
|
+
},
|
|
357
|
+
select: {
|
|
358
|
+
illustration: './images/component-illustrations/select.png',
|
|
359
|
+
summary:
|
|
360
|
+
'A <b>select</b> component is a menu that enables users to select 1 or more items from a list.',
|
|
361
|
+
label: 'beta',
|
|
362
|
+
},
|
|
363
|
+
sidebar: {
|
|
364
|
+
illustration: './images/component-illustrations/sidebar.png',
|
|
365
|
+
summary:
|
|
366
|
+
'A <b>sidebar</b> is a panel that splits content into a secondary area within a page.',
|
|
367
|
+
},
|
|
368
|
+
'simple-list': {
|
|
369
|
+
illustration: './images/component-illustrations/simple-list.png',
|
|
370
|
+
summary: 'A <b>simple list</b> displays selectable items within a page.',
|
|
371
|
+
},
|
|
372
|
+
skeleton: {
|
|
373
|
+
illustration: './images/component-illustrations/skeleton.png',
|
|
374
|
+
summary:
|
|
375
|
+
'A <b>skeleton</b> is a type of loading state that allows you to expose content incrementally.',
|
|
376
|
+
},
|
|
377
|
+
'skip-to-content': {
|
|
378
|
+
illustration: './images/component-illustrations/skip-to-content.png',
|
|
379
|
+
summary:
|
|
380
|
+
'A <b>skip to content</b> component allows users to bypass navigation when using a screen reader or keyboard',
|
|
381
|
+
},
|
|
382
|
+
slider: {
|
|
383
|
+
illustration: './images/component-illustrations/slider.png',
|
|
384
|
+
summary:
|
|
385
|
+
'A <b>slider</b> is an interactive element that allows users to quickly set and adjust a numeric value from a defined range of values.',
|
|
386
|
+
},
|
|
387
|
+
spinner: {
|
|
388
|
+
illustration: './images/component-illustrations/spinner.png',
|
|
389
|
+
summary:
|
|
390
|
+
'A <b>spinner</b> is an animated visual that indicates when a quick action is in progress.',
|
|
391
|
+
},
|
|
392
|
+
switch: {
|
|
393
|
+
illustration: './images/component-illustrations/switch.png',
|
|
394
|
+
summary:
|
|
395
|
+
'A <b>switch</b> is a control that toggles the state of a setting between on and off.',
|
|
396
|
+
},
|
|
397
|
+
'tab-content': {
|
|
398
|
+
illustration: './images/component-illustrations/tab-content.png',
|
|
399
|
+
summary:
|
|
400
|
+
'A <b>tab content</b> component is used to contain content within a tab.',
|
|
401
|
+
},
|
|
402
|
+
table: {
|
|
403
|
+
illustration: './images/component-illustrations/table.png',
|
|
404
|
+
summary:
|
|
405
|
+
'A <b>table</b> displays large data sets in a simple grid with column headers.',
|
|
406
|
+
},
|
|
407
|
+
tabs: {
|
|
408
|
+
illustration: './images/component-illustrations/tabs.png',
|
|
409
|
+
summary: '<b>Tabs</b> group similar content within sub-views of a page.',
|
|
410
|
+
},
|
|
411
|
+
'text-area': {
|
|
412
|
+
illustration: './images/component-illustrations/text-area.png',
|
|
413
|
+
summary:
|
|
414
|
+
'A <b>text area</b> allows users to enter a longer paragraph of text.',
|
|
415
|
+
},
|
|
416
|
+
'text-input-group': {
|
|
417
|
+
illustration: './images/component-illustrations/text-input-group.png',
|
|
418
|
+
summary:
|
|
419
|
+
"A <b>text input group</b> is a more custom, flexible, and composable version of a <a href='/components/forms/text-input'>text input</a> that includes elements like icons and buttons.",
|
|
420
|
+
},
|
|
421
|
+
'text-input': {
|
|
422
|
+
illustration: './images/component-illustrations/text-input.png',
|
|
423
|
+
summary: 'A <b>text input</b> components allows users to input short text.',
|
|
424
|
+
},
|
|
425
|
+
tile: {
|
|
426
|
+
illustration: './images/component-illustrations/tile.png',
|
|
427
|
+
summary:
|
|
428
|
+
'A <b>tile</b> is a container that allows users to select a static option.',
|
|
429
|
+
label: 'deprecated',
|
|
430
|
+
},
|
|
431
|
+
'time-picker': {
|
|
432
|
+
illustration: './images/component-illustrations/time-picker.png',
|
|
433
|
+
summary:
|
|
434
|
+
'A <b>time picker</b> component allows users to select a time from a list of options.',
|
|
435
|
+
},
|
|
436
|
+
timestamp: {
|
|
437
|
+
illustration: './images/component-illustrations/timestamp.png',
|
|
438
|
+
summary:
|
|
439
|
+
'A <b>timestamp</b> is a consistently formatted visual that displays date and time values.',
|
|
440
|
+
},
|
|
441
|
+
title: {
|
|
442
|
+
illustration: './images/component-illustrations/title.png',
|
|
443
|
+
summary:
|
|
444
|
+
'A <b>title</b> component applies top and bottom margins, font-weight, font-size, and line-height to page and section headings.',
|
|
445
|
+
},
|
|
446
|
+
'toggle-group': {
|
|
447
|
+
illustration: './images/component-illustrations/toggle-group.png',
|
|
448
|
+
summary:
|
|
449
|
+
'A <b>toggle group</b> is a set of controls that can be used to quickly switch between actions or states.',
|
|
450
|
+
},
|
|
451
|
+
toolbar: {
|
|
452
|
+
illustration: './images/component-illustrations/toolbar.png',
|
|
453
|
+
summary:
|
|
454
|
+
'A <b>toolbar</b> is a responsive container that displays controls that allow users to manage and manipulate a data set.',
|
|
455
|
+
},
|
|
456
|
+
tooltip: {
|
|
457
|
+
illustration: './images/component-illustrations/tooltip.png',
|
|
458
|
+
summary:
|
|
459
|
+
'A <b>tooltip</b> is a small, temporary, overlay window that provides additional information about an on-screen element.',
|
|
460
|
+
},
|
|
461
|
+
'tree-view': {
|
|
462
|
+
illustration: './images/component-illustrations/tree-view.png',
|
|
463
|
+
summary:
|
|
464
|
+
'A <b>tree view</b> is a structure that displays data in a hierarchical view.',
|
|
465
|
+
},
|
|
466
|
+
truncate: {
|
|
467
|
+
illustration: './images/component-illustrations/truncate.png',
|
|
468
|
+
summary:
|
|
469
|
+
'A <b>truncate</b> component can be used to shorten character strings—typically when the string overflows its container.',
|
|
470
|
+
},
|
|
471
|
+
wizard: {
|
|
472
|
+
illustration: './images/component-illustrations/wizard.png',
|
|
473
|
+
summary:
|
|
474
|
+
'A <b>wizard</b> is a guided workflow that helps users complete complex tasks, create objects, or follow a series of steps.',
|
|
475
|
+
},
|
|
476
|
+
}
|
|
@@ -3,12 +3,14 @@ id: Contribute
|
|
|
3
3
|
title: Contribute to PatternFly
|
|
4
4
|
section: get-started
|
|
5
5
|
propComponents: ['Button', 'BadgeCountObject']
|
|
6
|
+
cssPrefix: pf-v6-c-about-modal-box
|
|
6
7
|
---
|
|
7
8
|
|
|
8
|
-
## Community contributions
|
|
9
|
+
## Community contributions
|
|
9
10
|
|
|
10
|
-
Thank you for your interest in contributing to PatternFly! We depend on community contributions to help our design system grow and evolve. We encourage everyone, regardless of background, to get involved. Common contributions include (but aren't limited to):
|
|
11
|
-
|
|
11
|
+
Thank you for your interest in contributing to PatternFly! We depend on community contributions to help our design system grow and evolve. We encourage everyone, regardless of background, to get involved. Common contributions include (but aren't limited to):
|
|
12
|
+
|
|
13
|
+
- New feature ideas.
|
|
12
14
|
- Bug reports.
|
|
13
15
|
- Documentation updates.
|
|
14
16
|
|
|
@@ -20,29 +22,32 @@ If you have any ideas that don't fit into the projects outlined in this guide, p
|
|
|
20
22
|
|
|
21
23
|
If you have skills in visual and interaction design, you can contribute to PatternFly's design by taking an existing issue or proposing a new feature, enhancement, or icon. If you are interested in any of these projects, [reach out on the patternfly-design Slack channel.](http://join.slack.com/t/patternfly/shared_invite/zt-1npmqswgk-bF2R1E2rglV8jz5DNTezMQ)
|
|
22
24
|
|
|
23
|
-
### Existing design issues
|
|
25
|
+
### Existing design issues
|
|
24
26
|
|
|
25
27
|
The PatternFly design team is composed of visual and interaction designers who define the look and feel of the PatternFly library. The team follows an agile framework, planning their work in sprints, with a backlog that is tracked and managed via [this GitHub project board.](https://github.com/orgs/patternfly/projects/7/views/30) This board contains a list issues that are currently unassigned and waiting in the queue. If you see something here that you'd like to work on, leave a comment on the issue and a member of our team will reach out with next steps.
|
|
26
28
|
|
|
27
29
|
### New feature or enhancement
|
|
30
|
+
|
|
28
31
|
If you have an idea for a new design pattern, a new component type, or an existing feature improvement, we'd love to hear it. [Start by opening an issue in the patternfly-design repository.](https://github.com/patternfly/patternfly-design/issues) From there, a member of our team will reach out and work with you to plan and design a solution.
|
|
29
32
|
|
|
30
33
|
### New icons
|
|
34
|
+
|
|
31
35
|
We encourage designers to work with [the existing PatternFly icon set](/design-foundations/icons), which covers most common use cases. If your use case isn't covered, you can propose a new icon.
|
|
32
36
|
|
|
33
37
|
To contribute a new icon, [start by opening an issue in the patternfly-design repository](https://github.com/patternfly/patternfly-design/issues) that describes your idea and why it's needed. A member of our team will reach out to you to discuss next steps.
|
|
34
38
|
|
|
35
39
|
## Code
|
|
36
40
|
|
|
37
|
-
The primary PatternFly libraries include HTML/CSS (commonly called "core") and React. If you're looking to contribute to PatternFly's codebase, these libraries are a good place to start. You can help out by taking existing issues, or creating issues for bugs and other changes.
|
|
41
|
+
The primary PatternFly libraries include HTML/CSS (commonly called "core") and React. If you're looking to contribute to PatternFly's codebase, these libraries are a good place to start. You can help out by taking existing issues, or creating issues for bugs and other changes.
|
|
38
42
|
|
|
39
43
|
If you have any questions about these projects, you can reach out to us on our [patternfly-core](https://patternfly.slack.com/archives/C9Q224EFL) and [patternfly-react](https://patternfly.slack.com/archives/C4FM977N0) Slack channels.
|
|
40
44
|
|
|
41
|
-
### Existing development issues
|
|
45
|
+
### Existing development issues
|
|
42
46
|
|
|
43
|
-
To find work that has been approved, but not started, you can view open issues in our [patternfly](https://github.com/patternfly/patternfly/issues) (HTML/CSS) and [patternfly-react](https://github.com/patternfly/patternfly-react/issues) (React) repositories. If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps.
|
|
47
|
+
To find work that has been approved, but not started, you can view open issues in our [patternfly](https://github.com/patternfly/patternfly/issues) (HTML/CSS) and [patternfly-react](https://github.com/patternfly/patternfly-react/issues) (React) repositories. If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps.
|
|
44
48
|
|
|
45
49
|
Be sure to view our detailed contribution instructions for both of these repositories:
|
|
50
|
+
|
|
46
51
|
- [Core contribution guidelines](https://github.com/patternfly/patternfly#guidelines-for-css-development)
|
|
47
52
|
- [React contribution guidelines](https://github.com/patternfly/patternfly-react/blob/main/CONTRIBUTING.md#contribution-process)
|
|
48
53
|
|
|
@@ -50,13 +55,13 @@ Be sure to view our detailed contribution instructions for both of these reposit
|
|
|
50
55
|
|
|
51
56
|
If you believe that you've come across a PatternFly bug, alert our team, so that we can resolve the issue. To report a bug, follow these steps:
|
|
52
57
|
|
|
53
|
-
1. View the documentation for the feature, to confirm that the behavior is not functioning as intended.
|
|
58
|
+
1. View the documentation for the feature, to confirm that the behavior is not functioning as intended.
|
|
54
59
|
1. Search open issues in the [patternfly](https://github.com/patternfly/patternfly/issues) and [patternfly-react](https://github.com/patternfly/patternfly-react/issues) repositories to see if a related issue already exists.
|
|
55
|
-
|
|
56
|
-
|
|
60
|
+
- If the bug is present in only the React implementation of PatternFly, [create a bug issue in patternfly-react.](https://github.com/patternfly/patternfly-react/issues)
|
|
61
|
+
- If the bug can be seen on both the React and HTML/CSS side, [create a bug issue in patternfly](https://github.com/patternfly/patternfly/issues).
|
|
57
62
|
1. Be sure to mention which project the bug was noticed in and if there is a deadline that the fix is needed for.
|
|
58
63
|
|
|
59
|
-
## Documentation
|
|
64
|
+
## Documentation
|
|
60
65
|
|
|
61
66
|
Across our website, you can find PatternFly documentation that explains concepts, provides guidance, and outlines important resources for PatternFly users. Our documentation can always be improved, and we love to hear input from the people who use it.
|
|
62
67
|
|
|
@@ -64,9 +69,10 @@ If you'd like to contribute to documentation, you can refer to our [detailed con
|
|
|
64
69
|
|
|
65
70
|
### Existing documentation issues
|
|
66
71
|
|
|
67
|
-
Our website documentation is contained in the [patternfly-org repository](https://github.com/patternfly/patternfly-org). If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps.
|
|
72
|
+
Our website documentation is contained in the [patternfly-org repository](https://github.com/patternfly/patternfly-org). If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps.
|
|
68
73
|
|
|
69
74
|
### Design guidelines
|
|
75
|
+
|
|
70
76
|
Our design guidelines are found across our component, layout, chart, and pattern web pages. These guides clarify usage details to help designers follow best practices to create strong UI solutions.
|
|
71
77
|
|
|
72
|
-
If you'd like to contribute to our design guidelines, you can open an issue in [patternfly-org](https://github.com/patternfly/patternfly-org) to propose a new page or updates to an existing page. From there, our team will work with you to author and publish your new content.
|
|
78
|
+
If you'd like to contribute to our design guidelines, you can open an issue in [patternfly-org](https://github.com/patternfly/patternfly-org) to propose a new page or updates to an existing page. From there, our team will work with you to author and publish your new content.
|