@primer/view-components 0.0.104 → 0.0.106

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.
@@ -1,7 +1,9 @@
1
1
  [
2
2
  {
3
3
  "component": "ActionList",
4
+ "status": "alpha",
4
5
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb",
6
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/default/",
5
7
  "parameters": [
6
8
  {
7
9
  "name": "role",
@@ -37,7 +39,9 @@
37
39
  },
38
40
  {
39
41
  "component": "ActionList::Divider",
42
+ "status": "alpha",
40
43
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
44
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
41
45
  "parameters": [
42
46
  {
43
47
  "name": "scheme",
@@ -55,7 +59,9 @@
55
59
  },
56
60
  {
57
61
  "component": "ActionList::Heading",
62
+ "status": "alpha",
58
63
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
64
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
59
65
  "parameters": [
60
66
  {
61
67
  "name": "list_id",
@@ -97,7 +103,9 @@
97
103
  },
98
104
  {
99
105
  "component": "ActionList::Item",
106
+ "status": "alpha",
100
107
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/item.rb",
108
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item/default/",
101
109
  "parameters": [
102
110
  {
103
111
  "name": "list",
@@ -199,7 +207,9 @@
199
207
  },
200
208
  {
201
209
  "component": "ButtonMarketing",
210
+ "status": "alpha",
202
211
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb",
212
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing/default/",
203
213
  "parameters": [
204
214
  {
205
215
  "name": "scheme",
@@ -235,7 +245,9 @@
235
245
  },
236
246
  {
237
247
  "component": "Dialog",
248
+ "status": "alpha",
238
249
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog.rb",
250
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/default/",
239
251
  "parameters": [
240
252
  {
241
253
  "name": "id",
@@ -289,7 +301,9 @@
289
301
  },
290
302
  {
291
303
  "component": "HiddenTextExpander",
304
+ "status": "alpha",
292
305
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb",
306
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander/default/",
293
307
  "parameters": [
294
308
  {
295
309
  "name": "inline",
@@ -311,9 +325,69 @@
311
325
  }
312
326
  ]
313
327
  },
328
+ {
329
+ "component": "Image",
330
+ "status": "alpha",
331
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb",
332
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image/default/",
333
+ "parameters": [
334
+ {
335
+ "name": "src",
336
+ "type": "String",
337
+ "default": "N/A",
338
+ "description": "The source url of the image."
339
+ },
340
+ {
341
+ "name": "alt",
342
+ "type": "String",
343
+ "default": "N/A",
344
+ "description": "Specifies an alternate text for the image."
345
+ },
346
+ {
347
+ "name": "lazy",
348
+ "type": "Boolean",
349
+ "default": "`false`",
350
+ "description": "Whether or not to lazily load the image."
351
+ },
352
+ {
353
+ "name": "system_arguments",
354
+ "type": "Hash",
355
+ "default": "N/A",
356
+ "description": "[System arguments](/system-arguments)"
357
+ }
358
+ ]
359
+ },
360
+ {
361
+ "component": "ImageCrop",
362
+ "status": "alpha",
363
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb",
364
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop/default/",
365
+ "parameters": [
366
+ {
367
+ "name": "src",
368
+ "type": "String",
369
+ "default": "N/A",
370
+ "description": "The path of the image to crop."
371
+ },
372
+ {
373
+ "name": "rounded",
374
+ "type": "Boolean",
375
+ "default": "`true`",
376
+ "description": "If the crop mask should be a circle. Defaults to true."
377
+ },
378
+ {
379
+ "name": "system_arguments",
380
+ "type": "Hash",
381
+ "default": "N/A",
382
+ "description": "[System arguments](/system-arguments)"
383
+ }
384
+ ]
385
+ },
314
386
  {
315
387
  "component": "Layout",
388
+ "status": "alpha",
316
389
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb",
390
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/default/",
317
391
  "parameters": [
318
392
  {
319
393
  "name": "stacking_breakpoint",
@@ -343,7 +417,9 @@
343
417
  },
344
418
  {
345
419
  "component": "NavList",
420
+ "status": "alpha",
346
421
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
422
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/default/",
347
423
  "parameters": [
348
424
  {
349
425
  "name": "selected_item_id",
@@ -361,7 +437,9 @@
361
437
  },
362
438
  {
363
439
  "component": "NavList::Item",
440
+ "status": "alpha",
364
441
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
442
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
365
443
  "parameters": [
366
444
  {
367
445
  "name": "selected_item_id",
@@ -397,7 +475,9 @@
397
475
  },
398
476
  {
399
477
  "component": "NavList::Section",
478
+ "status": "alpha",
400
479
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/section.rb",
480
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/section/default/",
401
481
  "parameters": [
402
482
  {
403
483
  "name": "selected_item_id",
@@ -413,9 +493,43 @@
413
493
  }
414
494
  ]
415
495
  },
496
+ {
497
+ "component": "SegmentedControl",
498
+ "status": "alpha",
499
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb",
500
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/default/",
501
+ "parameters": [
502
+ {
503
+ "name": "hide_labels",
504
+ "type": "Boolean",
505
+ "default": "`false`",
506
+ "description": "Whether to hide the labels and only show the icons"
507
+ },
508
+ {
509
+ "name": "full_width",
510
+ "type": "Boolean",
511
+ "default": "`false`",
512
+ "description": "If the component should be full width"
513
+ },
514
+ {
515
+ "name": "size",
516
+ "type": "Symbol",
517
+ "default": "`:medium`",
518
+ "description": "One of `:large`, `:medium`, or `:small`."
519
+ },
520
+ {
521
+ "name": "system_arguments",
522
+ "type": "Hash",
523
+ "default": "N/A",
524
+ "description": "[System arguments](/system-arguments)"
525
+ }
526
+ ]
527
+ },
416
528
  {
417
529
  "component": "TabNav",
530
+ "status": "alpha",
418
531
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb",
532
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav/default/",
419
533
  "parameters": [
420
534
  {
421
535
  "name": "tag",
@@ -445,7 +559,9 @@
445
559
  },
446
560
  {
447
561
  "component": "TabPanels",
562
+ "status": "alpha",
448
563
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_panels.rb",
564
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels/default/",
449
565
  "parameters": [
450
566
  {
451
567
  "name": "label",
@@ -481,7 +597,9 @@
481
597
  },
482
598
  {
483
599
  "component": "TextField",
600
+ "status": "alpha",
484
601
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb",
602
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field/default/",
485
603
  "parameters": [
486
604
  {
487
605
  "name": "name",
@@ -613,7 +731,9 @@
613
731
  },
614
732
  {
615
733
  "component": "ToggleSwitch",
734
+ "status": "alpha",
616
735
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/toggle_switch.rb",
736
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch/default/",
617
737
  "parameters": [
618
738
  {
619
739
  "name": "src",
@@ -661,7 +781,9 @@
661
781
  },
662
782
  {
663
783
  "component": "Tooltip",
784
+ "status": "alpha",
664
785
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb",
786
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip/default/",
665
787
  "parameters": [
666
788
  {
667
789
  "name": "for_id",
@@ -697,7 +819,9 @@
697
819
  },
698
820
  {
699
821
  "component": "UnderlineNav",
822
+ "status": "alpha",
700
823
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb",
824
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav/default/",
701
825
  "parameters": [
702
826
  {
703
827
  "name": "tag",
@@ -733,7 +857,9 @@
733
857
  },
734
858
  {
735
859
  "component": "UnderlinePanels",
860
+ "status": "alpha",
736
861
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb",
862
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels/default/",
737
863
  "parameters": [
738
864
  {
739
865
  "name": "label",
@@ -769,7 +895,9 @@
769
895
  },
770
896
  {
771
897
  "component": "AutoComplete",
898
+ "status": "beta",
772
899
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb",
900
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/default/",
773
901
  "parameters": [
774
902
  {
775
903
  "name": "label_text",
@@ -865,7 +993,9 @@
865
993
  },
866
994
  {
867
995
  "component": "AutoComplete::Item",
996
+ "status": "beta",
868
997
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb",
998
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item/default/",
869
999
  "parameters": [
870
1000
  {
871
1001
  "name": "value",
@@ -907,7 +1037,9 @@
907
1037
  },
908
1038
  {
909
1039
  "component": "Avatar",
1040
+ "status": "beta",
910
1041
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar.rb",
1042
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar/default/",
911
1043
  "parameters": [
912
1044
  {
913
1045
  "name": "src",
@@ -949,7 +1081,9 @@
949
1081
  },
950
1082
  {
951
1083
  "component": "AvatarStack",
1084
+ "status": "beta",
952
1085
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar_stack.rb",
1086
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack/default/",
953
1087
  "parameters": [
954
1088
  {
955
1089
  "name": "tag",
@@ -983,9 +1117,67 @@
983
1117
  }
984
1118
  ]
985
1119
  },
1120
+ {
1121
+ "component": "Banner",
1122
+ "status": "beta",
1123
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/banner.rb",
1124
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/banner/default/",
1125
+ "parameters": [
1126
+ {
1127
+ "name": "full",
1128
+ "type": "Boolean",
1129
+ "default": "`false`",
1130
+ "description": "Whether the component should take up the full width of the screen."
1131
+ },
1132
+ {
1133
+ "name": "full_when_narrow",
1134
+ "type": "Boolean",
1135
+ "default": "`false`",
1136
+ "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
1137
+ },
1138
+ {
1139
+ "name": "dismissible",
1140
+ "type": "Boolean",
1141
+ "default": "`false`",
1142
+ "description": "Whether the component can be dismissed with an \"x\" button."
1143
+ },
1144
+ {
1145
+ "name": "description",
1146
+ "type": "String",
1147
+ "default": "`nil`",
1148
+ "description": "Description text rendered underneath the message."
1149
+ },
1150
+ {
1151
+ "name": "icon",
1152
+ "type": "Symbol",
1153
+ "default": "`nil`",
1154
+ "description": "The name of an [Octicon](https://primer.style/octicons/) icon to use. If no icon is provided, a default one will be chosen based on the scheme."
1155
+ },
1156
+ {
1157
+ "name": "scheme",
1158
+ "type": "Symbol",
1159
+ "default": "`:default`",
1160
+ "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
1161
+ },
1162
+ {
1163
+ "name": "reappear",
1164
+ "type": "Boolean",
1165
+ "default": "`false`",
1166
+ "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
1167
+ },
1168
+ {
1169
+ "name": "system_arguments",
1170
+ "type": "Hash",
1171
+ "default": "N/A",
1172
+ "description": "[System arguments](/system-arguments)"
1173
+ }
1174
+ ]
1175
+ },
986
1176
  {
987
1177
  "component": "BaseButton",
1178
+ "status": "beta",
988
1179
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb",
1180
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button/default/",
989
1181
  "parameters": [
990
1182
  {
991
1183
  "name": "tag",
@@ -1015,7 +1207,9 @@
1015
1207
  },
1016
1208
  {
1017
1209
  "component": "Blankslate",
1210
+ "status": "beta",
1018
1211
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb",
1212
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate/default/",
1019
1213
  "parameters": [
1020
1214
  {
1021
1215
  "name": "narrow",
@@ -1045,7 +1239,9 @@
1045
1239
  },
1046
1240
  {
1047
1241
  "component": "BorderBox",
1242
+ "status": "beta",
1048
1243
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb",
1244
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/default/",
1049
1245
  "parameters": [
1050
1246
  {
1051
1247
  "name": "padding",
@@ -1063,7 +1259,9 @@
1063
1259
  },
1064
1260
  {
1065
1261
  "component": "BorderBox::Header",
1262
+ "status": "beta",
1066
1263
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb",
1264
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header/default/",
1067
1265
  "parameters": [
1068
1266
  {
1069
1267
  "name": "system_arguments",
@@ -1075,7 +1273,9 @@
1075
1273
  },
1076
1274
  {
1077
1275
  "component": "Breadcrumbs",
1276
+ "status": "beta",
1078
1277
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb",
1278
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/default/",
1079
1279
  "parameters": [
1080
1280
  {
1081
1281
  "name": "system_arguments",
@@ -1087,7 +1287,9 @@
1087
1287
  },
1088
1288
  {
1089
1289
  "component": "Button",
1290
+ "status": "beta",
1090
1291
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button.rb",
1292
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button/default/",
1091
1293
  "parameters": [
1092
1294
  {
1093
1295
  "name": "scheme",
@@ -1135,7 +1337,9 @@
1135
1337
  },
1136
1338
  {
1137
1339
  "component": "ButtonGroup",
1340
+ "status": "beta",
1138
1341
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group.rb",
1342
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group/default/",
1139
1343
  "parameters": [
1140
1344
  {
1141
1345
  "name": "variant",
@@ -1159,7 +1363,9 @@
1159
1363
  },
1160
1364
  {
1161
1365
  "component": "CloseButton",
1366
+ "status": "beta",
1162
1367
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/close_button.rb",
1368
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button/default/",
1163
1369
  "parameters": [
1164
1370
  {
1165
1371
  "name": "type",
@@ -1177,7 +1383,9 @@
1177
1383
  },
1178
1384
  {
1179
1385
  "component": "Counter",
1386
+ "status": "beta",
1180
1387
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/counter.rb",
1388
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter/default/",
1181
1389
  "parameters": [
1182
1390
  {
1183
1391
  "name": "count",
@@ -1225,7 +1433,9 @@
1225
1433
  },
1226
1434
  {
1227
1435
  "component": "Details",
1436
+ "status": "beta",
1228
1437
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/details.rb",
1438
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details/default/",
1229
1439
  "parameters": [
1230
1440
  {
1231
1441
  "name": "overlay",
@@ -1249,7 +1459,9 @@
1249
1459
  },
1250
1460
  {
1251
1461
  "component": "Flash",
1462
+ "status": "beta",
1252
1463
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/flash.rb",
1464
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash/default/",
1253
1465
  "parameters": [
1254
1466
  {
1255
1467
  "name": "full",
@@ -1291,7 +1503,9 @@
1291
1503
  },
1292
1504
  {
1293
1505
  "component": "Heading",
1506
+ "status": "beta",
1294
1507
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/heading.rb",
1508
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading/default/",
1295
1509
  "parameters": [
1296
1510
  {
1297
1511
  "name": "tag",
@@ -1309,7 +1523,9 @@
1309
1523
  },
1310
1524
  {
1311
1525
  "component": "IconButton",
1526
+ "status": "beta",
1312
1527
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/icon_button.rb",
1528
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button/default/",
1313
1529
  "parameters": [
1314
1530
  {
1315
1531
  "name": "icon",
@@ -1379,9 +1595,99 @@
1379
1595
  }
1380
1596
  ]
1381
1597
  },
1598
+ {
1599
+ "component": "Label",
1600
+ "status": "beta",
1601
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/label.rb",
1602
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label/default/",
1603
+ "parameters": [
1604
+ {
1605
+ "name": "tag",
1606
+ "type": "Symbol",
1607
+ "default": "`:span`",
1608
+ "description": "One of `:a`, `:div`, `:span`, or `:summary`."
1609
+ },
1610
+ {
1611
+ "name": "scheme",
1612
+ "type": "Symbol",
1613
+ "default": "`:default`",
1614
+ "description": "One of `:accent`, `:attention`, `:danger`, `:default`, `:done`, `:info`, `:orange`, `:primary`, `:purple`, `:secondary`, `:severe`, `:sponsors`, `:success`, or `:warning`."
1615
+ },
1616
+ {
1617
+ "name": "size",
1618
+ "type": "Symbol",
1619
+ "default": "`:medium`",
1620
+ "description": "One of `:large` or `:medium`."
1621
+ },
1622
+ {
1623
+ "name": "inline",
1624
+ "type": "Boolean",
1625
+ "default": "`false`",
1626
+ "description": "Whether or not to render this label inline."
1627
+ },
1628
+ {
1629
+ "name": "variant",
1630
+ "type": "Symbol",
1631
+ "default": "`:none`",
1632
+ "description": "One of `:inline`, `:large`, or `:none`."
1633
+ },
1634
+ {
1635
+ "name": "system_arguments",
1636
+ "type": "Hash",
1637
+ "default": "N/A",
1638
+ "description": "[System arguments](/system-arguments)"
1639
+ }
1640
+ ]
1641
+ },
1642
+ {
1643
+ "component": "Link",
1644
+ "status": "beta",
1645
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
1646
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/",
1647
+ "parameters": [
1648
+ {
1649
+ "name": "tag",
1650
+ "type": "String",
1651
+ "default": "`:a`",
1652
+ "description": "One of `:a` or `:span`."
1653
+ },
1654
+ {
1655
+ "name": "href",
1656
+ "type": "String",
1657
+ "default": "`nil`",
1658
+ "description": "URL to be used for the Link. Required if tag is `:a`. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
1659
+ },
1660
+ {
1661
+ "name": "scheme",
1662
+ "type": "Symbol",
1663
+ "default": "`:default`",
1664
+ "description": "One of `:default`, `:primary`, or `:secondary`."
1665
+ },
1666
+ {
1667
+ "name": "muted",
1668
+ "type": "Boolean",
1669
+ "default": "`false`",
1670
+ "description": "Uses light gray for Link color, and blue on hover."
1671
+ },
1672
+ {
1673
+ "name": "underline",
1674
+ "type": "Boolean",
1675
+ "default": "`true`",
1676
+ "description": "Whether or not to underline the link."
1677
+ },
1678
+ {
1679
+ "name": "system_arguments",
1680
+ "type": "Hash",
1681
+ "default": "N/A",
1682
+ "description": "[System arguments](/system-arguments)"
1683
+ }
1684
+ ]
1685
+ },
1382
1686
  {
1383
1687
  "component": "Text",
1688
+ "status": "beta",
1384
1689
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb",
1690
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text/default/",
1385
1691
  "parameters": [
1386
1692
  {
1387
1693
  "name": "tag",
@@ -1399,7 +1705,9 @@
1399
1705
  },
1400
1706
  {
1401
1707
  "component": "Truncate",
1708
+ "status": "beta",
1402
1709
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb",
1710
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/default/",
1403
1711
  "parameters": [
1404
1712
  {
1405
1713
  "name": "system_arguments",
@@ -1411,7 +1719,9 @@
1411
1719
  },
1412
1720
  {
1413
1721
  "component": "Box",
1722
+ "status": "stable",
1414
1723
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb",
1724
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box/default/",
1415
1725
  "parameters": [
1416
1726
  {
1417
1727
  "name": "system_arguments",
@@ -1423,7 +1733,9 @@
1423
1733
  },
1424
1734
  {
1425
1735
  "component": "Button",
1736
+ "status": "beta",
1426
1737
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
1738
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button/default/",
1427
1739
  "parameters": [
1428
1740
  {
1429
1741
  "name": "scheme",
@@ -1483,7 +1795,9 @@
1483
1795
  },
1484
1796
  {
1485
1797
  "component": "ClipboardCopy",
1798
+ "status": "beta",
1486
1799
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/clipboard_copy.rb",
1800
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/clipboard_copy/default/",
1487
1801
  "parameters": [
1488
1802
  {
1489
1803
  "name": "aria-label",
@@ -1513,7 +1827,9 @@
1513
1827
  },
1514
1828
  {
1515
1829
  "component": "Dropdown",
1830
+ "status": "alpha",
1516
1831
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/dropdown.rb",
1832
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown/default/",
1517
1833
  "parameters": [
1518
1834
  {
1519
1835
  "name": "overlay",
@@ -1537,7 +1853,9 @@
1537
1853
  },
1538
1854
  {
1539
1855
  "component": "DropdownMenu",
1856
+ "status": "deprecated",
1540
1857
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/dropdown_menu_component.rb",
1858
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown_menu/default/",
1541
1859
  "parameters": [
1542
1860
  {
1543
1861
  "name": "direction",
@@ -1567,7 +1885,9 @@
1567
1885
  },
1568
1886
  {
1569
1887
  "component": "HellipButton",
1888
+ "status": "alpha",
1570
1889
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/hellip_button.rb",
1890
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/hellip_button/default/",
1571
1891
  "parameters": [
1572
1892
  {
1573
1893
  "name": "inline",
@@ -1585,7 +1905,9 @@
1585
1905
  },
1586
1906
  {
1587
1907
  "component": "IconButton",
1908
+ "status": "deprecated",
1588
1909
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb",
1910
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button/default/",
1589
1911
  "parameters": [
1590
1912
  {
1591
1913
  "name": "scheme",
@@ -1643,105 +1965,11 @@
1643
1965
  }
1644
1966
  ]
1645
1967
  },
1646
- {
1647
- "component": "Image",
1648
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/image.rb",
1649
- "parameters": [
1650
- {
1651
- "name": "src",
1652
- "type": "String",
1653
- "default": "N/A",
1654
- "description": "The source url of the image."
1655
- },
1656
- {
1657
- "name": "alt",
1658
- "type": "String",
1659
- "default": "N/A",
1660
- "description": "Specifies an alternate text for the image."
1661
- },
1662
- {
1663
- "name": "lazy",
1664
- "type": "Boolean",
1665
- "default": "`false`",
1666
- "description": "Whether or not to lazily load the image."
1667
- },
1668
- {
1669
- "name": "system_arguments",
1670
- "type": "Hash",
1671
- "default": "N/A",
1672
- "description": "[System arguments](/system-arguments)"
1673
- }
1674
- ]
1675
- },
1676
- {
1677
- "component": "ImageCrop",
1678
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/image_crop.rb",
1679
- "parameters": [
1680
- {
1681
- "name": "src",
1682
- "type": "String",
1683
- "default": "N/A",
1684
- "description": "The path of the image to crop."
1685
- },
1686
- {
1687
- "name": "rounded",
1688
- "type": "Boolean",
1689
- "default": "`true`",
1690
- "description": "If the crop mask should be a circle. Defaults to true."
1691
- },
1692
- {
1693
- "name": "system_arguments",
1694
- "type": "Hash",
1695
- "default": "N/A",
1696
- "description": "[System arguments](/system-arguments)"
1697
- }
1698
- ]
1699
- },
1700
- {
1701
- "component": "Label",
1702
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/label_component.rb",
1703
- "parameters": [
1704
- {
1705
- "name": "tag",
1706
- "type": "Symbol",
1707
- "default": "`:span`",
1708
- "description": "One of `:a`, `:div`, `:span`, or `:summary`."
1709
- },
1710
- {
1711
- "name": "scheme",
1712
- "type": "Symbol",
1713
- "default": "`:default`",
1714
- "description": "One of `:accent`, `:attention`, `:danger`, `:default`, `:done`, `:info`, `:orange`, `:primary`, `:purple`, `:secondary`, `:severe`, `:sponsors`, `:success`, or `:warning`."
1715
- },
1716
- {
1717
- "name": "size",
1718
- "type": "Symbol",
1719
- "default": "`:medium`",
1720
- "description": "One of `:large` or `:medium`."
1721
- },
1722
- {
1723
- "name": "inline",
1724
- "type": "Boolean",
1725
- "default": "`false`",
1726
- "description": "Whether or not to render this label inline."
1727
- },
1728
- {
1729
- "name": "variant",
1730
- "type": "Symbol",
1731
- "default": "`:none`",
1732
- "description": "One of `:inline`, `:large`, or `:none`."
1733
- },
1734
- {
1735
- "name": "system_arguments",
1736
- "type": "Hash",
1737
- "default": "N/A",
1738
- "description": "[System arguments](/system-arguments)"
1739
- }
1740
- ]
1741
- },
1742
1968
  {
1743
1969
  "component": "Layout",
1970
+ "status": "alpha",
1744
1971
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb",
1972
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout/default/",
1745
1973
  "parameters": [
1746
1974
  {
1747
1975
  "name": "responsive",
@@ -1769,51 +1997,11 @@
1769
1997
  }
1770
1998
  ]
1771
1999
  },
1772
- {
1773
- "component": "Link",
1774
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/link_component.rb",
1775
- "parameters": [
1776
- {
1777
- "name": "tag",
1778
- "type": "String",
1779
- "default": "`:a`",
1780
- "description": "One of `:a` or `:span`."
1781
- },
1782
- {
1783
- "name": "href",
1784
- "type": "String",
1785
- "default": "`nil`",
1786
- "description": "URL to be used for the Link. Required if tag is `:a`. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
1787
- },
1788
- {
1789
- "name": "scheme",
1790
- "type": "Symbol",
1791
- "default": "`:default`",
1792
- "description": "One of `:default`, `:primary`, or `:secondary`."
1793
- },
1794
- {
1795
- "name": "muted",
1796
- "type": "Boolean",
1797
- "default": "`false`",
1798
- "description": "Uses light gray for Link color, and blue on hover."
1799
- },
1800
- {
1801
- "name": "underline",
1802
- "type": "Boolean",
1803
- "default": "`true`",
1804
- "description": "Whether or not to underline the link."
1805
- },
1806
- {
1807
- "name": "system_arguments",
1808
- "type": "Hash",
1809
- "default": "N/A",
1810
- "description": "[System arguments](/system-arguments)"
1811
- }
1812
- ]
1813
- },
1814
2000
  {
1815
2001
  "component": "LocalTime",
2002
+ "status": "alpha",
1816
2003
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/local_time.rb",
2004
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/local_time/default/",
1817
2005
  "parameters": [
1818
2006
  {
1819
2007
  "name": "datetime",
@@ -1885,7 +2073,9 @@
1885
2073
  },
1886
2074
  {
1887
2075
  "component": "Markdown",
2076
+ "status": "beta",
1888
2077
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/markdown.rb",
2078
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/markdown/default/",
1889
2079
  "parameters": [
1890
2080
  {
1891
2081
  "name": "tag",
@@ -1903,7 +2093,9 @@
1903
2093
  },
1904
2094
  {
1905
2095
  "component": "Menu",
2096
+ "status": "alpha",
1906
2097
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/menu_component.rb",
2098
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/menu/default/",
1907
2099
  "parameters": [
1908
2100
  {
1909
2101
  "name": "system_arguments",
@@ -1915,7 +2107,9 @@
1915
2107
  },
1916
2108
  {
1917
2109
  "component": "Navigation::Tab",
2110
+ "status": "alpha",
1918
2111
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb",
2112
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab/default/",
1919
2113
  "parameters": [
1920
2114
  {
1921
2115
  "name": "list",
@@ -1963,7 +2157,9 @@
1963
2157
  },
1964
2158
  {
1965
2159
  "component": "Octicon",
2160
+ "status": "beta",
1966
2161
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/octicon_component.rb",
2162
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/octicon/default/",
1967
2163
  "parameters": [
1968
2164
  {
1969
2165
  "name": "icon_name",
@@ -1999,7 +2195,9 @@
1999
2195
  },
2000
2196
  {
2001
2197
  "component": "OcticonSymbols",
2198
+ "status": "alpha",
2002
2199
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/octicon_symbols_component.rb",
2200
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/octicon_symbols/default/",
2003
2201
  "parameters": [
2004
2202
  {
2005
2203
  "name": "icons",
@@ -2011,7 +2209,9 @@
2011
2209
  },
2012
2210
  {
2013
2211
  "component": "Popover",
2212
+ "status": "beta",
2014
2213
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/popover_component.rb",
2214
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/popover/default/",
2015
2215
  "parameters": [
2016
2216
  {
2017
2217
  "name": "system_arguments",
@@ -2023,7 +2223,9 @@
2023
2223
  },
2024
2224
  {
2025
2225
  "component": "ProgressBar",
2226
+ "status": "beta",
2026
2227
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/progress_bar_component.rb",
2228
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/progress_bar/default/",
2027
2229
  "parameters": [
2028
2230
  {
2029
2231
  "name": "size",
@@ -2041,7 +2243,9 @@
2041
2243
  },
2042
2244
  {
2043
2245
  "component": "Spinner",
2246
+ "status": "beta",
2044
2247
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/spinner_component.rb",
2248
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/spinner/default/",
2045
2249
  "parameters": [
2046
2250
  {
2047
2251
  "name": "size",
@@ -2065,7 +2269,9 @@
2065
2269
  },
2066
2270
  {
2067
2271
  "component": "State",
2272
+ "status": "beta",
2068
2273
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/state_component.rb",
2274
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/state/default/",
2069
2275
  "parameters": [
2070
2276
  {
2071
2277
  "name": "title",
@@ -2101,7 +2307,9 @@
2101
2307
  },
2102
2308
  {
2103
2309
  "component": "Subhead",
2310
+ "status": "beta",
2104
2311
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/subhead_component.rb",
2312
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/subhead/default/",
2105
2313
  "parameters": [
2106
2314
  {
2107
2315
  "name": "spacious",
@@ -2125,7 +2333,9 @@
2125
2333
  },
2126
2334
  {
2127
2335
  "component": "TabContainer",
2336
+ "status": "alpha",
2128
2337
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tab_container_component.rb",
2338
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tab_container/default/",
2129
2339
  "parameters": [
2130
2340
  {
2131
2341
  "name": "system_arguments",
@@ -2137,7 +2347,9 @@
2137
2347
  },
2138
2348
  {
2139
2349
  "component": "TimeAgo",
2350
+ "status": "beta",
2140
2351
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/time_ago_component.rb",
2352
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago/default/",
2141
2353
  "parameters": [
2142
2354
  {
2143
2355
  "name": "time",
@@ -2161,7 +2373,9 @@
2161
2373
  },
2162
2374
  {
2163
2375
  "component": "TimelineItem",
2376
+ "status": "beta",
2164
2377
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/timeline_item_component.rb",
2378
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/timeline_item/default/",
2165
2379
  "parameters": [
2166
2380
  {
2167
2381
  "name": "condensed",
@@ -2179,7 +2393,9 @@
2179
2393
  },
2180
2394
  {
2181
2395
  "component": "Tooltip",
2396
+ "status": "deprecated",
2182
2397
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tooltip.rb",
2398
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip/default/",
2183
2399
  "parameters": [
2184
2400
  {
2185
2401
  "name": "label",
@@ -2221,7 +2437,9 @@
2221
2437
  },
2222
2438
  {
2223
2439
  "component": "Truncate",
2440
+ "status": "beta",
2224
2441
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/truncate.rb",
2442
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate/default/",
2225
2443
  "parameters": [
2226
2444
  {
2227
2445
  "name": "tag",