@primer/view-components 0.1.9-rc.c124420c → 0.1.9-rc.ca2fbe65

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.
@@ -2,6 +2,9 @@
2
2
  {
3
3
  "fully_qualified_name": "Primer::Alpha::ActionList",
4
4
  "description": "An ActionList is a styled list of links. It acts as the base component for many\nother menu-type components, including `ActionMenu` and `SelectPanel`, as well as\nthe navigational component `NavList`.\n\nEach item in an action list can be augmented by specifying corresponding leading\nand/or trailing visuals.",
5
+ "is_form_component": false,
6
+ "is_published": true,
7
+ "requires_js": true,
5
8
  "component": "ActionList",
6
9
  "status": "alpha",
7
10
  "a11y_reviewed": false,
@@ -234,9 +237,149 @@
234
237
  }
235
238
  ],
236
239
  "subcomponents": [
240
+ {
241
+ "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
242
+ "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
243
+ "is_form_component": false,
244
+ "is_published": true,
245
+ "requires_js": false,
246
+ "component": "ActionList::FormWrapper",
247
+ "status": "alpha",
248
+ "a11y_reviewed": false,
249
+ "short_name": "ActionListFormWrapper",
250
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
251
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
252
+ "parameters": [
253
+
254
+ ],
255
+ "slots": [
256
+
257
+ ],
258
+ "methods": [
259
+
260
+ ],
261
+ "previews": [
262
+
263
+ ],
264
+ "subcomponents": [
265
+
266
+ ]
267
+ },
268
+ {
269
+ "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
270
+ "description": "Separator with optional text rendered above groups or between individual items.",
271
+ "is_form_component": false,
272
+ "is_published": true,
273
+ "requires_js": false,
274
+ "component": "ActionList::Divider",
275
+ "status": "alpha",
276
+ "a11y_reviewed": false,
277
+ "short_name": "ActionListDivider",
278
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
279
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
280
+ "parameters": [
281
+ {
282
+ "name": "scheme",
283
+ "type": "Symbol",
284
+ "default": "`:subtle`",
285
+ "description": "Display a background color if scheme is `filled`."
286
+ },
287
+ {
288
+ "name": "system_arguments",
289
+ "type": "Hash",
290
+ "default": "N/A",
291
+ "description": "{{link_to_system_arguments_docs}}"
292
+ }
293
+ ],
294
+ "slots": [
295
+
296
+ ],
297
+ "methods": [
298
+
299
+ ],
300
+ "previews": [
301
+
302
+ ],
303
+ "subcomponents": [
304
+
305
+ ]
306
+ },
307
+ {
308
+ "fully_qualified_name": "Primer::Alpha::ActionList::Heading",
309
+ "description": "Heading used to describe each sub list within an action list.",
310
+ "is_form_component": false,
311
+ "is_published": true,
312
+ "requires_js": false,
313
+ "component": "ActionList::Heading",
314
+ "status": "alpha",
315
+ "a11y_reviewed": false,
316
+ "short_name": "ActionListHeading",
317
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
318
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
319
+ "parameters": [
320
+ {
321
+ "name": "title",
322
+ "type": "String",
323
+ "default": "N/A",
324
+ "description": "Sub list title."
325
+ },
326
+ {
327
+ "name": "heading_level",
328
+ "type": "Integer",
329
+ "default": "`3`",
330
+ "description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
331
+ },
332
+ {
333
+ "name": "subtitle",
334
+ "type": "String",
335
+ "default": "`nil`",
336
+ "description": "Optional sub list description."
337
+ },
338
+ {
339
+ "name": "scheme",
340
+ "type": "Symbol",
341
+ "default": "`:subtle`",
342
+ "description": "Display a background color if scheme is `filled`."
343
+ },
344
+ {
345
+ "name": "system_arguments",
346
+ "type": "Hash",
347
+ "default": "N/A",
348
+ "description": "{{link_to_system_arguments_docs}}"
349
+ }
350
+ ],
351
+ "slots": [
352
+
353
+ ],
354
+ "methods": [
355
+ {
356
+ "name": "title_id",
357
+ "description": "Returns the value of attribute title_id.",
358
+ "parameters": [
359
+
360
+ ]
361
+ },
362
+ {
363
+ "name": "subtitle_id",
364
+ "description": "Returns the value of attribute subtitle_id.",
365
+ "parameters": [
366
+
367
+ ]
368
+ }
369
+ ],
370
+ "previews": [
371
+
372
+ ],
373
+ "subcomponents": [
374
+
375
+ ]
376
+ },
237
377
  {
238
378
  "fully_qualified_name": "Primer::Alpha::ActionList::Item",
239
379
  "description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.",
380
+ "is_form_component": false,
381
+ "is_published": true,
382
+ "requires_js": false,
240
383
  "component": "ActionList::Item",
241
384
  "status": "alpha",
242
385
  "a11y_reviewed": false,
@@ -469,134 +612,6 @@
469
612
  ],
470
613
  "subcomponents": [
471
614
 
472
- ]
473
- },
474
- {
475
- "fully_qualified_name": "Primer::Alpha::ActionList::Heading",
476
- "description": "Heading used to describe each sub list within an action list.",
477
- "component": "ActionList::Heading",
478
- "status": "alpha",
479
- "a11y_reviewed": false,
480
- "short_name": "ActionListHeading",
481
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
482
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
483
- "parameters": [
484
- {
485
- "name": "title",
486
- "type": "String",
487
- "default": "N/A",
488
- "description": "Sub list title."
489
- },
490
- {
491
- "name": "heading_level",
492
- "type": "Integer",
493
- "default": "`3`",
494
- "description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
495
- },
496
- {
497
- "name": "subtitle",
498
- "type": "String",
499
- "default": "`nil`",
500
- "description": "Optional sub list description."
501
- },
502
- {
503
- "name": "scheme",
504
- "type": "Symbol",
505
- "default": "`:subtle`",
506
- "description": "Display a background color if scheme is `filled`."
507
- },
508
- {
509
- "name": "system_arguments",
510
- "type": "Hash",
511
- "default": "N/A",
512
- "description": "{{link_to_system_arguments_docs}}"
513
- }
514
- ],
515
- "slots": [
516
-
517
- ],
518
- "methods": [
519
- {
520
- "name": "title_id",
521
- "description": "Returns the value of attribute title_id.",
522
- "parameters": [
523
-
524
- ]
525
- },
526
- {
527
- "name": "subtitle_id",
528
- "description": "Returns the value of attribute subtitle_id.",
529
- "parameters": [
530
-
531
- ]
532
- }
533
- ],
534
- "previews": [
535
-
536
- ],
537
- "subcomponents": [
538
-
539
- ]
540
- },
541
- {
542
- "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
543
- "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
544
- "component": "ActionList::FormWrapper",
545
- "status": "alpha",
546
- "a11y_reviewed": false,
547
- "short_name": "ActionListFormWrapper",
548
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
549
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
550
- "parameters": [
551
-
552
- ],
553
- "slots": [
554
-
555
- ],
556
- "methods": [
557
-
558
- ],
559
- "previews": [
560
-
561
- ],
562
- "subcomponents": [
563
-
564
- ]
565
- },
566
- {
567
- "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
568
- "description": "Separator with optional text rendered above groups or between individual items.",
569
- "component": "ActionList::Divider",
570
- "status": "alpha",
571
- "a11y_reviewed": false,
572
- "short_name": "ActionListDivider",
573
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
574
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
575
- "parameters": [
576
- {
577
- "name": "scheme",
578
- "type": "Symbol",
579
- "default": "`:subtle`",
580
- "description": "Display a background color if scheme is `filled`."
581
- },
582
- {
583
- "name": "system_arguments",
584
- "type": "Hash",
585
- "default": "N/A",
586
- "description": "{{link_to_system_arguments_docs}}"
587
- }
588
- ],
589
- "slots": [
590
-
591
- ],
592
- "methods": [
593
-
594
- ],
595
- "previews": [
596
-
597
- ],
598
- "subcomponents": [
599
-
600
615
  ]
601
616
  }
602
617
  ]
@@ -604,6 +619,9 @@
604
619
  {
605
620
  "fully_qualified_name": "Primer::Alpha::ActionMenu",
606
621
  "description": "ActionMenu is used for actions, navigation, to display secondary options, or single/multi select lists. They appear when users interact with buttons, actions, or other controls.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. The default is `:button`.",
622
+ "is_form_component": false,
623
+ "is_published": true,
624
+ "requires_js": true,
607
625
  "component": "ActionMenu",
608
626
  "status": "alpha",
609
627
  "a11y_reviewed": false,
@@ -889,6 +907,9 @@
889
907
  {
890
908
  "fully_qualified_name": "Primer::Alpha::ActionMenu::List",
891
909
  "description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.",
910
+ "is_form_component": false,
911
+ "is_published": true,
912
+ "requires_js": false,
892
913
  "component": "ActionMenu::List",
893
914
  "status": "alpha",
894
915
  "a11y_reviewed": false,
@@ -967,6 +988,9 @@
967
988
  {
968
989
  "fully_qualified_name": "Primer::Alpha::AutoComplete",
969
990
  "description": "Use `AutoComplete` to provide a user with a list of selectable suggestions that appear when they type into the\ninput field. This list is populated by server search results.",
991
+ "is_form_component": false,
992
+ "is_published": true,
993
+ "requires_js": false,
970
994
  "component": "AutoComplete",
971
995
  "status": "deprecated",
972
996
  "a11y_reviewed": false,
@@ -1096,6 +1120,9 @@
1096
1120
  {
1097
1121
  "fully_qualified_name": "Primer::Alpha::AutoComplete::Item",
1098
1122
  "description": "Use `AutoCompleteItem` to list results of an auto-completed search.",
1123
+ "is_form_component": false,
1124
+ "is_published": true,
1125
+ "requires_js": false,
1099
1126
  "component": "AutoComplete::Item",
1100
1127
  "status": "deprecated",
1101
1128
  "a11y_reviewed": false,
@@ -1146,6 +1173,9 @@
1146
1173
  {
1147
1174
  "fully_qualified_name": "Primer::Alpha::Banner",
1148
1175
  "description": "Use `Banner` to highlight important information.",
1176
+ "is_form_component": false,
1177
+ "is_published": true,
1178
+ "requires_js": true,
1149
1179
  "component": "Banner",
1150
1180
  "status": "alpha",
1151
1181
  "a11y_reviewed": false,
@@ -1258,6 +1288,9 @@
1258
1288
  {
1259
1289
  "fully_qualified_name": "Primer::Alpha::ButtonMarketing",
1260
1290
  "description": "Use `ButtonMarketing` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
1291
+ "is_form_component": false,
1292
+ "is_published": true,
1293
+ "requires_js": false,
1261
1294
  "component": "ButtonMarketing",
1262
1295
  "status": "alpha",
1263
1296
  "a11y_reviewed": false,
@@ -1331,6 +1364,9 @@
1331
1364
  {
1332
1365
  "fully_qualified_name": "Primer::Alpha::CheckBox",
1333
1366
  "description": "Check boxes are true/false inputs rendered as `<input type=\"checkbox\">` in HTML.\n\n## Schemes\n\nCheck boxes can submit values to the server using one of two schemes, either `:array`\nor `:boolean` (the default). Check boxes with a scheme of `:boolean` function like normal\nHTML check boxes. If they are checked, a value of \"1\" is sent to the server; if they are\nunchecked, a value of \"0\" is sent to the server. The checked and unchecked values can be\ncustomized via the `:value` and `:unchecked_value` arguments respectively.\n\nWhereas `:boolean` check boxes must have unique names, `:array` check boxes all have the\nsame name. On form submission, Rails will aggregate the values of the check boxes with the\nsame name and provide them to the controller as an array. If `:scheme:` is `:array`, the\n`:value` argument must also be provided. The `:unchecked_value` argument is ignored. If a\ncheck box is checked on submit, its corresponding value will appear in the array. If it is\nnot checked, its value will not appear in the array.\n\n## Caption templates\n\nCaption templates for `:array`-type check boxes work a little differently than they do for\nother input types. Because the name must be the same for all check boxes that make up an\narray, caption template file names are comprised of both the name _and_ the value of each\ncheck box. For example, a check box with the name `foo` and value `bar` must have a caption\ntemplate named `foo_bar_caption.html.erb`.\n\n## Nested Forms\n\nCheck boxes can have \"nested\" forms that are rendered below the caption. A common use-case\nis a form that is hidden until the check box is checked. Nested forms are indented slightly\nto align with the label and caption.\n\nDefine a nested form via the `#nested_form` method, which is expected to return an instance\nof a Primer form (see the usage section below).\n\nAny fields defined in the nested form are submitted along with the parent form's fields.\n\n**NOTE**: Check boxes do not automatically show or hide nested forms. If such behavior is\ndesired, it must be done by hand.",
1367
+ "is_form_component": true,
1368
+ "is_published": false,
1369
+ "requires_js": false,
1334
1370
  "component": "CheckBox",
1335
1371
  "status": "alpha",
1336
1372
  "a11y_reviewed": false,
@@ -1501,6 +1537,9 @@
1501
1537
  {
1502
1538
  "fully_qualified_name": "Primer::Alpha::CheckBoxGroup",
1503
1539
  "description": "Check box groups consist of one or more related check boxes.",
1540
+ "is_form_component": true,
1541
+ "is_published": false,
1542
+ "requires_js": false,
1504
1543
  "component": "CheckBoxGroup",
1505
1544
  "status": "alpha",
1506
1545
  "a11y_reviewed": false,
@@ -1586,6 +1625,9 @@
1586
1625
  {
1587
1626
  "fully_qualified_name": "Primer::Alpha::Dialog",
1588
1627
  "description": "A `Dialog` is used to remove the user from the main application flow,\nto confirm actions, ask for disambiguation or to present small forms.",
1628
+ "is_form_component": false,
1629
+ "is_published": true,
1630
+ "requires_js": false,
1589
1631
  "component": "Dialog",
1590
1632
  "status": "alpha",
1591
1633
  "a11y_reviewed": true,
@@ -1768,38 +1810,23 @@
1768
1810
  ],
1769
1811
  "subcomponents": [
1770
1812
  {
1771
- "fully_qualified_name": "Primer::Alpha::Dialog::Header",
1772
- "description": "A `Dialog::Header` is a compositional component, used to render the\nHeader of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
1773
- "component": "Dialog::Header",
1813
+ "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
1814
+ "description": "A `Dialog::Footer` is a compositional component, used to render the\nFooter of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
1815
+ "is_form_component": false,
1816
+ "is_published": true,
1817
+ "requires_js": false,
1818
+ "component": "Dialog::Footer",
1774
1819
  "status": "alpha",
1775
1820
  "a11y_reviewed": true,
1776
- "short_name": "DialogHeader",
1777
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
1778
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
1821
+ "short_name": "DialogFooter",
1822
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
1823
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
1779
1824
  "parameters": [
1780
- {
1781
- "name": "title",
1782
- "type": "String",
1783
- "default": "N/A",
1784
- "description": "Describes the content of the dialog."
1785
- },
1786
- {
1787
- "name": "subtitle",
1788
- "type": "String",
1789
- "default": "`nil`",
1790
- "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
1791
- },
1792
1825
  {
1793
1826
  "name": "show_divider",
1794
1827
  "type": "Boolean",
1795
1828
  "default": "`false`",
1796
- "description": "Show a divider between the header and body."
1797
- },
1798
- {
1799
- "name": "visually_hide_title",
1800
- "type": "Boolean",
1801
- "default": "`false`",
1802
- "description": "Visually hide the `title` while maintaining a label for assistive technologies."
1829
+ "description": "Show a divider between the footer and body."
1803
1830
  },
1804
1831
  {
1805
1832
  "name": "system_arguments",
@@ -1822,21 +1849,18 @@
1822
1849
  ]
1823
1850
  },
1824
1851
  {
1825
- "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
1826
- "description": "A `Dialog::Footer` is a compositional component, used to render the\nFooter of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
1827
- "component": "Dialog::Footer",
1852
+ "fully_qualified_name": "Primer::Alpha::Dialog::Body",
1853
+ "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
1854
+ "is_form_component": false,
1855
+ "is_published": true,
1856
+ "requires_js": false,
1857
+ "component": "Dialog::Body",
1828
1858
  "status": "alpha",
1829
1859
  "a11y_reviewed": true,
1830
- "short_name": "DialogFooter",
1831
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
1832
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
1860
+ "short_name": "DialogBody",
1861
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
1862
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
1833
1863
  "parameters": [
1834
- {
1835
- "name": "show_divider",
1836
- "type": "Boolean",
1837
- "default": "`false`",
1838
- "description": "Show a divider between the footer and body."
1839
- },
1840
1864
  {
1841
1865
  "name": "system_arguments",
1842
1866
  "type": "Hash",
@@ -1858,15 +1882,42 @@
1858
1882
  ]
1859
1883
  },
1860
1884
  {
1861
- "fully_qualified_name": "Primer::Alpha::Dialog::Body",
1862
- "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
1863
- "component": "Dialog::Body",
1885
+ "fully_qualified_name": "Primer::Alpha::Dialog::Header",
1886
+ "description": "A `Dialog::Header` is a compositional component, used to render the\nHeader of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
1887
+ "is_form_component": false,
1888
+ "is_published": true,
1889
+ "requires_js": false,
1890
+ "component": "Dialog::Header",
1864
1891
  "status": "alpha",
1865
1892
  "a11y_reviewed": true,
1866
- "short_name": "DialogBody",
1867
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
1868
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
1893
+ "short_name": "DialogHeader",
1894
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
1895
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
1869
1896
  "parameters": [
1897
+ {
1898
+ "name": "title",
1899
+ "type": "String",
1900
+ "default": "N/A",
1901
+ "description": "Describes the content of the dialog."
1902
+ },
1903
+ {
1904
+ "name": "subtitle",
1905
+ "type": "String",
1906
+ "default": "`nil`",
1907
+ "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
1908
+ },
1909
+ {
1910
+ "name": "show_divider",
1911
+ "type": "Boolean",
1912
+ "default": "`false`",
1913
+ "description": "Show a divider between the header and body."
1914
+ },
1915
+ {
1916
+ "name": "visually_hide_title",
1917
+ "type": "Boolean",
1918
+ "default": "`false`",
1919
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
1920
+ },
1870
1921
  {
1871
1922
  "name": "system_arguments",
1872
1923
  "type": "Hash",
@@ -1892,6 +1943,9 @@
1892
1943
  {
1893
1944
  "fully_qualified_name": "Primer::Alpha::Dropdown",
1894
1945
  "description": "`Dropdown` is a lightweight context menu for housing navigation and actions.\nThey're great for instances where you don't need the full power (and code) of the SelectMenu.",
1946
+ "is_form_component": false,
1947
+ "is_published": true,
1948
+ "requires_js": true,
1895
1949
  "component": "Dropdown",
1896
1950
  "status": "alpha",
1897
1951
  "a11y_reviewed": false,
@@ -1997,6 +2051,9 @@
1997
2051
  {
1998
2052
  "fully_qualified_name": "Primer::Alpha::Dropdown::Menu::Item",
1999
2053
  "description": "Items to be rendered in the `Dropdown` menu.",
2054
+ "is_form_component": false,
2055
+ "is_published": true,
2056
+ "requires_js": false,
2000
2057
  "component": "Dropdown::Menu::Item",
2001
2058
  "status": "alpha",
2002
2059
  "a11y_reviewed": false,
@@ -2022,6 +2079,9 @@
2022
2079
  {
2023
2080
  "fully_qualified_name": "Primer::Alpha::Dropdown::Menu",
2024
2081
  "description": "This component is part of `Dropdown` and should not be\nused as a standalone component.",
2082
+ "is_form_component": false,
2083
+ "is_published": true,
2084
+ "requires_js": false,
2025
2085
  "component": "Dropdown::Menu",
2026
2086
  "status": "alpha",
2027
2087
  "a11y_reviewed": false,
@@ -2095,6 +2155,9 @@
2095
2155
  {
2096
2156
  "fully_qualified_name": "Primer::Alpha::FormButton",
2097
2157
  "description": "A button input rendered using the HTML `<button type=\"button\">` tag.\n\nThis component wraps the Primer button component and supports the same slots and arguments.",
2158
+ "is_form_component": true,
2159
+ "is_published": false,
2160
+ "requires_js": false,
2098
2161
  "component": "FormButton",
2099
2162
  "status": "alpha",
2100
2163
  "a11y_reviewed": false,
@@ -2167,6 +2230,9 @@
2167
2230
  {
2168
2231
  "fully_qualified_name": "Primer::Alpha::FormControl",
2169
2232
  "description": "Wraps an input (or arbitrary content) with a label above and a caption and validation message beneath.\nNOTE: This `FormControl` component is designed for wrapping inputs that aren't supported by the Primer\nforms framework.",
2233
+ "is_form_component": false,
2234
+ "is_published": true,
2235
+ "requires_js": false,
2170
2236
  "component": "FormControl",
2171
2237
  "status": "alpha",
2172
2238
  "a11y_reviewed": false,
@@ -2260,6 +2326,9 @@
2260
2326
  {
2261
2327
  "fully_qualified_name": "Primer::Alpha::HellipButton",
2262
2328
  "description": "Use `HellipButton` to render a button with a hellip. Often used for hidden text expanders.",
2329
+ "is_form_component": false,
2330
+ "is_published": true,
2331
+ "requires_js": false,
2263
2332
  "component": "HellipButton",
2264
2333
  "status": "alpha",
2265
2334
  "a11y_reviewed": false,
@@ -2305,6 +2374,9 @@
2305
2374
  {
2306
2375
  "fully_qualified_name": "Primer::Alpha::HiddenTextExpander",
2307
2376
  "description": "Use `HiddenTextExpander` to indicate and toggle hidden text.",
2377
+ "is_form_component": false,
2378
+ "is_published": true,
2379
+ "requires_js": false,
2308
2380
  "component": "HiddenTextExpander",
2309
2381
  "status": "alpha",
2310
2382
  "a11y_reviewed": false,
@@ -2356,6 +2428,9 @@
2356
2428
  {
2357
2429
  "fully_qualified_name": "Primer::Alpha::Image",
2358
2430
  "description": "Use `Image` to render images.",
2431
+ "is_form_component": false,
2432
+ "is_published": true,
2433
+ "requires_js": false,
2359
2434
  "component": "Image",
2360
2435
  "status": "alpha",
2361
2436
  "a11y_reviewed": false,
@@ -2404,6 +2479,9 @@
2404
2479
  {
2405
2480
  "fully_qualified_name": "Primer::Alpha::ImageCrop",
2406
2481
  "description": "A client-side mechanism to crop images.",
2482
+ "is_form_component": false,
2483
+ "is_published": true,
2484
+ "requires_js": true,
2407
2485
  "component": "ImageCrop",
2408
2486
  "status": "alpha",
2409
2487
  "a11y_reviewed": false,
@@ -2471,6 +2549,9 @@
2471
2549
  {
2472
2550
  "fully_qualified_name": "Primer::Alpha::Layout",
2473
2551
  "description": "`Layout` provides foundational patterns for responsive pages.\n`Layout` can be used for simple two-column pages, or it can be nested to provide flexible 3-column experiences.\n On smaller screens, `Layout` uses vertically stacked rows to display content.\n\n`Layout` flows as both column, when there's enough horizontal space to render both `Main` and `Sidebar`side-by-side (on a desktop of tablet device, per instance);\nor it flows as a row, when `Main` and `Sidebar` are stacked vertically (e.g. on a mobile device).\n`Layout` should always work in any screen size.",
2552
+ "is_form_component": false,
2553
+ "is_published": true,
2554
+ "requires_js": false,
2474
2555
  "component": "Layout",
2475
2556
  "status": "alpha",
2476
2557
  "a11y_reviewed": false,
@@ -2602,6 +2683,9 @@
2602
2683
  {
2603
2684
  "fully_qualified_name": "Primer::Alpha::Layout::Sidebar",
2604
2685
  "description": "The layout's sidebar content.",
2686
+ "is_form_component": false,
2687
+ "is_published": true,
2688
+ "requires_js": false,
2605
2689
  "component": "Layout::Sidebar",
2606
2690
  "status": "alpha",
2607
2691
  "a11y_reviewed": false,
@@ -2627,6 +2711,9 @@
2627
2711
  {
2628
2712
  "fully_qualified_name": "Primer::Alpha::Layout::Main",
2629
2713
  "description": "The layout's main content.",
2714
+ "is_form_component": false,
2715
+ "is_published": true,
2716
+ "requires_js": false,
2630
2717
  "component": "Layout::Main",
2631
2718
  "status": "alpha",
2632
2719
  "a11y_reviewed": false,
@@ -2665,6 +2752,9 @@
2665
2752
  {
2666
2753
  "fully_qualified_name": "Primer::Alpha::Menu",
2667
2754
  "description": "Use `Menu` to create vertical lists of navigational links.",
2755
+ "is_form_component": false,
2756
+ "is_published": true,
2757
+ "requires_js": false,
2668
2758
  "component": "Menu",
2669
2759
  "status": "alpha",
2670
2760
  "a11y_reviewed": false,
@@ -2745,6 +2835,9 @@
2745
2835
  {
2746
2836
  "fully_qualified_name": "Primer::Alpha::MultiInput",
2747
2837
  "description": "Multi inputs are comprised of multiple constituent fields, only one of which is visible\nat a given time. They are designed for situations where constituent inputs are shown or\nhidden based on the value of another field. For example, consider an address form. If\nthe user chooses the USA as the country, the region input should show a list of states\nand US territories; if the user instead chooses Canada, the region input should show a\nlist of Canadian provinces, etc.\n\nUnlike everywhere else in Primer forms, constituent inputs are not directly passed a\n`name` attribute. Instead, developers pass a `name` attribute to the multi input itself.\nThe multi input then automatically assigns each constituent input the same name. This is\ndone so that the multi input looks like a single field from the server's point of view.\nUsing the address form example from earlier, this means only one value - either a US state\nor a Canadian provice - will be submitted to the server under the `region` key.\n\nActually, that's not quite true. Constituent inputs _are_ given a `name`, but it's added to\nthe input as the `data-name` attribute as a way to identify constituent inputs, and will not\nbe sent to the server.",
2838
+ "is_form_component": true,
2839
+ "is_published": false,
2840
+ "requires_js": true,
2748
2841
  "component": "MultiInput",
2749
2842
  "status": "alpha",
2750
2843
  "a11y_reviewed": false,
@@ -2901,6 +2994,9 @@
2901
2994
  {
2902
2995
  "fully_qualified_name": "Primer::Alpha::NavList",
2903
2996
  "description": "`NavList` provides a simple way to render side navigation, i.e. navigation\nthat appears to the left or right side of some main content. Each group in a\nnav list is a list of links.\n\nNav list groups can contain sub items. Rather than navigating to a URL, groups\nwith sub items expand and collapse on click. To indicate this functionality, the\ngroup will automatically render with a trailing chevron icon that changes direction\nwhen the group expands and collapses.\n\nNav list items appear visually active when selected. Each nav item must have one\nor more ID values that determine which item will appear selected. Use the\n`selected_item_id` argument to select the appropriate item.",
2997
+ "is_form_component": false,
2998
+ "is_published": true,
2999
+ "requires_js": true,
2904
3000
  "component": "NavList",
2905
3001
  "status": "alpha",
2906
3002
  "a11y_reviewed": false,
@@ -3006,6 +3102,9 @@
3006
3102
  {
3007
3103
  "fully_qualified_name": "Primer::Alpha::NavList::Item",
3008
3104
  "description": "Items are rendered as styled links. They can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters. Items are selected by ID. IDs can be specified via the\n`selected_item_ids` argument, which accepts a list of valid IDs for the item. Items can also\nthemselves contain sub items. Sub items are rendered collapsed by default.",
3105
+ "is_form_component": false,
3106
+ "is_published": true,
3107
+ "requires_js": true,
3009
3108
  "component": "NavList::Item",
3010
3109
  "status": "alpha",
3011
3110
  "a11y_reviewed": false,
@@ -3156,6 +3255,9 @@
3156
3255
  {
3157
3256
  "fully_qualified_name": "Primer::Alpha::NavList::Divider",
3158
3257
  "description": "Separator with optional text rendered above groups or between individual items.",
3258
+ "is_form_component": false,
3259
+ "is_published": true,
3260
+ "requires_js": false,
3159
3261
  "component": "NavList::Divider",
3160
3262
  "status": "alpha",
3161
3263
  "a11y_reviewed": false,
@@ -3192,6 +3294,9 @@
3192
3294
  {
3193
3295
  "fully_qualified_name": "Primer::Alpha::NavList::Group",
3194
3296
  "description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
3297
+ "is_form_component": false,
3298
+ "is_published": true,
3299
+ "requires_js": true,
3195
3300
  "component": "NavList::Group",
3196
3301
  "status": "alpha",
3197
3302
  "a11y_reviewed": false,
@@ -3289,6 +3394,9 @@
3289
3394
  {
3290
3395
  "fully_qualified_name": "Primer::Alpha::Navigation::Tab",
3291
3396
  "description": "This component is part of navigation components such as `Primer::Alpha::TabNav`\nand `Primer::Alpha::UnderlineNav` and should not be used by itself.",
3397
+ "is_form_component": false,
3398
+ "is_published": true,
3399
+ "requires_js": false,
3292
3400
  "component": "Navigation::Tab",
3293
3401
  "status": "alpha",
3294
3402
  "a11y_reviewed": false,
@@ -3408,6 +3516,9 @@
3408
3516
  {
3409
3517
  "fully_qualified_name": "Primer::Alpha::OcticonSymbols",
3410
3518
  "description": "OcticonSymbols renders a symbol dictionary using a list of {{link_to_octicons}}.",
3519
+ "is_form_component": false,
3520
+ "is_published": true,
3521
+ "requires_js": false,
3411
3522
  "component": "OcticonSymbols",
3412
3523
  "status": "alpha",
3413
3524
  "a11y_reviewed": false,
@@ -3438,6 +3549,9 @@
3438
3549
  {
3439
3550
  "fully_qualified_name": "Primer::Alpha::Overlay",
3440
3551
  "description": "Overlay components codify design patterns related to floating surfaces such\nas dialogs and menus. They are private components intended to be used by\nspecialized components, and mostly contain presentational logic and\nbehavior.",
3552
+ "is_form_component": false,
3553
+ "is_published": true,
3554
+ "requires_js": true,
3441
3555
  "component": "Overlay",
3442
3556
  "status": "alpha",
3443
3557
  "a11y_reviewed": false,
@@ -3654,51 +3768,18 @@
3654
3768
  ],
3655
3769
  "subcomponents": [
3656
3770
  {
3657
- "fully_qualified_name": "Primer::Alpha::Overlay::Header",
3658
- "description": "A `Overlay::Header` is a compositional component, used to render the\nHeader of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
3659
- "component": "Overlay::Header",
3771
+ "fully_qualified_name": "Primer::Alpha::Overlay::Body",
3772
+ "description": "A `Overlay::Body` is a compositional component, used to render the\nBody of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
3773
+ "is_form_component": false,
3774
+ "is_published": true,
3775
+ "requires_js": false,
3776
+ "component": "Overlay::Body",
3660
3777
  "status": "alpha",
3661
3778
  "a11y_reviewed": false,
3662
- "short_name": "OverlayHeader",
3663
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/header.rb",
3664
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/header/default/",
3779
+ "short_name": "OverlayBody",
3780
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb",
3781
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/",
3665
3782
  "parameters": [
3666
- {
3667
- "name": "title",
3668
- "type": "String",
3669
- "default": "N/A",
3670
- "description": "Describes the content of the Overlay."
3671
- },
3672
- {
3673
- "name": "subtitle",
3674
- "type": "String",
3675
- "default": "`nil`",
3676
- "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute."
3677
- },
3678
- {
3679
- "name": "overlay_id",
3680
- "type": "String",
3681
- "default": "`nil`",
3682
- "description": "Provides the id of the overlay element so the close button can close it"
3683
- },
3684
- {
3685
- "name": "size",
3686
- "type": "Symbol",
3687
- "default": "`:medium`",
3688
- "description": "The size of the Header. One of `:large` or `:medium`."
3689
- },
3690
- {
3691
- "name": "divider",
3692
- "type": "Boolean",
3693
- "default": "`false`",
3694
- "description": "Show a divider between the header and body."
3695
- },
3696
- {
3697
- "name": "visually_hide_title",
3698
- "type": "Boolean",
3699
- "default": "`false`",
3700
- "description": "Visually hide the `title` while maintaining a label for assistive technologies."
3701
- },
3702
3783
  {
3703
3784
  "name": "system_arguments",
3704
3785
  "type": "Hash",
@@ -3722,6 +3803,9 @@
3722
3803
  {
3723
3804
  "fully_qualified_name": "Primer::Alpha::Overlay::Footer",
3724
3805
  "description": "A `Overlay::Footer` is a compositional component, used to render the\nFooter of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
3806
+ "is_form_component": false,
3807
+ "is_published": true,
3808
+ "requires_js": false,
3725
3809
  "component": "Overlay::Footer",
3726
3810
  "status": "alpha",
3727
3811
  "a11y_reviewed": false,
@@ -3762,15 +3846,54 @@
3762
3846
  ]
3763
3847
  },
3764
3848
  {
3765
- "fully_qualified_name": "Primer::Alpha::Overlay::Body",
3766
- "description": "A `Overlay::Body` is a compositional component, used to render the\nBody of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
3767
- "component": "Overlay::Body",
3849
+ "fully_qualified_name": "Primer::Alpha::Overlay::Header",
3850
+ "description": "A `Overlay::Header` is a compositional component, used to render the\nHeader of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
3851
+ "is_form_component": false,
3852
+ "is_published": true,
3853
+ "requires_js": false,
3854
+ "component": "Overlay::Header",
3768
3855
  "status": "alpha",
3769
3856
  "a11y_reviewed": false,
3770
- "short_name": "OverlayBody",
3771
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb",
3772
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/",
3857
+ "short_name": "OverlayHeader",
3858
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/header.rb",
3859
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/header/default/",
3773
3860
  "parameters": [
3861
+ {
3862
+ "name": "title",
3863
+ "type": "String",
3864
+ "default": "N/A",
3865
+ "description": "Describes the content of the Overlay."
3866
+ },
3867
+ {
3868
+ "name": "subtitle",
3869
+ "type": "String",
3870
+ "default": "`nil`",
3871
+ "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute."
3872
+ },
3873
+ {
3874
+ "name": "overlay_id",
3875
+ "type": "String",
3876
+ "default": "`nil`",
3877
+ "description": "Provides the id of the overlay element so the close button can close it"
3878
+ },
3879
+ {
3880
+ "name": "size",
3881
+ "type": "Symbol",
3882
+ "default": "`:medium`",
3883
+ "description": "The size of the Header. One of `:large` or `:medium`."
3884
+ },
3885
+ {
3886
+ "name": "divider",
3887
+ "type": "Boolean",
3888
+ "default": "`false`",
3889
+ "description": "Show a divider between the header and body."
3890
+ },
3891
+ {
3892
+ "name": "visually_hide_title",
3893
+ "type": "Boolean",
3894
+ "default": "`false`",
3895
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
3896
+ },
3774
3897
  {
3775
3898
  "name": "system_arguments",
3776
3899
  "type": "Hash",
@@ -3796,6 +3919,9 @@
3796
3919
  {
3797
3920
  "fully_qualified_name": "Primer::Alpha::RadioButton",
3798
3921
  "description": "Radio buttons represent one of a set of options and are rendered as `<input type=\"radio\">` in HTML.\n**NOTE**: You probably want to use the {{#link_to_component}}Primer::Alpha::RadioButtonGroup{{/link_to_component}}\ncomponent instead, as it allows rendering a group of options.",
3922
+ "is_form_component": true,
3923
+ "is_published": false,
3924
+ "requires_js": false,
3799
3925
  "component": "RadioButton",
3800
3926
  "status": "alpha",
3801
3927
  "a11y_reviewed": false,
@@ -3942,6 +4068,9 @@
3942
4068
  {
3943
4069
  "fully_qualified_name": "Primer::Alpha::RadioButtonGroup",
3944
4070
  "description": "A group of mutually exclusive radio buttons.",
4071
+ "is_form_component": true,
4072
+ "is_published": false,
4073
+ "requires_js": false,
3945
4074
  "component": "RadioButtonGroup",
3946
4075
  "status": "alpha",
3947
4076
  "a11y_reviewed": false,
@@ -4027,6 +4156,9 @@
4027
4156
  {
4028
4157
  "fully_qualified_name": "Primer::Alpha::SegmentedControl",
4029
4158
  "description": "Use a segmented control to let users select an option from a short list and immediately apply the selection",
4159
+ "is_form_component": false,
4160
+ "is_published": true,
4161
+ "requires_js": false,
4030
4162
  "component": "SegmentedControl",
4031
4163
  "status": "alpha",
4032
4164
  "a11y_reviewed": true,
@@ -4117,6 +4249,9 @@
4117
4249
  {
4118
4250
  "fully_qualified_name": "Primer::Alpha::SegmentedControl::Item",
4119
4251
  "description": "SegmentedControl::Item is a private component that is only used by SegmentedControl\nIt wraps the Button and IconButton components to provide the correct styles",
4252
+ "is_form_component": false,
4253
+ "is_published": true,
4254
+ "requires_js": false,
4120
4255
  "component": "SegmentedControl::Item",
4121
4256
  "status": "alpha",
4122
4257
  "a11y_reviewed": true,
@@ -4167,6 +4302,9 @@
4167
4302
  {
4168
4303
  "fully_qualified_name": "Primer::Alpha::Select",
4169
4304
  "description": "Select lists are single-line text inputs rendered as `<select>` tags in HTML.",
4305
+ "is_form_component": true,
4306
+ "is_published": false,
4307
+ "requires_js": false,
4170
4308
  "component": "Select",
4171
4309
  "status": "alpha",
4172
4310
  "a11y_reviewed": false,
@@ -4354,6 +4492,9 @@
4354
4492
  {
4355
4493
  "fully_qualified_name": "Primer::Alpha::SubmitButton",
4356
4494
  "description": "A submit button input rendered using the HTML `<button type=\"submit\">` tag.\n\nThis component wraps the Primer button component and supports the same slots and arguments.",
4495
+ "is_form_component": true,
4496
+ "is_published": false,
4497
+ "requires_js": false,
4357
4498
  "component": "SubmitButton",
4358
4499
  "status": "alpha",
4359
4500
  "a11y_reviewed": false,
@@ -4426,6 +4567,9 @@
4426
4567
  {
4427
4568
  "fully_qualified_name": "Primer::Alpha::TabContainer",
4428
4569
  "description": "Use `TabContainer` to create tabbed content with keyboard support. This component does not add any styles.\nIt only provides the tab functionality. If you want styled Tabs you can look at {{#link_to_component}}Primer::Alpha::TabNav{{/link_to_component}}.\n\nThis component requires javascript.",
4570
+ "is_form_component": false,
4571
+ "is_published": true,
4572
+ "requires_js": true,
4429
4573
  "component": "TabContainer",
4430
4574
  "status": "alpha",
4431
4575
  "a11y_reviewed": false,
@@ -4456,6 +4600,9 @@
4456
4600
  {
4457
4601
  "fully_qualified_name": "Primer::Alpha::TabNav",
4458
4602
  "description": "Use `TabNav` to style navigation with a tab-based selected state, typically used for navigation placed at the top of the page.\nFor panel navigation, use {{#link_to_component}}Primer::Alpha::TabPanels{{/link_to_component}} instead.",
4603
+ "is_form_component": false,
4604
+ "is_published": true,
4605
+ "requires_js": false,
4459
4606
  "component": "TabNav",
4460
4607
  "status": "alpha",
4461
4608
  "a11y_reviewed": false,
@@ -4552,6 +4699,9 @@
4552
4699
  {
4553
4700
  "fully_qualified_name": "Primer::Alpha::TabPanels",
4554
4701
  "description": "Use `TabPanels` for tabs with panel navigation.",
4702
+ "is_form_component": false,
4703
+ "is_published": true,
4704
+ "requires_js": true,
4555
4705
  "component": "TabPanels",
4556
4706
  "status": "alpha",
4557
4707
  "a11y_reviewed": false,
@@ -4655,6 +4805,9 @@
4655
4805
  {
4656
4806
  "fully_qualified_name": "Primer::Alpha::TextArea",
4657
4807
  "description": "Text areas are multi-line text inputs rendered using the `<textarea>` tag in HTML.",
4808
+ "is_form_component": true,
4809
+ "is_published": false,
4810
+ "requires_js": false,
4658
4811
  "component": "TextArea",
4659
4812
  "status": "alpha",
4660
4813
  "a11y_reviewed": false,
@@ -4807,6 +4960,9 @@
4807
4960
  {
4808
4961
  "fully_qualified_name": "Primer::Alpha::TextField",
4809
4962
  "description": "Text fields are single-line text inputs rendered as `<input type=\"text\">` in HTML.",
4963
+ "is_form_component": true,
4964
+ "is_published": true,
4965
+ "requires_js": false,
4810
4966
  "component": "TextField",
4811
4967
  "status": "alpha",
4812
4968
  "a11y_reviewed": false,
@@ -5022,6 +5178,9 @@
5022
5178
  {
5023
5179
  "fully_qualified_name": "Primer::Alpha::ToggleSwitch",
5024
5180
  "description": "The ToggleSwitch component is a button that toggles between two boolean states. It is meant to be used for\nsettings that should cause an immediate update. If configured with a \"src\" attribute, the component will\nmake a POST request containing data of the form \"value: 0 | 1\".",
5181
+ "is_form_component": false,
5182
+ "is_published": true,
5183
+ "requires_js": true,
5025
5184
  "component": "ToggleSwitch",
5026
5185
  "status": "alpha",
5027
5186
  "a11y_reviewed": false,
@@ -5142,6 +5301,9 @@
5142
5301
  {
5143
5302
  "fully_qualified_name": "Primer::Alpha::Tooltip",
5144
5303
  "description": "`Tooltip` only appears on mouse hover or keyboard focus and contain a label or description text. Use tooltips sparingly and as a last resort.\nUse tooltips as a last resort. Please consider [Tooltips alternatives](https://primer.style/design/accessibility/tooltip-alternatives).\n\nWhen using a tooltip, follow the provided guidelines to avoid accessibility issues:\n- Tooltips should contain only **non-essential text**. Tooltips can easily be missed and are not accessible on touch devices so never use tooltips to convey critical information.\n- `Tooltip` should be rendered through the API of {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}}, {{#link_to_component}}Primer::Beta::Link{{/link_to_component}}, or {{#link_to_component}}Primer::IconButton{{/link_to_component}}. Avoid using `Tooltip` a standalone component unless absolutely necessary (and **only** on interactive elements).",
5304
+ "is_form_component": false,
5305
+ "is_published": true,
5306
+ "requires_js": true,
5145
5307
  "component": "Tooltip",
5146
5308
  "status": "alpha",
5147
5309
  "a11y_reviewed": false,
@@ -5230,6 +5392,9 @@
5230
5392
  {
5231
5393
  "fully_qualified_name": "Primer::Alpha::UnderlineNav",
5232
5394
  "description": "Use `UnderlineNav` to style navigation links with a minimal\nunderlined selected state, typically placed at the top\nof the page.\n\nFor panel navigation, use {{#link_to_component}}Primer::Alpha::UnderlinePanels{{/link_to_component}} instead.",
5395
+ "is_form_component": false,
5396
+ "is_published": true,
5397
+ "requires_js": false,
5233
5398
  "component": "UnderlineNav",
5234
5399
  "status": "alpha",
5235
5400
  "a11y_reviewed": false,
@@ -5333,6 +5498,9 @@
5333
5498
  {
5334
5499
  "fully_qualified_name": "Primer::Alpha::UnderlinePanels",
5335
5500
  "description": "Use `UnderlinePanels` to style tabs with an associated panel and an underlined selected state.",
5501
+ "is_form_component": false,
5502
+ "is_published": true,
5503
+ "requires_js": true,
5336
5504
  "component": "UnderlinePanels",
5337
5505
  "status": "alpha",
5338
5506
  "a11y_reviewed": false,
@@ -5437,6 +5605,9 @@
5437
5605
  {
5438
5606
  "fully_qualified_name": "Primer::Beta::AutoComplete",
5439
5607
  "description": "Use `AutoComplete` to provide a user with a list of selectable suggestions that appear when they type into the\ninput field. This list is populated by server search results.",
5608
+ "is_form_component": false,
5609
+ "is_published": true,
5610
+ "requires_js": true,
5440
5611
  "component": "AutoComplete",
5441
5612
  "status": "beta",
5442
5613
  "a11y_reviewed": false,
@@ -5668,6 +5839,9 @@
5668
5839
  {
5669
5840
  "fully_qualified_name": "Primer::Beta::AutoComplete::Item",
5670
5841
  "description": "Use `AutoCompleteItem` to list results of an auto-completed search.",
5842
+ "is_form_component": false,
5843
+ "is_published": true,
5844
+ "requires_js": false,
5671
5845
  "component": "AutoComplete::Item",
5672
5846
  "status": "beta",
5673
5847
  "a11y_reviewed": false,
@@ -5779,6 +5953,9 @@
5779
5953
  {
5780
5954
  "fully_qualified_name": "Primer::Beta::Avatar",
5781
5955
  "description": "`Avatar` can be used to represent users and organizations on GitHub.\n\n- Use the default circle avatar for users, and the square shape\nfor organizations or any other non-human avatars.\n- By default, `Avatar` will render a static `<img>`. To have `Avatar` function as a link, set the `href` which will wrap the `<img>` in a `<a>`.\n- Set `size` to update the height and width of the `Avatar` in pixels.\n- To stack multiple avatars together, use {{#link_to_component}}Primer::Beta::AvatarStack{{/link_to_component}}.",
5956
+ "is_form_component": false,
5957
+ "is_published": true,
5958
+ "requires_js": false,
5782
5959
  "component": "Avatar",
5783
5960
  "status": "beta",
5784
5961
  "a11y_reviewed": false,
@@ -5863,6 +6040,9 @@
5863
6040
  {
5864
6041
  "fully_qualified_name": "Primer::Beta::AvatarStack",
5865
6042
  "description": "Use `AvatarStack` to stack multiple avatars together.",
6043
+ "is_form_component": false,
6044
+ "is_published": true,
6045
+ "requires_js": false,
5866
6046
  "component": "AvatarStack",
5867
6047
  "status": "beta",
5868
6048
  "a11y_reviewed": false,
@@ -5947,6 +6127,9 @@
5947
6127
  {
5948
6128
  "fully_qualified_name": "Primer::Beta::BaseButton",
5949
6129
  "description": "Use `BaseButton` to render an unstyled `<button>` tag that can be customized.",
6130
+ "is_form_component": false,
6131
+ "is_published": true,
6132
+ "requires_js": false,
5950
6133
  "component": "BaseButton",
5951
6134
  "status": "beta",
5952
6135
  "a11y_reviewed": false,
@@ -6004,6 +6187,9 @@
6004
6187
  {
6005
6188
  "fully_qualified_name": "Primer::Beta::Blankslate",
6006
6189
  "description": "Use `Blankslate` when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.",
6190
+ "is_form_component": false,
6191
+ "is_published": true,
6192
+ "requires_js": false,
6007
6193
  "component": "Blankslate",
6008
6194
  "status": "beta",
6009
6195
  "a11y_reviewed": false,
@@ -6178,6 +6364,9 @@
6178
6364
  {
6179
6365
  "fully_qualified_name": "Primer::Beta::BorderBox",
6180
6366
  "description": "`BorderBox` is a Box component with a border.",
6367
+ "is_form_component": false,
6368
+ "is_published": true,
6369
+ "requires_js": false,
6181
6370
  "component": "BorderBox",
6182
6371
  "status": "beta",
6183
6372
  "a11y_reviewed": false,
@@ -6288,6 +6477,9 @@
6288
6477
  {
6289
6478
  "fully_qualified_name": "Primer::Beta::BorderBox::Header",
6290
6479
  "description": "`BorderBox::Header` is used inside `BorderBox` to render its header slot.",
6480
+ "is_form_component": false,
6481
+ "is_published": true,
6482
+ "requires_js": false,
6291
6483
  "component": "BorderBox::Header",
6292
6484
  "status": "beta",
6293
6485
  "a11y_reviewed": false,
@@ -6337,6 +6529,9 @@
6337
6529
  {
6338
6530
  "fully_qualified_name": "Primer::Beta::Breadcrumbs",
6339
6531
  "description": "Use `Breadcrumbs` to display page hierarchy.\n\n#### Known issues\n\n##### Responsiveness\n\n`Breadcrumbs` is not optimized for responsive designs.",
6532
+ "is_form_component": false,
6533
+ "is_published": true,
6534
+ "requires_js": false,
6340
6535
  "component": "Breadcrumbs",
6341
6536
  "status": "beta",
6342
6537
  "a11y_reviewed": false,
@@ -6390,6 +6585,9 @@
6390
6585
  {
6391
6586
  "fully_qualified_name": "Primer::Beta::Breadcrumbs::Item",
6392
6587
  "description": "This component is part of `Primer::Beta::Breadcrumbs` and should not be\nused as a standalone component.",
6588
+ "is_form_component": false,
6589
+ "is_published": true,
6590
+ "requires_js": false,
6393
6591
  "component": "Breadcrumbs::Item",
6394
6592
  "status": "alpha",
6395
6593
  "a11y_reviewed": false,
@@ -6454,6 +6652,9 @@
6454
6652
  {
6455
6653
  "fully_qualified_name": "Primer::Beta::Button",
6456
6654
  "description": "Use `Button` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
6655
+ "is_form_component": false,
6656
+ "is_published": true,
6657
+ "requires_js": false,
6457
6658
  "component": "Button",
6458
6659
  "status": "beta",
6459
6660
  "a11y_reviewed": false,
@@ -6647,6 +6848,9 @@
6647
6848
  {
6648
6849
  "fully_qualified_name": "Primer::Beta::ButtonGroup",
6649
6850
  "description": "Use `ButtonGroup` to render a series of buttons.",
6851
+ "is_form_component": false,
6852
+ "is_published": true,
6853
+ "requires_js": false,
6650
6854
  "component": "ButtonGroup",
6651
6855
  "status": "beta",
6652
6856
  "a11y_reviewed": false,
@@ -6709,6 +6913,9 @@
6709
6913
  {
6710
6914
  "fully_qualified_name": "Primer::Beta::ClipboardCopy",
6711
6915
  "description": "Use `ClipboardCopy` to copy element text content or input values to the clipboard.",
6916
+ "is_form_component": false,
6917
+ "is_published": true,
6918
+ "requires_js": true,
6712
6919
  "component": "ClipboardCopy",
6713
6920
  "status": "beta",
6714
6921
  "a11y_reviewed": false,
@@ -6776,6 +6983,9 @@
6776
6983
  {
6777
6984
  "fully_qualified_name": "Primer::Beta::CloseButton",
6778
6985
  "description": "Use `CloseButton` to render an `×` without default button styles.\n\n[0]: https://primer.style/view-components/system-arguments#html-attributes",
6986
+ "is_form_component": false,
6987
+ "is_published": true,
6988
+ "requires_js": false,
6779
6989
  "component": "CloseButton",
6780
6990
  "status": "beta",
6781
6991
  "a11y_reviewed": false,
@@ -6821,6 +7031,9 @@
6821
7031
  {
6822
7032
  "fully_qualified_name": "Primer::Beta::Counter",
6823
7033
  "description": "Use `Counter` to add a count to navigational elements and buttons.",
7034
+ "is_form_component": false,
7035
+ "is_published": true,
7036
+ "requires_js": false,
6824
7037
  "component": "Counter",
6825
7038
  "status": "beta",
6826
7039
  "a11y_reviewed": false,
@@ -6911,6 +7124,9 @@
6911
7124
  {
6912
7125
  "fully_qualified_name": "Primer::Beta::Details",
6913
7126
  "description": "Use `DetailsComponent` to reveal content after clicking a button.",
7127
+ "is_form_component": false,
7128
+ "is_published": true,
7129
+ "requires_js": false,
6914
7130
  "component": "Details",
6915
7131
  "status": "beta",
6916
7132
  "a11y_reviewed": false,
@@ -7007,6 +7223,9 @@
7007
7223
  {
7008
7224
  "fully_qualified_name": "Primer::Beta::Flash",
7009
7225
  "description": "Use `Flash` to inform users of successful or pending actions.",
7226
+ "is_form_component": false,
7227
+ "is_published": true,
7228
+ "requires_js": false,
7010
7229
  "component": "Flash",
7011
7230
  "status": "beta",
7012
7231
  "a11y_reviewed": false,
@@ -7097,6 +7316,9 @@
7097
7316
  {
7098
7317
  "fully_qualified_name": "Primer::Beta::Heading",
7099
7318
  "description": "`Heading` should be used to communicate page organization and hierarchy.\n\n- Set tag to one of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, `:h6` based on what is appropriate for the page context.\n- Use `Heading` as the title of a section or sub section.\n- Do not use `Heading` for styling alone. For simply styling text, consider using {{#link_to_component}}Primer::Beta::Text{{/link_to_component}} with relevant {{link_to_typography_docs}}\n such as `font_size` and `font_weight`.\n- Do not jump heading levels. For instance, do not follow a `<h1>` with an `<h3>`. Heading levels should increase by one in ascending order.",
7319
+ "is_form_component": false,
7320
+ "is_published": true,
7321
+ "requires_js": false,
7100
7322
  "component": "Heading",
7101
7323
  "status": "beta",
7102
7324
  "a11y_reviewed": false,
@@ -7142,6 +7364,9 @@
7142
7364
  {
7143
7365
  "fully_qualified_name": "Primer::Beta::IconButton",
7144
7366
  "description": "Use `IconButton` to render Icon-only buttons without the default button styles.\n\n`IconButton` will always render with a tooltip unless the tag is `:summary`.\n`IconButton` will always render with a tooltip unless the tag is `:summary`.",
7367
+ "is_form_component": false,
7368
+ "is_published": true,
7369
+ "requires_js": false,
7145
7370
  "component": "IconButton",
7146
7371
  "status": "beta",
7147
7372
  "a11y_reviewed": false,
@@ -7251,6 +7476,9 @@
7251
7476
  {
7252
7477
  "fully_qualified_name": "Primer::Beta::Label",
7253
7478
  "description": "Use `Label` to add contextual metadata to a design.",
7479
+ "is_form_component": false,
7480
+ "is_published": true,
7481
+ "requires_js": false,
7254
7482
  "component": "Label",
7255
7483
  "status": "beta",
7256
7484
  "a11y_reviewed": false,
@@ -7335,6 +7563,9 @@
7335
7563
  {
7336
7564
  "fully_qualified_name": "Primer::Beta::Link",
7337
7565
  "description": "Use `Link` for navigating from one page to another. `Link` styles anchor tags with default blue styling and hover text-decoration.",
7566
+ "is_form_component": false,
7567
+ "is_published": true,
7568
+ "requires_js": true,
7338
7569
  "component": "Link",
7339
7570
  "status": "beta",
7340
7571
  "a11y_reviewed": false,
@@ -7431,6 +7662,9 @@
7431
7662
  {
7432
7663
  "fully_qualified_name": "Primer::Beta::Markdown",
7433
7664
  "description": "Use `Markdown` to wrap markdown content.",
7665
+ "is_form_component": false,
7666
+ "is_published": true,
7667
+ "requires_js": false,
7434
7668
  "component": "Markdown",
7435
7669
  "status": "beta",
7436
7670
  "a11y_reviewed": false,
@@ -7476,6 +7710,9 @@
7476
7710
  {
7477
7711
  "fully_qualified_name": "Primer::Beta::Octicon",
7478
7712
  "description": "`Octicon` renders an {{link_to_octicons}} with {{link_to_system_arguments_docs}}.\n`Octicon` can also be rendered with the `primer_octicon` helper, which accepts the same arguments.",
7713
+ "is_form_component": false,
7714
+ "is_published": true,
7715
+ "requires_js": false,
7479
7716
  "component": "Octicon",
7480
7717
  "status": "beta",
7481
7718
  "a11y_reviewed": false,
@@ -7539,6 +7776,9 @@
7539
7776
  {
7540
7777
  "fully_qualified_name": "Primer::Beta::Popover",
7541
7778
  "description": "Use `Popover` to bring attention to specific user interface elements, typically to suggest an action or to guide users through a new experience.\n\nBy default, the popover renders with absolute positioning, meaning it should usually be wrapped in an element with a relative position in order to be positioned properly. To render the popover with relative positioning, use the relative property.",
7779
+ "is_form_component": false,
7780
+ "is_published": true,
7781
+ "requires_js": false,
7542
7782
  "component": "Popover",
7543
7783
  "status": "beta",
7544
7784
  "a11y_reviewed": false,
@@ -7629,6 +7869,9 @@
7629
7869
  {
7630
7870
  "fully_qualified_name": "Primer::Beta::ProgressBar",
7631
7871
  "description": "Use `ProgressBar` to visualize task completion.",
7872
+ "is_form_component": false,
7873
+ "is_published": true,
7874
+ "requires_js": false,
7632
7875
  "component": "ProgressBar",
7633
7876
  "status": "beta",
7634
7877
  "a11y_reviewed": false,
@@ -7702,6 +7945,9 @@
7702
7945
  {
7703
7946
  "fully_qualified_name": "Primer::Beta::RelativeTime",
7704
7947
  "description": "Formats a timestamp as a localized string or as relative text that auto-updates in the user's browser.",
7948
+ "is_form_component": false,
7949
+ "is_published": true,
7950
+ "requires_js": false,
7705
7951
  "component": "RelativeTime",
7706
7952
  "status": "beta",
7707
7953
  "a11y_reviewed": false,
@@ -7858,6 +8104,9 @@
7858
8104
  {
7859
8105
  "fully_qualified_name": "Primer::Beta::Spinner",
7860
8106
  "description": "Use `Spinner` to let users know that content is being loaded.",
8107
+ "is_form_component": false,
8108
+ "is_published": true,
8109
+ "requires_js": false,
7861
8110
  "component": "Spinner",
7862
8111
  "status": "beta",
7863
8112
  "a11y_reviewed": false,
@@ -7909,6 +8158,9 @@
7909
8158
  {
7910
8159
  "fully_qualified_name": "Primer::Beta::State",
7911
8160
  "description": "Use `State` for rendering the status of an item.",
8161
+ "is_form_component": false,
8162
+ "is_published": true,
8163
+ "requires_js": false,
7912
8164
  "component": "State",
7913
8165
  "status": "beta",
7914
8166
  "a11y_reviewed": false,
@@ -7982,6 +8234,9 @@
7982
8234
  {
7983
8235
  "fully_qualified_name": "Primer::Beta::Subhead",
7984
8236
  "description": "Use `Subhead` as the start of a section. The `:heading` slot will render an `<h2>` font-sized text.\n\n- Optionally set the `:description` slot to render a short description and the `:actions` slot for a related action.\n- Use a succinct, one-line description for the `:description` slot. For longer descriptions, omit the description slot and render a paragraph below the `Subhead`.\n- Use the actions slot to render a related action to the right of the heading. Use {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}} or {{#link_to_component}}Primer::Beta::Link{{/link_to_component}}.",
8237
+ "is_form_component": false,
8238
+ "is_published": true,
8239
+ "requires_js": false,
7985
8240
  "component": "Subhead",
7986
8241
  "status": "beta",
7987
8242
  "a11y_reviewed": false,
@@ -8095,6 +8350,9 @@
8095
8350
  {
8096
8351
  "fully_qualified_name": "Primer::Beta::Text",
8097
8352
  "description": "`Text` is a wrapper component that will apply typography styles to the text inside.",
8353
+ "is_form_component": false,
8354
+ "is_published": true,
8355
+ "requires_js": false,
8098
8356
  "component": "Text",
8099
8357
  "status": "beta",
8100
8358
  "a11y_reviewed": false,
@@ -8140,6 +8398,9 @@
8140
8398
  {
8141
8399
  "fully_qualified_name": "Primer::Beta::TimelineItem",
8142
8400
  "description": "Use `TimelineItem` to display items on a vertical timeline, connected by badge elements.",
8401
+ "is_form_component": false,
8402
+ "is_published": true,
8403
+ "requires_js": false,
8143
8404
  "component": "TimelineItem",
8144
8405
  "status": "beta",
8145
8406
  "a11y_reviewed": false,
@@ -8223,6 +8484,9 @@
8223
8484
  {
8224
8485
  "fully_qualified_name": "Primer::Beta::TimelineItem::Badge",
8225
8486
  "description": "This component is part of `Primer::Beta::TimelineItem` and should not be\nused as a standalone component.",
8487
+ "is_form_component": false,
8488
+ "is_published": true,
8489
+ "requires_js": false,
8226
8490
  "component": "TimelineItem::Badge",
8227
8491
  "status": "beta",
8228
8492
  "a11y_reviewed": false,
@@ -8250,6 +8514,9 @@
8250
8514
  {
8251
8515
  "fully_qualified_name": "Primer::Beta::Truncate",
8252
8516
  "description": "Use `Truncate` to shorten overflowing text with an ellipsis.",
8517
+ "is_form_component": false,
8518
+ "is_published": true,
8519
+ "requires_js": false,
8253
8520
  "component": "Truncate",
8254
8521
  "status": "beta",
8255
8522
  "a11y_reviewed": false,
@@ -8330,6 +8597,9 @@
8330
8597
  {
8331
8598
  "fully_qualified_name": "Primer::Beta::Truncate::TruncateText",
8332
8599
  "description": "This component is part of `Primer::Beta::Truncate` and should not be\nused as a standalone component.",
8600
+ "is_form_component": false,
8601
+ "is_published": true,
8602
+ "requires_js": false,
8333
8603
  "component": "Truncate::TruncateText",
8334
8604
  "status": "alpha",
8335
8605
  "a11y_reviewed": false,
@@ -8357,6 +8627,9 @@
8357
8627
  {
8358
8628
  "fully_qualified_name": "Primer::BlankslateComponent",
8359
8629
  "description": "Use `Blankslate` when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.",
8630
+ "is_form_component": false,
8631
+ "is_published": true,
8632
+ "requires_js": false,
8360
8633
  "component": "Blankslate",
8361
8634
  "status": "deprecated",
8362
8635
  "a11y_reviewed": false,
@@ -8488,6 +8761,9 @@
8488
8761
  {
8489
8762
  "fully_qualified_name": "Primer::Box",
8490
8763
  "description": "`Box` is a basic wrapper component for most layout related needs.",
8764
+ "is_form_component": false,
8765
+ "is_published": true,
8766
+ "requires_js": false,
8491
8767
  "component": "Box",
8492
8768
  "status": "stable",
8493
8769
  "a11y_reviewed": false,
@@ -8537,6 +8813,9 @@
8537
8813
  {
8538
8814
  "fully_qualified_name": "Primer::ButtonComponent",
8539
8815
  "description": "Use `Button` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
8816
+ "is_form_component": false,
8817
+ "is_published": true,
8818
+ "requires_js": true,
8540
8819
  "component": "Button",
8541
8820
  "status": "deprecated",
8542
8821
  "a11y_reviewed": false,
@@ -8669,6 +8948,9 @@
8669
8948
  {
8670
8949
  "fully_qualified_name": "Primer::ConditionalWrapper",
8671
8950
  "description": "Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition\nis true, a `Primer::BaseComponent` will render around the content. If the condition is false, only\nthe content is rendered.",
8951
+ "is_form_component": false,
8952
+ "is_published": true,
8953
+ "requires_js": false,
8672
8954
  "component": "ConditionalWrapper",
8673
8955
  "status": "alpha",
8674
8956
  "a11y_reviewed": false,
@@ -8694,6 +8976,9 @@
8694
8976
  {
8695
8977
  "fully_qualified_name": "Primer::Content",
8696
8978
  "description": "Use `Content` as a helper to render content passed to a slot without adding any tags.",
8979
+ "is_form_component": false,
8980
+ "is_published": true,
8981
+ "requires_js": false,
8697
8982
  "component": "Content",
8698
8983
  "status": "stable",
8699
8984
  "a11y_reviewed": false,
@@ -8719,6 +9004,9 @@
8719
9004
  {
8720
9005
  "fully_qualified_name": "Primer::IconButton",
8721
9006
  "description": "Use `IconButton` to render Icon-only buttons without the default button styles.\n\n`IconButton` will always render with a tooltip unless the tag is `:summary`.",
9007
+ "is_form_component": false,
9008
+ "is_published": true,
9009
+ "requires_js": true,
8722
9010
  "component": "IconButton",
8723
9011
  "status": "deprecated",
8724
9012
  "a11y_reviewed": false,
@@ -8797,6 +9085,9 @@
8797
9085
  {
8798
9086
  "fully_qualified_name": "Primer::LayoutComponent",
8799
9087
  "description": "Use `Layout` to build a main/sidebar layout.",
9088
+ "is_form_component": false,
9089
+ "is_published": true,
9090
+ "requires_js": false,
8800
9091
  "component": "Layout",
8801
9092
  "status": "deprecated",
8802
9093
  "a11y_reviewed": false,
@@ -8868,6 +9159,9 @@
8868
9159
  {
8869
9160
  "fully_qualified_name": "Primer::Navigation::TabComponent",
8870
9161
  "description": "nodoc",
9162
+ "is_form_component": false,
9163
+ "is_published": true,
9164
+ "requires_js": false,
8871
9165
  "component": "Navigation::Tab",
8872
9166
  "status": "deprecated",
8873
9167
  "a11y_reviewed": false,
@@ -8981,6 +9275,9 @@
8981
9275
  {
8982
9276
  "fully_qualified_name": "Primer::Tooltip",
8983
9277
  "description": "`Tooltip` is a wrapper component that will apply a tooltip to the provided content.",
9278
+ "is_form_component": false,
9279
+ "is_published": true,
9280
+ "requires_js": false,
8984
9281
  "component": "Tooltip",
8985
9282
  "status": "deprecated",
8986
9283
  "a11y_reviewed": false,
@@ -9041,6 +9338,9 @@
9041
9338
  {
9042
9339
  "fully_qualified_name": "Primer::Truncate",
9043
9340
  "description": "Use `Truncate` to shorten overflowing text with an ellipsis.",
9341
+ "is_form_component": false,
9342
+ "is_published": true,
9343
+ "requires_js": false,
9044
9344
  "component": "Truncate",
9045
9345
  "status": "deprecated",
9046
9346
  "a11y_reviewed": false,