playbook_ui_docs 13.30.0.pre.alpha.20240515remotebuildkitconversion3150 → 13.31.0.pre.alpha.PBNTR342navtabbing3230
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/app/pb_kits/playbook/pb_date_year_stacked/docs/_date_year_stacked_default.jsx +4 -1
- data/app/pb_kits/playbook/pb_draggable/docs/_draggable_default.jsx +14 -19
- data/app/pb_kits/playbook/pb_draggable/docs/_draggable_default.md +5 -3
- data/app/pb_kits/playbook/pb_draggable/docs/_draggable_with_cards.md +7 -3
- data/app/pb_kits/playbook/pb_draggable/docs/_draggable_with_list.md +3 -5
- data/app/pb_kits/playbook/pb_draggable/docs/_draggable_with_selectable_list.md +3 -5
- data/app/pb_kits/playbook/pb_form/docs/_form_form_with_validate.html.erb +9 -0
- data/app/pb_kits/playbook/pb_icon/docs/_icon_default.html.erb +1 -6
- data/app/pb_kits/playbook/pb_icon/docs/_icon_default.jsx +3 -20
- data/app/pb_kits/playbook/pb_nav/docs/_tab_nav.html.erb +12 -0
- data/app/pb_kits/playbook/pb_nav/docs/_tab_nav.html.md +0 -0
- data/app/pb_kits/playbook/pb_nav/docs/example.yml +1 -0
- data/dist/menu.yml +566 -472
- data/dist/playbook-doc.js +5 -5
- metadata +4 -2
data/dist/menu.yml
CHANGED
|
@@ -1,474 +1,568 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
---
|
|
2
|
+
web: &1
|
|
3
|
+
- rails
|
|
4
|
+
- react
|
|
5
|
+
all: &3
|
|
6
|
+
- rails
|
|
7
|
+
- react
|
|
8
|
+
- swift
|
|
9
|
+
rails_swift:
|
|
10
|
+
- rails
|
|
11
|
+
- swift
|
|
12
|
+
react_swift:
|
|
13
|
+
- swift
|
|
14
|
+
- react
|
|
15
|
+
rails_only: &4
|
|
16
|
+
- rails
|
|
17
|
+
react_only: &2
|
|
18
|
+
- react
|
|
19
|
+
swift_only:
|
|
20
|
+
- swift
|
|
9
21
|
kits:
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
description:
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
- name:
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
- name:
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
22
|
+
- category: alerts_and_dialogs
|
|
23
|
+
description:
|
|
24
|
+
components:
|
|
25
|
+
- name: dialog
|
|
26
|
+
platforms: *1
|
|
27
|
+
description:
|
|
28
|
+
status: stable
|
|
29
|
+
- name: fixed_confirmation_toast
|
|
30
|
+
platforms: *1
|
|
31
|
+
description: Fixed Confirmation Toast is used as an alert. Success is used when
|
|
32
|
+
a user successfully completes an action. Error is used when there is an error
|
|
33
|
+
and the user cannot proceed. Neutral is used to display information to a user
|
|
34
|
+
to complete a task.
|
|
35
|
+
status: stable
|
|
36
|
+
- name: popover
|
|
37
|
+
platforms: *1
|
|
38
|
+
description: A popover is a way to toggle content on top of other content. It
|
|
39
|
+
can be used for small texts, small forms, or even dropdowns. By default, popover
|
|
40
|
+
will toggle open/closed by simply clicking the trigger element.
|
|
41
|
+
status: stable
|
|
42
|
+
- name: tooltip
|
|
43
|
+
platforms: *1
|
|
44
|
+
description:
|
|
45
|
+
status: stable
|
|
46
|
+
- category: buttons
|
|
47
|
+
description: Buttons are used primarily for actions, such as “Save” and “Cancel”.
|
|
48
|
+
Link Buttons are used for less important or less commonly used actions, such as
|
|
49
|
+
“view shipping settings”.
|
|
50
|
+
components:
|
|
51
|
+
- name: button
|
|
52
|
+
platforms: *1
|
|
53
|
+
description:
|
|
54
|
+
status: stable
|
|
55
|
+
- name: button_toolbar
|
|
56
|
+
platforms: *1
|
|
57
|
+
description: This kit should primarily hold the most commonly used buttons.
|
|
58
|
+
status: stable
|
|
59
|
+
- name: circle_icon_button
|
|
60
|
+
platforms: *1
|
|
61
|
+
description: When using Icon Circle Button, the icon must be clear a clear indication
|
|
62
|
+
of what the button does because there is no text.
|
|
63
|
+
status: stable
|
|
64
|
+
- category: data_visualization
|
|
65
|
+
description:
|
|
66
|
+
components:
|
|
67
|
+
- name: map
|
|
68
|
+
platforms: *2
|
|
69
|
+
description: This kit provides a wrapping class to place around the MapLibre library.
|
|
70
|
+
status: stable
|
|
71
|
+
- name: table
|
|
72
|
+
platforms: *1
|
|
73
|
+
description: Tables display a collection of structured data and typically have
|
|
74
|
+
the ability to sort, filter, and paginate data.
|
|
75
|
+
status: stable
|
|
76
|
+
- name: advanced_table
|
|
77
|
+
platforms: *1
|
|
78
|
+
description: The Advanced Table can be used to display complex, nested data in
|
|
79
|
+
a way that allows for expansion and/or sorting.
|
|
80
|
+
status: stable
|
|
81
|
+
- name: list
|
|
82
|
+
platforms: *1
|
|
83
|
+
description: Lists display a vertical set of related content.
|
|
84
|
+
status: stable
|
|
85
|
+
- name: filter
|
|
86
|
+
platforms: *1
|
|
87
|
+
description: This kit can be implemented in a variety of ways. To see examples
|
|
88
|
+
of how to implement this kit in production visit the /dev_docs/search page in
|
|
89
|
+
production.
|
|
90
|
+
status: stable
|
|
91
|
+
- name: distribution_bar
|
|
92
|
+
platforms: *1
|
|
93
|
+
description: Can be used in the same way a pie chart can be used. By default,
|
|
94
|
+
Distribution Bar comparatively represents data without numbers.
|
|
95
|
+
status: stable
|
|
96
|
+
- name: legend
|
|
97
|
+
platforms: *1
|
|
98
|
+
description: A key used to compare the variables and their value in any given
|
|
99
|
+
graph.
|
|
100
|
+
status: stable
|
|
101
|
+
- name: gauge
|
|
102
|
+
platforms: *1
|
|
103
|
+
description:
|
|
104
|
+
status: stable
|
|
105
|
+
- name: bar_graph
|
|
106
|
+
platforms: *1
|
|
107
|
+
description: Bar graphs are used to compare data. Bar graphs are not typically
|
|
108
|
+
used to show percentages.
|
|
109
|
+
status: stable
|
|
110
|
+
- name: circle_chart
|
|
111
|
+
platforms: *1
|
|
112
|
+
description:
|
|
113
|
+
status: stable
|
|
114
|
+
- name: line_graph
|
|
115
|
+
platforms: *1
|
|
116
|
+
description: Line graphs are used to show changes in data over time.
|
|
117
|
+
status: stable
|
|
118
|
+
- name: treemap_chart
|
|
119
|
+
platforms: *1
|
|
120
|
+
description: Treemap charts are used to compare the relative size of groups of
|
|
121
|
+
data. They can also use a nested data structure, allowing a user to drill down
|
|
122
|
+
into a group to see its constituent data points.
|
|
123
|
+
status: stable
|
|
124
|
+
- category: date_and_time_text_patterns
|
|
125
|
+
description: ''
|
|
126
|
+
components:
|
|
127
|
+
- name: date
|
|
128
|
+
platforms: *1
|
|
129
|
+
description: Use to display the date. Year will not display if it is the current
|
|
130
|
+
year.
|
|
131
|
+
status: stable
|
|
132
|
+
- name: date_range_inline
|
|
133
|
+
platforms: *1
|
|
134
|
+
description: Use to display a date range. Year will not show if it is the current
|
|
135
|
+
year.
|
|
136
|
+
status: stable
|
|
137
|
+
- name: date_range_stacked
|
|
138
|
+
platforms: *1
|
|
139
|
+
description:
|
|
140
|
+
status: stable
|
|
141
|
+
- name: date_stacked
|
|
142
|
+
platforms: *1
|
|
143
|
+
description: Use to display the date, stacking month and day. Year will not show
|
|
144
|
+
if it is the current year.
|
|
145
|
+
status: stable
|
|
146
|
+
- name: date_time
|
|
147
|
+
platforms: *1
|
|
148
|
+
description: Date Time is a composite kit that leverages the Date and Time kits.
|
|
149
|
+
The Date Time kit is affected by time zones and defaults to "America/New_York".
|
|
150
|
+
- name: date_time_stacked
|
|
151
|
+
platforms: *1
|
|
152
|
+
description:
|
|
153
|
+
status: stable
|
|
154
|
+
- name: date_year_stacked
|
|
155
|
+
platforms: *1
|
|
156
|
+
description: This kit is a simple option for displaying dates in a month, day
|
|
157
|
+
and the year format.
|
|
158
|
+
status: stable
|
|
159
|
+
- name: time
|
|
160
|
+
platforms: *1
|
|
161
|
+
description: This kit consist of large display and table display format. It includes
|
|
162
|
+
and icon, and a time zone.
|
|
163
|
+
status: stable
|
|
164
|
+
- name: time_range_inline
|
|
165
|
+
platforms: *1
|
|
166
|
+
description:
|
|
167
|
+
status: stable
|
|
168
|
+
- name: time_stacked
|
|
169
|
+
platforms: *1
|
|
170
|
+
description:
|
|
171
|
+
status: stable
|
|
172
|
+
- name: timestamp
|
|
173
|
+
platforms: *3
|
|
174
|
+
description: This low profile kit displays time. Elapsed, current, future, or
|
|
175
|
+
otherwise.
|
|
176
|
+
status: stable
|
|
177
|
+
- name: weekday_stacked
|
|
178
|
+
platforms: *1
|
|
179
|
+
description:
|
|
180
|
+
status: stable
|
|
181
|
+
- category: form_and_dashboard_text_patterns
|
|
182
|
+
description: ''
|
|
183
|
+
components:
|
|
184
|
+
- name: contact
|
|
185
|
+
platforms: *1
|
|
186
|
+
description: Use to display customer's or user's contact information.
|
|
187
|
+
status: stable
|
|
188
|
+
- name: currency
|
|
189
|
+
platforms: *1
|
|
190
|
+
description: Use to display monetary amounts, typically on dashboards or other
|
|
191
|
+
layouts to show an overview or summary. User understanding increase when paired
|
|
192
|
+
with labels.
|
|
193
|
+
status: stable
|
|
194
|
+
- name: home_address_street
|
|
195
|
+
platforms: *1
|
|
196
|
+
description: This kit can be used to display the address for a homeowner/project.
|
|
197
|
+
It contains street address, APT format, City, state and zip. A Project hashtag
|
|
198
|
+
can be used as a prop to link back to a project.
|
|
199
|
+
status: stable
|
|
200
|
+
- name: label_pill
|
|
201
|
+
platforms: *1
|
|
202
|
+
description: This kit combines the caption and pill kit with all its variants.
|
|
203
|
+
status: stable
|
|
204
|
+
- name: label_value
|
|
205
|
+
platforms: *1
|
|
206
|
+
description: This kit can be very versatile when used to display text data.
|
|
207
|
+
status: stable
|
|
208
|
+
- name: person
|
|
209
|
+
platforms: *1
|
|
210
|
+
description: This kit is broken down into a first name last name format with normal
|
|
211
|
+
and bold weighted text.
|
|
212
|
+
status: stable
|
|
213
|
+
- name: person_contact
|
|
214
|
+
platforms: *1
|
|
215
|
+
description: This kit can be used to display a person contact information.
|
|
216
|
+
status: stable
|
|
217
|
+
- name: source
|
|
218
|
+
platforms: *1
|
|
219
|
+
description: General use is to describe the discovery of businesses, customers,
|
|
220
|
+
etc. This kit can also be used for other purposes as well.
|
|
221
|
+
status: stable
|
|
222
|
+
- name: dashboard_value
|
|
223
|
+
platforms: *1
|
|
224
|
+
description: Use in dashboards to give the viewer a quick overview of important
|
|
225
|
+
metrics. If want to show currency, use Currency Kit.
|
|
226
|
+
status: stable
|
|
227
|
+
- name: stat_change
|
|
228
|
+
platforms: *1
|
|
229
|
+
description: Displays the increase, decrease, or neutral change in data.
|
|
230
|
+
status: stable
|
|
231
|
+
- name: stat_value
|
|
232
|
+
platforms: *1
|
|
233
|
+
description: This kit was cerated for the main use as a dashboard display for
|
|
234
|
+
numbers. A large label is an optional part if it needs more clarity.
|
|
235
|
+
status: stable
|
|
236
|
+
- name: title_count
|
|
237
|
+
platforms: *1
|
|
238
|
+
description: This kits consists of title kit and body text. It is used to display
|
|
239
|
+
a title and a count (numbers). It has a base size and a large formation for
|
|
240
|
+
dashboard use.
|
|
241
|
+
status: stable
|
|
242
|
+
- name: title_detail
|
|
243
|
+
platforms: *1
|
|
244
|
+
description: This kit can be used in many versatile ways. It consist of a title
|
|
245
|
+
4 and light body text kit.
|
|
246
|
+
status: stable
|
|
247
|
+
- category: form_elements
|
|
248
|
+
description:
|
|
249
|
+
components:
|
|
250
|
+
- name: file_upload
|
|
251
|
+
platforms: *1
|
|
252
|
+
description:
|
|
253
|
+
status: stable
|
|
254
|
+
- name: toggle
|
|
255
|
+
platforms: *1
|
|
256
|
+
description: Physical switch that allows users to turn things on or off. Used
|
|
257
|
+
for applying system states, presenting binary options and activating a state.
|
|
258
|
+
status: stable
|
|
259
|
+
- name: form_pill
|
|
260
|
+
platforms: *1
|
|
261
|
+
description:
|
|
262
|
+
status: stable
|
|
263
|
+
- name: form
|
|
264
|
+
platforms: *4
|
|
265
|
+
description: The form kit provides consumers with a convenient, consistently styled
|
|
266
|
+
<form> wrapper.
|
|
267
|
+
status: stable
|
|
268
|
+
- name: form_group
|
|
269
|
+
platforms: *1
|
|
270
|
+
description:
|
|
271
|
+
status: stable
|
|
272
|
+
- category: form_input
|
|
273
|
+
description: ''
|
|
274
|
+
components:
|
|
275
|
+
- name: passphrase
|
|
276
|
+
platforms: *1
|
|
277
|
+
description:
|
|
278
|
+
status: stable
|
|
279
|
+
- name: phone_number_input
|
|
280
|
+
platforms: *1
|
|
281
|
+
description:
|
|
282
|
+
status: stable
|
|
283
|
+
- name: text_input
|
|
284
|
+
platforms: *1
|
|
285
|
+
description: Area where user can enter small amount of text. Commonly used in
|
|
286
|
+
forms.
|
|
287
|
+
status: stable
|
|
288
|
+
- name: rich_text_editor
|
|
289
|
+
platforms: *1
|
|
290
|
+
description:
|
|
291
|
+
status: stable
|
|
292
|
+
- name: textarea
|
|
293
|
+
platforms: *1
|
|
294
|
+
description: Area where user can enter larger amounts of text. Commonly used in
|
|
295
|
+
forms.
|
|
296
|
+
status: stable
|
|
297
|
+
- name: typeahead
|
|
298
|
+
platforms: *1
|
|
299
|
+
description: Typeahead is auto suggestion or completion based on what the user
|
|
300
|
+
is starting to type, gets refined as the user types more.
|
|
301
|
+
status: stable
|
|
302
|
+
- category: form_selection
|
|
303
|
+
description:
|
|
304
|
+
components:
|
|
305
|
+
- name: date_picker
|
|
306
|
+
platforms: *1
|
|
307
|
+
description: Playbook's date picker is built using flatpickr, a vanilla js library.
|
|
308
|
+
Common date picker use cases and features have been adapted into simple prop
|
|
309
|
+
based configuration detailed in the docs below.
|
|
310
|
+
status: stable
|
|
311
|
+
- name: dropdown
|
|
312
|
+
platforms: *1
|
|
313
|
+
description: ''
|
|
314
|
+
status: stable
|
|
315
|
+
- name: multi_level_select
|
|
316
|
+
platforms: *1
|
|
317
|
+
description: The MultiLevelSelect kit renders a multi leveled select dropdown
|
|
318
|
+
based on data from the user.
|
|
319
|
+
status: stable
|
|
320
|
+
- name: select
|
|
321
|
+
platforms: *1
|
|
322
|
+
description: Select displays multiple options for a user to pick from in a dropdown
|
|
323
|
+
menu. User selects one option.
|
|
324
|
+
status: stable
|
|
325
|
+
- name: selectable_card
|
|
326
|
+
platforms: *1
|
|
327
|
+
description: Cards for information/content that can be selected. There is design
|
|
328
|
+
for unselected and selected states. Typically used as a form element.
|
|
329
|
+
status: stable
|
|
330
|
+
- name: selectable_card_icon
|
|
331
|
+
platforms: *1
|
|
332
|
+
description:
|
|
333
|
+
status: stable
|
|
334
|
+
- name: selectable_icon
|
|
335
|
+
platforms: *1
|
|
336
|
+
description:
|
|
337
|
+
status: stable
|
|
338
|
+
- name: radio
|
|
339
|
+
platforms: *3
|
|
340
|
+
description: Radio is a control that allows the user to only choose one predefined
|
|
341
|
+
option.
|
|
342
|
+
status: stable
|
|
343
|
+
- name: checkbox
|
|
344
|
+
platforms: *1
|
|
345
|
+
description: Checkbox is used for a list of selections that are meant to have
|
|
346
|
+
one or more options checked.
|
|
347
|
+
status: stable
|
|
348
|
+
- name: selectable_list
|
|
349
|
+
platforms: *1
|
|
350
|
+
description:
|
|
351
|
+
status: stable
|
|
352
|
+
- category: icons_and_images
|
|
353
|
+
description: ''
|
|
354
|
+
components:
|
|
355
|
+
- name: icon
|
|
356
|
+
platforms: *1
|
|
357
|
+
description: An icon is a graphic symbol that represents an object (ie a file)
|
|
358
|
+
or a function. They can be used to give the user feedback.
|
|
359
|
+
status: stable
|
|
360
|
+
- name: icon_circle
|
|
361
|
+
platforms: *1
|
|
362
|
+
description: Similar to Icon, Icon Circle is a graphical symbol within a circle
|
|
363
|
+
used to visually indicate an object or function.
|
|
364
|
+
status: stable
|
|
365
|
+
- name: icon_stat_value
|
|
366
|
+
platforms: *1
|
|
367
|
+
description:
|
|
368
|
+
status: stable
|
|
369
|
+
- name: icon_value
|
|
370
|
+
platforms: *1
|
|
371
|
+
description: Icon Value leverages our icon kit, to display a value of some sort
|
|
372
|
+
in the interface. Typically, this includes a numerical value.
|
|
373
|
+
status: stable
|
|
374
|
+
- name: user_badge
|
|
375
|
+
platforms: *1
|
|
376
|
+
description: This kit was created to display employee icons related to a Nitro
|
|
377
|
+
user. Currently there is the PVI logo and the Million Dollar Rep Icon.
|
|
378
|
+
status: stable
|
|
379
|
+
- name: image
|
|
380
|
+
platforms: *1
|
|
381
|
+
description: A responsive image component.
|
|
382
|
+
status: stable
|
|
383
|
+
- name: lightbox
|
|
384
|
+
platforms: *2
|
|
385
|
+
description: The Lightbox kit is a popup window overlay that will appear on top
|
|
386
|
+
of your webpage and cover the entirety of the screen.
|
|
387
|
+
status: stable
|
|
388
|
+
- name: star_rating
|
|
389
|
+
platforms: *1
|
|
390
|
+
description: A component to view other people’s opinions and experiences. Use
|
|
391
|
+
when you want to show evaluation or a quick quantitative rating. Most effective
|
|
392
|
+
when paired with reviews.
|
|
393
|
+
status: stable
|
|
394
|
+
- category: layout_and_structure
|
|
395
|
+
description:
|
|
396
|
+
components:
|
|
397
|
+
- name: flex
|
|
398
|
+
platforms: *1
|
|
399
|
+
description: This kit is used to build most of the complex interfaces. The Flex
|
|
400
|
+
Kit is used the same way flex box is used.
|
|
401
|
+
status: stable
|
|
402
|
+
- name: layout
|
|
403
|
+
platforms: *1
|
|
404
|
+
description: Layouts used for positioning content inside of pages, cards, or containers.
|
|
405
|
+
status: stable
|
|
406
|
+
- name: card
|
|
407
|
+
platforms: *3
|
|
408
|
+
description:
|
|
409
|
+
status: stable
|
|
410
|
+
- name: section_separator
|
|
411
|
+
platforms: *1
|
|
412
|
+
description: Section separator is a divider line that compartmentalizes content,
|
|
413
|
+
typically used on cards or white backgrounds.
|
|
414
|
+
status: stable
|
|
415
|
+
- name: background
|
|
416
|
+
platforms: *1
|
|
417
|
+
description: The background kit is used for adding a background to a page or to
|
|
418
|
+
any container.
|
|
419
|
+
status: stable
|
|
420
|
+
- name: collapsible
|
|
421
|
+
platforms: *1
|
|
422
|
+
description:
|
|
423
|
+
status: stable
|
|
424
|
+
- name: overlay
|
|
425
|
+
platforms: *1
|
|
426
|
+
status: stable
|
|
427
|
+
- name: draggable
|
|
428
|
+
platforms: *2
|
|
429
|
+
description:
|
|
430
|
+
status: beta
|
|
431
|
+
- category: message_text_patterns
|
|
432
|
+
description:
|
|
433
|
+
components:
|
|
434
|
+
- name: highlight
|
|
435
|
+
platforms: *1
|
|
436
|
+
description: Highlight is used to pick out or emphasize content.
|
|
437
|
+
status: stable
|
|
438
|
+
- name: message
|
|
439
|
+
platforms: *1
|
|
440
|
+
description: This multi kit consist of a an avatar, a status, a caption, a body
|
|
441
|
+
text, and a time stamp. All which can be optional.
|
|
442
|
+
status: stable
|
|
443
|
+
- category: navigation
|
|
444
|
+
description:
|
|
445
|
+
components:
|
|
446
|
+
- name: bread_crumbs
|
|
447
|
+
platforms: *1
|
|
448
|
+
description: BreadCrumbs can be used for keeping a user aware of their route location.
|
|
449
|
+
status: stable
|
|
450
|
+
- name: nav
|
|
451
|
+
platforms: *1
|
|
452
|
+
description: The nav is a grouped set of links that take the user to another page,
|
|
453
|
+
or tab through parts of a page. It comes in horizontal or vertical with several
|
|
454
|
+
different variants.
|
|
455
|
+
status: stable
|
|
456
|
+
- name: pagination
|
|
457
|
+
platforms: *4
|
|
458
|
+
description:
|
|
459
|
+
status: stable
|
|
460
|
+
- category: state_and_progress_indicators
|
|
461
|
+
description:
|
|
462
|
+
components:
|
|
463
|
+
- name: loading_inline
|
|
464
|
+
platforms: *1
|
|
465
|
+
description: The loading kit is used to indicate to users that a page is still
|
|
466
|
+
loading, or an action is still being processed.
|
|
467
|
+
status: stable
|
|
468
|
+
- name: progress_pills
|
|
469
|
+
platforms: *1
|
|
470
|
+
description: Progress pills indicate a specific point in time of a series of sequential
|
|
471
|
+
steps. They are used to track progress of something over time.
|
|
472
|
+
status: stable
|
|
473
|
+
- name: progress_simple
|
|
474
|
+
platforms: *1
|
|
475
|
+
description: Displays the current progress of an operation flow. User understanding
|
|
476
|
+
increases when paired with labels or numbers.
|
|
477
|
+
- name: progress_step
|
|
478
|
+
platforms: *1
|
|
479
|
+
description: 'Progress step kit is used to show the progress of a process. There
|
|
480
|
+
are three types of steps in this kit: completed, active, and inactive.'
|
|
481
|
+
status: stable
|
|
482
|
+
- name: walkthrough
|
|
483
|
+
platforms: *1
|
|
484
|
+
description:
|
|
485
|
+
status: stable
|
|
486
|
+
- name: timeline
|
|
487
|
+
platforms: *1
|
|
488
|
+
description: The timeline kit can use two different line styles in the same timeline
|
|
489
|
+
- solid and dotted line styles.
|
|
490
|
+
status: stable
|
|
491
|
+
- category: tags
|
|
492
|
+
description:
|
|
493
|
+
components:
|
|
494
|
+
- name: badge
|
|
495
|
+
platforms: *1
|
|
496
|
+
description: Badges can be used for notification, tags, and status. They are used
|
|
497
|
+
for count and numbers.
|
|
498
|
+
status: stable
|
|
499
|
+
- name: online_status
|
|
500
|
+
platforms: *1
|
|
501
|
+
description: Online Status is a small indicator that lets the user know the status
|
|
502
|
+
of a person or item.
|
|
503
|
+
status: stable
|
|
504
|
+
- name: pill
|
|
505
|
+
platforms: *3
|
|
506
|
+
description: A pill uses both a keyword and a specific color to categorize an
|
|
507
|
+
item.
|
|
508
|
+
status: stable
|
|
509
|
+
- name: hashtag
|
|
510
|
+
platforms: *1
|
|
511
|
+
description: Hashtag is used to display home, project and other forms of IDs.
|
|
512
|
+
They can be used as a link.
|
|
513
|
+
status: stable
|
|
514
|
+
- category: typography
|
|
515
|
+
description: ''
|
|
516
|
+
components:
|
|
517
|
+
- name: body
|
|
518
|
+
platforms: *1
|
|
519
|
+
description: Default text style for paragraphs. Follow hiearchy when using "light"
|
|
520
|
+
or "lighter" variants to deemphasize text — default style should be followed
|
|
521
|
+
by "light" followed by "lighter".
|
|
522
|
+
status: stable
|
|
523
|
+
- name: caption
|
|
524
|
+
platforms: *1
|
|
525
|
+
description: Use to provide supplementary context. Default size is best when providing
|
|
526
|
+
supplementary context to a small section (i.e. label for a text input, label
|
|
527
|
+
for a paragraph). Use large caption when supplementary text covers more content.
|
|
528
|
+
status: stable
|
|
529
|
+
- name: detail
|
|
530
|
+
platforms: *1
|
|
531
|
+
description: Used for tables or designs with large amounts of data or text.
|
|
532
|
+
status: stable
|
|
533
|
+
- name: title
|
|
534
|
+
platforms: *1
|
|
535
|
+
description: Typically used as headers. Follow semantic hierarchy — Title 1s should
|
|
536
|
+
be followed by Title 2s followed by Title 3s and so on, without skipping any
|
|
537
|
+
levels.
|
|
538
|
+
status: stable
|
|
539
|
+
- category: user
|
|
540
|
+
description:
|
|
541
|
+
components:
|
|
542
|
+
- name: avatar
|
|
543
|
+
platforms: *3
|
|
544
|
+
description: Avatar displays a user's picture. This helps aid easy recognition
|
|
545
|
+
of the user. This kit is normally not used by itself, but rather used within
|
|
546
|
+
other kits. The only time Avatar should be used instead of the User kit is when
|
|
547
|
+
you are not going to display the user's name.
|
|
548
|
+
status: stable
|
|
549
|
+
- name: avatar_action_button
|
|
550
|
+
platforms: *1
|
|
551
|
+
description:
|
|
552
|
+
status: stable
|
|
553
|
+
- name: multiple_users
|
|
554
|
+
platforms: *1
|
|
555
|
+
description: The multiple users kit is used to show that more than one user is
|
|
556
|
+
associated to an action or item.
|
|
557
|
+
status: stable
|
|
558
|
+
- name: multiple_users_stacked
|
|
559
|
+
platforms: *1
|
|
560
|
+
description: Multiple users stacked is used in tight spaces, where we need to
|
|
561
|
+
indicate that multiple users are associated to a specific action or item.
|
|
562
|
+
status: stable
|
|
452
563
|
- name: user
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
status: "stable"
|
|
459
|
-
- name: "avatar_action_button"
|
|
460
|
-
platforms: *web
|
|
461
|
-
description:
|
|
462
|
-
status: "stable"
|
|
463
|
-
- name: "multiple_users"
|
|
464
|
-
platforms: *web
|
|
465
|
-
description: The multiple users kit is used to show that more than one user is associated to an action or item.
|
|
466
|
-
status: "stable"
|
|
467
|
-
- name: "multiple_users_stacked"
|
|
468
|
-
platforms: *web
|
|
469
|
-
description: Multiple users stacked is used in tight spaces, where we need to indicate that multiple users are associated to a specific action or item.
|
|
470
|
-
status: "stable"
|
|
471
|
-
- name: "user"
|
|
472
|
-
platforms: *web
|
|
473
|
-
description: This kit was created for having a systematic way of displaying users with avatar, titles, name and territory. This is a versatile kit with features than can be added to display more info.
|
|
474
|
-
status: "stable"
|
|
564
|
+
platforms: *1
|
|
565
|
+
description: This kit was created for having a systematic way of displaying users
|
|
566
|
+
with avatar, titles, name and territory. This is a versatile kit with features
|
|
567
|
+
than can be added to display more info.
|
|
568
|
+
status: stable
|