primer_view_components 0.43.2 → 0.43.3
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/app/assets/javascripts/components/primer/beta/details_toggle_element.d.ts +4 -3
- data/app/assets/javascripts/primer_view_components.js +1 -1
- data/app/assets/javascripts/primer_view_components.js.map +1 -1
- data/app/assets/styles/primer_view_components.css +1 -1
- data/app/assets/styles/primer_view_components.css.map +1 -1
- data/app/components/primer/alpha/action_list.js +0 -2
- data/app/components/primer/alpha/action_list.ts +0 -2
- data/app/components/primer/alpha/toggle_switch.js +1 -0
- data/app/components/primer/alpha/toggle_switch.ts +1 -0
- data/app/components/primer/beta/breadcrumbs.css +1 -1
- data/app/components/primer/beta/breadcrumbs.css.map +1 -1
- data/app/components/primer/beta/breadcrumbs.pcss +1 -0
- data/app/components/primer/beta/details.rb +22 -12
- data/app/components/primer/beta/details_toggle_element.d.ts +4 -3
- data/app/components/primer/beta/details_toggle_element.js +12 -7
- data/app/components/primer/beta/details_toggle_element.ts +12 -7
- data/app/components/primer/beta/nav_list.js +0 -1
- data/app/components/primer/beta/nav_list.ts +0 -1
- data/app/components/primer/beta/nav_list_group_element.js +1 -0
- data/app/components/primer/beta/nav_list_group_element.ts +1 -0
- data/app/lib/primer/forms/acts_as_component.rb +0 -2
- data/config/routes.rb +27 -0
- data/lib/primer/accessibility.rb +3 -0
- data/lib/primer/view_components/linters/autocorrectable.rb +1 -1
- data/lib/primer/view_components/linters/migrations/iconbutton_component.rb +4 -7
- data/lib/primer/view_components/linters/migrations/truncate_component.rb +4 -7
- data/lib/primer/view_components/version.rb +1 -1
- data/lib/rubocop/cop/primer/base_cop.rb +1 -1
- data/lib/rubocop/cop/primer/component_name_migration.rb +7 -8
- data/lib/rubocop/cop/primer/deprecated_arguments.rb +7 -8
- data/lib/rubocop/cop/primer/deprecated_button_arguments.rb +5 -6
- data/lib/rubocop/cop/primer/deprecated_label_schemes.rb +6 -7
- data/lib/rubocop/cop/primer/deprecated_label_variants.rb +7 -14
- data/lib/rubocop/cop/primer/no_tag_memoize.rb +1 -1
- data/lib/rubocop/cop/primer/primer_octicon.rb +5 -6
- data/previews/primer/beta/breadcrumbs_preview/with_long_items.html.erb +13 -0
- data/previews/primer/beta/breadcrumbs_preview.rb +6 -0
- data/previews/primer/beta/details_preview.rb +16 -0
- data/static/arguments.json +67 -37
- data/static/audited_at.json +1 -0
- data/static/constants.json +13 -2
- data/static/info_arch.json +638 -1407
- data/static/previews.json +112 -0
- data/static/statuses.json +1 -0
- metadata +4 -2
data/static/info_arch.json
CHANGED
|
@@ -36,14 +36,10 @@
|
|
|
36
36
|
{
|
|
37
37
|
"name": "items",
|
|
38
38
|
"description": null,
|
|
39
|
-
"parameters": [
|
|
40
|
-
|
|
41
|
-
]
|
|
39
|
+
"parameters": []
|
|
42
40
|
}
|
|
43
41
|
],
|
|
44
|
-
"methods": [
|
|
45
|
-
|
|
46
|
-
],
|
|
42
|
+
"methods": [],
|
|
47
43
|
"previews": [
|
|
48
44
|
{
|
|
49
45
|
"preview_path": "primer/alpha/action_bar/default",
|
|
@@ -152,18 +148,10 @@
|
|
|
152
148
|
"description": "{{link_to_system_arguments_docs}}"
|
|
153
149
|
}
|
|
154
150
|
],
|
|
155
|
-
"slots": [
|
|
156
|
-
|
|
157
|
-
],
|
|
158
|
-
"
|
|
159
|
-
|
|
160
|
-
],
|
|
161
|
-
"previews": [
|
|
162
|
-
|
|
163
|
-
],
|
|
164
|
-
"subcomponents": [
|
|
165
|
-
|
|
166
|
-
]
|
|
151
|
+
"slots": [],
|
|
152
|
+
"methods": [],
|
|
153
|
+
"previews": [],
|
|
154
|
+
"subcomponents": []
|
|
167
155
|
},
|
|
168
156
|
{
|
|
169
157
|
"fully_qualified_name": "Primer::Alpha::ActionBar::Divider",
|
|
@@ -178,21 +166,11 @@
|
|
|
178
166
|
"short_name": "ActionBarDivider",
|
|
179
167
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/divider.rb",
|
|
180
168
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/divider/default/",
|
|
181
|
-
"parameters": [
|
|
182
|
-
|
|
183
|
-
],
|
|
184
|
-
"
|
|
185
|
-
|
|
186
|
-
],
|
|
187
|
-
"methods": [
|
|
188
|
-
|
|
189
|
-
],
|
|
190
|
-
"previews": [
|
|
191
|
-
|
|
192
|
-
],
|
|
193
|
-
"subcomponents": [
|
|
194
|
-
|
|
195
|
-
]
|
|
169
|
+
"parameters": [],
|
|
170
|
+
"slots": [],
|
|
171
|
+
"methods": [],
|
|
172
|
+
"previews": [],
|
|
173
|
+
"subcomponents": []
|
|
196
174
|
}
|
|
197
175
|
]
|
|
198
176
|
},
|
|
@@ -287,9 +265,7 @@
|
|
|
287
265
|
{
|
|
288
266
|
"name": "items",
|
|
289
267
|
"description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.",
|
|
290
|
-
"parameters": [
|
|
291
|
-
|
|
292
|
-
]
|
|
268
|
+
"parameters": []
|
|
293
269
|
}
|
|
294
270
|
],
|
|
295
271
|
"methods": [
|
|
@@ -310,9 +286,7 @@
|
|
|
310
286
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
311
287
|
}
|
|
312
288
|
],
|
|
313
|
-
"return_types": [
|
|
314
|
-
|
|
315
|
-
]
|
|
289
|
+
"return_types": []
|
|
316
290
|
},
|
|
317
291
|
{
|
|
318
292
|
"name": "with_divider",
|
|
@@ -325,9 +299,7 @@
|
|
|
325
299
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Divider{{/link_to_component}}."
|
|
326
300
|
}
|
|
327
301
|
],
|
|
328
|
-
"return_types": [
|
|
329
|
-
|
|
330
|
-
]
|
|
302
|
+
"return_types": []
|
|
331
303
|
},
|
|
332
304
|
{
|
|
333
305
|
"name": "with_avatar_item",
|
|
@@ -376,49 +348,31 @@
|
|
|
376
348
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
377
349
|
}
|
|
378
350
|
],
|
|
379
|
-
"return_types": [
|
|
380
|
-
|
|
381
|
-
]
|
|
351
|
+
"return_types": []
|
|
382
352
|
},
|
|
383
353
|
{
|
|
384
354
|
"name": "id",
|
|
385
355
|
"description": "Returns the value of attribute id.",
|
|
386
|
-
"parameters": [
|
|
387
|
-
|
|
388
|
-
],
|
|
389
|
-
"return_types": [
|
|
390
|
-
|
|
391
|
-
]
|
|
356
|
+
"parameters": [],
|
|
357
|
+
"return_types": []
|
|
392
358
|
},
|
|
393
359
|
{
|
|
394
360
|
"name": "select_variant",
|
|
395
361
|
"description": "Returns the value of attribute select_variant.",
|
|
396
|
-
"parameters": [
|
|
397
|
-
|
|
398
|
-
],
|
|
399
|
-
"return_types": [
|
|
400
|
-
|
|
401
|
-
]
|
|
362
|
+
"parameters": [],
|
|
363
|
+
"return_types": []
|
|
402
364
|
},
|
|
403
365
|
{
|
|
404
366
|
"name": "role",
|
|
405
367
|
"description": "Returns the value of attribute role.",
|
|
406
|
-
"parameters": [
|
|
407
|
-
|
|
408
|
-
],
|
|
409
|
-
"return_types": [
|
|
410
|
-
|
|
411
|
-
]
|
|
368
|
+
"parameters": [],
|
|
369
|
+
"return_types": []
|
|
412
370
|
},
|
|
413
371
|
{
|
|
414
372
|
"name": "aria_selection_variant",
|
|
415
373
|
"description": "Returns the value of attribute aria_selection_variant.",
|
|
416
|
-
"parameters": [
|
|
417
|
-
|
|
418
|
-
],
|
|
419
|
-
"return_types": [
|
|
420
|
-
|
|
421
|
-
]
|
|
374
|
+
"parameters": [],
|
|
375
|
+
"return_types": []
|
|
422
376
|
},
|
|
423
377
|
{
|
|
424
378
|
"name": "build_item",
|
|
@@ -437,9 +391,7 @@
|
|
|
437
391
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
438
392
|
}
|
|
439
393
|
],
|
|
440
|
-
"return_types": [
|
|
441
|
-
|
|
442
|
-
]
|
|
394
|
+
"return_types": []
|
|
443
395
|
},
|
|
444
396
|
{
|
|
445
397
|
"name": "build_avatar_item",
|
|
@@ -488,19 +440,13 @@
|
|
|
488
440
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
489
441
|
}
|
|
490
442
|
],
|
|
491
|
-
"return_types": [
|
|
492
|
-
|
|
493
|
-
]
|
|
443
|
+
"return_types": []
|
|
494
444
|
},
|
|
495
445
|
{
|
|
496
446
|
"name": "post_list_content_block",
|
|
497
447
|
"description": "Returns the value of attribute post_list_content_block.",
|
|
498
|
-
"parameters": [
|
|
499
|
-
|
|
500
|
-
],
|
|
501
|
-
"return_types": [
|
|
502
|
-
|
|
503
|
-
]
|
|
448
|
+
"parameters": [],
|
|
449
|
+
"return_types": []
|
|
504
450
|
}
|
|
505
451
|
],
|
|
506
452
|
"previews": [
|
|
@@ -1008,16 +954,12 @@
|
|
|
1008
954
|
{
|
|
1009
955
|
"name": "leading_visual",
|
|
1010
956
|
"description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
|
|
1011
|
-
"parameters": [
|
|
1012
|
-
|
|
1013
|
-
]
|
|
957
|
+
"parameters": []
|
|
1014
958
|
},
|
|
1015
959
|
{
|
|
1016
960
|
"name": "trailing_visual",
|
|
1017
961
|
"description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
|
|
1018
|
-
"parameters": [
|
|
1019
|
-
|
|
1020
|
-
]
|
|
962
|
+
"parameters": []
|
|
1021
963
|
},
|
|
1022
964
|
{
|
|
1023
965
|
"name": "trailing_action",
|
|
@@ -1054,79 +996,49 @@
|
|
|
1054
996
|
{
|
|
1055
997
|
"name": "id",
|
|
1056
998
|
"description": "Returns the value of attribute id.",
|
|
1057
|
-
"parameters": [
|
|
1058
|
-
|
|
1059
|
-
],
|
|
1060
|
-
"return_types": [
|
|
1061
|
-
|
|
1062
|
-
]
|
|
999
|
+
"parameters": [],
|
|
1000
|
+
"return_types": []
|
|
1063
1001
|
},
|
|
1064
1002
|
{
|
|
1065
1003
|
"name": "item_id",
|
|
1066
1004
|
"description": "Returns the value of attribute item_id.",
|
|
1067
|
-
"parameters": [
|
|
1068
|
-
|
|
1069
|
-
],
|
|
1070
|
-
"return_types": [
|
|
1071
|
-
|
|
1072
|
-
]
|
|
1005
|
+
"parameters": [],
|
|
1006
|
+
"return_types": []
|
|
1073
1007
|
},
|
|
1074
1008
|
{
|
|
1075
1009
|
"name": "list",
|
|
1076
1010
|
"description": "Returns the value of attribute list.",
|
|
1077
|
-
"parameters": [
|
|
1078
|
-
|
|
1079
|
-
],
|
|
1080
|
-
"return_types": [
|
|
1081
|
-
|
|
1082
|
-
]
|
|
1011
|
+
"parameters": [],
|
|
1012
|
+
"return_types": []
|
|
1083
1013
|
},
|
|
1084
1014
|
{
|
|
1085
1015
|
"name": "href",
|
|
1086
1016
|
"description": "Returns the value of attribute href.",
|
|
1087
|
-
"parameters": [
|
|
1088
|
-
|
|
1089
|
-
],
|
|
1090
|
-
"return_types": [
|
|
1091
|
-
|
|
1092
|
-
]
|
|
1017
|
+
"parameters": [],
|
|
1018
|
+
"return_types": []
|
|
1093
1019
|
},
|
|
1094
1020
|
{
|
|
1095
1021
|
"name": "active",
|
|
1096
1022
|
"description": "Returns the value of attribute active.",
|
|
1097
|
-
"parameters": [
|
|
1098
|
-
|
|
1099
|
-
],
|
|
1100
|
-
"return_types": [
|
|
1101
|
-
|
|
1102
|
-
]
|
|
1023
|
+
"parameters": [],
|
|
1024
|
+
"return_types": []
|
|
1103
1025
|
},
|
|
1104
1026
|
{
|
|
1105
1027
|
"name": "disabled",
|
|
1106
1028
|
"description": "Returns the value of attribute disabled.",
|
|
1107
|
-
"parameters": [
|
|
1108
|
-
|
|
1109
|
-
],
|
|
1110
|
-
"return_types": [
|
|
1111
|
-
|
|
1112
|
-
]
|
|
1029
|
+
"parameters": [],
|
|
1030
|
+
"return_types": []
|
|
1113
1031
|
},
|
|
1114
1032
|
{
|
|
1115
1033
|
"name": "parent",
|
|
1116
1034
|
"description": "Returns the value of attribute parent.",
|
|
1117
|
-
"parameters": [
|
|
1118
|
-
|
|
1119
|
-
],
|
|
1120
|
-
"return_types": [
|
|
1121
|
-
|
|
1122
|
-
]
|
|
1035
|
+
"parameters": [],
|
|
1036
|
+
"return_types": []
|
|
1123
1037
|
},
|
|
1124
1038
|
{
|
|
1125
1039
|
"name": "active?",
|
|
1126
1040
|
"description": "Returns the value of attribute active.\nWhether or not this item is active.",
|
|
1127
|
-
"parameters": [
|
|
1128
|
-
|
|
1129
|
-
],
|
|
1041
|
+
"parameters": [],
|
|
1130
1042
|
"return_types": [
|
|
1131
1043
|
"Boolean"
|
|
1132
1044
|
]
|
|
@@ -1134,20 +1046,14 @@
|
|
|
1134
1046
|
{
|
|
1135
1047
|
"name": "disabled?",
|
|
1136
1048
|
"description": "Returns the value of attribute disabled.\nWhether or not this item is disabled.",
|
|
1137
|
-
"parameters": [
|
|
1138
|
-
|
|
1139
|
-
],
|
|
1049
|
+
"parameters": [],
|
|
1140
1050
|
"return_types": [
|
|
1141
1051
|
"Boolean"
|
|
1142
1052
|
]
|
|
1143
1053
|
}
|
|
1144
1054
|
],
|
|
1145
|
-
"previews": [
|
|
1146
|
-
|
|
1147
|
-
],
|
|
1148
|
-
"subcomponents": [
|
|
1149
|
-
|
|
1150
|
-
]
|
|
1055
|
+
"previews": [],
|
|
1056
|
+
"subcomponents": []
|
|
1151
1057
|
},
|
|
1152
1058
|
{
|
|
1153
1059
|
"fully_qualified_name": "Primer::Alpha::ActionList::Heading",
|
|
@@ -1194,37 +1100,23 @@
|
|
|
1194
1100
|
"description": "{{link_to_system_arguments_docs}}"
|
|
1195
1101
|
}
|
|
1196
1102
|
],
|
|
1197
|
-
"slots": [
|
|
1198
|
-
|
|
1199
|
-
],
|
|
1103
|
+
"slots": [],
|
|
1200
1104
|
"methods": [
|
|
1201
1105
|
{
|
|
1202
1106
|
"name": "title_id",
|
|
1203
1107
|
"description": "Returns the value of attribute title_id.",
|
|
1204
|
-
"parameters": [
|
|
1205
|
-
|
|
1206
|
-
],
|
|
1207
|
-
"return_types": [
|
|
1208
|
-
|
|
1209
|
-
]
|
|
1108
|
+
"parameters": [],
|
|
1109
|
+
"return_types": []
|
|
1210
1110
|
},
|
|
1211
1111
|
{
|
|
1212
1112
|
"name": "subtitle_id",
|
|
1213
1113
|
"description": "Returns the value of attribute subtitle_id.",
|
|
1214
|
-
"parameters": [
|
|
1215
|
-
|
|
1216
|
-
],
|
|
1217
|
-
"return_types": [
|
|
1218
|
-
|
|
1219
|
-
]
|
|
1114
|
+
"parameters": [],
|
|
1115
|
+
"return_types": []
|
|
1220
1116
|
}
|
|
1221
1117
|
],
|
|
1222
|
-
"previews": [
|
|
1223
|
-
|
|
1224
|
-
],
|
|
1225
|
-
"subcomponents": [
|
|
1226
|
-
|
|
1227
|
-
]
|
|
1118
|
+
"previews": [],
|
|
1119
|
+
"subcomponents": []
|
|
1228
1120
|
},
|
|
1229
1121
|
{
|
|
1230
1122
|
"fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
|
|
@@ -1239,21 +1131,11 @@
|
|
|
1239
1131
|
"short_name": "ActionListFormWrapper",
|
|
1240
1132
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
|
|
1241
1133
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
|
|
1242
|
-
"parameters": [
|
|
1243
|
-
|
|
1244
|
-
],
|
|
1245
|
-
"
|
|
1246
|
-
|
|
1247
|
-
],
|
|
1248
|
-
"methods": [
|
|
1249
|
-
|
|
1250
|
-
],
|
|
1251
|
-
"previews": [
|
|
1252
|
-
|
|
1253
|
-
],
|
|
1254
|
-
"subcomponents": [
|
|
1255
|
-
|
|
1256
|
-
]
|
|
1134
|
+
"parameters": [],
|
|
1135
|
+
"slots": [],
|
|
1136
|
+
"methods": [],
|
|
1137
|
+
"previews": [],
|
|
1138
|
+
"subcomponents": []
|
|
1257
1139
|
},
|
|
1258
1140
|
{
|
|
1259
1141
|
"fully_qualified_name": "Primer::Alpha::ActionList::Divider",
|
|
@@ -1282,18 +1164,10 @@
|
|
|
1282
1164
|
"description": "{{link_to_system_arguments_docs}}"
|
|
1283
1165
|
}
|
|
1284
1166
|
],
|
|
1285
|
-
"slots": [
|
|
1286
|
-
|
|
1287
|
-
],
|
|
1288
|
-
"
|
|
1289
|
-
|
|
1290
|
-
],
|
|
1291
|
-
"previews": [
|
|
1292
|
-
|
|
1293
|
-
],
|
|
1294
|
-
"subcomponents": [
|
|
1295
|
-
|
|
1296
|
-
]
|
|
1167
|
+
"slots": [],
|
|
1168
|
+
"methods": [],
|
|
1169
|
+
"previews": [],
|
|
1170
|
+
"subcomponents": []
|
|
1297
1171
|
}
|
|
1298
1172
|
]
|
|
1299
1173
|
},
|
|
@@ -1414,32 +1288,20 @@
|
|
|
1414
1288
|
{
|
|
1415
1289
|
"name": "list",
|
|
1416
1290
|
"description": "Returns the value of attribute list.",
|
|
1417
|
-
"parameters": [
|
|
1418
|
-
|
|
1419
|
-
],
|
|
1420
|
-
"return_types": [
|
|
1421
|
-
|
|
1422
|
-
]
|
|
1291
|
+
"parameters": [],
|
|
1292
|
+
"return_types": []
|
|
1423
1293
|
},
|
|
1424
1294
|
{
|
|
1425
1295
|
"name": "preload",
|
|
1426
1296
|
"description": "Returns the value of attribute preload.",
|
|
1427
|
-
"parameters": [
|
|
1428
|
-
|
|
1429
|
-
],
|
|
1430
|
-
"return_types": [
|
|
1431
|
-
|
|
1432
|
-
]
|
|
1297
|
+
"parameters": [],
|
|
1298
|
+
"return_types": []
|
|
1433
1299
|
},
|
|
1434
1300
|
{
|
|
1435
1301
|
"name": "preload?",
|
|
1436
1302
|
"description": "Returns the value of attribute preload.",
|
|
1437
|
-
"parameters": [
|
|
1438
|
-
|
|
1439
|
-
],
|
|
1440
|
-
"return_types": [
|
|
1441
|
-
|
|
1442
|
-
]
|
|
1303
|
+
"parameters": [],
|
|
1304
|
+
"return_types": []
|
|
1443
1305
|
},
|
|
1444
1306
|
{
|
|
1445
1307
|
"name": "with_show_button",
|
|
@@ -1452,9 +1314,7 @@
|
|
|
1452
1314
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot."
|
|
1453
1315
|
}
|
|
1454
1316
|
],
|
|
1455
|
-
"return_types": [
|
|
1456
|
-
|
|
1457
|
-
]
|
|
1317
|
+
"return_types": []
|
|
1458
1318
|
},
|
|
1459
1319
|
{
|
|
1460
1320
|
"name": "with_item",
|
|
@@ -1467,9 +1327,7 @@
|
|
|
1467
1327
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
1468
1328
|
}
|
|
1469
1329
|
],
|
|
1470
|
-
"return_types": [
|
|
1471
|
-
|
|
1472
|
-
]
|
|
1330
|
+
"return_types": []
|
|
1473
1331
|
},
|
|
1474
1332
|
{
|
|
1475
1333
|
"name": "with_divider",
|
|
@@ -1482,9 +1340,7 @@
|
|
|
1482
1340
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}}'s `divider` slot."
|
|
1483
1341
|
}
|
|
1484
1342
|
],
|
|
1485
|
-
"return_types": [
|
|
1486
|
-
|
|
1487
|
-
]
|
|
1343
|
+
"return_types": []
|
|
1488
1344
|
},
|
|
1489
1345
|
{
|
|
1490
1346
|
"name": "with_avatar_item",
|
|
@@ -1527,9 +1383,7 @@
|
|
|
1527
1383
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
|
1528
1384
|
}
|
|
1529
1385
|
],
|
|
1530
|
-
"return_types": [
|
|
1531
|
-
|
|
1532
|
-
]
|
|
1386
|
+
"return_types": []
|
|
1533
1387
|
}
|
|
1534
1388
|
],
|
|
1535
1389
|
"previews": [
|
|
@@ -1933,27 +1787,17 @@
|
|
|
1933
1787
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}}"
|
|
1934
1788
|
}
|
|
1935
1789
|
],
|
|
1936
|
-
"slots": [
|
|
1937
|
-
|
|
1938
|
-
],
|
|
1790
|
+
"slots": [],
|
|
1939
1791
|
"methods": [
|
|
1940
1792
|
{
|
|
1941
1793
|
"name": "items",
|
|
1942
1794
|
"description": "Returns the value of attribute items.",
|
|
1943
|
-
"parameters": [
|
|
1944
|
-
|
|
1945
|
-
],
|
|
1946
|
-
"return_types": [
|
|
1947
|
-
|
|
1948
|
-
]
|
|
1795
|
+
"parameters": [],
|
|
1796
|
+
"return_types": []
|
|
1949
1797
|
}
|
|
1950
1798
|
],
|
|
1951
|
-
"previews": [
|
|
1952
|
-
|
|
1953
|
-
],
|
|
1954
|
-
"subcomponents": [
|
|
1955
|
-
|
|
1956
|
-
]
|
|
1799
|
+
"previews": [],
|
|
1800
|
+
"subcomponents": []
|
|
1957
1801
|
},
|
|
1958
1802
|
{
|
|
1959
1803
|
"fully_qualified_name": "Primer::Alpha::ActionMenu::Heading",
|
|
@@ -1968,21 +1812,11 @@
|
|
|
1968
1812
|
"short_name": "ActionMenuHeading",
|
|
1969
1813
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/heading.rb",
|
|
1970
1814
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/heading/default/",
|
|
1971
|
-
"parameters": [
|
|
1972
|
-
|
|
1973
|
-
],
|
|
1974
|
-
"
|
|
1975
|
-
|
|
1976
|
-
],
|
|
1977
|
-
"methods": [
|
|
1978
|
-
|
|
1979
|
-
],
|
|
1980
|
-
"previews": [
|
|
1981
|
-
|
|
1982
|
-
],
|
|
1983
|
-
"subcomponents": [
|
|
1984
|
-
|
|
1985
|
-
]
|
|
1815
|
+
"parameters": [],
|
|
1816
|
+
"slots": [],
|
|
1817
|
+
"methods": [],
|
|
1818
|
+
"previews": [],
|
|
1819
|
+
"subcomponents": []
|
|
1986
1820
|
},
|
|
1987
1821
|
{
|
|
1988
1822
|
"fully_qualified_name": "Primer::Alpha::ActionMenu::ListWrapper",
|
|
@@ -2033,20 +1867,12 @@
|
|
|
2033
1867
|
{
|
|
2034
1868
|
"name": "items",
|
|
2035
1869
|
"description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.",
|
|
2036
|
-
"parameters": [
|
|
2037
|
-
|
|
2038
|
-
]
|
|
1870
|
+
"parameters": []
|
|
2039
1871
|
}
|
|
2040
1872
|
],
|
|
2041
|
-
"methods": [
|
|
2042
|
-
|
|
2043
|
-
]
|
|
2044
|
-
"previews": [
|
|
2045
|
-
|
|
2046
|
-
],
|
|
2047
|
-
"subcomponents": [
|
|
2048
|
-
|
|
2049
|
-
]
|
|
1873
|
+
"methods": [],
|
|
1874
|
+
"previews": [],
|
|
1875
|
+
"subcomponents": []
|
|
2050
1876
|
},
|
|
2051
1877
|
{
|
|
2052
1878
|
"fully_qualified_name": "Primer::Alpha::ActionMenu::Group",
|
|
@@ -2139,9 +1965,7 @@
|
|
|
2139
1965
|
{
|
|
2140
1966
|
"name": "items",
|
|
2141
1967
|
"description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.",
|
|
2142
|
-
"parameters": [
|
|
2143
|
-
|
|
2144
|
-
]
|
|
1968
|
+
"parameters": []
|
|
2145
1969
|
}
|
|
2146
1970
|
],
|
|
2147
1971
|
"methods": [
|
|
@@ -2156,17 +1980,11 @@
|
|
|
2156
1980
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::Heading{{/link_to_component}}."
|
|
2157
1981
|
}
|
|
2158
1982
|
],
|
|
2159
|
-
"return_types": [
|
|
2160
|
-
|
|
2161
|
-
]
|
|
1983
|
+
"return_types": []
|
|
2162
1984
|
}
|
|
2163
1985
|
],
|
|
2164
|
-
"previews": [
|
|
2165
|
-
|
|
2166
|
-
],
|
|
2167
|
-
"subcomponents": [
|
|
2168
|
-
|
|
2169
|
-
]
|
|
1986
|
+
"previews": [],
|
|
1987
|
+
"subcomponents": []
|
|
2170
1988
|
}
|
|
2171
1989
|
]
|
|
2172
1990
|
},
|
|
@@ -2408,18 +2226,10 @@
|
|
|
2408
2226
|
"description": "{{link_to_system_arguments_docs}}"
|
|
2409
2227
|
}
|
|
2410
2228
|
],
|
|
2411
|
-
"slots": [
|
|
2412
|
-
|
|
2413
|
-
],
|
|
2414
|
-
"
|
|
2415
|
-
|
|
2416
|
-
],
|
|
2417
|
-
"previews": [
|
|
2418
|
-
|
|
2419
|
-
],
|
|
2420
|
-
"subcomponents": [
|
|
2421
|
-
|
|
2422
|
-
]
|
|
2229
|
+
"slots": [],
|
|
2230
|
+
"methods": [],
|
|
2231
|
+
"previews": [],
|
|
2232
|
+
"subcomponents": []
|
|
2423
2233
|
}
|
|
2424
2234
|
]
|
|
2425
2235
|
},
|
|
@@ -2483,7 +2293,7 @@
|
|
|
2483
2293
|
"name": "scheme",
|
|
2484
2294
|
"type": "Symbol",
|
|
2485
2295
|
"default": "`:default`",
|
|
2486
|
-
"description": "One of `:danger`, `:default`, `:success`, or `:warning`."
|
|
2296
|
+
"description": "One of `:danger`, `:default`, `:success`, `:upsell`, or `:warning`."
|
|
2487
2297
|
},
|
|
2488
2298
|
{
|
|
2489
2299
|
"name": "system_arguments",
|
|
@@ -2496,14 +2306,10 @@
|
|
|
2496
2306
|
{
|
|
2497
2307
|
"name": "action",
|
|
2498
2308
|
"description": "A button or custom content that will render on the right-hand side of the component.\n\nTo render a button, call the `with_action_button` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}}.\n\nTo render custom content, call the `with_action_content` method and pass a block that returns HTML.",
|
|
2499
|
-
"parameters": [
|
|
2500
|
-
|
|
2501
|
-
]
|
|
2309
|
+
"parameters": []
|
|
2502
2310
|
}
|
|
2503
2311
|
],
|
|
2504
|
-
"methods": [
|
|
2505
|
-
|
|
2506
|
-
],
|
|
2312
|
+
"methods": [],
|
|
2507
2313
|
"previews": [
|
|
2508
2314
|
{
|
|
2509
2315
|
"preview_path": "primer/alpha/banner/playground",
|
|
@@ -2583,6 +2389,19 @@
|
|
|
2583
2389
|
]
|
|
2584
2390
|
}
|
|
2585
2391
|
},
|
|
2392
|
+
{
|
|
2393
|
+
"preview_path": "primer/alpha/banner/scheme_upsell",
|
|
2394
|
+
"name": "scheme_upsell",
|
|
2395
|
+
"snapshot": "true",
|
|
2396
|
+
"skip_rules": {
|
|
2397
|
+
"wont_fix": [
|
|
2398
|
+
"region"
|
|
2399
|
+
],
|
|
2400
|
+
"will_fix": [
|
|
2401
|
+
"color-contrast"
|
|
2402
|
+
]
|
|
2403
|
+
}
|
|
2404
|
+
},
|
|
2586
2405
|
{
|
|
2587
2406
|
"preview_path": "primer/alpha/banner/dismissible",
|
|
2588
2407
|
"name": "dismissible",
|
|
@@ -2649,9 +2468,7 @@
|
|
|
2649
2468
|
}
|
|
2650
2469
|
}
|
|
2651
2470
|
],
|
|
2652
|
-
"subcomponents": [
|
|
2653
|
-
|
|
2654
|
-
]
|
|
2471
|
+
"subcomponents": []
|
|
2655
2472
|
},
|
|
2656
2473
|
{
|
|
2657
2474
|
"fully_qualified_name": "Primer::Alpha::ButtonMarketing",
|
|
@@ -2704,12 +2521,8 @@
|
|
|
2704
2521
|
"description": "{{link_to_system_arguments_docs}}"
|
|
2705
2522
|
}
|
|
2706
2523
|
],
|
|
2707
|
-
"slots": [
|
|
2708
|
-
|
|
2709
|
-
],
|
|
2710
|
-
"methods": [
|
|
2711
|
-
|
|
2712
|
-
],
|
|
2524
|
+
"slots": [],
|
|
2525
|
+
"methods": [],
|
|
2713
2526
|
"previews": [
|
|
2714
2527
|
{
|
|
2715
2528
|
"preview_path": "primer/alpha/button_marketing/playground",
|
|
@@ -2829,9 +2642,7 @@
|
|
|
2829
2642
|
}
|
|
2830
2643
|
}
|
|
2831
2644
|
],
|
|
2832
|
-
"subcomponents": [
|
|
2833
|
-
|
|
2834
|
-
]
|
|
2645
|
+
"subcomponents": []
|
|
2835
2646
|
},
|
|
2836
2647
|
{
|
|
2837
2648
|
"fully_qualified_name": "Primer::Alpha::CheckBox",
|
|
@@ -2980,12 +2791,8 @@
|
|
|
2980
2791
|
"description": "Controls how check box values are submitted to the server. One of `:array` or `:boolean`.."
|
|
2981
2792
|
}
|
|
2982
2793
|
],
|
|
2983
|
-
"slots": [
|
|
2984
|
-
|
|
2985
|
-
],
|
|
2986
|
-
"methods": [
|
|
2987
|
-
|
|
2988
|
-
],
|
|
2794
|
+
"slots": [],
|
|
2795
|
+
"methods": [],
|
|
2989
2796
|
"previews": [
|
|
2990
2797
|
{
|
|
2991
2798
|
"preview_path": "primer/alpha/check_box/playground",
|
|
@@ -3066,9 +2873,7 @@
|
|
|
3066
2873
|
}
|
|
3067
2874
|
}
|
|
3068
2875
|
],
|
|
3069
|
-
"subcomponents": [
|
|
3070
|
-
|
|
3071
|
-
]
|
|
2876
|
+
"subcomponents": []
|
|
3072
2877
|
},
|
|
3073
2878
|
{
|
|
3074
2879
|
"fully_qualified_name": "Primer::Alpha::CheckBoxGroup",
|
|
@@ -3127,9 +2932,7 @@
|
|
|
3127
2932
|
"description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
|
|
3128
2933
|
}
|
|
3129
2934
|
],
|
|
3130
|
-
"slots": [
|
|
3131
|
-
|
|
3132
|
-
],
|
|
2935
|
+
"slots": [],
|
|
3133
2936
|
"methods": [
|
|
3134
2937
|
{
|
|
3135
2938
|
"name": "check_box",
|
|
@@ -3148,9 +2951,7 @@
|
|
|
3148
2951
|
"description": "The block accepted by {{#link_to_component}}Primer::Alpha::CheckBox{{/link_to_component}}."
|
|
3149
2952
|
}
|
|
3150
2953
|
],
|
|
3151
|
-
"return_types": [
|
|
3152
|
-
|
|
3153
|
-
]
|
|
2954
|
+
"return_types": []
|
|
3154
2955
|
}
|
|
3155
2956
|
],
|
|
3156
2957
|
"previews": [
|
|
@@ -3246,9 +3047,7 @@
|
|
|
3246
3047
|
}
|
|
3247
3048
|
}
|
|
3248
3049
|
],
|
|
3249
|
-
"subcomponents": [
|
|
3250
|
-
|
|
3251
|
-
]
|
|
3050
|
+
"subcomponents": []
|
|
3252
3051
|
},
|
|
3253
3052
|
{
|
|
3254
3053
|
"fully_qualified_name": "Primer::Alpha::Dialog",
|
|
@@ -3391,12 +3190,8 @@
|
|
|
3391
3190
|
{
|
|
3392
3191
|
"name": "id",
|
|
3393
3192
|
"description": "The dialog's ID value.",
|
|
3394
|
-
"parameters": [
|
|
3395
|
-
|
|
3396
|
-
],
|
|
3397
|
-
"return_types": [
|
|
3398
|
-
|
|
3399
|
-
]
|
|
3193
|
+
"parameters": [],
|
|
3194
|
+
"return_types": []
|
|
3400
3195
|
}
|
|
3401
3196
|
],
|
|
3402
3197
|
"previews": [
|
|
@@ -3633,6 +3428,32 @@
|
|
|
3633
3428
|
"color-contrast"
|
|
3634
3429
|
]
|
|
3635
3430
|
}
|
|
3431
|
+
},
|
|
3432
|
+
{
|
|
3433
|
+
"preview_path": "primer/alpha/dialog/with_header_close_button_label",
|
|
3434
|
+
"name": "with_header_close_button_label",
|
|
3435
|
+
"snapshot": "false",
|
|
3436
|
+
"skip_rules": {
|
|
3437
|
+
"wont_fix": [
|
|
3438
|
+
"region"
|
|
3439
|
+
],
|
|
3440
|
+
"will_fix": [
|
|
3441
|
+
"color-contrast"
|
|
3442
|
+
]
|
|
3443
|
+
}
|
|
3444
|
+
},
|
|
3445
|
+
{
|
|
3446
|
+
"preview_path": "primer/alpha/dialog/without_header_close_button_label",
|
|
3447
|
+
"name": "without_header_close_button_label",
|
|
3448
|
+
"snapshot": "false",
|
|
3449
|
+
"skip_rules": {
|
|
3450
|
+
"wont_fix": [
|
|
3451
|
+
"region"
|
|
3452
|
+
],
|
|
3453
|
+
"will_fix": [
|
|
3454
|
+
"color-contrast"
|
|
3455
|
+
]
|
|
3456
|
+
}
|
|
3636
3457
|
}
|
|
3637
3458
|
],
|
|
3638
3459
|
"subcomponents": [
|
|
@@ -3686,6 +3507,12 @@
|
|
|
3686
3507
|
"default": "`:medium`",
|
|
3687
3508
|
"description": "One of `:large` or `:medium`."
|
|
3688
3509
|
},
|
|
3510
|
+
{
|
|
3511
|
+
"name": "close_label",
|
|
3512
|
+
"type": "String",
|
|
3513
|
+
"default": "`Close`",
|
|
3514
|
+
"description": "The aria-label text of the close \"x\" button."
|
|
3515
|
+
},
|
|
3689
3516
|
{
|
|
3690
3517
|
"name": "system_arguments",
|
|
3691
3518
|
"type": "Hash",
|
|
@@ -3719,15 +3546,9 @@
|
|
|
3719
3546
|
]
|
|
3720
3547
|
}
|
|
3721
3548
|
],
|
|
3722
|
-
"methods": [
|
|
3723
|
-
|
|
3724
|
-
]
|
|
3725
|
-
"previews": [
|
|
3726
|
-
|
|
3727
|
-
],
|
|
3728
|
-
"subcomponents": [
|
|
3729
|
-
|
|
3730
|
-
]
|
|
3549
|
+
"methods": [],
|
|
3550
|
+
"previews": [],
|
|
3551
|
+
"subcomponents": []
|
|
3731
3552
|
},
|
|
3732
3553
|
{
|
|
3733
3554
|
"fully_qualified_name": "Primer::Alpha::Dialog::Body",
|
|
@@ -3750,18 +3571,10 @@
|
|
|
3750
3571
|
"description": "{{link_to_system_arguments_docs}}"
|
|
3751
3572
|
}
|
|
3752
3573
|
],
|
|
3753
|
-
"slots": [
|
|
3754
|
-
|
|
3755
|
-
],
|
|
3756
|
-
"
|
|
3757
|
-
|
|
3758
|
-
],
|
|
3759
|
-
"previews": [
|
|
3760
|
-
|
|
3761
|
-
],
|
|
3762
|
-
"subcomponents": [
|
|
3763
|
-
|
|
3764
|
-
]
|
|
3574
|
+
"slots": [],
|
|
3575
|
+
"methods": [],
|
|
3576
|
+
"previews": [],
|
|
3577
|
+
"subcomponents": []
|
|
3765
3578
|
},
|
|
3766
3579
|
{
|
|
3767
3580
|
"fully_qualified_name": "Primer::Alpha::Dialog::Footer",
|
|
@@ -3790,18 +3603,10 @@
|
|
|
3790
3603
|
"description": "{{link_to_system_arguments_docs}}"
|
|
3791
3604
|
}
|
|
3792
3605
|
],
|
|
3793
|
-
"slots": [
|
|
3794
|
-
|
|
3795
|
-
],
|
|
3796
|
-
"
|
|
3797
|
-
|
|
3798
|
-
],
|
|
3799
|
-
"previews": [
|
|
3800
|
-
|
|
3801
|
-
],
|
|
3802
|
-
"subcomponents": [
|
|
3803
|
-
|
|
3804
|
-
]
|
|
3606
|
+
"slots": [],
|
|
3607
|
+
"methods": [],
|
|
3608
|
+
"previews": [],
|
|
3609
|
+
"subcomponents": []
|
|
3805
3610
|
}
|
|
3806
3611
|
]
|
|
3807
3612
|
},
|
|
@@ -3894,9 +3699,7 @@
|
|
|
3894
3699
|
]
|
|
3895
3700
|
}
|
|
3896
3701
|
],
|
|
3897
|
-
"methods": [
|
|
3898
|
-
|
|
3899
|
-
],
|
|
3702
|
+
"methods": [],
|
|
3900
3703
|
"previews": [
|
|
3901
3704
|
{
|
|
3902
3705
|
"preview_path": "primer/alpha/dropdown/playground",
|
|
@@ -4108,21 +3911,11 @@
|
|
|
4108
3911
|
"short_name": "DropdownMenuItem",
|
|
4109
3912
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu/item.rb",
|
|
4110
3913
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/item/default/",
|
|
4111
|
-
"parameters": [
|
|
4112
|
-
|
|
4113
|
-
],
|
|
4114
|
-
"
|
|
4115
|
-
|
|
4116
|
-
],
|
|
4117
|
-
"methods": [
|
|
4118
|
-
|
|
4119
|
-
],
|
|
4120
|
-
"previews": [
|
|
4121
|
-
|
|
4122
|
-
],
|
|
4123
|
-
"subcomponents": [
|
|
4124
|
-
|
|
4125
|
-
]
|
|
3914
|
+
"parameters": [],
|
|
3915
|
+
"slots": [],
|
|
3916
|
+
"methods": [],
|
|
3917
|
+
"previews": [],
|
|
3918
|
+
"subcomponents": []
|
|
4126
3919
|
},
|
|
4127
3920
|
{
|
|
4128
3921
|
"fully_qualified_name": "Primer::Alpha::Dropdown::Menu",
|
|
@@ -4189,15 +3982,9 @@
|
|
|
4189
3982
|
]
|
|
4190
3983
|
}
|
|
4191
3984
|
],
|
|
4192
|
-
"methods": [
|
|
4193
|
-
|
|
4194
|
-
]
|
|
4195
|
-
"previews": [
|
|
4196
|
-
|
|
4197
|
-
],
|
|
4198
|
-
"subcomponents": [
|
|
4199
|
-
|
|
4200
|
-
]
|
|
3985
|
+
"methods": [],
|
|
3986
|
+
"previews": [],
|
|
3987
|
+
"subcomponents": []
|
|
4201
3988
|
}
|
|
4202
3989
|
]
|
|
4203
3990
|
},
|
|
@@ -4264,18 +4051,10 @@
|
|
|
4264
4051
|
"description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
|
|
4265
4052
|
}
|
|
4266
4053
|
],
|
|
4267
|
-
"slots": [
|
|
4268
|
-
|
|
4269
|
-
],
|
|
4270
|
-
"
|
|
4271
|
-
|
|
4272
|
-
],
|
|
4273
|
-
"previews": [
|
|
4274
|
-
|
|
4275
|
-
],
|
|
4276
|
-
"subcomponents": [
|
|
4277
|
-
|
|
4278
|
-
]
|
|
4054
|
+
"slots": [],
|
|
4055
|
+
"methods": [],
|
|
4056
|
+
"previews": [],
|
|
4057
|
+
"subcomponents": []
|
|
4279
4058
|
},
|
|
4280
4059
|
{
|
|
4281
4060
|
"fully_qualified_name": "Primer::Alpha::FormControl",
|
|
@@ -4344,25 +4123,19 @@
|
|
|
4344
4123
|
{
|
|
4345
4124
|
"name": "caption",
|
|
4346
4125
|
"description": "Describes the field and what sorts of input it expects. Displayed below the input.\nNote that this slot takes precedence over the `caption:` argument in the constructor.",
|
|
4347
|
-
"parameters": [
|
|
4348
|
-
|
|
4349
|
-
]
|
|
4126
|
+
"parameters": []
|
|
4350
4127
|
},
|
|
4351
4128
|
{
|
|
4352
4129
|
"name": "input",
|
|
4353
4130
|
"description": "The input content. Yields a set of {{link_to_system_arguments_docs}} that should be added to the input.",
|
|
4354
|
-
"parameters": [
|
|
4355
|
-
|
|
4356
|
-
]
|
|
4131
|
+
"parameters": []
|
|
4357
4132
|
}
|
|
4358
4133
|
],
|
|
4359
4134
|
"methods": [
|
|
4360
4135
|
{
|
|
4361
4136
|
"name": "required?",
|
|
4362
4137
|
"description": "Whether or not this input is marked as required.",
|
|
4363
|
-
"parameters": [
|
|
4364
|
-
|
|
4365
|
-
],
|
|
4138
|
+
"parameters": [],
|
|
4366
4139
|
"return_types": [
|
|
4367
4140
|
"Boolean"
|
|
4368
4141
|
]
|
|
@@ -4370,9 +4143,7 @@
|
|
|
4370
4143
|
{
|
|
4371
4144
|
"name": "visually_hide_label?",
|
|
4372
4145
|
"description": "Whether or not to hide the label visually. The label will still be visible to screen readers.",
|
|
4373
|
-
"parameters": [
|
|
4374
|
-
|
|
4375
|
-
],
|
|
4146
|
+
"parameters": [],
|
|
4376
4147
|
"return_types": [
|
|
4377
4148
|
"Boolean"
|
|
4378
4149
|
]
|
|
@@ -4380,9 +4151,7 @@
|
|
|
4380
4151
|
{
|
|
4381
4152
|
"name": "full_width?",
|
|
4382
4153
|
"description": "Whether or not the form control should take up all the horizontal space allowed by its container.",
|
|
4383
|
-
"parameters": [
|
|
4384
|
-
|
|
4385
|
-
],
|
|
4154
|
+
"parameters": [],
|
|
4386
4155
|
"return_types": [
|
|
4387
4156
|
"Boolean"
|
|
4388
4157
|
]
|
|
@@ -4468,9 +4237,7 @@
|
|
|
4468
4237
|
}
|
|
4469
4238
|
}
|
|
4470
4239
|
],
|
|
4471
|
-
"subcomponents": [
|
|
4472
|
-
|
|
4473
|
-
]
|
|
4240
|
+
"subcomponents": []
|
|
4474
4241
|
},
|
|
4475
4242
|
{
|
|
4476
4243
|
"fully_qualified_name": "Primer::Alpha::HellipButton",
|
|
@@ -4505,12 +4272,8 @@
|
|
|
4505
4272
|
"description": "{{link_to_system_arguments_docs}}"
|
|
4506
4273
|
}
|
|
4507
4274
|
],
|
|
4508
|
-
"slots": [
|
|
4509
|
-
|
|
4510
|
-
],
|
|
4511
|
-
"methods": [
|
|
4512
|
-
|
|
4513
|
-
],
|
|
4275
|
+
"slots": [],
|
|
4276
|
+
"methods": [],
|
|
4514
4277
|
"previews": [
|
|
4515
4278
|
{
|
|
4516
4279
|
"preview_path": "primer/alpha/hellip_button/default",
|
|
@@ -4539,9 +4302,7 @@
|
|
|
4539
4302
|
}
|
|
4540
4303
|
}
|
|
4541
4304
|
],
|
|
4542
|
-
"subcomponents": [
|
|
4543
|
-
|
|
4544
|
-
]
|
|
4305
|
+
"subcomponents": []
|
|
4545
4306
|
},
|
|
4546
4307
|
{
|
|
4547
4308
|
"fully_qualified_name": "Primer::Alpha::HiddenTextExpander",
|
|
@@ -4576,12 +4337,8 @@
|
|
|
4576
4337
|
"description": "{{link_to_system_arguments_docs}}"
|
|
4577
4338
|
}
|
|
4578
4339
|
],
|
|
4579
|
-
"slots": [
|
|
4580
|
-
|
|
4581
|
-
],
|
|
4582
|
-
"methods": [
|
|
4583
|
-
|
|
4584
|
-
],
|
|
4340
|
+
"slots": [],
|
|
4341
|
+
"methods": [],
|
|
4585
4342
|
"previews": [
|
|
4586
4343
|
{
|
|
4587
4344
|
"preview_path": "primer/alpha/hidden_text_expander/playground",
|
|
@@ -4610,9 +4367,7 @@
|
|
|
4610
4367
|
}
|
|
4611
4368
|
}
|
|
4612
4369
|
],
|
|
4613
|
-
"subcomponents": [
|
|
4614
|
-
|
|
4615
|
-
]
|
|
4370
|
+
"subcomponents": []
|
|
4616
4371
|
},
|
|
4617
4372
|
{
|
|
4618
4373
|
"fully_qualified_name": "Primer::Alpha::Image",
|
|
@@ -4653,18 +4408,81 @@
|
|
|
4653
4408
|
"description": "{{link_to_system_arguments_docs}}"
|
|
4654
4409
|
}
|
|
4655
4410
|
],
|
|
4656
|
-
"slots": [
|
|
4657
|
-
|
|
4658
|
-
],
|
|
4659
|
-
"
|
|
4660
|
-
|
|
4411
|
+
"slots": [],
|
|
4412
|
+
"methods": [],
|
|
4413
|
+
"previews": [],
|
|
4414
|
+
"subcomponents": []
|
|
4415
|
+
},
|
|
4416
|
+
{
|
|
4417
|
+
"fully_qualified_name": "Primer::Alpha::IncludeFragment",
|
|
4418
|
+
"description": "Use `IncludeFragment` to load HTML elements from the server.\nAdd additional usage considerations or best practices that may aid the user to use the component correctly.",
|
|
4419
|
+
"accessibility_docs": "Add any accessibility considerations",
|
|
4420
|
+
"is_form_component": false,
|
|
4421
|
+
"is_published": true,
|
|
4422
|
+
"requires_js": false,
|
|
4423
|
+
"component": "IncludeFragment",
|
|
4424
|
+
"status": "alpha",
|
|
4425
|
+
"a11y_reviewed": false,
|
|
4426
|
+
"short_name": "IncludeFragment",
|
|
4427
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/include_fragment.rb",
|
|
4428
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/include_fragment/default/",
|
|
4429
|
+
"parameters": [
|
|
4430
|
+
{
|
|
4431
|
+
"name": "src",
|
|
4432
|
+
"type": "String",
|
|
4433
|
+
"default": "`nil`",
|
|
4434
|
+
"description": "The URL from which to retrieve an HTML element fragment."
|
|
4435
|
+
},
|
|
4436
|
+
{
|
|
4437
|
+
"name": "loading",
|
|
4438
|
+
"type": "Symbol",
|
|
4439
|
+
"default": "`nil`",
|
|
4440
|
+
"description": "One of `:eager` or `:lazy`."
|
|
4441
|
+
},
|
|
4442
|
+
{
|
|
4443
|
+
"name": "accept",
|
|
4444
|
+
"type": "String",
|
|
4445
|
+
"default": "`nil`",
|
|
4446
|
+
"description": "What to send as the Accept header."
|
|
4447
|
+
},
|
|
4448
|
+
{
|
|
4449
|
+
"name": "system_arguments",
|
|
4450
|
+
"type": "Hash",
|
|
4451
|
+
"default": "N/A",
|
|
4452
|
+
"description": "{{link_to_system_arguments_docs}}"
|
|
4453
|
+
}
|
|
4661
4454
|
],
|
|
4455
|
+
"slots": [],
|
|
4456
|
+
"methods": [],
|
|
4662
4457
|
"previews": [
|
|
4663
|
-
|
|
4458
|
+
{
|
|
4459
|
+
"preview_path": "primer/alpha/include_fragment/playground",
|
|
4460
|
+
"name": "playground",
|
|
4461
|
+
"snapshot": "false",
|
|
4462
|
+
"skip_rules": {
|
|
4463
|
+
"wont_fix": [
|
|
4464
|
+
"region"
|
|
4465
|
+
],
|
|
4466
|
+
"will_fix": [
|
|
4467
|
+
"color-contrast"
|
|
4468
|
+
]
|
|
4469
|
+
}
|
|
4470
|
+
},
|
|
4471
|
+
{
|
|
4472
|
+
"preview_path": "primer/alpha/include_fragment/default",
|
|
4473
|
+
"name": "default",
|
|
4474
|
+
"snapshot": "false",
|
|
4475
|
+
"skip_rules": {
|
|
4476
|
+
"wont_fix": [
|
|
4477
|
+
"region"
|
|
4478
|
+
],
|
|
4479
|
+
"will_fix": [
|
|
4480
|
+
"color-contrast"
|
|
4481
|
+
]
|
|
4482
|
+
}
|
|
4483
|
+
}
|
|
4664
4484
|
],
|
|
4665
|
-
"subcomponents": [
|
|
4666
|
-
|
|
4667
|
-
]
|
|
4485
|
+
"subcomponents": []
|
|
4668
4486
|
},
|
|
4669
4487
|
{
|
|
4670
4488
|
"fully_qualified_name": "Primer::Alpha::Layout",
|
|
@@ -4755,9 +4573,7 @@
|
|
|
4755
4573
|
]
|
|
4756
4574
|
}
|
|
4757
4575
|
],
|
|
4758
|
-
"methods": [
|
|
4759
|
-
|
|
4760
|
-
],
|
|
4576
|
+
"methods": [],
|
|
4761
4577
|
"previews": [
|
|
4762
4578
|
{
|
|
4763
4579
|
"preview_path": "primer/alpha/layout/playground",
|
|
@@ -5047,21 +4863,11 @@
|
|
|
5047
4863
|
"short_name": "LayoutSidebar",
|
|
5048
4864
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/sidebar.rb",
|
|
5049
4865
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/sidebar/default/",
|
|
5050
|
-
"parameters": [
|
|
5051
|
-
|
|
5052
|
-
],
|
|
5053
|
-
"
|
|
5054
|
-
|
|
5055
|
-
],
|
|
5056
|
-
"methods": [
|
|
5057
|
-
|
|
5058
|
-
],
|
|
5059
|
-
"previews": [
|
|
5060
|
-
|
|
5061
|
-
],
|
|
5062
|
-
"subcomponents": [
|
|
5063
|
-
|
|
5064
|
-
]
|
|
4866
|
+
"parameters": [],
|
|
4867
|
+
"slots": [],
|
|
4868
|
+
"methods": [],
|
|
4869
|
+
"previews": [],
|
|
4870
|
+
"subcomponents": []
|
|
5065
4871
|
},
|
|
5066
4872
|
{
|
|
5067
4873
|
"fully_qualified_name": "Primer::Alpha::Layout::Main",
|
|
@@ -5090,18 +4896,10 @@
|
|
|
5090
4896
|
"description": "{{link_to_system_arguments_docs}}"
|
|
5091
4897
|
}
|
|
5092
4898
|
],
|
|
5093
|
-
"slots": [
|
|
5094
|
-
|
|
5095
|
-
],
|
|
5096
|
-
"
|
|
5097
|
-
|
|
5098
|
-
],
|
|
5099
|
-
"previews": [
|
|
5100
|
-
|
|
5101
|
-
],
|
|
5102
|
-
"subcomponents": [
|
|
5103
|
-
|
|
5104
|
-
]
|
|
4899
|
+
"slots": [],
|
|
4900
|
+
"methods": [],
|
|
4901
|
+
"previews": [],
|
|
4902
|
+
"subcomponents": []
|
|
5105
4903
|
}
|
|
5106
4904
|
]
|
|
5107
4905
|
},
|
|
@@ -5170,9 +4968,7 @@
|
|
|
5170
4968
|
]
|
|
5171
4969
|
}
|
|
5172
4970
|
],
|
|
5173
|
-
"methods": [
|
|
5174
|
-
|
|
5175
|
-
],
|
|
4971
|
+
"methods": [],
|
|
5176
4972
|
"previews": [
|
|
5177
4973
|
{
|
|
5178
4974
|
"preview_path": "primer/alpha/menu/playground",
|
|
@@ -5201,9 +4997,7 @@
|
|
|
5201
4997
|
}
|
|
5202
4998
|
}
|
|
5203
4999
|
],
|
|
5204
|
-
"subcomponents": [
|
|
5205
|
-
|
|
5206
|
-
]
|
|
5000
|
+
"subcomponents": []
|
|
5207
5001
|
},
|
|
5208
5002
|
{
|
|
5209
5003
|
"fully_qualified_name": "Primer::Alpha::MultiInput",
|
|
@@ -5328,12 +5122,8 @@
|
|
|
5328
5122
|
"description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
|
|
5329
5123
|
}
|
|
5330
5124
|
],
|
|
5331
|
-
"slots": [
|
|
5332
|
-
|
|
5333
|
-
],
|
|
5334
|
-
"methods": [
|
|
5335
|
-
|
|
5336
|
-
],
|
|
5125
|
+
"slots": [],
|
|
5126
|
+
"methods": [],
|
|
5337
5127
|
"previews": [
|
|
5338
5128
|
{
|
|
5339
5129
|
"preview_path": "primer/alpha/multi_input/playground",
|
|
@@ -5401,9 +5191,7 @@
|
|
|
5401
5191
|
}
|
|
5402
5192
|
}
|
|
5403
5193
|
],
|
|
5404
|
-
"subcomponents": [
|
|
5405
|
-
|
|
5406
|
-
]
|
|
5194
|
+
"subcomponents": []
|
|
5407
5195
|
},
|
|
5408
5196
|
{
|
|
5409
5197
|
"fully_qualified_name": "Primer::Alpha::NavList",
|
|
@@ -5436,24 +5224,16 @@
|
|
|
5436
5224
|
{
|
|
5437
5225
|
"name": "heading",
|
|
5438
5226
|
"description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Heading{{/link_to_component}}.",
|
|
5439
|
-
"parameters": [
|
|
5440
|
-
|
|
5441
|
-
]
|
|
5227
|
+
"parameters": []
|
|
5442
5228
|
},
|
|
5443
5229
|
{
|
|
5444
5230
|
"name": "items",
|
|
5445
5231
|
"description": "Items. Items can be individual items, dividers, or groups. See the documentation for `#with_item`, `#with_divider`, and `#with_group` respectively for more information.",
|
|
5446
|
-
"parameters": [
|
|
5447
|
-
|
|
5448
|
-
]
|
|
5232
|
+
"parameters": []
|
|
5449
5233
|
}
|
|
5450
5234
|
],
|
|
5451
|
-
"methods": [
|
|
5452
|
-
|
|
5453
|
-
],
|
|
5454
|
-
"previews": [
|
|
5455
|
-
|
|
5456
|
-
],
|
|
5235
|
+
"methods": [],
|
|
5236
|
+
"previews": [],
|
|
5457
5237
|
"subcomponents": [
|
|
5458
5238
|
{
|
|
5459
5239
|
"fully_qualified_name": "Primer::Alpha::NavList::Item",
|
|
@@ -5534,16 +5314,12 @@
|
|
|
5534
5314
|
{
|
|
5535
5315
|
"name": "leading_visual",
|
|
5536
5316
|
"description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
|
|
5537
|
-
"parameters": [
|
|
5538
|
-
|
|
5539
|
-
]
|
|
5317
|
+
"parameters": []
|
|
5540
5318
|
},
|
|
5541
5319
|
{
|
|
5542
5320
|
"name": "trailing_visual",
|
|
5543
5321
|
"description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
|
|
5544
|
-
"parameters": [
|
|
5545
|
-
|
|
5546
|
-
]
|
|
5322
|
+
"parameters": []
|
|
5547
5323
|
},
|
|
5548
5324
|
{
|
|
5549
5325
|
"name": "trailing_action",
|
|
@@ -5576,15 +5352,9 @@
|
|
|
5576
5352
|
]
|
|
5577
5353
|
}
|
|
5578
5354
|
],
|
|
5579
|
-
"methods": [
|
|
5580
|
-
|
|
5581
|
-
]
|
|
5582
|
-
"previews": [
|
|
5583
|
-
|
|
5584
|
-
],
|
|
5585
|
-
"subcomponents": [
|
|
5586
|
-
|
|
5587
|
-
]
|
|
5355
|
+
"methods": [],
|
|
5356
|
+
"previews": [],
|
|
5357
|
+
"subcomponents": []
|
|
5588
5358
|
},
|
|
5589
5359
|
{
|
|
5590
5360
|
"fully_qualified_name": "Primer::Alpha::NavList::Heading",
|
|
@@ -5625,18 +5395,10 @@
|
|
|
5625
5395
|
"description": "{{link_to_system_arguments_docs}}"
|
|
5626
5396
|
}
|
|
5627
5397
|
],
|
|
5628
|
-
"slots": [
|
|
5629
|
-
|
|
5630
|
-
],
|
|
5631
|
-
"
|
|
5632
|
-
|
|
5633
|
-
],
|
|
5634
|
-
"previews": [
|
|
5635
|
-
|
|
5636
|
-
],
|
|
5637
|
-
"subcomponents": [
|
|
5638
|
-
|
|
5639
|
-
]
|
|
5398
|
+
"slots": [],
|
|
5399
|
+
"methods": [],
|
|
5400
|
+
"previews": [],
|
|
5401
|
+
"subcomponents": []
|
|
5640
5402
|
},
|
|
5641
5403
|
{
|
|
5642
5404
|
"fully_qualified_name": "Primer::Alpha::NavList::Divider",
|
|
@@ -5665,18 +5427,10 @@
|
|
|
5665
5427
|
"description": "{{link_to_system_arguments_docs}}"
|
|
5666
5428
|
}
|
|
5667
5429
|
],
|
|
5668
|
-
"slots": [
|
|
5669
|
-
|
|
5670
|
-
],
|
|
5671
|
-
"
|
|
5672
|
-
|
|
5673
|
-
],
|
|
5674
|
-
"previews": [
|
|
5675
|
-
|
|
5676
|
-
],
|
|
5677
|
-
"subcomponents": [
|
|
5678
|
-
|
|
5679
|
-
]
|
|
5430
|
+
"slots": [],
|
|
5431
|
+
"methods": [],
|
|
5432
|
+
"previews": [],
|
|
5433
|
+
"subcomponents": []
|
|
5680
5434
|
},
|
|
5681
5435
|
{
|
|
5682
5436
|
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
|
@@ -5767,15 +5521,9 @@
|
|
|
5767
5521
|
]
|
|
5768
5522
|
}
|
|
5769
5523
|
],
|
|
5770
|
-
"methods": [
|
|
5771
|
-
|
|
5772
|
-
]
|
|
5773
|
-
"previews": [
|
|
5774
|
-
|
|
5775
|
-
],
|
|
5776
|
-
"subcomponents": [
|
|
5777
|
-
|
|
5778
|
-
]
|
|
5524
|
+
"methods": [],
|
|
5525
|
+
"previews": [],
|
|
5526
|
+
"subcomponents": []
|
|
5779
5527
|
}
|
|
5780
5528
|
]
|
|
5781
5529
|
},
|
|
@@ -5890,20 +5638,12 @@
|
|
|
5890
5638
|
{
|
|
5891
5639
|
"name": "selected",
|
|
5892
5640
|
"description": "Returns the value of attribute selected.",
|
|
5893
|
-
"parameters": [
|
|
5894
|
-
|
|
5895
|
-
],
|
|
5896
|
-
"return_types": [
|
|
5897
|
-
|
|
5898
|
-
]
|
|
5641
|
+
"parameters": [],
|
|
5642
|
+
"return_types": []
|
|
5899
5643
|
}
|
|
5900
5644
|
],
|
|
5901
|
-
"previews": [
|
|
5902
|
-
|
|
5903
|
-
],
|
|
5904
|
-
"subcomponents": [
|
|
5905
|
-
|
|
5906
|
-
]
|
|
5645
|
+
"previews": [],
|
|
5646
|
+
"subcomponents": []
|
|
5907
5647
|
},
|
|
5908
5648
|
{
|
|
5909
5649
|
"fully_qualified_name": "Primer::Alpha::OcticonSymbols",
|
|
@@ -5926,12 +5666,8 @@
|
|
|
5926
5666
|
"description": "List of icons to render, in the format { symbol: :icon_name, size: :small }"
|
|
5927
5667
|
}
|
|
5928
5668
|
],
|
|
5929
|
-
"slots": [
|
|
5930
|
-
|
|
5931
|
-
],
|
|
5932
|
-
"methods": [
|
|
5933
|
-
|
|
5934
|
-
],
|
|
5669
|
+
"slots": [],
|
|
5670
|
+
"methods": [],
|
|
5935
5671
|
"previews": [
|
|
5936
5672
|
{
|
|
5937
5673
|
"preview_path": "primer/alpha/octicon_symbols/playground",
|
|
@@ -5960,9 +5696,7 @@
|
|
|
5960
5696
|
}
|
|
5961
5697
|
}
|
|
5962
5698
|
],
|
|
5963
|
-
"subcomponents": [
|
|
5964
|
-
|
|
5965
|
-
]
|
|
5699
|
+
"subcomponents": []
|
|
5966
5700
|
},
|
|
5967
5701
|
{
|
|
5968
5702
|
"fully_qualified_name": "Primer::Alpha::Overlay",
|
|
@@ -6155,9 +5889,7 @@
|
|
|
6155
5889
|
]
|
|
6156
5890
|
}
|
|
6157
5891
|
],
|
|
6158
|
-
"methods": [
|
|
6159
|
-
|
|
6160
|
-
],
|
|
5892
|
+
"methods": [],
|
|
6161
5893
|
"previews": [
|
|
6162
5894
|
{
|
|
6163
5895
|
"preview_path": "primer/alpha/overlay/playground",
|
|
@@ -6322,15 +6054,9 @@
|
|
|
6322
6054
|
]
|
|
6323
6055
|
}
|
|
6324
6056
|
],
|
|
6325
|
-
"methods": [
|
|
6326
|
-
|
|
6327
|
-
]
|
|
6328
|
-
"previews": [
|
|
6329
|
-
|
|
6330
|
-
],
|
|
6331
|
-
"subcomponents": [
|
|
6332
|
-
|
|
6333
|
-
]
|
|
6057
|
+
"methods": [],
|
|
6058
|
+
"previews": [],
|
|
6059
|
+
"subcomponents": []
|
|
6334
6060
|
},
|
|
6335
6061
|
{
|
|
6336
6062
|
"fully_qualified_name": "Primer::Alpha::Overlay::Footer",
|
|
@@ -6365,18 +6091,10 @@
|
|
|
6365
6091
|
"description": "{{link_to_system_arguments_docs}}"
|
|
6366
6092
|
}
|
|
6367
6093
|
],
|
|
6368
|
-
"slots": [
|
|
6369
|
-
|
|
6370
|
-
],
|
|
6371
|
-
"
|
|
6372
|
-
|
|
6373
|
-
],
|
|
6374
|
-
"previews": [
|
|
6375
|
-
|
|
6376
|
-
],
|
|
6377
|
-
"subcomponents": [
|
|
6378
|
-
|
|
6379
|
-
]
|
|
6094
|
+
"slots": [],
|
|
6095
|
+
"methods": [],
|
|
6096
|
+
"previews": [],
|
|
6097
|
+
"subcomponents": []
|
|
6380
6098
|
},
|
|
6381
6099
|
{
|
|
6382
6100
|
"fully_qualified_name": "Primer::Alpha::Overlay::Body",
|
|
@@ -6399,18 +6117,10 @@
|
|
|
6399
6117
|
"description": "{{link_to_system_arguments_docs}}"
|
|
6400
6118
|
}
|
|
6401
6119
|
],
|
|
6402
|
-
"slots": [
|
|
6403
|
-
|
|
6404
|
-
],
|
|
6405
|
-
"
|
|
6406
|
-
|
|
6407
|
-
],
|
|
6408
|
-
"previews": [
|
|
6409
|
-
|
|
6410
|
-
],
|
|
6411
|
-
"subcomponents": [
|
|
6412
|
-
|
|
6413
|
-
]
|
|
6120
|
+
"slots": [],
|
|
6121
|
+
"methods": [],
|
|
6122
|
+
"previews": [],
|
|
6123
|
+
"subcomponents": []
|
|
6414
6124
|
}
|
|
6415
6125
|
]
|
|
6416
6126
|
},
|
|
@@ -6537,12 +6247,8 @@
|
|
|
6537
6247
|
"description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
|
|
6538
6248
|
}
|
|
6539
6249
|
],
|
|
6540
|
-
"slots": [
|
|
6541
|
-
|
|
6542
|
-
],
|
|
6543
|
-
"methods": [
|
|
6544
|
-
|
|
6545
|
-
],
|
|
6250
|
+
"slots": [],
|
|
6251
|
+
"methods": [],
|
|
6546
6252
|
"previews": [
|
|
6547
6253
|
{
|
|
6548
6254
|
"preview_path": "primer/alpha/radio_button/playground",
|
|
@@ -6623,9 +6329,7 @@
|
|
|
6623
6329
|
}
|
|
6624
6330
|
}
|
|
6625
6331
|
],
|
|
6626
|
-
"subcomponents": [
|
|
6627
|
-
|
|
6628
|
-
]
|
|
6332
|
+
"subcomponents": []
|
|
6629
6333
|
},
|
|
6630
6334
|
{
|
|
6631
6335
|
"fully_qualified_name": "Primer::Alpha::RadioButtonGroup",
|
|
@@ -6684,9 +6388,7 @@
|
|
|
6684
6388
|
"description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
|
|
6685
6389
|
}
|
|
6686
6390
|
],
|
|
6687
|
-
"slots": [
|
|
6688
|
-
|
|
6689
|
-
],
|
|
6391
|
+
"slots": [],
|
|
6690
6392
|
"methods": [
|
|
6691
6393
|
{
|
|
6692
6394
|
"name": "radio_button",
|
|
@@ -6705,9 +6407,7 @@
|
|
|
6705
6407
|
"description": "The block accepted by {{#link_to_component}}Primer::Alpha::RadioButton{{/link_to_component}}."
|
|
6706
6408
|
}
|
|
6707
6409
|
],
|
|
6708
|
-
"return_types": [
|
|
6709
|
-
|
|
6710
|
-
]
|
|
6410
|
+
"return_types": []
|
|
6711
6411
|
}
|
|
6712
6412
|
],
|
|
6713
6413
|
"previews": [
|
|
@@ -6803,9 +6503,7 @@
|
|
|
6803
6503
|
}
|
|
6804
6504
|
}
|
|
6805
6505
|
],
|
|
6806
|
-
"subcomponents": [
|
|
6807
|
-
|
|
6808
|
-
]
|
|
6506
|
+
"subcomponents": []
|
|
6809
6507
|
},
|
|
6810
6508
|
{
|
|
6811
6509
|
"fully_qualified_name": "Primer::Alpha::SegmentedControl",
|
|
@@ -6860,9 +6558,7 @@
|
|
|
6860
6558
|
]
|
|
6861
6559
|
}
|
|
6862
6560
|
],
|
|
6863
|
-
"methods": [
|
|
6864
|
-
|
|
6865
|
-
],
|
|
6561
|
+
"methods": [],
|
|
6866
6562
|
"previews": [
|
|
6867
6563
|
{
|
|
6868
6564
|
"preview_path": "primer/alpha/segmented_control/playground",
|
|
@@ -7126,17 +6822,11 @@
|
|
|
7126
6822
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}}'s `with_trailing_visual_label` slot."
|
|
7127
6823
|
}
|
|
7128
6824
|
],
|
|
7129
|
-
"return_types": [
|
|
7130
|
-
|
|
7131
|
-
]
|
|
6825
|
+
"return_types": []
|
|
7132
6826
|
}
|
|
7133
6827
|
],
|
|
7134
|
-
"previews": [
|
|
7135
|
-
|
|
7136
|
-
],
|
|
7137
|
-
"subcomponents": [
|
|
7138
|
-
|
|
7139
|
-
]
|
|
6828
|
+
"previews": [],
|
|
6829
|
+
"subcomponents": []
|
|
7140
6830
|
}
|
|
7141
6831
|
]
|
|
7142
6832
|
},
|
|
@@ -7287,9 +6977,7 @@
|
|
|
7287
6977
|
"description": "Create a prompt option with blank value and the text asking user to select something."
|
|
7288
6978
|
}
|
|
7289
6979
|
],
|
|
7290
|
-
"slots": [
|
|
7291
|
-
|
|
7292
|
-
],
|
|
6980
|
+
"slots": [],
|
|
7293
6981
|
"methods": [
|
|
7294
6982
|
{
|
|
7295
6983
|
"name": "option",
|
|
@@ -7308,9 +6996,7 @@
|
|
|
7308
6996
|
"description": "The value sent to the server on form submission."
|
|
7309
6997
|
}
|
|
7310
6998
|
],
|
|
7311
|
-
"return_types": [
|
|
7312
|
-
|
|
7313
|
-
]
|
|
6999
|
+
"return_types": []
|
|
7314
7000
|
}
|
|
7315
7001
|
],
|
|
7316
7002
|
"previews": [
|
|
@@ -7432,13 +7118,11 @@
|
|
|
7432
7118
|
}
|
|
7433
7119
|
}
|
|
7434
7120
|
],
|
|
7435
|
-
"subcomponents": [
|
|
7436
|
-
|
|
7437
|
-
]
|
|
7121
|
+
"subcomponents": []
|
|
7438
7122
|
},
|
|
7439
7123
|
{
|
|
7440
7124
|
"fully_qualified_name": "Primer::Alpha::SelectPanel",
|
|
7441
|
-
"description": "Select panels allow for selecting from a large number of options and can be thought of as a more capable\nversion of the traditional HTML `<select>` element.\n\nSelect panels:\n\n1. feature an input field at the top that allows an end user to filter the list of results.\n1. can render their items statically or dynamically by fetching results from the server.\n1. allow selecting a single item or multiple items.\n1. permit leading visuals like Octicons, avatars, and custom SVGs.\n1. can be used as form inputs in Rails forms.\n\n## Static list items\n\nThe Rails `SelectPanel` component allows items to be provided statically or loaded dynamically from the\nserver. Providing items statically is done using a fetch strategy of `:local` in combination with the\n`item` slot:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new(fetch_strategy: :local))) do |panel| %>\n <% panel.with_show_button { \"Select item\" } %>\n <% panel.with_item(label: \"Item 1\") %>\n <% panel.with_item(label: \"Item 2\") %>\n<% end %>\n```\n\n## Dynamic list items\n\nList items can also be fetched dynamically from the server and will require creating a Rails controller action\nto respond with the list of items in addition to rendering the `SelectPanel` instance. Render the instance as\nnormal, providing your desired [fetch strategy](#fetch-strategies):\n\n```erb\n<%= render(\n Primer::Alpha::SelectPanel.new(\n fetch_strategy: :remote,\n src: search_items_path # perhaps a Rails URL helper\n )\n) %>\n```\n\nDefine a controller action to serve the list of items. The `SelectPanel` component passes any filter text in\nthe `q=` URL parameter.\n\n```ruby\nclass SearchItemsController < ApplicationController\n def show\n # NOTE: params[:q] may be nil since there is no filter string available\n # when the panel is first opened\n @results = SomeModel.search(params[:q] || \"\")\n end\nend\n```\n\nResponses must be HTML fragments, eg. have a content type of `text/html+fragment`. This content type isn't\navailable by default in Rails, so you may have to register it eg. in an initializer:\n\n```ruby\nMime::Type.register(\"text/fragment+html\", :html_fragment)\n```\n\nRender a `Primer::Alpha::SelectPanel::ItemList` in the action's template, search_items/show.html_fragment.erb:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n <% @results.each do |result| %>\n <% list.with_item(label: result.title) do |item| %>\n <% item.with_description(result.description) %>\n <% end %>\n <% end %>\n<% end %>\n```\n\n### Selection consistency\n\nThe `SelectPanel` component automatically \"remembers\" which items have been selected across item fetch requests,\nmeaning the controller that renders dynamic list items does not (and should not) remember these selections or\npersist them until the user has confirmed them, either by submitting the form or otherwise indicating completion.\nThe `SelectPanel` component does not include unconfirmed selection data in requests.\n\n## Fetch strategies\n\nThe list of items can be fetched from a remote URL, or provided as a static list, configured using the\n`fetch_strategy` attribute. Fetch strategies are summarized below.\n\n1. `:remote`: a query is made to the URL in the `src` attribute every time the input field changes.\n\n2. `:eventually_local`: a query is made to the URL in the `src` attribute when the panel is first opened. The\n results are \"remembered\" and filtered in-memory for all subsequent filter operations, i.e. when the input\n field changes.\n\n3. `:local`: the list of items is provided statically ahead of time and filtered in-memory. No requests are made\n to the server.\n\n## Customizing filter behavior\n\nIf the fetch strategy is `:remote`, then filtering is handled server-side. The server should render a\n`Primer::Alpha::SelectPanel::ItemList` (an alias of {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}})\nin the response containing the filtered list of items. The component achieves remote fetching via the\n[remote-input-element](https://github.com/github/remote-input-element), which sends a request to the\nserver with the filter string in the `q=` parameter. Responses must be HTML fragments, eg. have a content\ntype of `text/html+fragment`.\n\n### Local filtering\n\nIf the fetch strategy is `:local` or `:eventually_local`, filtering is performed client-side. Filter behavior can\nbe customized in JavaScript by setting the `filterFn` attribute on the instance of `SelectPanelElement`, eg:\n\n```javascript\ndocument.querySelector(\"select-panel\").filterFn = (item: HTMLElement, query: string): boolean => {\n // return true if the item should be displayed, false otherwise\n}\n```\n\nThe element's default filter function uses the value of the `data-filter-string` attribute, falling back to the\nelement's `innerText` property. It performs a case-insensitive substring match against the filter string.\n\n### `SelectPanel`s as form inputs\n\n`SelectPanel`s can be used as form inputs. They behave very similarly to how HTML `<select>` boxes behave, and\nplay nicely with Rails' built-in form mechanisms. Pass arguments via the `form_arguments:` argument, including\nthe Rails form builder object and the name of the field. Each list item must also have a value specified in\n`content_arguments: { data: { value: } }`.\n\n```erb\n<% form_with(model: Address.new) do |f| %>\n <%= render(Primer::Alpha::SelectPanel.new(form_arguments: { builder: f, name: \"country\" })) do |menu| %>\n <% countries.each do |country|\n <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>\n <% end %>\n <% end %>\n<% end %>\n```\n\nThe value of the `data: { value: ... }` argument is sent to the server on submit, keyed using the name provided above\n(eg. `\"country\"`). If no value is provided for an item, the value of that item is the item's label. Here's the\ncorresponding `AddressesController` that might be written to handle the form above:\n\n```ruby\nclass AddressesController < ApplicationController\n def create\n puts \"You chose #{address_params[:country]} as your country\"\n end\n\n private\n\n def address_params\n params.require(:address).permit(:country)\n end\nend\n```\n\nIf items are provided dynamically, things become a bit more complicated. The `form_for` or `form_with` method call\nhappens in the view that renders the `SelectPanel`, which means the form builder object but isn't available in the\nview that renders the list items. In such a case, it can be useful to create an instance of the form builder maually:\n\n```erb\n<% builder = ActionView::Helpers::FormBuilder.new(\n \"address\", # the name of the model, used to wrap input names, eg 'address[country]'\n nil, # object (eg. the Address instance, which we can omit)\n self, # template\n {} # options\n) %>\n<%= render(Primer::Alpha::SelectPanel::ItemList.new(\n form_arguments: { builder: builder, name: \"country\" }\n)) do |list| %>\n <% countries.each do |country| %>\n <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>\n <% end %>\n<% end %>\n```\n\n### JavaScript API\n\n`SelectPanel`s render a `<select-panel>` custom element that exposes behavior to the client.\n\n#### Utility methods\n\n* `show()`: Manually open the panel. Under normal circumstances, a show button is used to show the panel, but this method exists to support unusual use-cases.\n* `hide()`: Manually hides (closes) the panel.\n\n#### Query methods\n\n* `getItemById(itemId: string): Element`: Returns the item's HTML `<li>` element. The return value can be passed as the `item` argument to the other methods listed below.\n* `isItemChecked(item: Element): boolean`: Returns `true` if the item is checked, `false` otherwise.\n* `isItemHidden(item: Element): boolean`: Returns `true` if the item is hidden, `false` otherwise.\n* `isItemDisabled(item: Element): boolean`: Returns `true` if the item is disabled, `false` otherwise.\n\nNOTE: Item IDs are special values provided by the user that are attached to `SelectPanel` list items as the `data-item-id`\nHTML attribute. Item IDs can be provided by passing an `item_id:` attribute when adding items to the panel, eg:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new) do |panel| %>\n <% panel.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\nThe same is true when rendering `ItemList`s:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n <% list.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\n#### State methods\n\n* `enableItem(item: Element)`: Enables the item, i.e. makes it clickable by the mouse and keyboard.\n* `disableItem(item: Element)`: Disables the item, i.e. makes it unclickable by the mouse and keyboard.\n* `checkItem(item: Element)`: Checks the item. Only has an effect in single- and multi-select modes.\n* `uncheckItem(item: Element)`: Unchecks the item. Only has an effect in multi-select mode, since items cannot be unchecked in single-select mode.\n\n#### Events\n\n|Name |Type |Bubbles |Cancelable |\n|:--------------------|:------------------------------------------|:-------|:----------|\n|`itemActivated` |`CustomEvent<ItemActivatedEvent>` |Yes |No |\n|`beforeItemActivated`|`CustomEvent<ItemActivatedEvent>` |Yes |Yes |\n|`dialog:open` |`CustomEvent<{dialog: HTMLDialogElement}>` |No |No |\n|`panelClosed` |`CustomEvent<{panel: SelectPanelElement}>` |Yes |No |\n\n_Item activation_\n\nThe `<select-panel>` element fires an `itemActivated` event whenever an item is activated (eg. clicked) via the mouse or keyboard.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n \"itemActivated\",\n (event: CustomEvent<ItemActivatedEvent>) => {\n event.detail.item // Element: the <li> item that was activated\n event.detail.checked // boolean: whether or not the result of the activation checked the item\n }\n)\n```\n\nThe `beforeItemActivated` event fires before an item is activated. Canceling this event will prevent the item\nfrom being activated.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n \"beforeItemActivated\",\n (event: CustomEvent<ItemActivatedEvent>) => {\n event.detail.item // Element: the <li> item that was activated\n event.detail.checked // boolean: whether or not the result of the activation checked the item\n event.preventDefault() // Cancel the event to prevent activation (eg. checking/unchecking)\n }\n)\n```",
|
|
7125
|
+
"description": "Select panels allow for selecting from a large number of options and can be thought of as a more capable\nversion of the traditional HTML `<select>` element.\n\nSelect panels:\n\n1. feature an input field at the top that allows an end user to filter the list of results.\n1. can render their items statically or dynamically by fetching results from the server.\n1. allow selecting a single item or multiple items.\n1. permit leading visuals like Octicons, avatars, and custom SVGs.\n1. can be used as form inputs in Rails forms.\n\n## Static list items\n\nThe Rails `SelectPanel` component allows items to be provided statically or loaded dynamically from the\nserver. Providing items statically is done using a fetch strategy of `:local` in combination with the\n`item` slot:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new(fetch_strategy: :local))) do |panel| %>\n <% panel.with_show_button { \"Select item\" } %>\n <% panel.with_item(label: \"Item 1\") %>\n <% panel.with_item(label: \"Item 2\") %>\n<% end %>\n```\n\n## Dynamic list items\n\nList items can also be fetched dynamically from the server and will require creating a Rails controller action\nto respond with the list of items in addition to rendering the `SelectPanel` instance. Render the instance as\nnormal, providing your desired [fetch strategy](#fetch-strategies):\n\n```erb\n<%= render(\n Primer::Alpha::SelectPanel.new(\n fetch_strategy: :remote,\n src: search_items_path # perhaps a Rails URL helper\n )\n) %>\n```\n\nDefine a controller action to serve the list of items. The `SelectPanel` component passes any filter text in\nthe `q=` URL parameter.\n\n```ruby\nclass SearchItemsController < ApplicationController\n def show\n # NOTE: params[:q] may be nil since there is no filter string available\n # when the panel is first opened\n @results = SomeModel.search(params[:q] || \"\")\n end\nend\n```\n\nResponses must be HTML fragments, eg. have a content type of `text/html+fragment`. This content type isn't\navailable by default in Rails, so you may have to register it eg. in an initializer:\n\n```ruby\nMime::Type.register(\"text/fragment+html\", :html_fragment)\n```\n\nRender a `Primer::Alpha::SelectPanel::ItemList` in the action's template, search_items/show.html_fragment.erb:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n <% @results.each do |result| %>\n <% list.with_item(label: result.title) do |item| %>\n <% item.with_description(result.description) %>\n <% end %>\n <% end %>\n<% end %>\n```\n\n### Selection consistency\n\nThe `SelectPanel` component automatically \"remembers\" which items have been selected across item fetch requests,\nmeaning the controller that renders dynamic list items does not (and should not) remember these selections or\npersist them until the user has confirmed them, either by submitting the form or otherwise indicating completion.\nThe `SelectPanel` component does not include unconfirmed selection data in requests.\n\n## Fetch strategies\n\nThe list of items can be fetched from a remote URL, or provided as a static list, configured using the\n`fetch_strategy` attribute. Fetch strategies are summarized below.\n\n1. `:remote`: a query is made to the URL in the `src` attribute every time the input field changes.\n\n2. `:eventually_local`: a query is made to the URL in the `src` attribute when the panel is first opened. The\n results are \"remembered\" and filtered in-memory for all subsequent filter operations, i.e. when the input\n field changes.\n\n3. `:local`: the list of items is provided statically ahead of time and filtered in-memory. No requests are made\n to the server.\n\n## Customizing filter behavior\n\nIf the fetch strategy is `:remote`, then filtering is handled server-side. The server should render a\n`Primer::Alpha::SelectPanel::ItemList` (an alias of {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}})\nin the response containing the filtered list of items. The component achieves remote fetching via the\n[remote-input-element](https://github.com/github/remote-input-element), which sends a request to the\nserver with the filter string in the `q=` parameter. Responses must be HTML fragments, eg. have a content\ntype of `text/html+fragment`.\n\n### Local filtering\n\nIf the fetch strategy is `:local` or `:eventually_local`, filtering is performed client-side. Filter behavior can\nbe customized in JavaScript by setting the `filterFn` attribute on the instance of `SelectPanelElement`, eg:\n\n```javascript\ndocument.querySelector(\"select-panel\").filterFn = (item: HTMLElement, query: string): boolean => {\n // return true if the item should be displayed, false otherwise\n}\n```\n\nThe element's default filter function uses the value of the `data-filter-string` attribute, falling back to the\nelement's `innerText` property. It performs a case-insensitive substring match against the filter string.\n\n### `SelectPanel`s as form inputs\n\n`SelectPanel`s can be used as form inputs. They behave very similarly to how HTML `<select>` boxes behave, and\nplay nicely with Rails' built-in form mechanisms. Pass arguments via the `form_arguments:` argument, including\nthe Rails form builder object and the name of the field. Each list item must also have a value specified in\n`content_arguments: { data: { value: } }`.\n\n```erb\n<% form_with(model: Address.new) do |f| %>\n <%= render(Primer::Alpha::SelectPanel.new(form_arguments: { builder: f, name: \"country\" })) do |menu| %>\n <% countries.each do |country|\n <% menu.with_item(label: country.name, content_arguments: { data: { value: country.code } }) %>\n <% end %>\n <% end %>\n<% end %>\n```\n\nThe value of the `data: { value: ... }` argument is sent to the server on submit, keyed using the name provided above\n(eg. `\"country\"`). If no value is provided for an item, the value of that item is the item's label. Here's the\ncorresponding `AddressesController` that might be written to handle the form above:\n\n```ruby\nclass AddressesController < ApplicationController\n def create\n puts \"You chose #{address_params[:country]} as your country\"\n end\n\n private\n\n def address_params\n params.require(:address).permit(:country)\n end\nend\n```\n### JavaScript API\n\n`SelectPanel`s render a `<select-panel>` custom element that exposes behavior to the client.\n\n#### Utility methods\n\n* `show()`: Manually open the panel. Under normal circumstances, a show button is used to show the panel, but this method exists to support unusual use-cases.\n* `hide()`: Manually hides (closes) the panel.\n\n#### Query methods\n\n* `getItemById(itemId: string): Element`: Returns the item's HTML `<li>` element. The return value can be passed as the `item` argument to the other methods listed below.\n* `isItemChecked(item: Element): boolean`: Returns `true` if the item is checked, `false` otherwise.\n* `isItemHidden(item: Element): boolean`: Returns `true` if the item is hidden, `false` otherwise.\n* `isItemDisabled(item: Element): boolean`: Returns `true` if the item is disabled, `false` otherwise.\n\nNOTE: Item IDs are special values provided by the user that are attached to `SelectPanel` list items as the `data-item-id`\nHTML attribute. Item IDs can be provided by passing an `item_id:` attribute when adding items to the panel, eg:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel.new) do |panel| %>\n <% panel.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\nThe same is true when rendering `ItemList`s:\n\n```erb\n<%= render(Primer::Alpha::SelectPanel::ItemList.new) do |list| %>\n <% list.with_item(item_id: \"my-id\") %>\n<% end %>\n```\n\n#### State methods\n\n* `enableItem(item: Element)`: Enables the item, i.e. makes it clickable by the mouse and keyboard.\n* `disableItem(item: Element)`: Disables the item, i.e. makes it unclickable by the mouse and keyboard.\n* `checkItem(item: Element)`: Checks the item. Only has an effect in single- and multi-select modes.\n* `uncheckItem(item: Element)`: Unchecks the item. Only has an effect in multi-select mode, since items cannot be unchecked in single-select mode.\n\n#### Events\n\n|Name |Type |Bubbles |Cancelable |\n|:--------------------|:------------------------------------------|:-------|:----------|\n|`itemActivated` |`CustomEvent<ItemActivatedEvent>` |Yes |No |\n|`beforeItemActivated`|`CustomEvent<ItemActivatedEvent>` |Yes |Yes |\n|`dialog:open` |`CustomEvent<{dialog: HTMLDialogElement}>` |No |No |\n|`panelClosed` |`CustomEvent<{panel: SelectPanelElement}>` |Yes |No |\n\n_Item activation_\n\nThe `<select-panel>` element fires an `itemActivated` event whenever an item is activated (eg. clicked) via the mouse or keyboard.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n \"itemActivated\",\n (event: CustomEvent<ItemActivatedEvent>) => {\n event.detail.item // Element: the <li> item that was activated\n event.detail.checked // boolean: whether or not the result of the activation checked the item\n }\n)\n```\n\nThe `beforeItemActivated` event fires before an item is activated. Canceling this event will prevent the item\nfrom being activated.\n\n```typescript\ndocument.querySelector(\"select-panel\").addEventListener(\n \"beforeItemActivated\",\n (event: CustomEvent<ItemActivatedEvent>) => {\n event.detail.item // Element: the <li> item that was activated\n event.detail.checked // boolean: whether or not the result of the activation checked the item\n event.preventDefault() // Cancel the event to prevent activation (eg. checking/unchecking)\n }\n)\n```",
|
|
7442
7126
|
"accessibility_docs": null,
|
|
7443
7127
|
"is_form_component": false,
|
|
7444
7128
|
"is_published": true,
|
|
@@ -7532,7 +7216,13 @@
|
|
|
7532
7216
|
"name": "form_arguments",
|
|
7533
7217
|
"type": "Hash",
|
|
7534
7218
|
"default": "`{}`",
|
|
7535
|
-
"description": "Form arguments
|
|
7219
|
+
"description": "Form arguments. Supported for `local`, and experimentally supported for `remote` and `eventually_local` strategies by enabling the `use_experimental_non_local_form` flag."
|
|
7220
|
+
},
|
|
7221
|
+
{
|
|
7222
|
+
"name": "use_experimental_non_local_form",
|
|
7223
|
+
"type": "Boolean",
|
|
7224
|
+
"default": "`false`",
|
|
7225
|
+
"description": "A feature flag used to slowly roll out moving the input field (generated from form arguments) to the top of the SelectPanel HTML thus allowing remote fetching to have default form values. At this time, support is only available for the :single select variant. See: https://github.com/github/primer/issues/4923."
|
|
7536
7226
|
},
|
|
7537
7227
|
{
|
|
7538
7228
|
"name": "show_filter",
|
|
@@ -7623,25 +7313,19 @@
|
|
|
7623
7313
|
{
|
|
7624
7314
|
"name": "preload_error_content",
|
|
7625
7315
|
"description": "Customizable content for the error message that appears when items are fetched for the first time. This message\nappears in place of the list of items.\nFor more information, see the [documentation regarding SelectPanel error messaging](/components/selectpanel#errorwarning).",
|
|
7626
|
-
"parameters": [
|
|
7627
|
-
|
|
7628
|
-
]
|
|
7316
|
+
"parameters": []
|
|
7629
7317
|
},
|
|
7630
7318
|
{
|
|
7631
7319
|
"name": "error_content",
|
|
7632
7320
|
"description": "Customizable content for the error message that appears when items are fetched as the result of a filter\noperation. This message appears as a banner above the previously fetched list of items.\nFor more information, see the [documentation regarding SelectPanel error messaging](/components/selectpanel#errorwarning).",
|
|
7633
|
-
"parameters": [
|
|
7634
|
-
|
|
7635
|
-
]
|
|
7321
|
+
"parameters": []
|
|
7636
7322
|
}
|
|
7637
7323
|
],
|
|
7638
7324
|
"methods": [
|
|
7639
7325
|
{
|
|
7640
7326
|
"name": "src",
|
|
7641
7327
|
"description": "The URL to fetch search results from.",
|
|
7642
|
-
"parameters": [
|
|
7643
|
-
|
|
7644
|
-
],
|
|
7328
|
+
"parameters": [],
|
|
7645
7329
|
"return_types": [
|
|
7646
7330
|
"String"
|
|
7647
7331
|
]
|
|
@@ -7649,9 +7333,7 @@
|
|
|
7649
7333
|
{
|
|
7650
7334
|
"name": "panel_id",
|
|
7651
7335
|
"description": "The unique ID of the panel.",
|
|
7652
|
-
"parameters": [
|
|
7653
|
-
|
|
7654
|
-
],
|
|
7336
|
+
"parameters": [],
|
|
7655
7337
|
"return_types": [
|
|
7656
7338
|
"String"
|
|
7657
7339
|
]
|
|
@@ -7659,9 +7341,7 @@
|
|
|
7659
7341
|
{
|
|
7660
7342
|
"name": "body_id",
|
|
7661
7343
|
"description": "The unique ID of the panel body.",
|
|
7662
|
-
"parameters": [
|
|
7663
|
-
|
|
7664
|
-
],
|
|
7344
|
+
"parameters": [],
|
|
7665
7345
|
"return_types": [
|
|
7666
7346
|
"String"
|
|
7667
7347
|
]
|
|
@@ -7669,9 +7349,7 @@
|
|
|
7669
7349
|
{
|
|
7670
7350
|
"name": "select_variant",
|
|
7671
7351
|
"description": "One of `:multiple`, `:none`, or `:single`.",
|
|
7672
|
-
"parameters": [
|
|
7673
|
-
|
|
7674
|
-
],
|
|
7352
|
+
"parameters": [],
|
|
7675
7353
|
"return_types": [
|
|
7676
7354
|
"Symbol"
|
|
7677
7355
|
]
|
|
@@ -7679,9 +7357,7 @@
|
|
|
7679
7357
|
{
|
|
7680
7358
|
"name": "banner_scheme",
|
|
7681
7359
|
"description": "One of `:danger` or `:warning`.",
|
|
7682
|
-
"parameters": [
|
|
7683
|
-
|
|
7684
|
-
],
|
|
7360
|
+
"parameters": [],
|
|
7685
7361
|
"return_types": [
|
|
7686
7362
|
"Symbol"
|
|
7687
7363
|
]
|
|
@@ -7689,9 +7365,7 @@
|
|
|
7689
7365
|
{
|
|
7690
7366
|
"name": "fetch_strategy",
|
|
7691
7367
|
"description": "One of `:eventually_local`, `:local`, or `:remote`.",
|
|
7692
|
-
"parameters": [
|
|
7693
|
-
|
|
7694
|
-
],
|
|
7368
|
+
"parameters": [],
|
|
7695
7369
|
"return_types": [
|
|
7696
7370
|
"Symbol"
|
|
7697
7371
|
]
|
|
@@ -7699,9 +7373,7 @@
|
|
|
7699
7373
|
{
|
|
7700
7374
|
"name": "preload",
|
|
7701
7375
|
"description": "Whether to preload search results when the page loads. If this option is false, results are loaded when the panel is opened.",
|
|
7702
|
-
"parameters": [
|
|
7703
|
-
|
|
7704
|
-
],
|
|
7376
|
+
"parameters": [],
|
|
7705
7377
|
"return_types": [
|
|
7706
7378
|
"Boolean"
|
|
7707
7379
|
]
|
|
@@ -7709,9 +7381,7 @@
|
|
|
7709
7381
|
{
|
|
7710
7382
|
"name": "preload?",
|
|
7711
7383
|
"description": "Whether to preload search results when the page loads. If this option is false, results are loaded when the panel is opened.",
|
|
7712
|
-
"parameters": [
|
|
7713
|
-
|
|
7714
|
-
],
|
|
7384
|
+
"parameters": [],
|
|
7715
7385
|
"return_types": [
|
|
7716
7386
|
"Boolean"
|
|
7717
7387
|
]
|
|
@@ -7719,9 +7389,7 @@
|
|
|
7719
7389
|
{
|
|
7720
7390
|
"name": "show_filter",
|
|
7721
7391
|
"description": "Whether or not to show the filter input.",
|
|
7722
|
-
"parameters": [
|
|
7723
|
-
|
|
7724
|
-
],
|
|
7392
|
+
"parameters": [],
|
|
7725
7393
|
"return_types": [
|
|
7726
7394
|
"Boolean"
|
|
7727
7395
|
]
|
|
@@ -7729,9 +7397,7 @@
|
|
|
7729
7397
|
{
|
|
7730
7398
|
"name": "show_filter?",
|
|
7731
7399
|
"description": "Whether or not to show the filter input.",
|
|
7732
|
-
"parameters": [
|
|
7733
|
-
|
|
7734
|
-
],
|
|
7400
|
+
"parameters": [],
|
|
7735
7401
|
"return_types": [
|
|
7736
7402
|
"Boolean"
|
|
7737
7403
|
]
|
|
@@ -7747,9 +7413,7 @@
|
|
|
7747
7413
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}}'s `item` slot."
|
|
7748
7414
|
}
|
|
7749
7415
|
],
|
|
7750
|
-
"return_types": [
|
|
7751
|
-
|
|
7752
|
-
]
|
|
7416
|
+
"return_types": []
|
|
7753
7417
|
}
|
|
7754
7418
|
],
|
|
7755
7419
|
"previews": [
|
|
@@ -8052,6 +7716,19 @@
|
|
|
8052
7716
|
]
|
|
8053
7717
|
}
|
|
8054
7718
|
},
|
|
7719
|
+
{
|
|
7720
|
+
"preview_path": "primer/alpha/select_panel/remote_fetch_form",
|
|
7721
|
+
"name": "remote_fetch_form",
|
|
7722
|
+
"snapshot": "interactive",
|
|
7723
|
+
"skip_rules": {
|
|
7724
|
+
"wont_fix": [
|
|
7725
|
+
"region"
|
|
7726
|
+
],
|
|
7727
|
+
"will_fix": [
|
|
7728
|
+
"color-contrast"
|
|
7729
|
+
]
|
|
7730
|
+
}
|
|
7731
|
+
},
|
|
8055
7732
|
{
|
|
8056
7733
|
"preview_path": "primer/alpha/select_panel/multiselect_form",
|
|
8057
7734
|
"name": "multiselect_form",
|
|
@@ -8149,20 +7826,12 @@
|
|
|
8149
7826
|
{
|
|
8150
7827
|
"name": "items",
|
|
8151
7828
|
"description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.",
|
|
8152
|
-
"parameters": [
|
|
8153
|
-
|
|
8154
|
-
]
|
|
7829
|
+
"parameters": []
|
|
8155
7830
|
}
|
|
8156
7831
|
],
|
|
8157
|
-
"methods": [
|
|
8158
|
-
|
|
8159
|
-
]
|
|
8160
|
-
"previews": [
|
|
8161
|
-
|
|
8162
|
-
],
|
|
8163
|
-
"subcomponents": [
|
|
8164
|
-
|
|
8165
|
-
]
|
|
7832
|
+
"methods": [],
|
|
7833
|
+
"previews": [],
|
|
7834
|
+
"subcomponents": []
|
|
8166
7835
|
}
|
|
8167
7836
|
]
|
|
8168
7837
|
},
|
|
@@ -8229,12 +7898,8 @@
|
|
|
8229
7898
|
"description": "{{link_to_system_arguments_docs}}"
|
|
8230
7899
|
}
|
|
8231
7900
|
],
|
|
8232
|
-
"slots": [
|
|
8233
|
-
|
|
8234
|
-
],
|
|
8235
|
-
"methods": [
|
|
8236
|
-
|
|
8237
|
-
],
|
|
7901
|
+
"slots": [],
|
|
7902
|
+
"methods": [],
|
|
8238
7903
|
"previews": [
|
|
8239
7904
|
{
|
|
8240
7905
|
"preview_path": "primer/alpha/stack/default",
|
|
@@ -8263,9 +7928,7 @@
|
|
|
8263
7928
|
}
|
|
8264
7929
|
}
|
|
8265
7930
|
],
|
|
8266
|
-
"subcomponents": [
|
|
8267
|
-
|
|
8268
|
-
]
|
|
7931
|
+
"subcomponents": []
|
|
8269
7932
|
},
|
|
8270
7933
|
{
|
|
8271
7934
|
"fully_qualified_name": "Primer::Alpha::StackItem",
|
|
@@ -8300,12 +7963,8 @@
|
|
|
8300
7963
|
"description": "{{link_to_system_arguments_docs}}"
|
|
8301
7964
|
}
|
|
8302
7965
|
],
|
|
8303
|
-
"slots": [
|
|
8304
|
-
|
|
8305
|
-
],
|
|
8306
|
-
"methods": [
|
|
8307
|
-
|
|
8308
|
-
],
|
|
7966
|
+
"slots": [],
|
|
7967
|
+
"methods": [],
|
|
8309
7968
|
"previews": [
|
|
8310
7969
|
{
|
|
8311
7970
|
"preview_path": "primer/alpha/stack_item/default",
|
|
@@ -8334,9 +7993,7 @@
|
|
|
8334
7993
|
}
|
|
8335
7994
|
}
|
|
8336
7995
|
],
|
|
8337
|
-
"subcomponents": [
|
|
8338
|
-
|
|
8339
|
-
]
|
|
7996
|
+
"subcomponents": []
|
|
8340
7997
|
},
|
|
8341
7998
|
{
|
|
8342
7999
|
"fully_qualified_name": "Primer::Alpha::SubmitButton",
|
|
@@ -8401,18 +8058,10 @@
|
|
|
8401
8058
|
"description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
|
|
8402
8059
|
}
|
|
8403
8060
|
],
|
|
8404
|
-
"slots": [
|
|
8405
|
-
|
|
8406
|
-
],
|
|
8407
|
-
"
|
|
8408
|
-
|
|
8409
|
-
],
|
|
8410
|
-
"previews": [
|
|
8411
|
-
|
|
8412
|
-
],
|
|
8413
|
-
"subcomponents": [
|
|
8414
|
-
|
|
8415
|
-
]
|
|
8061
|
+
"slots": [],
|
|
8062
|
+
"methods": [],
|
|
8063
|
+
"previews": [],
|
|
8064
|
+
"subcomponents": []
|
|
8416
8065
|
},
|
|
8417
8066
|
{
|
|
8418
8067
|
"fully_qualified_name": "Primer::Alpha::TabContainer",
|
|
@@ -8435,18 +8084,10 @@
|
|
|
8435
8084
|
"description": "{{link_to_system_arguments_docs}}"
|
|
8436
8085
|
}
|
|
8437
8086
|
],
|
|
8438
|
-
"slots": [
|
|
8439
|
-
|
|
8440
|
-
],
|
|
8441
|
-
"
|
|
8442
|
-
|
|
8443
|
-
],
|
|
8444
|
-
"previews": [
|
|
8445
|
-
|
|
8446
|
-
],
|
|
8447
|
-
"subcomponents": [
|
|
8448
|
-
|
|
8449
|
-
]
|
|
8087
|
+
"slots": [],
|
|
8088
|
+
"methods": [],
|
|
8089
|
+
"previews": [],
|
|
8090
|
+
"subcomponents": []
|
|
8450
8091
|
},
|
|
8451
8092
|
{
|
|
8452
8093
|
"fully_qualified_name": "Primer::Alpha::TabNav",
|
|
@@ -8519,9 +8160,7 @@
|
|
|
8519
8160
|
]
|
|
8520
8161
|
}
|
|
8521
8162
|
],
|
|
8522
|
-
"methods": [
|
|
8523
|
-
|
|
8524
|
-
],
|
|
8163
|
+
"methods": [],
|
|
8525
8164
|
"previews": [
|
|
8526
8165
|
{
|
|
8527
8166
|
"preview_path": "primer/alpha/tab_nav/playground",
|
|
@@ -8576,9 +8215,7 @@
|
|
|
8576
8215
|
}
|
|
8577
8216
|
}
|
|
8578
8217
|
],
|
|
8579
|
-
"subcomponents": [
|
|
8580
|
-
|
|
8581
|
-
]
|
|
8218
|
+
"subcomponents": []
|
|
8582
8219
|
},
|
|
8583
8220
|
{
|
|
8584
8221
|
"fully_qualified_name": "Primer::Alpha::TabPanels",
|
|
@@ -8663,9 +8300,7 @@
|
|
|
8663
8300
|
]
|
|
8664
8301
|
}
|
|
8665
8302
|
],
|
|
8666
|
-
"methods": [
|
|
8667
|
-
|
|
8668
|
-
],
|
|
8303
|
+
"methods": [],
|
|
8669
8304
|
"previews": [
|
|
8670
8305
|
{
|
|
8671
8306
|
"preview_path": "primer/alpha/tab_panels/playground",
|
|
@@ -8707,9 +8342,7 @@
|
|
|
8707
8342
|
}
|
|
8708
8343
|
}
|
|
8709
8344
|
],
|
|
8710
|
-
"subcomponents": [
|
|
8711
|
-
|
|
8712
|
-
]
|
|
8345
|
+
"subcomponents": []
|
|
8713
8346
|
},
|
|
8714
8347
|
{
|
|
8715
8348
|
"fully_qualified_name": "Primer::Alpha::TextArea",
|
|
@@ -8840,12 +8473,8 @@
|
|
|
8840
8473
|
"description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
|
|
8841
8474
|
}
|
|
8842
8475
|
],
|
|
8843
|
-
"slots": [
|
|
8844
|
-
|
|
8845
|
-
],
|
|
8846
|
-
"methods": [
|
|
8847
|
-
|
|
8848
|
-
],
|
|
8476
|
+
"slots": [],
|
|
8477
|
+
"methods": [],
|
|
8849
8478
|
"previews": [
|
|
8850
8479
|
{
|
|
8851
8480
|
"preview_path": "primer/alpha/text_area/playground",
|
|
@@ -8965,9 +8594,7 @@
|
|
|
8965
8594
|
}
|
|
8966
8595
|
}
|
|
8967
8596
|
],
|
|
8968
|
-
"subcomponents": [
|
|
8969
|
-
|
|
8970
|
-
]
|
|
8597
|
+
"subcomponents": []
|
|
8971
8598
|
},
|
|
8972
8599
|
{
|
|
8973
8600
|
"fully_qualified_name": "Primer::Alpha::TextField",
|
|
@@ -9152,12 +8779,8 @@
|
|
|
9152
8779
|
"description": "The HTML id attribute of the clear button."
|
|
9153
8780
|
}
|
|
9154
8781
|
],
|
|
9155
|
-
"slots": [
|
|
9156
|
-
|
|
9157
|
-
],
|
|
9158
|
-
"methods": [
|
|
9159
|
-
|
|
9160
|
-
],
|
|
8782
|
+
"slots": [],
|
|
8783
|
+
"methods": [],
|
|
9161
8784
|
"previews": [
|
|
9162
8785
|
{
|
|
9163
8786
|
"preview_path": "primer/alpha/text_field/playground",
|
|
@@ -9537,9 +9160,7 @@
|
|
|
9537
9160
|
}
|
|
9538
9161
|
}
|
|
9539
9162
|
],
|
|
9540
|
-
"subcomponents": [
|
|
9541
|
-
|
|
9542
|
-
]
|
|
9163
|
+
"subcomponents": []
|
|
9543
9164
|
},
|
|
9544
9165
|
{
|
|
9545
9166
|
"fully_qualified_name": "Primer::Alpha::ToggleSwitch",
|
|
@@ -9610,12 +9231,8 @@
|
|
|
9610
9231
|
"description": "{{link_to_system_arguments_docs}}"
|
|
9611
9232
|
}
|
|
9612
9233
|
],
|
|
9613
|
-
"slots": [
|
|
9614
|
-
|
|
9615
|
-
],
|
|
9616
|
-
"methods": [
|
|
9617
|
-
|
|
9618
|
-
],
|
|
9234
|
+
"slots": [],
|
|
9235
|
+
"methods": [],
|
|
9619
9236
|
"previews": [
|
|
9620
9237
|
{
|
|
9621
9238
|
"preview_path": "primer/alpha/toggle_switch/playground",
|
|
@@ -9800,9 +9417,7 @@
|
|
|
9800
9417
|
}
|
|
9801
9418
|
}
|
|
9802
9419
|
],
|
|
9803
|
-
"subcomponents": [
|
|
9804
|
-
|
|
9805
|
-
]
|
|
9420
|
+
"subcomponents": []
|
|
9806
9421
|
},
|
|
9807
9422
|
{
|
|
9808
9423
|
"fully_qualified_name": "Primer::Alpha::Tooltip",
|
|
@@ -9849,19 +9464,13 @@
|
|
|
9849
9464
|
"description": "{{link_to_system_arguments_docs}}"
|
|
9850
9465
|
}
|
|
9851
9466
|
],
|
|
9852
|
-
"slots": [
|
|
9853
|
-
|
|
9854
|
-
],
|
|
9467
|
+
"slots": [],
|
|
9855
9468
|
"methods": [
|
|
9856
9469
|
{
|
|
9857
9470
|
"name": "id",
|
|
9858
9471
|
"description": "Returns the value of attribute id.",
|
|
9859
|
-
"parameters": [
|
|
9860
|
-
|
|
9861
|
-
],
|
|
9862
|
-
"return_types": [
|
|
9863
|
-
|
|
9864
|
-
]
|
|
9472
|
+
"parameters": [],
|
|
9473
|
+
"return_types": []
|
|
9865
9474
|
}
|
|
9866
9475
|
],
|
|
9867
9476
|
"previews": [
|
|
@@ -10100,9 +9709,7 @@
|
|
|
10100
9709
|
}
|
|
10101
9710
|
}
|
|
10102
9711
|
],
|
|
10103
|
-
"subcomponents": [
|
|
10104
|
-
|
|
10105
|
-
]
|
|
9712
|
+
"subcomponents": []
|
|
10106
9713
|
},
|
|
10107
9714
|
{
|
|
10108
9715
|
"fully_qualified_name": "Primer::Alpha::UnderlineNav",
|
|
@@ -10187,9 +9794,7 @@
|
|
|
10187
9794
|
]
|
|
10188
9795
|
}
|
|
10189
9796
|
],
|
|
10190
|
-
"methods": [
|
|
10191
|
-
|
|
10192
|
-
],
|
|
9797
|
+
"methods": [],
|
|
10193
9798
|
"previews": [
|
|
10194
9799
|
{
|
|
10195
9800
|
"preview_path": "primer/alpha/underline_nav/playground",
|
|
@@ -10231,9 +9836,7 @@
|
|
|
10231
9836
|
}
|
|
10232
9837
|
}
|
|
10233
9838
|
],
|
|
10234
|
-
"subcomponents": [
|
|
10235
|
-
|
|
10236
|
-
]
|
|
9839
|
+
"subcomponents": []
|
|
10237
9840
|
},
|
|
10238
9841
|
{
|
|
10239
9842
|
"fully_qualified_name": "Primer::Alpha::UnderlinePanels",
|
|
@@ -10324,9 +9927,7 @@
|
|
|
10324
9927
|
]
|
|
10325
9928
|
}
|
|
10326
9929
|
],
|
|
10327
|
-
"methods": [
|
|
10328
|
-
|
|
10329
|
-
],
|
|
9930
|
+
"methods": [],
|
|
10330
9931
|
"previews": [
|
|
10331
9932
|
{
|
|
10332
9933
|
"preview_path": "primer/alpha/underline_panels/playground",
|
|
@@ -10381,9 +9982,7 @@
|
|
|
10381
9982
|
}
|
|
10382
9983
|
}
|
|
10383
9984
|
],
|
|
10384
|
-
"subcomponents": [
|
|
10385
|
-
|
|
10386
|
-
]
|
|
9985
|
+
"subcomponents": []
|
|
10387
9986
|
},
|
|
10388
9987
|
{
|
|
10389
9988
|
"fully_qualified_name": "Primer::Beta::AutoComplete",
|
|
@@ -10534,9 +10133,7 @@
|
|
|
10534
10133
|
]
|
|
10535
10134
|
}
|
|
10536
10135
|
],
|
|
10537
|
-
"methods": [
|
|
10538
|
-
|
|
10539
|
-
],
|
|
10136
|
+
"methods": [],
|
|
10540
10137
|
"previews": [
|
|
10541
10138
|
{
|
|
10542
10139
|
"preview_path": "primer/beta/auto_complete/playground",
|
|
@@ -10876,15 +10473,9 @@
|
|
|
10876
10473
|
]
|
|
10877
10474
|
}
|
|
10878
10475
|
],
|
|
10879
|
-
"methods": [
|
|
10880
|
-
|
|
10881
|
-
]
|
|
10882
|
-
"previews": [
|
|
10883
|
-
|
|
10884
|
-
],
|
|
10885
|
-
"subcomponents": [
|
|
10886
|
-
|
|
10887
|
-
]
|
|
10476
|
+
"methods": [],
|
|
10477
|
+
"previews": [],
|
|
10478
|
+
"subcomponents": []
|
|
10888
10479
|
},
|
|
10889
10480
|
{
|
|
10890
10481
|
"fully_qualified_name": "Primer::Beta::AutoComplete::NoResultItem",
|
|
@@ -10899,9 +10490,7 @@
|
|
|
10899
10490
|
"short_name": "AutoCompleteNoResultItem",
|
|
10900
10491
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/no_result_item.rb",
|
|
10901
10492
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/no_result_item/default/",
|
|
10902
|
-
"parameters": [
|
|
10903
|
-
|
|
10904
|
-
],
|
|
10493
|
+
"parameters": [],
|
|
10905
10494
|
"slots": [
|
|
10906
10495
|
{
|
|
10907
10496
|
"name": "leading_visual",
|
|
@@ -10940,15 +10529,9 @@
|
|
|
10940
10529
|
]
|
|
10941
10530
|
}
|
|
10942
10531
|
],
|
|
10943
|
-
"methods": [
|
|
10944
|
-
|
|
10945
|
-
]
|
|
10946
|
-
"previews": [
|
|
10947
|
-
|
|
10948
|
-
],
|
|
10949
|
-
"subcomponents": [
|
|
10950
|
-
|
|
10951
|
-
]
|
|
10532
|
+
"methods": [],
|
|
10533
|
+
"previews": [],
|
|
10534
|
+
"subcomponents": []
|
|
10952
10535
|
}
|
|
10953
10536
|
]
|
|
10954
10537
|
},
|
|
@@ -11003,12 +10586,8 @@
|
|
|
11003
10586
|
"description": "{{link_to_system_arguments_docs}}"
|
|
11004
10587
|
}
|
|
11005
10588
|
],
|
|
11006
|
-
"slots": [
|
|
11007
|
-
|
|
11008
|
-
],
|
|
11009
|
-
"methods": [
|
|
11010
|
-
|
|
11011
|
-
],
|
|
10589
|
+
"slots": [],
|
|
10590
|
+
"methods": [],
|
|
11012
10591
|
"previews": [
|
|
11013
10592
|
{
|
|
11014
10593
|
"preview_path": "primer/beta/avatar/playground",
|
|
@@ -11180,9 +10759,7 @@
|
|
|
11180
10759
|
}
|
|
11181
10760
|
}
|
|
11182
10761
|
],
|
|
11183
|
-
"subcomponents": [
|
|
11184
|
-
|
|
11185
|
-
]
|
|
10762
|
+
"subcomponents": []
|
|
11186
10763
|
},
|
|
11187
10764
|
{
|
|
11188
10765
|
"fully_qualified_name": "Primer::Beta::AvatarStack",
|
|
@@ -11243,9 +10820,7 @@
|
|
|
11243
10820
|
]
|
|
11244
10821
|
}
|
|
11245
10822
|
],
|
|
11246
|
-
"methods": [
|
|
11247
|
-
|
|
11248
|
-
],
|
|
10823
|
+
"methods": [],
|
|
11249
10824
|
"previews": [
|
|
11250
10825
|
{
|
|
11251
10826
|
"preview_path": "primer/beta/avatar_stack/playground",
|
|
@@ -11365,9 +10940,7 @@
|
|
|
11365
10940
|
}
|
|
11366
10941
|
}
|
|
11367
10942
|
],
|
|
11368
|
-
"subcomponents": [
|
|
11369
|
-
|
|
11370
|
-
]
|
|
10943
|
+
"subcomponents": []
|
|
11371
10944
|
},
|
|
11372
10945
|
{
|
|
11373
10946
|
"fully_qualified_name": "Primer::Beta::BaseButton",
|
|
@@ -11420,29 +10993,19 @@
|
|
|
11420
10993
|
"description": "{{link_to_system_arguments_docs}}"
|
|
11421
10994
|
}
|
|
11422
10995
|
],
|
|
11423
|
-
"slots": [
|
|
11424
|
-
|
|
11425
|
-
],
|
|
10996
|
+
"slots": [],
|
|
11426
10997
|
"methods": [
|
|
11427
10998
|
{
|
|
11428
10999
|
"name": "disabled",
|
|
11429
11000
|
"description": "Returns the value of attribute disabled.",
|
|
11430
|
-
"parameters": [
|
|
11431
|
-
|
|
11432
|
-
],
|
|
11433
|
-
"return_types": [
|
|
11434
|
-
|
|
11435
|
-
]
|
|
11001
|
+
"parameters": [],
|
|
11002
|
+
"return_types": []
|
|
11436
11003
|
},
|
|
11437
11004
|
{
|
|
11438
11005
|
"name": "disabled?",
|
|
11439
11006
|
"description": "Returns the value of attribute disabled.",
|
|
11440
|
-
"parameters": [
|
|
11441
|
-
|
|
11442
|
-
],
|
|
11443
|
-
"return_types": [
|
|
11444
|
-
|
|
11445
|
-
]
|
|
11007
|
+
"parameters": [],
|
|
11008
|
+
"return_types": []
|
|
11446
11009
|
}
|
|
11447
11010
|
],
|
|
11448
11011
|
"previews": [
|
|
@@ -11486,9 +11049,7 @@
|
|
|
11486
11049
|
}
|
|
11487
11050
|
}
|
|
11488
11051
|
],
|
|
11489
|
-
"subcomponents": [
|
|
11490
|
-
|
|
11491
|
-
]
|
|
11052
|
+
"subcomponents": []
|
|
11492
11053
|
},
|
|
11493
11054
|
{
|
|
11494
11055
|
"fully_qualified_name": "Primer::Beta::Blankslate",
|
|
@@ -11609,9 +11170,7 @@
|
|
|
11609
11170
|
]
|
|
11610
11171
|
}
|
|
11611
11172
|
],
|
|
11612
|
-
"methods": [
|
|
11613
|
-
|
|
11614
|
-
],
|
|
11173
|
+
"methods": [],
|
|
11615
11174
|
"previews": [
|
|
11616
11175
|
{
|
|
11617
11176
|
"preview_path": "primer/beta/blankslate/playground",
|
|
@@ -11783,9 +11342,7 @@
|
|
|
11783
11342
|
}
|
|
11784
11343
|
}
|
|
11785
11344
|
],
|
|
11786
|
-
"subcomponents": [
|
|
11787
|
-
|
|
11788
|
-
]
|
|
11345
|
+
"subcomponents": []
|
|
11789
11346
|
},
|
|
11790
11347
|
{
|
|
11791
11348
|
"fully_qualified_name": "Primer::Beta::BorderBox",
|
|
@@ -11870,9 +11427,7 @@
|
|
|
11870
11427
|
]
|
|
11871
11428
|
}
|
|
11872
11429
|
],
|
|
11873
|
-
"methods": [
|
|
11874
|
-
|
|
11875
|
-
],
|
|
11430
|
+
"methods": [],
|
|
11876
11431
|
"previews": [
|
|
11877
11432
|
{
|
|
11878
11433
|
"preview_path": "primer/beta/border_box/playground",
|
|
@@ -12012,20 +11567,12 @@
|
|
|
12012
11567
|
{
|
|
12013
11568
|
"name": "id",
|
|
12014
11569
|
"description": "Returns the value of attribute id.",
|
|
12015
|
-
"parameters": [
|
|
12016
|
-
|
|
12017
|
-
],
|
|
12018
|
-
"return_types": [
|
|
12019
|
-
|
|
12020
|
-
]
|
|
11570
|
+
"parameters": [],
|
|
11571
|
+
"return_types": []
|
|
12021
11572
|
}
|
|
12022
11573
|
],
|
|
12023
|
-
"previews": [
|
|
12024
|
-
|
|
12025
|
-
],
|
|
12026
|
-
"subcomponents": [
|
|
12027
|
-
|
|
12028
|
-
]
|
|
11574
|
+
"previews": [],
|
|
11575
|
+
"subcomponents": []
|
|
12029
11576
|
}
|
|
12030
11577
|
]
|
|
12031
11578
|
},
|
|
@@ -12070,9 +11617,7 @@
|
|
|
12070
11617
|
]
|
|
12071
11618
|
}
|
|
12072
11619
|
],
|
|
12073
|
-
"methods": [
|
|
12074
|
-
|
|
12075
|
-
],
|
|
11620
|
+
"methods": [],
|
|
12076
11621
|
"previews": [
|
|
12077
11622
|
{
|
|
12078
11623
|
"preview_path": "primer/beta/breadcrumbs/playground",
|
|
@@ -12138,6 +11683,19 @@
|
|
|
12138
11683
|
"color-contrast"
|
|
12139
11684
|
]
|
|
12140
11685
|
}
|
|
11686
|
+
},
|
|
11687
|
+
{
|
|
11688
|
+
"preview_path": "primer/beta/breadcrumbs/with_long_items",
|
|
11689
|
+
"name": "with_long_items",
|
|
11690
|
+
"snapshot": "true",
|
|
11691
|
+
"skip_rules": {
|
|
11692
|
+
"wont_fix": [
|
|
11693
|
+
"region"
|
|
11694
|
+
],
|
|
11695
|
+
"will_fix": [
|
|
11696
|
+
"color-contrast"
|
|
11697
|
+
]
|
|
11698
|
+
}
|
|
12141
11699
|
}
|
|
12142
11700
|
],
|
|
12143
11701
|
"subcomponents": [
|
|
@@ -12154,22 +11712,14 @@
|
|
|
12154
11712
|
"short_name": "BreadcrumbsItem",
|
|
12155
11713
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs/item.rb",
|
|
12156
11714
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/item/default/",
|
|
12157
|
-
"parameters": [
|
|
12158
|
-
|
|
12159
|
-
],
|
|
12160
|
-
"slots": [
|
|
12161
|
-
|
|
12162
|
-
],
|
|
11715
|
+
"parameters": [],
|
|
11716
|
+
"slots": [],
|
|
12163
11717
|
"methods": [
|
|
12164
11718
|
{
|
|
12165
11719
|
"name": "selected",
|
|
12166
11720
|
"description": "Returns the value of attribute selected.",
|
|
12167
|
-
"parameters": [
|
|
12168
|
-
|
|
12169
|
-
],
|
|
12170
|
-
"return_types": [
|
|
12171
|
-
|
|
12172
|
-
]
|
|
11721
|
+
"parameters": [],
|
|
11722
|
+
"return_types": []
|
|
12173
11723
|
},
|
|
12174
11724
|
{
|
|
12175
11725
|
"name": "selected=",
|
|
@@ -12182,19 +11732,13 @@
|
|
|
12182
11732
|
"description": "the value to set the attribute selected to."
|
|
12183
11733
|
}
|
|
12184
11734
|
],
|
|
12185
|
-
"return_types": [
|
|
12186
|
-
|
|
12187
|
-
]
|
|
11735
|
+
"return_types": []
|
|
12188
11736
|
},
|
|
12189
11737
|
{
|
|
12190
11738
|
"name": "href",
|
|
12191
11739
|
"description": "Returns the value of attribute href.",
|
|
12192
|
-
"parameters": [
|
|
12193
|
-
|
|
12194
|
-
],
|
|
12195
|
-
"return_types": [
|
|
12196
|
-
|
|
12197
|
-
]
|
|
11740
|
+
"parameters": [],
|
|
11741
|
+
"return_types": []
|
|
12198
11742
|
},
|
|
12199
11743
|
{
|
|
12200
11744
|
"name": "href=",
|
|
@@ -12207,17 +11751,11 @@
|
|
|
12207
11751
|
"description": "the value to set the attribute href to."
|
|
12208
11752
|
}
|
|
12209
11753
|
],
|
|
12210
|
-
"return_types": [
|
|
12211
|
-
|
|
12212
|
-
]
|
|
11754
|
+
"return_types": []
|
|
12213
11755
|
}
|
|
12214
11756
|
],
|
|
12215
|
-
"previews": [
|
|
12216
|
-
|
|
12217
|
-
],
|
|
12218
|
-
"subcomponents": [
|
|
12219
|
-
|
|
12220
|
-
]
|
|
11757
|
+
"previews": [],
|
|
11758
|
+
"subcomponents": []
|
|
12221
11759
|
}
|
|
12222
11760
|
]
|
|
12223
11761
|
},
|
|
@@ -12358,9 +11896,7 @@
|
|
|
12358
11896
|
]
|
|
12359
11897
|
}
|
|
12360
11898
|
],
|
|
12361
|
-
"methods": [
|
|
12362
|
-
|
|
12363
|
-
],
|
|
11899
|
+
"methods": [],
|
|
12364
11900
|
"previews": [
|
|
12365
11901
|
{
|
|
12366
11902
|
"preview_path": "primer/beta/button/playground",
|
|
@@ -12636,9 +12172,7 @@
|
|
|
12636
12172
|
}
|
|
12637
12173
|
}
|
|
12638
12174
|
],
|
|
12639
|
-
"subcomponents": [
|
|
12640
|
-
|
|
12641
|
-
]
|
|
12175
|
+
"subcomponents": []
|
|
12642
12176
|
},
|
|
12643
12177
|
{
|
|
12644
12178
|
"fully_qualified_name": "Primer::Beta::ButtonGroup",
|
|
@@ -12677,9 +12211,7 @@
|
|
|
12677
12211
|
{
|
|
12678
12212
|
"name": "buttons",
|
|
12679
12213
|
"description": "List of buttons to be rendered. Add buttons via the `#with_button`, `#with_menu_button`, and `#with_clipboard_copy_button` methods (see below).",
|
|
12680
|
-
"parameters": [
|
|
12681
|
-
|
|
12682
|
-
]
|
|
12214
|
+
"parameters": []
|
|
12683
12215
|
}
|
|
12684
12216
|
],
|
|
12685
12217
|
"methods": [
|
|
@@ -12700,9 +12232,7 @@
|
|
|
12700
12232
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} or {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}, depending on the value of the `icon:` argument."
|
|
12701
12233
|
}
|
|
12702
12234
|
],
|
|
12703
|
-
"return_types": [
|
|
12704
|
-
|
|
12705
|
-
]
|
|
12235
|
+
"return_types": []
|
|
12706
12236
|
},
|
|
12707
12237
|
{
|
|
12708
12238
|
"name": "with_menu_button",
|
|
@@ -12715,9 +12245,7 @@
|
|
|
12715
12245
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::ButtonGroup::MenuButton{{/link_to_component}}."
|
|
12716
12246
|
}
|
|
12717
12247
|
],
|
|
12718
|
-
"return_types": [
|
|
12719
|
-
|
|
12720
|
-
]
|
|
12248
|
+
"return_types": []
|
|
12721
12249
|
},
|
|
12722
12250
|
{
|
|
12723
12251
|
"name": "with_clipboard_copy_button",
|
|
@@ -12730,9 +12258,7 @@
|
|
|
12730
12258
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::ClipboardCopyButton{{/link_to_component}}."
|
|
12731
12259
|
}
|
|
12732
12260
|
],
|
|
12733
|
-
"return_types": [
|
|
12734
|
-
|
|
12735
|
-
]
|
|
12261
|
+
"return_types": []
|
|
12736
12262
|
}
|
|
12737
12263
|
],
|
|
12738
12264
|
"previews": [
|
|
@@ -12856,18 +12382,10 @@
|
|
|
12856
12382
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} or {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}, depending on the value of the `icon:` argument."
|
|
12857
12383
|
}
|
|
12858
12384
|
],
|
|
12859
|
-
"slots": [
|
|
12860
|
-
|
|
12861
|
-
],
|
|
12862
|
-
"
|
|
12863
|
-
|
|
12864
|
-
],
|
|
12865
|
-
"previews": [
|
|
12866
|
-
|
|
12867
|
-
],
|
|
12868
|
-
"subcomponents": [
|
|
12869
|
-
|
|
12870
|
-
]
|
|
12385
|
+
"slots": [],
|
|
12386
|
+
"methods": [],
|
|
12387
|
+
"previews": [],
|
|
12388
|
+
"subcomponents": []
|
|
12871
12389
|
}
|
|
12872
12390
|
]
|
|
12873
12391
|
},
|
|
@@ -12910,12 +12428,8 @@
|
|
|
12910
12428
|
"description": "{{link_to_system_arguments_docs}}"
|
|
12911
12429
|
}
|
|
12912
12430
|
],
|
|
12913
|
-
"slots": [
|
|
12914
|
-
|
|
12915
|
-
],
|
|
12916
|
-
"methods": [
|
|
12917
|
-
|
|
12918
|
-
],
|
|
12431
|
+
"slots": [],
|
|
12432
|
+
"methods": [],
|
|
12919
12433
|
"previews": [
|
|
12920
12434
|
{
|
|
12921
12435
|
"preview_path": "primer/beta/clipboard_copy/playground",
|
|
@@ -12970,9 +12484,7 @@
|
|
|
12970
12484
|
}
|
|
12971
12485
|
}
|
|
12972
12486
|
],
|
|
12973
|
-
"subcomponents": [
|
|
12974
|
-
|
|
12975
|
-
]
|
|
12487
|
+
"subcomponents": []
|
|
12976
12488
|
},
|
|
12977
12489
|
{
|
|
12978
12490
|
"fully_qualified_name": "Primer::Beta::ClipboardCopyBaseButton",
|
|
@@ -13025,18 +12537,10 @@
|
|
|
13025
12537
|
"description": "{{link_to_system_arguments_docs}}"
|
|
13026
12538
|
}
|
|
13027
12539
|
],
|
|
13028
|
-
"slots": [
|
|
13029
|
-
|
|
13030
|
-
],
|
|
13031
|
-
"
|
|
13032
|
-
|
|
13033
|
-
],
|
|
13034
|
-
"previews": [
|
|
13035
|
-
|
|
13036
|
-
],
|
|
13037
|
-
"subcomponents": [
|
|
13038
|
-
|
|
13039
|
-
]
|
|
12540
|
+
"slots": [],
|
|
12541
|
+
"methods": [],
|
|
12542
|
+
"previews": [],
|
|
12543
|
+
"subcomponents": []
|
|
13040
12544
|
},
|
|
13041
12545
|
{
|
|
13042
12546
|
"fully_qualified_name": "Primer::Beta::ClipboardCopyButton",
|
|
@@ -13115,9 +12619,7 @@
|
|
|
13115
12619
|
]
|
|
13116
12620
|
}
|
|
13117
12621
|
],
|
|
13118
|
-
"methods": [
|
|
13119
|
-
|
|
13120
|
-
],
|
|
12622
|
+
"methods": [],
|
|
13121
12623
|
"previews": [
|
|
13122
12624
|
{
|
|
13123
12625
|
"preview_path": "primer/beta/clipboard_copy_button/playground",
|
|
@@ -13159,9 +12661,7 @@
|
|
|
13159
12661
|
}
|
|
13160
12662
|
}
|
|
13161
12663
|
],
|
|
13162
|
-
"subcomponents": [
|
|
13163
|
-
|
|
13164
|
-
]
|
|
12664
|
+
"subcomponents": []
|
|
13165
12665
|
},
|
|
13166
12666
|
{
|
|
13167
12667
|
"fully_qualified_name": "Primer::Beta::CloseButton",
|
|
@@ -13196,12 +12696,8 @@
|
|
|
13196
12696
|
"description": "{{link_to_system_arguments_docs}}"
|
|
13197
12697
|
}
|
|
13198
12698
|
],
|
|
13199
|
-
"slots": [
|
|
13200
|
-
|
|
13201
|
-
],
|
|
13202
|
-
"methods": [
|
|
13203
|
-
|
|
13204
|
-
],
|
|
12699
|
+
"slots": [],
|
|
12700
|
+
"methods": [],
|
|
13205
12701
|
"previews": [
|
|
13206
12702
|
{
|
|
13207
12703
|
"preview_path": "primer/beta/close_button/playground",
|
|
@@ -13230,9 +12726,7 @@
|
|
|
13230
12726
|
}
|
|
13231
12727
|
}
|
|
13232
12728
|
],
|
|
13233
|
-
"subcomponents": [
|
|
13234
|
-
|
|
13235
|
-
]
|
|
12729
|
+
"subcomponents": []
|
|
13236
12730
|
},
|
|
13237
12731
|
{
|
|
13238
12732
|
"fully_qualified_name": "Primer::Beta::Counter",
|
|
@@ -13291,12 +12785,8 @@
|
|
|
13291
12785
|
"description": "{{link_to_system_arguments_docs}}"
|
|
13292
12786
|
}
|
|
13293
12787
|
],
|
|
13294
|
-
"slots": [
|
|
13295
|
-
|
|
13296
|
-
],
|
|
13297
|
-
"methods": [
|
|
13298
|
-
|
|
13299
|
-
],
|
|
12788
|
+
"slots": [],
|
|
12789
|
+
"methods": [],
|
|
13300
12790
|
"previews": [
|
|
13301
12791
|
{
|
|
13302
12792
|
"preview_path": "primer/beta/counter/playground",
|
|
@@ -13455,9 +12945,7 @@
|
|
|
13455
12945
|
}
|
|
13456
12946
|
}
|
|
13457
12947
|
],
|
|
13458
|
-
"subcomponents": [
|
|
13459
|
-
|
|
13460
|
-
]
|
|
12948
|
+
"subcomponents": []
|
|
13461
12949
|
},
|
|
13462
12950
|
{
|
|
13463
12951
|
"fully_qualified_name": "Primer::Beta::Details",
|
|
@@ -13546,42 +13034,26 @@
|
|
|
13546
13034
|
{
|
|
13547
13035
|
"name": "disabled",
|
|
13548
13036
|
"description": "Returns the value of attribute disabled.",
|
|
13549
|
-
"parameters": [
|
|
13550
|
-
|
|
13551
|
-
],
|
|
13552
|
-
"return_types": [
|
|
13553
|
-
|
|
13554
|
-
]
|
|
13037
|
+
"parameters": [],
|
|
13038
|
+
"return_types": []
|
|
13555
13039
|
},
|
|
13556
13040
|
{
|
|
13557
13041
|
"name": "disabled?",
|
|
13558
13042
|
"description": "Returns the value of attribute disabled.",
|
|
13559
|
-
"parameters": [
|
|
13560
|
-
|
|
13561
|
-
],
|
|
13562
|
-
"return_types": [
|
|
13563
|
-
|
|
13564
|
-
]
|
|
13043
|
+
"parameters": [],
|
|
13044
|
+
"return_types": []
|
|
13565
13045
|
},
|
|
13566
13046
|
{
|
|
13567
13047
|
"name": "open",
|
|
13568
13048
|
"description": "Returns the value of attribute open.",
|
|
13569
|
-
"parameters": [
|
|
13570
|
-
|
|
13571
|
-
],
|
|
13572
|
-
"return_types": [
|
|
13573
|
-
|
|
13574
|
-
]
|
|
13049
|
+
"parameters": [],
|
|
13050
|
+
"return_types": []
|
|
13575
13051
|
},
|
|
13576
13052
|
{
|
|
13577
13053
|
"name": "open?",
|
|
13578
13054
|
"description": "Returns the value of attribute open.",
|
|
13579
|
-
"parameters": [
|
|
13580
|
-
|
|
13581
|
-
],
|
|
13582
|
-
"return_types": [
|
|
13583
|
-
|
|
13584
|
-
]
|
|
13055
|
+
"parameters": [],
|
|
13056
|
+
"return_types": []
|
|
13585
13057
|
}
|
|
13586
13058
|
],
|
|
13587
13059
|
"previews": [
|
|
@@ -13649,11 +13121,22 @@
|
|
|
13649
13121
|
"color-contrast"
|
|
13650
13122
|
]
|
|
13651
13123
|
}
|
|
13124
|
+
},
|
|
13125
|
+
{
|
|
13126
|
+
"preview_path": "primer/beta/details/with_aria_labels",
|
|
13127
|
+
"name": "with_aria_labels",
|
|
13128
|
+
"snapshot": "false",
|
|
13129
|
+
"skip_rules": {
|
|
13130
|
+
"wont_fix": [
|
|
13131
|
+
"region"
|
|
13132
|
+
],
|
|
13133
|
+
"will_fix": [
|
|
13134
|
+
"color-contrast"
|
|
13135
|
+
]
|
|
13136
|
+
}
|
|
13652
13137
|
}
|
|
13653
13138
|
],
|
|
13654
|
-
"subcomponents": [
|
|
13655
|
-
|
|
13656
|
-
]
|
|
13139
|
+
"subcomponents": []
|
|
13657
13140
|
},
|
|
13658
13141
|
{
|
|
13659
13142
|
"fully_qualified_name": "Primer::Beta::Flash",
|
|
@@ -13720,9 +13203,7 @@
|
|
|
13720
13203
|
]
|
|
13721
13204
|
}
|
|
13722
13205
|
],
|
|
13723
|
-
"methods": [
|
|
13724
|
-
|
|
13725
|
-
],
|
|
13206
|
+
"methods": [],
|
|
13726
13207
|
"previews": [
|
|
13727
13208
|
{
|
|
13728
13209
|
"preview_path": "primer/beta/flash/playground",
|
|
@@ -13842,9 +13323,7 @@
|
|
|
13842
13323
|
}
|
|
13843
13324
|
}
|
|
13844
13325
|
],
|
|
13845
|
-
"subcomponents": [
|
|
13846
|
-
|
|
13847
|
-
]
|
|
13326
|
+
"subcomponents": []
|
|
13848
13327
|
},
|
|
13849
13328
|
{
|
|
13850
13329
|
"fully_qualified_name": "Primer::Beta::Heading",
|
|
@@ -13873,12 +13352,8 @@
|
|
|
13873
13352
|
"description": "{{link_to_system_arguments_docs}}"
|
|
13874
13353
|
}
|
|
13875
13354
|
],
|
|
13876
|
-
"slots": [
|
|
13877
|
-
|
|
13878
|
-
],
|
|
13879
|
-
"methods": [
|
|
13880
|
-
|
|
13881
|
-
],
|
|
13355
|
+
"slots": [],
|
|
13356
|
+
"methods": [],
|
|
13882
13357
|
"previews": [
|
|
13883
13358
|
{
|
|
13884
13359
|
"preview_path": "primer/beta/heading/playground",
|
|
@@ -13907,9 +13382,7 @@
|
|
|
13907
13382
|
}
|
|
13908
13383
|
}
|
|
13909
13384
|
],
|
|
13910
|
-
"subcomponents": [
|
|
13911
|
-
|
|
13912
|
-
]
|
|
13385
|
+
"subcomponents": []
|
|
13913
13386
|
},
|
|
13914
13387
|
{
|
|
13915
13388
|
"fully_qualified_name": "Primer::Beta::IconButton",
|
|
@@ -13992,12 +13465,8 @@
|
|
|
13992
13465
|
"description": "{{link_to_system_arguments_docs}}"
|
|
13993
13466
|
}
|
|
13994
13467
|
],
|
|
13995
|
-
"slots": [
|
|
13996
|
-
|
|
13997
|
-
],
|
|
13998
|
-
"methods": [
|
|
13999
|
-
|
|
14000
|
-
],
|
|
13468
|
+
"slots": [],
|
|
13469
|
+
"methods": [],
|
|
14001
13470
|
"previews": [
|
|
14002
13471
|
{
|
|
14003
13472
|
"preview_path": "primer/beta/icon_button/playground",
|
|
@@ -14091,9 +13560,7 @@
|
|
|
14091
13560
|
}
|
|
14092
13561
|
}
|
|
14093
13562
|
],
|
|
14094
|
-
"subcomponents": [
|
|
14095
|
-
|
|
14096
|
-
]
|
|
13563
|
+
"subcomponents": []
|
|
14097
13564
|
},
|
|
14098
13565
|
{
|
|
14099
13566
|
"fully_qualified_name": "Primer::Beta::Label",
|
|
@@ -14146,12 +13613,8 @@
|
|
|
14146
13613
|
"description": "{{link_to_system_arguments_docs}}"
|
|
14147
13614
|
}
|
|
14148
13615
|
],
|
|
14149
|
-
"slots": [
|
|
14150
|
-
|
|
14151
|
-
],
|
|
14152
|
-
"methods": [
|
|
14153
|
-
|
|
14154
|
-
],
|
|
13616
|
+
"slots": [],
|
|
13617
|
+
"methods": [],
|
|
14155
13618
|
"previews": [
|
|
14156
13619
|
{
|
|
14157
13620
|
"preview_path": "primer/beta/label/playground",
|
|
@@ -14362,9 +13825,7 @@
|
|
|
14362
13825
|
}
|
|
14363
13826
|
}
|
|
14364
13827
|
],
|
|
14365
|
-
"subcomponents": [
|
|
14366
|
-
|
|
14367
|
-
]
|
|
13828
|
+
"subcomponents": []
|
|
14368
13829
|
},
|
|
14369
13830
|
{
|
|
14370
13831
|
"fully_qualified_name": "Primer::Beta::Link",
|
|
@@ -14455,9 +13916,7 @@
|
|
|
14455
13916
|
]
|
|
14456
13917
|
}
|
|
14457
13918
|
],
|
|
14458
|
-
"methods": [
|
|
14459
|
-
|
|
14460
|
-
],
|
|
13919
|
+
"methods": [],
|
|
14461
13920
|
"previews": [
|
|
14462
13921
|
{
|
|
14463
13922
|
"preview_path": "primer/beta/link/playground",
|
|
@@ -14590,9 +14049,7 @@
|
|
|
14590
14049
|
}
|
|
14591
14050
|
}
|
|
14592
14051
|
],
|
|
14593
|
-
"subcomponents": [
|
|
14594
|
-
|
|
14595
|
-
]
|
|
14052
|
+
"subcomponents": []
|
|
14596
14053
|
},
|
|
14597
14054
|
{
|
|
14598
14055
|
"fully_qualified_name": "Primer::Beta::Markdown",
|
|
@@ -14621,18 +14078,10 @@
|
|
|
14621
14078
|
"description": "{{link_to_system_arguments_docs}}"
|
|
14622
14079
|
}
|
|
14623
14080
|
],
|
|
14624
|
-
"slots": [
|
|
14625
|
-
|
|
14626
|
-
],
|
|
14627
|
-
"
|
|
14628
|
-
|
|
14629
|
-
],
|
|
14630
|
-
"previews": [
|
|
14631
|
-
|
|
14632
|
-
],
|
|
14633
|
-
"subcomponents": [
|
|
14634
|
-
|
|
14635
|
-
]
|
|
14081
|
+
"slots": [],
|
|
14082
|
+
"methods": [],
|
|
14083
|
+
"previews": [],
|
|
14084
|
+
"subcomponents": []
|
|
14636
14085
|
},
|
|
14637
14086
|
{
|
|
14638
14087
|
"fully_qualified_name": "Primer::Beta::NavList",
|
|
@@ -14665,16 +14114,12 @@
|
|
|
14665
14114
|
{
|
|
14666
14115
|
"name": "heading",
|
|
14667
14116
|
"description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Heading{{/link_to_component}}.",
|
|
14668
|
-
"parameters": [
|
|
14669
|
-
|
|
14670
|
-
]
|
|
14117
|
+
"parameters": []
|
|
14671
14118
|
},
|
|
14672
14119
|
{
|
|
14673
14120
|
"name": "items",
|
|
14674
14121
|
"description": "Items. Items can be individual items, dividers, or groups. See the documentation for `#with_item`, `#with_divider`, and `#with_group` respectively for more information.",
|
|
14675
|
-
"parameters": [
|
|
14676
|
-
|
|
14677
|
-
]
|
|
14122
|
+
"parameters": []
|
|
14678
14123
|
}
|
|
14679
14124
|
],
|
|
14680
14125
|
"methods": [
|
|
@@ -14695,9 +14140,7 @@
|
|
|
14695
14140
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
14696
14141
|
}
|
|
14697
14142
|
],
|
|
14698
|
-
"return_types": [
|
|
14699
|
-
|
|
14700
|
-
]
|
|
14143
|
+
"return_types": []
|
|
14701
14144
|
},
|
|
14702
14145
|
{
|
|
14703
14146
|
"name": "with_avatar_item",
|
|
@@ -14746,9 +14189,7 @@
|
|
|
14746
14189
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
14747
14190
|
}
|
|
14748
14191
|
],
|
|
14749
|
-
"return_types": [
|
|
14750
|
-
|
|
14751
|
-
]
|
|
14192
|
+
"return_types": []
|
|
14752
14193
|
},
|
|
14753
14194
|
{
|
|
14754
14195
|
"name": "with_group",
|
|
@@ -14761,9 +14202,7 @@
|
|
|
14761
14202
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Group{{/link_to_component}}."
|
|
14762
14203
|
}
|
|
14763
14204
|
],
|
|
14764
|
-
"return_types": [
|
|
14765
|
-
|
|
14766
|
-
]
|
|
14205
|
+
"return_types": []
|
|
14767
14206
|
},
|
|
14768
14207
|
{
|
|
14769
14208
|
"name": "with_divider",
|
|
@@ -14776,9 +14215,7 @@
|
|
|
14776
14215
|
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Divider{{/link_to_component}}."
|
|
14777
14216
|
}
|
|
14778
14217
|
],
|
|
14779
|
-
"return_types": [
|
|
14780
|
-
|
|
14781
|
-
]
|
|
14218
|
+
"return_types": []
|
|
14782
14219
|
},
|
|
14783
14220
|
{
|
|
14784
14221
|
"name": "build_item",
|
|
@@ -14797,9 +14234,7 @@
|
|
|
14797
14234
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
14798
14235
|
}
|
|
14799
14236
|
],
|
|
14800
|
-
"return_types": [
|
|
14801
|
-
|
|
14802
|
-
]
|
|
14237
|
+
"return_types": []
|
|
14803
14238
|
},
|
|
14804
14239
|
{
|
|
14805
14240
|
"name": "build_avatar_item",
|
|
@@ -14848,16 +14283,12 @@
|
|
|
14848
14283
|
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
|
14849
14284
|
}
|
|
14850
14285
|
],
|
|
14851
|
-
"return_types": [
|
|
14852
|
-
|
|
14853
|
-
]
|
|
14286
|
+
"return_types": []
|
|
14854
14287
|
},
|
|
14855
14288
|
{
|
|
14856
14289
|
"name": "render_outer_list?",
|
|
14857
14290
|
"description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a `<ul>`",
|
|
14858
|
-
"parameters": [
|
|
14859
|
-
|
|
14860
|
-
],
|
|
14291
|
+
"parameters": [],
|
|
14861
14292
|
"return_types": [
|
|
14862
14293
|
"Boolean"
|
|
14863
14294
|
]
|
|
@@ -15022,57 +14453,35 @@
|
|
|
15022
14453
|
"description": "{{link_to_system_arguments_docs}}"
|
|
15023
14454
|
}
|
|
15024
14455
|
],
|
|
15025
|
-
"slots": [
|
|
15026
|
-
|
|
15027
|
-
],
|
|
14456
|
+
"slots": [],
|
|
15028
14457
|
"methods": [
|
|
15029
14458
|
{
|
|
15030
14459
|
"name": "title",
|
|
15031
14460
|
"description": "Returns the value of attribute title.",
|
|
15032
|
-
"parameters": [
|
|
15033
|
-
|
|
15034
|
-
],
|
|
15035
|
-
"return_types": [
|
|
15036
|
-
|
|
15037
|
-
]
|
|
14461
|
+
"parameters": [],
|
|
14462
|
+
"return_types": []
|
|
15038
14463
|
},
|
|
15039
14464
|
{
|
|
15040
14465
|
"name": "id",
|
|
15041
14466
|
"description": "Returns the value of attribute id.",
|
|
15042
|
-
"parameters": [
|
|
15043
|
-
|
|
15044
|
-
],
|
|
15045
|
-
"return_types": [
|
|
15046
|
-
|
|
15047
|
-
]
|
|
14467
|
+
"parameters": [],
|
|
14468
|
+
"return_types": []
|
|
15048
14469
|
},
|
|
15049
14470
|
{
|
|
15050
14471
|
"name": "heading_level",
|
|
15051
14472
|
"description": "Returns the value of attribute heading_level.",
|
|
15052
|
-
"parameters": [
|
|
15053
|
-
|
|
15054
|
-
],
|
|
15055
|
-
"return_types": [
|
|
15056
|
-
|
|
15057
|
-
]
|
|
14473
|
+
"parameters": [],
|
|
14474
|
+
"return_types": []
|
|
15058
14475
|
},
|
|
15059
14476
|
{
|
|
15060
14477
|
"name": "system_arguments",
|
|
15061
14478
|
"description": "Returns the value of attribute system_arguments.",
|
|
15062
|
-
"parameters": [
|
|
15063
|
-
|
|
15064
|
-
],
|
|
15065
|
-
"return_types": [
|
|
15066
|
-
|
|
15067
|
-
]
|
|
14479
|
+
"parameters": [],
|
|
14480
|
+
"return_types": []
|
|
15068
14481
|
}
|
|
15069
14482
|
],
|
|
15070
|
-
"previews": [
|
|
15071
|
-
|
|
15072
|
-
],
|
|
15073
|
-
"subcomponents": [
|
|
15074
|
-
|
|
15075
|
-
]
|
|
14483
|
+
"previews": [],
|
|
14484
|
+
"subcomponents": []
|
|
15076
14485
|
},
|
|
15077
14486
|
{
|
|
15078
14487
|
"fully_qualified_name": "Primer::Beta::NavList::Item",
|
|
@@ -15153,16 +14562,12 @@
|
|
|
15153
14562
|
{
|
|
15154
14563
|
"name": "leading_visual",
|
|
15155
14564
|
"description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
|
|
15156
|
-
"parameters": [
|
|
15157
|
-
|
|
15158
|
-
]
|
|
14565
|
+
"parameters": []
|
|
15159
14566
|
},
|
|
15160
14567
|
{
|
|
15161
14568
|
"name": "trailing_visual",
|
|
15162
14569
|
"description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
|
|
15163
|
-
"parameters": [
|
|
15164
|
-
|
|
15165
|
-
]
|
|
14570
|
+
"parameters": []
|
|
15166
14571
|
},
|
|
15167
14572
|
{
|
|
15168
14573
|
"name": "trailing_action",
|
|
@@ -15199,29 +14604,19 @@
|
|
|
15199
14604
|
{
|
|
15200
14605
|
"name": "selected_by_ids",
|
|
15201
14606
|
"description": "Returns the value of attribute selected_by_ids.",
|
|
15202
|
-
"parameters": [
|
|
15203
|
-
|
|
15204
|
-
],
|
|
15205
|
-
"return_types": [
|
|
15206
|
-
|
|
15207
|
-
]
|
|
14607
|
+
"parameters": [],
|
|
14608
|
+
"return_types": []
|
|
15208
14609
|
},
|
|
15209
14610
|
{
|
|
15210
14611
|
"name": "sub_item",
|
|
15211
14612
|
"description": "Returns the value of attribute sub_item.",
|
|
15212
|
-
"parameters": [
|
|
15213
|
-
|
|
15214
|
-
],
|
|
15215
|
-
"return_types": [
|
|
15216
|
-
|
|
15217
|
-
]
|
|
14613
|
+
"parameters": [],
|
|
14614
|
+
"return_types": []
|
|
15218
14615
|
},
|
|
15219
14616
|
{
|
|
15220
14617
|
"name": "sub_item?",
|
|
15221
14618
|
"description": "Returns the value of attribute sub_item.\nWhether or not this item is nested under a parent item.",
|
|
15222
|
-
"parameters": [
|
|
15223
|
-
|
|
15224
|
-
],
|
|
14619
|
+
"parameters": [],
|
|
15225
14620
|
"return_types": [
|
|
15226
14621
|
"Boolean"
|
|
15227
14622
|
]
|
|
@@ -15229,30 +14624,20 @@
|
|
|
15229
14624
|
{
|
|
15230
14625
|
"name": "expand!",
|
|
15231
14626
|
"description": "Cause this item to show its list of sub items when rendered.",
|
|
15232
|
-
"parameters": [
|
|
15233
|
-
|
|
15234
|
-
],
|
|
15235
|
-
"return_types": [
|
|
15236
|
-
|
|
15237
|
-
]
|
|
14627
|
+
"parameters": [],
|
|
14628
|
+
"return_types": []
|
|
15238
14629
|
},
|
|
15239
14630
|
{
|
|
15240
14631
|
"name": "item_active?",
|
|
15241
14632
|
"description": "Normally it would be easier to simply ask each item for its active status, eg.\nitems.any?(&:active?), but unfortunately the view context is not set on each\nitem until _after_ the parent's before_render, etc methods have been called.\nThis means helper methods like current_page? will blow up with an error, since\n`helpers` is simply an alias for the view context (i.e. an instance of\nActionView::Base). Since we know the view context for the parent object must\nbe set before `before_render` is invoked, we can call helper methods here in\nthe parent and bypass the problem entirely. Maybe not the most OO approach,\nbut it works.",
|
|
15242
|
-
"parameters": [
|
|
15243
|
-
|
|
15244
|
-
],
|
|
14633
|
+
"parameters": [],
|
|
15245
14634
|
"return_types": [
|
|
15246
14635
|
"Boolean"
|
|
15247
14636
|
]
|
|
15248
14637
|
}
|
|
15249
14638
|
],
|
|
15250
|
-
"previews": [
|
|
15251
|
-
|
|
15252
|
-
],
|
|
15253
|
-
"subcomponents": [
|
|
15254
|
-
|
|
15255
|
-
]
|
|
14639
|
+
"previews": [],
|
|
14640
|
+
"subcomponents": []
|
|
15256
14641
|
},
|
|
15257
14642
|
{
|
|
15258
14643
|
"fully_qualified_name": "Primer::Beta::NavList::Divider",
|
|
@@ -15281,18 +14666,10 @@
|
|
|
15281
14666
|
"description": "{{link_to_system_arguments_docs}}"
|
|
15282
14667
|
}
|
|
15283
14668
|
],
|
|
15284
|
-
"slots": [
|
|
15285
|
-
|
|
15286
|
-
],
|
|
15287
|
-
"
|
|
15288
|
-
|
|
15289
|
-
],
|
|
15290
|
-
"previews": [
|
|
15291
|
-
|
|
15292
|
-
],
|
|
15293
|
-
"subcomponents": [
|
|
15294
|
-
|
|
15295
|
-
]
|
|
14669
|
+
"slots": [],
|
|
14670
|
+
"methods": [],
|
|
14671
|
+
"previews": [],
|
|
14672
|
+
"subcomponents": []
|
|
15296
14673
|
},
|
|
15297
14674
|
{
|
|
15298
14675
|
"fully_qualified_name": "Primer::Beta::NavList::Group",
|
|
@@ -15387,20 +14764,12 @@
|
|
|
15387
14764
|
{
|
|
15388
14765
|
"name": "expand!",
|
|
15389
14766
|
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
|
15390
|
-
"parameters": [
|
|
15391
|
-
|
|
15392
|
-
],
|
|
15393
|
-
"return_types": [
|
|
15394
|
-
|
|
15395
|
-
]
|
|
14767
|
+
"parameters": [],
|
|
14768
|
+
"return_types": []
|
|
15396
14769
|
}
|
|
15397
14770
|
],
|
|
15398
|
-
"previews": [
|
|
15399
|
-
|
|
15400
|
-
],
|
|
15401
|
-
"subcomponents": [
|
|
15402
|
-
|
|
15403
|
-
]
|
|
14771
|
+
"previews": [],
|
|
14772
|
+
"subcomponents": []
|
|
15404
14773
|
}
|
|
15405
14774
|
]
|
|
15406
14775
|
},
|
|
@@ -15449,12 +14818,8 @@
|
|
|
15449
14818
|
"description": "{{link_to_system_arguments_docs}}"
|
|
15450
14819
|
}
|
|
15451
14820
|
],
|
|
15452
|
-
"slots": [
|
|
15453
|
-
|
|
15454
|
-
],
|
|
15455
|
-
"methods": [
|
|
15456
|
-
|
|
15457
|
-
],
|
|
14821
|
+
"slots": [],
|
|
14822
|
+
"methods": [],
|
|
15458
14823
|
"previews": [
|
|
15459
14824
|
{
|
|
15460
14825
|
"preview_path": "primer/beta/octicon/playground",
|
|
@@ -15483,9 +14848,7 @@
|
|
|
15483
14848
|
}
|
|
15484
14849
|
}
|
|
15485
14850
|
],
|
|
15486
|
-
"subcomponents": [
|
|
15487
|
-
|
|
15488
|
-
]
|
|
14851
|
+
"subcomponents": []
|
|
15489
14852
|
},
|
|
15490
14853
|
{
|
|
15491
14854
|
"fully_qualified_name": "Primer::Beta::Popover",
|
|
@@ -15552,9 +14915,7 @@
|
|
|
15552
14915
|
]
|
|
15553
14916
|
}
|
|
15554
14917
|
],
|
|
15555
|
-
"methods": [
|
|
15556
|
-
|
|
15557
|
-
],
|
|
14918
|
+
"methods": [],
|
|
15558
14919
|
"previews": [
|
|
15559
14920
|
{
|
|
15560
14921
|
"preview_path": "primer/beta/popover/playground",
|
|
@@ -15648,9 +15009,7 @@
|
|
|
15648
15009
|
}
|
|
15649
15010
|
}
|
|
15650
15011
|
],
|
|
15651
|
-
"subcomponents": [
|
|
15652
|
-
|
|
15653
|
-
]
|
|
15012
|
+
"subcomponents": []
|
|
15654
15013
|
},
|
|
15655
15014
|
{
|
|
15656
15015
|
"fully_qualified_name": "Primer::Beta::ProgressBar",
|
|
@@ -15705,9 +15064,7 @@
|
|
|
15705
15064
|
]
|
|
15706
15065
|
}
|
|
15707
15066
|
],
|
|
15708
|
-
"methods": [
|
|
15709
|
-
|
|
15710
|
-
],
|
|
15067
|
+
"methods": [],
|
|
15711
15068
|
"previews": [
|
|
15712
15069
|
{
|
|
15713
15070
|
"preview_path": "primer/beta/progress_bar/playground",
|
|
@@ -15775,9 +15132,7 @@
|
|
|
15775
15132
|
}
|
|
15776
15133
|
}
|
|
15777
15134
|
],
|
|
15778
|
-
"subcomponents": [
|
|
15779
|
-
|
|
15780
|
-
]
|
|
15135
|
+
"subcomponents": []
|
|
15781
15136
|
},
|
|
15782
15137
|
{
|
|
15783
15138
|
"fully_qualified_name": "Primer::Beta::RelativeTime",
|
|
@@ -15908,12 +15263,8 @@
|
|
|
15908
15263
|
"description": "{{link_to_system_arguments_docs}}"
|
|
15909
15264
|
}
|
|
15910
15265
|
],
|
|
15911
|
-
"slots": [
|
|
15912
|
-
|
|
15913
|
-
],
|
|
15914
|
-
"methods": [
|
|
15915
|
-
|
|
15916
|
-
],
|
|
15266
|
+
"slots": [],
|
|
15267
|
+
"methods": [],
|
|
15917
15268
|
"previews": [
|
|
15918
15269
|
{
|
|
15919
15270
|
"preview_path": "primer/beta/relative_time/playground",
|
|
@@ -16007,9 +15358,7 @@
|
|
|
16007
15358
|
}
|
|
16008
15359
|
}
|
|
16009
15360
|
],
|
|
16010
|
-
"subcomponents": [
|
|
16011
|
-
|
|
16012
|
-
]
|
|
15361
|
+
"subcomponents": []
|
|
16013
15362
|
},
|
|
16014
15363
|
{
|
|
16015
15364
|
"fully_qualified_name": "Primer::Beta::Spinner",
|
|
@@ -16044,12 +15393,8 @@
|
|
|
16044
15393
|
"description": "{{link_to_system_arguments_docs}}"
|
|
16045
15394
|
}
|
|
16046
15395
|
],
|
|
16047
|
-
"slots": [
|
|
16048
|
-
|
|
16049
|
-
],
|
|
16050
|
-
"methods": [
|
|
16051
|
-
|
|
16052
|
-
],
|
|
15396
|
+
"slots": [],
|
|
15397
|
+
"methods": [],
|
|
16053
15398
|
"previews": [
|
|
16054
15399
|
{
|
|
16055
15400
|
"preview_path": "primer/beta/spinner/playground",
|
|
@@ -16078,9 +15423,7 @@
|
|
|
16078
15423
|
}
|
|
16079
15424
|
}
|
|
16080
15425
|
],
|
|
16081
|
-
"subcomponents": [
|
|
16082
|
-
|
|
16083
|
-
]
|
|
15426
|
+
"subcomponents": []
|
|
16084
15427
|
},
|
|
16085
15428
|
{
|
|
16086
15429
|
"fully_qualified_name": "Primer::Beta::State",
|
|
@@ -16127,12 +15470,8 @@
|
|
|
16127
15470
|
"description": "{{link_to_system_arguments_docs}}"
|
|
16128
15471
|
}
|
|
16129
15472
|
],
|
|
16130
|
-
"slots": [
|
|
16131
|
-
|
|
16132
|
-
],
|
|
16133
|
-
"methods": [
|
|
16134
|
-
|
|
16135
|
-
],
|
|
15473
|
+
"slots": [],
|
|
15474
|
+
"methods": [],
|
|
16136
15475
|
"previews": [
|
|
16137
15476
|
{
|
|
16138
15477
|
"preview_path": "primer/beta/state/playground",
|
|
@@ -16239,9 +15578,7 @@
|
|
|
16239
15578
|
}
|
|
16240
15579
|
}
|
|
16241
15580
|
],
|
|
16242
|
-
"subcomponents": [
|
|
16243
|
-
|
|
16244
|
-
]
|
|
15581
|
+
"subcomponents": []
|
|
16245
15582
|
},
|
|
16246
15583
|
{
|
|
16247
15584
|
"fully_qualified_name": "Primer::Beta::Subhead",
|
|
@@ -16326,9 +15663,7 @@
|
|
|
16326
15663
|
]
|
|
16327
15664
|
}
|
|
16328
15665
|
],
|
|
16329
|
-
"methods": [
|
|
16330
|
-
|
|
16331
|
-
],
|
|
15666
|
+
"methods": [],
|
|
16332
15667
|
"previews": [
|
|
16333
15668
|
{
|
|
16334
15669
|
"preview_path": "primer/beta/subhead/playground",
|
|
@@ -16448,9 +15783,7 @@
|
|
|
16448
15783
|
}
|
|
16449
15784
|
}
|
|
16450
15785
|
],
|
|
16451
|
-
"subcomponents": [
|
|
16452
|
-
|
|
16453
|
-
]
|
|
15786
|
+
"subcomponents": []
|
|
16454
15787
|
},
|
|
16455
15788
|
{
|
|
16456
15789
|
"fully_qualified_name": "Primer::Beta::Text",
|
|
@@ -16479,12 +15812,8 @@
|
|
|
16479
15812
|
"description": "{{link_to_system_arguments_docs}}"
|
|
16480
15813
|
}
|
|
16481
15814
|
],
|
|
16482
|
-
"slots": [
|
|
16483
|
-
|
|
16484
|
-
],
|
|
16485
|
-
"methods": [
|
|
16486
|
-
|
|
16487
|
-
],
|
|
15815
|
+
"slots": [],
|
|
15816
|
+
"methods": [],
|
|
16488
15817
|
"previews": [
|
|
16489
15818
|
{
|
|
16490
15819
|
"preview_path": "primer/beta/text/playground",
|
|
@@ -16513,9 +15842,7 @@
|
|
|
16513
15842
|
}
|
|
16514
15843
|
}
|
|
16515
15844
|
],
|
|
16516
|
-
"subcomponents": [
|
|
16517
|
-
|
|
16518
|
-
]
|
|
15845
|
+
"subcomponents": []
|
|
16519
15846
|
},
|
|
16520
15847
|
{
|
|
16521
15848
|
"fully_qualified_name": "Primer::Beta::TimelineItem",
|
|
@@ -16588,9 +15915,7 @@
|
|
|
16588
15915
|
]
|
|
16589
15916
|
}
|
|
16590
15917
|
],
|
|
16591
|
-
"methods": [
|
|
16592
|
-
|
|
16593
|
-
],
|
|
15918
|
+
"methods": [],
|
|
16594
15919
|
"previews": [
|
|
16595
15920
|
{
|
|
16596
15921
|
"preview_path": "primer/beta/timeline_item/playground",
|
|
@@ -16633,21 +15958,11 @@
|
|
|
16633
15958
|
"short_name": "TimelineItemBadge",
|
|
16634
15959
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/timeline_item/badge.rb",
|
|
16635
15960
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/timeline_item/badge/default/",
|
|
16636
|
-
"parameters": [
|
|
16637
|
-
|
|
16638
|
-
],
|
|
16639
|
-
"
|
|
16640
|
-
|
|
16641
|
-
],
|
|
16642
|
-
"methods": [
|
|
16643
|
-
|
|
16644
|
-
],
|
|
16645
|
-
"previews": [
|
|
16646
|
-
|
|
16647
|
-
],
|
|
16648
|
-
"subcomponents": [
|
|
16649
|
-
|
|
16650
|
-
]
|
|
15961
|
+
"parameters": [],
|
|
15962
|
+
"slots": [],
|
|
15963
|
+
"methods": [],
|
|
15964
|
+
"previews": [],
|
|
15965
|
+
"subcomponents": []
|
|
16651
15966
|
}
|
|
16652
15967
|
]
|
|
16653
15968
|
},
|
|
@@ -16704,9 +16019,7 @@
|
|
|
16704
16019
|
]
|
|
16705
16020
|
}
|
|
16706
16021
|
],
|
|
16707
|
-
"methods": [
|
|
16708
|
-
|
|
16709
|
-
],
|
|
16022
|
+
"methods": [],
|
|
16710
16023
|
"previews": [
|
|
16711
16024
|
{
|
|
16712
16025
|
"preview_path": "primer/beta/truncate/playground",
|
|
@@ -16788,21 +16101,11 @@
|
|
|
16788
16101
|
"short_name": "TruncateTruncateText",
|
|
16789
16102
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate/truncate_text.rb",
|
|
16790
16103
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/truncate_text/default/",
|
|
16791
|
-
"parameters": [
|
|
16792
|
-
|
|
16793
|
-
],
|
|
16794
|
-
"
|
|
16795
|
-
|
|
16796
|
-
],
|
|
16797
|
-
"methods": [
|
|
16798
|
-
|
|
16799
|
-
],
|
|
16800
|
-
"previews": [
|
|
16801
|
-
|
|
16802
|
-
],
|
|
16803
|
-
"subcomponents": [
|
|
16804
|
-
|
|
16805
|
-
]
|
|
16104
|
+
"parameters": [],
|
|
16105
|
+
"slots": [],
|
|
16106
|
+
"methods": [],
|
|
16107
|
+
"previews": [],
|
|
16108
|
+
"subcomponents": []
|
|
16806
16109
|
}
|
|
16807
16110
|
]
|
|
16808
16111
|
},
|
|
@@ -16931,15 +16234,9 @@
|
|
|
16931
16234
|
]
|
|
16932
16235
|
}
|
|
16933
16236
|
],
|
|
16934
|
-
"methods": [
|
|
16935
|
-
|
|
16936
|
-
]
|
|
16937
|
-
"previews": [
|
|
16938
|
-
|
|
16939
|
-
],
|
|
16940
|
-
"subcomponents": [
|
|
16941
|
-
|
|
16942
|
-
]
|
|
16237
|
+
"methods": [],
|
|
16238
|
+
"previews": [],
|
|
16239
|
+
"subcomponents": []
|
|
16943
16240
|
},
|
|
16944
16241
|
{
|
|
16945
16242
|
"fully_qualified_name": "Primer::Box",
|
|
@@ -16962,12 +16259,8 @@
|
|
|
16962
16259
|
"description": "{{link_to_system_arguments_docs}}"
|
|
16963
16260
|
}
|
|
16964
16261
|
],
|
|
16965
|
-
"slots": [
|
|
16966
|
-
|
|
16967
|
-
],
|
|
16968
|
-
"methods": [
|
|
16969
|
-
|
|
16970
|
-
],
|
|
16262
|
+
"slots": [],
|
|
16263
|
+
"methods": [],
|
|
16971
16264
|
"previews": [
|
|
16972
16265
|
{
|
|
16973
16266
|
"preview_path": "primer/box/playground",
|
|
@@ -17022,9 +16315,7 @@
|
|
|
17022
16315
|
}
|
|
17023
16316
|
}
|
|
17024
16317
|
],
|
|
17025
|
-
"subcomponents": [
|
|
17026
|
-
|
|
17027
|
-
]
|
|
16318
|
+
"subcomponents": []
|
|
17028
16319
|
},
|
|
17029
16320
|
{
|
|
17030
16321
|
"fully_qualified_name": "Primer::ButtonComponent",
|
|
@@ -17143,34 +16434,22 @@
|
|
|
17143
16434
|
{
|
|
17144
16435
|
"name": "icon",
|
|
17145
16436
|
"description": "remove alias when all buttons are migrated to new slot names",
|
|
17146
|
-
"parameters": [
|
|
17147
|
-
|
|
17148
|
-
],
|
|
17149
|
-
"return_types": [
|
|
17150
|
-
|
|
17151
|
-
]
|
|
16437
|
+
"parameters": [],
|
|
16438
|
+
"return_types": []
|
|
17152
16439
|
},
|
|
17153
16440
|
{
|
|
17154
16441
|
"name": "counter",
|
|
17155
16442
|
"description": "remove alias when all buttons are migrated to new slot names",
|
|
17156
|
-
"parameters": [
|
|
17157
|
-
|
|
17158
|
-
],
|
|
17159
|
-
"return_types": [
|
|
17160
|
-
|
|
17161
|
-
]
|
|
16443
|
+
"parameters": [],
|
|
16444
|
+
"return_types": []
|
|
17162
16445
|
}
|
|
17163
16446
|
],
|
|
17164
|
-
"previews": [
|
|
17165
|
-
|
|
17166
|
-
],
|
|
17167
|
-
"subcomponents": [
|
|
17168
|
-
|
|
17169
|
-
]
|
|
16447
|
+
"previews": [],
|
|
16448
|
+
"subcomponents": []
|
|
17170
16449
|
},
|
|
17171
16450
|
{
|
|
17172
16451
|
"fully_qualified_name": "Primer::ConditionalWrapper",
|
|
17173
|
-
"description": "Conditionally renders a
|
|
16452
|
+
"description": "Conditionally renders a component around the given content. If the given condition\nis true, the component will render around the content. If the condition is false, only\nthe content is rendered.",
|
|
17174
16453
|
"accessibility_docs": null,
|
|
17175
16454
|
"is_form_component": false,
|
|
17176
16455
|
"is_published": true,
|
|
@@ -17186,27 +16465,25 @@
|
|
|
17186
16465
|
"name": "condition",
|
|
17187
16466
|
"type": "Boolean",
|
|
17188
16467
|
"default": "N/A",
|
|
17189
|
-
"description": "Whether or not to wrap the content in a
|
|
16468
|
+
"description": "Whether or not to wrap the content in a component."
|
|
16469
|
+
},
|
|
16470
|
+
{
|
|
16471
|
+
"name": "component",
|
|
16472
|
+
"type": "Class",
|
|
16473
|
+
"default": "`Primer::BaseComponent`",
|
|
16474
|
+
"description": "The component class to use as a wrapper, defaults to `Primer::BaseComponent`"
|
|
17190
16475
|
},
|
|
17191
16476
|
{
|
|
17192
16477
|
"name": "base_component_arguments",
|
|
17193
16478
|
"type": "Hash",
|
|
17194
16479
|
"default": "N/A",
|
|
17195
|
-
"description": "The arguments to pass to
|
|
16480
|
+
"description": "The arguments to pass to the component."
|
|
17196
16481
|
}
|
|
17197
16482
|
],
|
|
17198
|
-
"slots": [
|
|
17199
|
-
|
|
17200
|
-
],
|
|
17201
|
-
"
|
|
17202
|
-
|
|
17203
|
-
],
|
|
17204
|
-
"previews": [
|
|
17205
|
-
|
|
17206
|
-
],
|
|
17207
|
-
"subcomponents": [
|
|
17208
|
-
|
|
17209
|
-
]
|
|
16483
|
+
"slots": [],
|
|
16484
|
+
"methods": [],
|
|
16485
|
+
"previews": [],
|
|
16486
|
+
"subcomponents": []
|
|
17210
16487
|
},
|
|
17211
16488
|
{
|
|
17212
16489
|
"fully_qualified_name": "Primer::Content",
|
|
@@ -17221,21 +16498,11 @@
|
|
|
17221
16498
|
"short_name": "Content",
|
|
17222
16499
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/content.rb",
|
|
17223
16500
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/content/default/",
|
|
17224
|
-
"parameters": [
|
|
17225
|
-
|
|
17226
|
-
],
|
|
17227
|
-
"
|
|
17228
|
-
|
|
17229
|
-
],
|
|
17230
|
-
"methods": [
|
|
17231
|
-
|
|
17232
|
-
],
|
|
17233
|
-
"previews": [
|
|
17234
|
-
|
|
17235
|
-
],
|
|
17236
|
-
"subcomponents": [
|
|
17237
|
-
|
|
17238
|
-
]
|
|
16501
|
+
"parameters": [],
|
|
16502
|
+
"slots": [],
|
|
16503
|
+
"methods": [],
|
|
16504
|
+
"previews": [],
|
|
16505
|
+
"subcomponents": []
|
|
17239
16506
|
},
|
|
17240
16507
|
{
|
|
17241
16508
|
"fully_qualified_name": "Primer::IconButton",
|
|
@@ -17306,18 +16573,10 @@
|
|
|
17306
16573
|
"description": "{{link_to_system_arguments_docs}}"
|
|
17307
16574
|
}
|
|
17308
16575
|
],
|
|
17309
|
-
"slots": [
|
|
17310
|
-
|
|
17311
|
-
],
|
|
17312
|
-
"
|
|
17313
|
-
|
|
17314
|
-
],
|
|
17315
|
-
"previews": [
|
|
17316
|
-
|
|
17317
|
-
],
|
|
17318
|
-
"subcomponents": [
|
|
17319
|
-
|
|
17320
|
-
]
|
|
16576
|
+
"slots": [],
|
|
16577
|
+
"methods": [],
|
|
16578
|
+
"previews": [],
|
|
16579
|
+
"subcomponents": []
|
|
17321
16580
|
},
|
|
17322
16581
|
{
|
|
17323
16582
|
"fully_qualified_name": "Primer::LayoutComponent",
|
|
@@ -17384,15 +16643,9 @@
|
|
|
17384
16643
|
]
|
|
17385
16644
|
}
|
|
17386
16645
|
],
|
|
17387
|
-
"methods": [
|
|
17388
|
-
|
|
17389
|
-
]
|
|
17390
|
-
"previews": [
|
|
17391
|
-
|
|
17392
|
-
],
|
|
17393
|
-
"subcomponents": [
|
|
17394
|
-
|
|
17395
|
-
]
|
|
16646
|
+
"methods": [],
|
|
16647
|
+
"previews": [],
|
|
16648
|
+
"subcomponents": []
|
|
17396
16649
|
},
|
|
17397
16650
|
{
|
|
17398
16651
|
"fully_qualified_name": "Primer::Navigation::TabComponent",
|
|
@@ -17501,15 +16754,9 @@
|
|
|
17501
16754
|
]
|
|
17502
16755
|
}
|
|
17503
16756
|
],
|
|
17504
|
-
"methods": [
|
|
17505
|
-
|
|
17506
|
-
]
|
|
17507
|
-
"previews": [
|
|
17508
|
-
|
|
17509
|
-
],
|
|
17510
|
-
"subcomponents": [
|
|
17511
|
-
|
|
17512
|
-
]
|
|
16757
|
+
"methods": [],
|
|
16758
|
+
"previews": [],
|
|
16759
|
+
"subcomponents": []
|
|
17513
16760
|
},
|
|
17514
16761
|
{
|
|
17515
16762
|
"fully_qualified_name": "Primer::Tooltip",
|
|
@@ -17562,18 +16809,10 @@
|
|
|
17562
16809
|
"description": "{{link_to_system_arguments_docs}}"
|
|
17563
16810
|
}
|
|
17564
16811
|
],
|
|
17565
|
-
"slots": [
|
|
17566
|
-
|
|
17567
|
-
],
|
|
17568
|
-
"
|
|
17569
|
-
|
|
17570
|
-
],
|
|
17571
|
-
"previews": [
|
|
17572
|
-
|
|
17573
|
-
],
|
|
17574
|
-
"subcomponents": [
|
|
17575
|
-
|
|
17576
|
-
]
|
|
16812
|
+
"slots": [],
|
|
16813
|
+
"methods": [],
|
|
16814
|
+
"previews": [],
|
|
16815
|
+
"subcomponents": []
|
|
17577
16816
|
},
|
|
17578
16817
|
{
|
|
17579
16818
|
"fully_qualified_name": "Primer::Truncate",
|
|
@@ -17620,18 +16859,10 @@
|
|
|
17620
16859
|
"description": "{{link_to_system_arguments_docs}}"
|
|
17621
16860
|
}
|
|
17622
16861
|
],
|
|
17623
|
-
"slots": [
|
|
17624
|
-
|
|
17625
|
-
],
|
|
17626
|
-
"
|
|
17627
|
-
|
|
17628
|
-
],
|
|
17629
|
-
"previews": [
|
|
17630
|
-
|
|
17631
|
-
],
|
|
17632
|
-
"subcomponents": [
|
|
17633
|
-
|
|
17634
|
-
]
|
|
16862
|
+
"slots": [],
|
|
16863
|
+
"methods": [],
|
|
16864
|
+
"previews": [],
|
|
16865
|
+
"subcomponents": []
|
|
17635
16866
|
},
|
|
17636
16867
|
{
|
|
17637
16868
|
"component": "BaseComponent",
|