jekyll-v4-theme-primer 0.11.0 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (111) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -3
  3. data/_sass/@primer/css/base/normalize.scss +1 -0
  4. data/_sass/@primer/css/core/index.scss +0 -1
  5. data/_sass/@primer/css/forms/form-group.scss +2 -1
  6. data/_sass/@primer/css/forms/index.scss +0 -1
  7. data/_sass/@primer/css/labels/index.scss +0 -1
  8. data/_sass/@primer/css/layout/app-frame.scss +6 -6
  9. data/_sass/@primer/css/layout/stack.scss +6 -6
  10. data/_sass/@primer/css/markdown/lists.scss +4 -4
  11. data/_sass/@primer/css/primitives/index.scss +9 -9
  12. data/_sass/@primer/css/support/variables/misc.scss +1 -1
  13. data/_sass/@primer/css/utilities/borders.scss +8 -8
  14. data/_sass/@primer/css/utilities/visibility-display.scss +10 -9
  15. data/_sass/@primer/view-components/app/assets/javascripts/primer_view_components.js +1 -1
  16. data/_sass/@primer/view-components/app/assets/javascripts/primer_view_components.js.map +1 -1
  17. data/_sass/@primer/view-components/app/assets/styles/primer_view_components.css +3 -3
  18. data/_sass/@primer/view-components/app/assets/styles/primer_view_components.css.map +1 -1
  19. data/_sass/@primer/view-components/app/components/primer/alpha/action_list.css +1 -1
  20. data/_sass/@primer/view-components/app/components/primer/alpha/action_list.css.json +131 -1
  21. data/_sass/@primer/view-components/app/components/primer/alpha/action_menu/action_menu_element.d.ts +29 -0
  22. data/_sass/@primer/view-components/app/components/primer/alpha/action_menu/action_menu_element.js +217 -0
  23. data/_sass/@primer/view-components/app/components/primer/alpha/auto_complete.css +1 -1
  24. data/_sass/@primer/view-components/app/components/primer/alpha/auto_complete.css.json +23 -1
  25. data/_sass/@primer/view-components/app/components/primer/alpha/banner.css +1 -1
  26. data/_sass/@primer/view-components/app/components/primer/alpha/banner.css.json +24 -1
  27. data/_sass/@primer/view-components/app/components/primer/alpha/button_marketing.css.json +33 -1
  28. data/_sass/@primer/view-components/app/components/primer/alpha/dialog.css +1 -1
  29. data/_sass/@primer/view-components/app/components/primer/alpha/dialog.css.json +80 -1
  30. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.css +1 -1
  31. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.css.json +40 -1
  32. data/_sass/@primer/view-components/app/components/primer/alpha/layout.css +1 -1
  33. data/_sass/@primer/view-components/app/components/primer/alpha/layout.css.json +80 -1
  34. data/_sass/@primer/view-components/app/components/primer/alpha/menu.css +1 -1
  35. data/_sass/@primer/view-components/app/components/primer/alpha/menu.css.json +28 -1
  36. data/_sass/@primer/view-components/app/components/primer/alpha/modal_dialog.js +12 -0
  37. data/_sass/@primer/view-components/app/components/primer/alpha/nav_list.d.ts +7 -4
  38. data/_sass/@primer/view-components/app/components/primer/alpha/nav_list.js +121 -9
  39. data/_sass/@primer/view-components/app/components/primer/alpha/overlay.css +1 -0
  40. data/_sass/@primer/view-components/app/components/primer/alpha/overlay.css.json +8 -0
  41. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.css +1 -1
  42. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.css.json +31 -1
  43. data/_sass/@primer/view-components/app/components/primer/alpha/tab_nav.css +1 -1
  44. data/_sass/@primer/view-components/app/components/primer/alpha/tab_nav.css.json +24 -1
  45. data/_sass/@primer/view-components/app/components/primer/alpha/text_field.css +3 -3
  46. data/_sass/@primer/view-components/app/components/primer/alpha/text_field.css.json +134 -1
  47. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.css +1 -1
  48. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.css.json +40 -1
  49. data/_sass/@primer/view-components/app/components/primer/alpha/underline_nav.css +1 -1
  50. data/_sass/@primer/view-components/app/components/primer/alpha/underline_nav.css.json +28 -1
  51. data/_sass/@primer/view-components/app/components/primer/anchored_position.d.ts +27 -0
  52. data/_sass/@primer/view-components/app/components/primer/anchored_position.js +149 -0
  53. data/_sass/@primer/view-components/app/components/primer/beta/avatar.css +1 -1
  54. data/_sass/@primer/view-components/app/components/primer/beta/avatar.css.json +17 -1
  55. data/_sass/@primer/view-components/app/components/primer/beta/avatar_stack.css +1 -1
  56. data/_sass/@primer/view-components/app/components/primer/beta/avatar_stack.css.json +28 -1
  57. data/_sass/@primer/view-components/app/components/primer/beta/blankslate.css +1 -1
  58. data/_sass/@primer/view-components/app/components/primer/beta/blankslate.css.json +22 -1
  59. data/_sass/@primer/view-components/app/components/primer/beta/border_box.css +1 -1
  60. data/_sass/@primer/view-components/app/components/primer/beta/border_box.css.json +54 -1
  61. data/_sass/@primer/view-components/app/components/primer/beta/breadcrumbs.css.json +11 -1
  62. data/_sass/@primer/view-components/app/components/primer/beta/button.css +1 -1
  63. data/_sass/@primer/view-components/app/components/primer/beta/button.css.json +71 -1
  64. data/_sass/@primer/view-components/app/components/primer/beta/counter.css +1 -1
  65. data/_sass/@primer/view-components/app/components/primer/beta/counter.css.json +10 -1
  66. data/_sass/@primer/view-components/app/components/primer/beta/flash.css +1 -1
  67. data/_sass/@primer/view-components/app/components/primer/beta/flash.css.json +27 -1
  68. data/_sass/@primer/view-components/app/components/primer/beta/label.css +1 -1
  69. data/_sass/@primer/view-components/app/components/primer/beta/label.css.json +25 -1
  70. data/_sass/@primer/view-components/app/components/primer/beta/link.css.json +19 -1
  71. data/_sass/@primer/view-components/app/components/primer/beta/popover.css +1 -1
  72. data/_sass/@primer/view-components/app/components/primer/beta/popover.css.json +39 -1
  73. data/_sass/@primer/view-components/app/components/primer/beta/progress_bar.css.json +10 -1
  74. data/_sass/@primer/view-components/app/components/primer/beta/state.css +1 -1
  75. data/_sass/@primer/view-components/app/components/primer/beta/state.css.json +13 -1
  76. data/_sass/@primer/view-components/app/components/primer/beta/subhead.css +1 -1
  77. data/_sass/@primer/view-components/app/components/primer/beta/subhead.css.json +12 -1
  78. data/_sass/@primer/view-components/app/components/primer/beta/timeline_item.css +1 -1
  79. data/_sass/@primer/view-components/app/components/primer/beta/timeline_item.css.json +16 -1
  80. data/_sass/@primer/view-components/app/components/primer/beta/truncate.css +1 -1
  81. data/_sass/@primer/view-components/app/components/primer/beta/truncate.css.json +12 -1
  82. data/_sass/@primer/view-components/app/components/primer/focus_group.d.ts +19 -0
  83. data/_sass/@primer/view-components/app/components/primer/focus_group.js +144 -0
  84. data/_sass/@primer/view-components/app/components/primer/primer.d.ts +5 -2
  85. data/_sass/@primer/view-components/app/components/primer/primer.js +5 -2
  86. data/_sass/@primer/view-components/app/components/primer/truncate.css.json +13 -1
  87. data/_sass/@primer/view-components/lib/primer/forms/primer_text_field.js +17 -6
  88. data/_sass/@primer/view-components/package.json +6 -4
  89. data/_sass/@primer/view-components/static/arguments.json +2167 -346
  90. data/_sass/@primer/view-components/static/audited_at.json +22 -22
  91. data/_sass/@primer/view-components/static/classes.json +579 -0
  92. data/_sass/@primer/view-components/static/constants.json +215 -61
  93. data/_sass/@primer/view-components/static/info_arch.json +9090 -0
  94. data/_sass/@primer/view-components/static/previews.json +2020 -0
  95. data/_sass/@primer/view-components/static/statuses.json +23 -23
  96. data/_sass/{jekyll-theme-primer.scss → jekyll-v4-theme-primer.scss} +3 -3
  97. data/_sass/primer.scss +1 -1
  98. data/assets/css/style.scss +1 -1
  99. metadata +16 -15
  100. data/_sass/@primer/css/actionlist/action-list-item-divider.scss +0 -48
  101. data/_sass/@primer/css/actionlist/action-list-item.scss +0 -593
  102. data/_sass/@primer/css/actionlist/action-list-tree.scss +0 -118
  103. data/_sass/@primer/css/actionlist/action-list-variables.scss +0 -8
  104. data/_sass/@primer/css/actionlist/action-list.scss +0 -67
  105. data/_sass/@primer/css/actionlist/index.scss +0 -6
  106. data/_sass/@primer/css/forms/form-validation.scss +0 -265
  107. data/_sass/@primer/css/labels/diffstat.scss +0 -37
  108. data/_sass/@primer/view-components/app/components/primer/time_ago_component.d.ts +0 -1
  109. data/_sass/@primer/view-components/app/components/primer/time_ago_component.js +0 -1
  110. /data/_sass/@primer/view-components/app/components/primer/{local_time.d.ts → beta/relative_time.d.ts} +0 -0
  111. /data/_sass/@primer/view-components/app/components/primer/{local_time.js → beta/relative_time.js} +0 -0
@@ -2,13 +2,21 @@
2
2
  {
3
3
  "component": "ActionList",
4
4
  "status": "alpha",
5
+ "a11y_reviewed": false,
6
+ "short_name": "ActionList",
5
7
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb",
6
8
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/default/",
7
9
  "parameters": [
10
+ {
11
+ "name": "id",
12
+ "type": "String",
13
+ "default": "`self.class.generate_id`",
14
+ "description": "HTML ID value."
15
+ },
8
16
  {
9
17
  "name": "role",
10
18
  "type": "Boolean",
11
- "default": "`:list`",
19
+ "default": "`nil`",
12
20
  "description": "ARIA role describing the function of the list. listbox and menu are a common values."
13
21
  },
14
22
  {
@@ -21,7 +29,7 @@
21
29
  "name": "scheme",
22
30
  "type": "Symbol",
23
31
  "default": "`:full`",
24
- "description": "One of `:full` or `:inset`.. `inset` children are offset (vertically and horizontally) from list edges. `full` (default) children are flush (vertically and horizontally) with list edges."
32
+ "description": "One of `:full` or `:inset`. `inset` children are offset (vertically and horizontally) from list edges. `full` (default) children are flush (vertically and horizontally) with list edges."
25
33
  },
26
34
  {
27
35
  "name": "show_dividers",
@@ -29,6 +37,18 @@
29
37
  "default": "`false`",
30
38
  "description": "Display a divider above each item in the list when it does not follow a header or divider."
31
39
  },
40
+ {
41
+ "name": "select_variant",
42
+ "type": "Symbol",
43
+ "default": "`:none`",
44
+ "description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`."
45
+ },
46
+ {
47
+ "name": "form_arguments",
48
+ "type": "Hash",
49
+ "default": "`{}`",
50
+ "description": "Allows an `ActionList` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission. *NOTE*: Consider using an [ActionMenu](/components/alpha/actionmenu) instead of using this feature directly."
51
+ },
32
52
  {
33
53
  "name": "system_arguments",
34
54
  "type": "Hash",
@@ -40,6 +60,8 @@
40
60
  {
41
61
  "component": "ActionList::Divider",
42
62
  "status": "alpha",
63
+ "a11y_reviewed": false,
64
+ "short_name": "ActionListDivider",
43
65
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
44
66
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
45
67
  "parameters": [
@@ -57,24 +79,37 @@
57
79
  }
58
80
  ]
59
81
  },
82
+ {
83
+ "component": "ActionList::FormWrapper",
84
+ "status": "alpha",
85
+ "a11y_reviewed": false,
86
+ "short_name": "ActionListFormWrapper",
87
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
88
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
89
+ "parameters": [
90
+
91
+ ]
92
+ },
60
93
  {
61
94
  "component": "ActionList::Heading",
62
95
  "status": "alpha",
96
+ "a11y_reviewed": false,
97
+ "short_name": "ActionListHeading",
63
98
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
64
99
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
65
100
  "parameters": [
66
- {
67
- "name": "list_id",
68
- "type": "String",
69
- "default": "N/A",
70
- "description": "The unique identifier of the sub list the heading belongs to. Used internally."
71
- },
72
101
  {
73
102
  "name": "title",
74
103
  "type": "String",
75
104
  "default": "N/A",
76
105
  "description": "Sub list title."
77
106
  },
107
+ {
108
+ "name": "heading_level",
109
+ "type": "Integer",
110
+ "default": "`3`",
111
+ "description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
112
+ },
78
113
  {
79
114
  "name": "subtitle",
80
115
  "type": "String",
@@ -87,12 +122,6 @@
87
122
  "default": "`:subtle`",
88
123
  "description": "Display a background color if scheme is `filled`."
89
124
  },
90
- {
91
- "name": "tag",
92
- "type": "Symbol",
93
- "default": "`:h3`",
94
- "description": "Semantic tag for the heading."
95
- },
96
125
  {
97
126
  "name": "system_arguments",
98
127
  "type": "Hash",
@@ -104,6 +133,8 @@
104
133
  {
105
134
  "component": "ActionList::Item",
106
135
  "status": "alpha",
136
+ "a11y_reviewed": false,
137
+ "short_name": "ActionListItem",
107
138
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/item.rb",
108
139
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item/default/",
109
140
  "parameters": [
@@ -122,8 +153,8 @@
122
153
  {
123
154
  "name": "label",
124
155
  "type": "String",
125
- "default": "N/A",
126
- "description": "Item label."
156
+ "default": "`nil`",
157
+ "description": "Item label. If no label is provided, content is used."
127
158
  },
128
159
  {
129
160
  "name": "label_classes",
@@ -131,12 +162,24 @@
131
162
  "default": "`nil`",
132
163
  "description": "CSS classes that will be added to the label."
133
164
  },
165
+ {
166
+ "name": "label_arguments",
167
+ "type": "Hash",
168
+ "default": "`{}`",
169
+ "description": "[System arguments](/system-arguments) used to construct the label."
170
+ },
134
171
  {
135
172
  "name": "content_arguments",
136
173
  "type": "Hash",
137
174
  "default": "`{}`",
138
175
  "description": "[System arguments](/system-arguments) used to construct the item's anchor or button tag."
139
176
  },
177
+ {
178
+ "name": "form_arguments",
179
+ "type": "Hash",
180
+ "default": "`{}`",
181
+ "description": "Allows the item to submit a form on click. The URL passed in the `href:` option will be used as the form action. Pass the `method:` option to this hash to control what kind of request is made, One of `:delete`, `:get`, `:head`, `:patch`, `:post`, or `:put`. The `name:` option is required and specifies the desired name of the field that will be included in the params sent to the server on form submission. Specify the `value:` option to send a custom value to the server; otherwise the value of `name:` is sent."
182
+ },
140
183
  {
141
184
  "name": "truncate_label",
142
185
  "type": "Boolean",
@@ -152,7 +195,7 @@
152
195
  {
153
196
  "name": "role",
154
197
  "type": "String",
155
- "default": "`:listitem`",
198
+ "default": "`nil`",
156
199
  "description": "ARIA role describing the function of the item."
157
200
  },
158
201
  {
@@ -183,7 +226,7 @@
183
226
  "name": "active",
184
227
  "type": "Boolean",
185
228
  "default": "`false`",
186
- "description": "Sets an active state on navigational items."
229
+ "description": "If the parent list's `select_variant` is set to `:single` or `:multiple`, causes this item to render checked."
187
230
  },
188
231
  {
189
232
  "name": "on_click",
@@ -205,9 +248,213 @@
205
248
  }
206
249
  ]
207
250
  },
251
+ {
252
+ "component": "ActionMenu",
253
+ "status": "alpha",
254
+ "a11y_reviewed": false,
255
+ "short_name": "ActionMenu",
256
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb",
257
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/",
258
+ "parameters": [
259
+ {
260
+ "name": "menu_id",
261
+ "type": "String",
262
+ "default": "`self.class.generate_id`",
263
+ "description": "Id of the menu."
264
+ },
265
+ {
266
+ "name": "anchor_align",
267
+ "type": "Symbol",
268
+ "default": "`:start`",
269
+ "description": "One of `:center`, `:end`, or `:start`.."
270
+ },
271
+ {
272
+ "name": "anchor_side",
273
+ "type": "Symbol",
274
+ "default": "`:outside_bottom`",
275
+ "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.."
276
+ },
277
+ {
278
+ "name": "size",
279
+ "type": "Symbol",
280
+ "default": "`:auto`",
281
+ "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
282
+ },
283
+ {
284
+ "name": "src",
285
+ "type": "String",
286
+ "default": "`nil`",
287
+ "description": "Used with an `include-fragment` element to load menu content from the given source URL."
288
+ },
289
+ {
290
+ "name": "preload",
291
+ "type": "Boolean",
292
+ "default": "`false`",
293
+ "description": "When true, and src is present, loads the `include-fragment` on trigger hover."
294
+ },
295
+ {
296
+ "name": "dynamic_label",
297
+ "type": "Boolean",
298
+ "default": "`false`",
299
+ "description": "Whether or not to display the text of the currently selected item in the show button."
300
+ },
301
+ {
302
+ "name": "dynamic_label_prefix",
303
+ "type": "String",
304
+ "default": "`nil`",
305
+ "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
306
+ },
307
+ {
308
+ "name": "select_variant",
309
+ "type": "Symbol",
310
+ "default": "`:none`",
311
+ "description": "One of `:multiple`, `:none`, or `:single`."
312
+ },
313
+ {
314
+ "name": "form_arguments",
315
+ "type": "Hash",
316
+ "default": "`{}`",
317
+ "description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission."
318
+ },
319
+ {
320
+ "name": "system_arguments",
321
+ "type": "Hash",
322
+ "default": "N/A",
323
+ "description": "[System arguments](/system-arguments)."
324
+ }
325
+ ]
326
+ },
327
+ {
328
+ "component": "ActionMenu::List",
329
+ "status": "alpha",
330
+ "a11y_reviewed": false,
331
+ "short_name": "ActionMenuList",
332
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb",
333
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/",
334
+ "parameters": [
335
+ {
336
+ "name": "menu_id",
337
+ "type": "String",
338
+ "default": "N/A",
339
+ "description": "ID of the parent menu."
340
+ },
341
+ {
342
+ "name": "system_arguments",
343
+ "type": "Hash",
344
+ "default": "N/A",
345
+ "description": "The arguments accepted by [ActionList](/components/alpha/actionlist)"
346
+ }
347
+ ]
348
+ },
349
+ {
350
+ "component": "AutoComplete",
351
+ "status": "deprecated",
352
+ "a11y_reviewed": false,
353
+ "short_name": "AutoComplete",
354
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/auto_complete.rb",
355
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/auto_complete/default/",
356
+ "parameters": [
357
+ {
358
+ "name": "label_text",
359
+ "type": "String",
360
+ "default": "N/A",
361
+ "description": "The label of the input."
362
+ },
363
+ {
364
+ "name": "src",
365
+ "type": "String",
366
+ "default": "N/A",
367
+ "description": "The route to query."
368
+ },
369
+ {
370
+ "name": "input_id",
371
+ "type": "String",
372
+ "default": "N/A",
373
+ "description": "Id of the input element."
374
+ },
375
+ {
376
+ "name": "input_name",
377
+ "type": "String",
378
+ "default": "`nil`",
379
+ "description": "Optional name of the input element, defaults to `input_id` when not set."
380
+ },
381
+ {
382
+ "name": "list_id",
383
+ "type": "String",
384
+ "default": "N/A",
385
+ "description": "Id of the list element."
386
+ },
387
+ {
388
+ "name": "with_icon",
389
+ "type": "Boolean",
390
+ "default": "`false`",
391
+ "description": "Controls if a search icon is visible, defaults to `false`."
392
+ },
393
+ {
394
+ "name": "is_label_visible",
395
+ "type": "Boolean",
396
+ "default": "`true`",
397
+ "description": "Controls if the label is visible. If `false`, screen reader only text will be added."
398
+ },
399
+ {
400
+ "name": "is_clearable",
401
+ "type": "Boolean",
402
+ "default": "`false`",
403
+ "description": "Adds optional clear button."
404
+ },
405
+ {
406
+ "name": "is_label_inline",
407
+ "type": "Boolean",
408
+ "default": "`false`",
409
+ "description": "Controls if the label is inline. On smaller screens, label will always become stacked."
410
+ },
411
+ {
412
+ "name": "system_arguments",
413
+ "type": "Hash",
414
+ "default": "N/A",
415
+ "description": "[System arguments](/system-arguments)"
416
+ }
417
+ ]
418
+ },
419
+ {
420
+ "component": "AutoComplete::Item",
421
+ "status": "deprecated",
422
+ "a11y_reviewed": false,
423
+ "short_name": "AutoCompleteItem",
424
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/auto_complete/item.rb",
425
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/auto_complete/item/default/",
426
+ "parameters": [
427
+ {
428
+ "name": "value",
429
+ "type": "String",
430
+ "default": "N/A",
431
+ "description": "Value of the item."
432
+ },
433
+ {
434
+ "name": "selected",
435
+ "type": "Boolean",
436
+ "default": "`false`",
437
+ "description": "Whether the item is selected."
438
+ },
439
+ {
440
+ "name": "disabled",
441
+ "type": "Boolean",
442
+ "default": "`false`",
443
+ "description": "Whether the item is disabled."
444
+ },
445
+ {
446
+ "name": "system_arguments",
447
+ "type": "Hash",
448
+ "default": "N/A",
449
+ "description": "[System arguments](/system-arguments)"
450
+ }
451
+ ]
452
+ },
208
453
  {
209
454
  "component": "Banner",
210
455
  "status": "alpha",
456
+ "a11y_reviewed": false,
457
+ "short_name": "Banner",
211
458
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/banner.rb",
212
459
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/banner/default/",
213
460
  "parameters": [
@@ -264,6 +511,8 @@
264
511
  {
265
512
  "component": "ButtonMarketing",
266
513
  "status": "alpha",
514
+ "a11y_reviewed": false,
515
+ "short_name": "ButtonMarketing",
267
516
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb",
268
517
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing/default/",
269
518
  "parameters": [
@@ -300,214 +549,236 @@
300
549
  ]
301
550
  },
302
551
  {
303
- "component": "Dialog",
552
+ "component": "CheckBox",
304
553
  "status": "alpha",
305
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog.rb",
306
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/default/",
554
+ "a11y_reviewed": false,
555
+ "short_name": "CheckBox",
556
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/check_box.rb",
557
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/check_box/default/",
307
558
  "parameters": [
559
+ {
560
+ "name": "name",
561
+ "type": "String",
562
+ "default": "N/A",
563
+ "description": "Value for the HTML name attribute."
564
+ },
308
565
  {
309
566
  "name": "id",
310
567
  "type": "String",
311
- "default": "`self.class.generate_id`",
312
- "description": "The id of the dialog."
568
+ "default": "N/A",
569
+ "description": "Value for the HTML id attribute."
313
570
  },
314
571
  {
315
- "name": "title",
572
+ "name": "class",
316
573
  "type": "String",
317
574
  "default": "N/A",
318
- "description": "Describes the content of the dialog."
575
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
319
576
  },
320
577
  {
321
- "name": "subtitle",
578
+ "name": "classes",
579
+ "type": "Array",
580
+ "default": "N/A",
581
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
582
+ },
583
+ {
584
+ "name": "caption",
322
585
  "type": "String",
323
- "default": "`nil`",
324
- "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute."
586
+ "default": "N/A",
587
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
325
588
  },
326
589
  {
327
- "name": "size",
328
- "type": "Symbol",
329
- "default": "`:medium`",
330
- "description": "The size of the dialog. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
590
+ "name": "label",
591
+ "type": "String",
592
+ "default": "N/A",
593
+ "description": "Label text displayed above the input."
331
594
  },
332
595
  {
333
- "name": "position",
334
- "type": "Symbol",
335
- "default": "`:center`",
336
- "description": "The position of the dialog. One of `:center`, `:left`, or `:right`."
596
+ "name": "visually_hide_label",
597
+ "type": "Boolean",
598
+ "default": "N/A",
599
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
337
600
  },
338
601
  {
339
- "name": "position_narrow",
340
- "type": "Symbol",
341
- "default": "`:inherit`",
342
- "description": "The position of the dialog when narrow. One of `:bottom`, `:fullscreen`, `:inherit`, `:left`, or `:right`."
602
+ "name": "disabled",
603
+ "type": "Boolean",
604
+ "default": "N/A",
605
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
343
606
  },
344
607
  {
345
- "name": "visually_hide_title",
608
+ "name": "hidden",
346
609
  "type": "Boolean",
347
- "default": "`false`",
348
- "description": "If true will hide the heading title, while still making it available to Screen Readers."
610
+ "default": "N/A",
611
+ "description": "When set to `true`, visually hides the field."
349
612
  },
350
613
  {
351
- "name": "system_arguments",
352
- "type": "Hash",
614
+ "name": "invalid",
615
+ "type": "Boolean",
353
616
  "default": "N/A",
354
- "description": "[System arguments](/system-arguments)"
355
- }
356
- ]
357
- },
358
- {
359
- "component": "Dropdown",
360
- "status": "alpha",
361
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb",
362
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/default/",
363
- "parameters": [
364
- {
365
- "name": "overlay",
366
- "type": "Symbol",
367
- "default": "`:default`",
368
- "description": "One of `:dark`, `:default`, or `:none`."
617
+ "description": "If set to `true`, the input will be rendered with a red border. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
369
618
  },
370
619
  {
371
- "name": "with_caret",
372
- "type": "Boolean",
373
- "default": "`false`",
374
- "description": "Whether or not a caret should be rendered in the button."
620
+ "name": "validation_message",
621
+ "type": "String",
622
+ "default": "N/A",
623
+ "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
375
624
  },
376
625
  {
377
- "name": "system_arguments",
626
+ "name": "label_arguments",
378
627
  "type": "Hash",
379
628
  "default": "N/A",
380
- "description": "[System arguments](/system-arguments)"
381
- }
382
- ]
383
- },
384
- {
385
- "component": "HellipButton",
386
- "status": "alpha",
387
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hellip_button.rb",
388
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hellip_button/default/",
389
- "parameters": [
629
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
630
+ },
390
631
  {
391
- "name": "inline",
632
+ "name": "scope_name_to_model",
392
633
  "type": "Boolean",
393
- "default": "`false`",
394
- "description": "Whether or not the button is inline."
634
+ "default": "N/A",
635
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field name. For example, if the field name is `my_field`, Rails will normally emit an HTML name attribute of `model[my_field]`. Setting `scope_name_to_model` to `false` will cause Rails to emit `my_field` instead."
395
636
  },
396
637
  {
397
- "name": "system_arguments",
398
- "type": "Hash",
638
+ "name": "scope_id_to_model",
639
+ "type": "Boolean",
399
640
  "default": "N/A",
400
- "description": "[System arguments](/system-arguments)"
401
- }
402
- ]
403
- },
404
- {
405
- "component": "HiddenTextExpander",
406
- "status": "alpha",
407
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb",
408
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander/default/",
409
- "parameters": [
641
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field ID. For example, if the field name is `my_field`, Rails will normally emit an HTML ID attribute of `model_my_field`. Setting `scope_id_to_model` to `false` will cause Rails to emit `my_field` instead."
642
+ },
410
643
  {
411
- "name": "inline",
644
+ "name": "required",
412
645
  "type": "Boolean",
413
- "default": "`false`",
414
- "description": "Whether or not the expander is inline."
646
+ "default": "N/A",
647
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
415
648
  },
416
649
  {
417
- "name": "button_arguments",
650
+ "name": "aria",
418
651
  "type": "Hash",
419
- "default": "`{}`",
420
- "description": "[System arguments](/system-arguments) for the button element."
652
+ "default": "N/A",
653
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
654
+ },
655
+ {
656
+ "name": "data",
657
+ "type": "Hash",
658
+ "default": "N/A",
659
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
421
660
  },
422
661
  {
423
662
  "name": "system_arguments",
424
663
  "type": "Hash",
425
664
  "default": "N/A",
426
- "description": "[System arguments](/system-arguments)"
427
- }
428
- ]
429
- },
430
- {
431
- "component": "Image",
432
- "status": "alpha",
433
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb",
434
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image/default/",
435
- "parameters": [
665
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
666
+ },
436
667
  {
437
- "name": "src",
668
+ "name": "name",
438
669
  "type": "String",
439
670
  "default": "N/A",
440
- "description": "The source url of the image."
671
+ "description": "Value for the HTML name attribute."
441
672
  },
442
673
  {
443
- "name": "alt",
674
+ "name": "value",
444
675
  "type": "String",
445
676
  "default": "N/A",
446
- "description": "Specifies an alternate text for the image."
677
+ "description": "On form submission, this value will be sent to the server if the check box is checked. Defaults to \"1\"."
447
678
  },
448
679
  {
449
- "name": "lazy",
450
- "type": "Boolean",
451
- "default": "`false`",
452
- "description": "Whether or not to lazily load the image."
680
+ "name": "unchecked_value",
681
+ "type": "String",
682
+ "default": "N/A",
683
+ "description": "On form submission, this value will be sent to the server if the check box is _not_ checked. Defaults to \"0\"."
453
684
  },
454
685
  {
455
- "name": "system_arguments",
456
- "type": "Hash",
686
+ "name": "scheme",
687
+ "type": "Symbol",
457
688
  "default": "N/A",
458
- "description": "[System arguments](/system-arguments)"
689
+ "description": "Controls how check box values are submitted to the server. One of `:array` or `:boolean`.."
459
690
  }
460
691
  ]
461
692
  },
462
693
  {
463
- "component": "ImageCrop",
694
+ "component": "CheckBoxGroup",
464
695
  "status": "alpha",
465
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb",
466
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop/default/",
696
+ "a11y_reviewed": false,
697
+ "short_name": "CheckBoxGroup",
698
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/check_box_group.rb",
699
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/check_box_group/default/",
467
700
  "parameters": [
468
701
  {
469
- "name": "src",
702
+ "name": "name",
470
703
  "type": "String",
471
704
  "default": "N/A",
472
- "description": "The path of the image to crop."
705
+ "description": "Value for the HTML name attribute. When provided, the check box values will be submitted in to the server in `:array` mode. See the [CheckBox](/components/alpha/checkbox) for more information."
473
706
  },
474
707
  {
475
- "name": "rounded",
708
+ "name": "label",
709
+ "type": "String",
710
+ "default": "N/A",
711
+ "description": "Label text displayed above the input."
712
+ },
713
+ {
714
+ "name": "hidden",
476
715
  "type": "Boolean",
477
- "default": "`true`",
478
- "description": "If the crop mask should be a circle. Defaults to true."
716
+ "default": "N/A",
717
+ "description": "When set to `true`, visually hides the group."
479
718
  },
480
719
  {
481
- "name": "system_arguments",
720
+ "name": "caption",
721
+ "type": "String",
722
+ "default": "N/A",
723
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the group."
724
+ },
725
+ {
726
+ "name": "label_arguments",
482
727
  "type": "Hash",
483
728
  "default": "N/A",
484
- "description": "[System arguments](/system-arguments)"
729
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
485
730
  }
486
731
  ]
487
732
  },
488
733
  {
489
- "component": "Layout",
734
+ "component": "Dialog",
490
735
  "status": "alpha",
491
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb",
492
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/default/",
736
+ "a11y_reviewed": true,
737
+ "short_name": "Dialog",
738
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog.rb",
739
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/default/",
493
740
  "parameters": [
494
741
  {
495
- "name": "stacking_breakpoint",
742
+ "name": "id",
743
+ "type": "String",
744
+ "default": "`self.class.generate_id`",
745
+ "description": "The id of the dialog."
746
+ },
747
+ {
748
+ "name": "title",
749
+ "type": "String",
750
+ "default": "N/A",
751
+ "description": "Describes the content of the dialog."
752
+ },
753
+ {
754
+ "name": "subtitle",
755
+ "type": "String",
756
+ "default": "`nil`",
757
+ "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute."
758
+ },
759
+ {
760
+ "name": "size",
496
761
  "type": "Symbol",
497
- "default": "`:md`",
498
- "description": "When the `Layout` should change from rows into columns. One of `:lg`, `:md`, or `:sm`."
762
+ "default": "`:medium`",
763
+ "description": "The size of the dialog. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
499
764
  },
500
765
  {
501
- "name": "first_in_source",
766
+ "name": "position",
502
767
  "type": "Symbol",
503
- "default": "`:sidebar`",
504
- "description": "Which element to render first in the HTML. This will change the keyboard navigation order. One of `:main` or `:sidebar`."
768
+ "default": "`:center`",
769
+ "description": "The position of the dialog. One of `:center`, `:left`, or `:right`."
505
770
  },
506
771
  {
507
- "name": "gutter",
772
+ "name": "position_narrow",
508
773
  "type": "Symbol",
509
- "default": "`:default`",
510
- "description": "The amount of space between the main section and the sidebar. One of `:condensed`, `:default`, `:none`, or `:spacious`."
774
+ "default": "`:inherit`",
775
+ "description": "The position of the dialog when narrow. One of `:bottom`, `:fullscreen`, `:inherit`, `:left`, or `:right`."
776
+ },
777
+ {
778
+ "name": "visually_hide_title",
779
+ "type": "Boolean",
780
+ "default": "`false`",
781
+ "description": "If true will hide the heading title, while still making it available to Screen Readers."
511
782
  },
512
783
  {
513
784
  "name": "system_arguments",
@@ -518,10 +789,12 @@
518
789
  ]
519
790
  },
520
791
  {
521
- "component": "Menu",
792
+ "component": "Dialog::Body",
522
793
  "status": "alpha",
523
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/menu.rb",
524
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/menu/default/",
794
+ "a11y_reviewed": true,
795
+ "short_name": "DialogBody",
796
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
797
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
525
798
  "parameters": [
526
799
  {
527
800
  "name": "system_arguments",
@@ -532,16 +805,18 @@
532
805
  ]
533
806
  },
534
807
  {
535
- "component": "NavList",
808
+ "component": "Dialog::Footer",
536
809
  "status": "alpha",
537
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
538
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/default/",
810
+ "a11y_reviewed": true,
811
+ "short_name": "DialogFooter",
812
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
813
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
539
814
  "parameters": [
540
815
  {
541
- "name": "selected_item_id",
542
- "type": "Symbol",
543
- "default": "`nil`",
544
- "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
816
+ "name": "show_divider",
817
+ "type": "Boolean",
818
+ "default": "`false`",
819
+ "description": "Show a divider between the footer and body."
545
820
  },
546
821
  {
547
822
  "name": "system_arguments",
@@ -552,34 +827,36 @@
552
827
  ]
553
828
  },
554
829
  {
555
- "component": "NavList::Item",
830
+ "component": "Dialog::Header",
556
831
  "status": "alpha",
557
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
558
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
832
+ "a11y_reviewed": true,
833
+ "short_name": "DialogHeader",
834
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
835
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
559
836
  "parameters": [
560
837
  {
561
- "name": "selected_item_id",
562
- "type": "Symbol",
563
- "default": "`nil`",
564
- "description": "The ID of the currently selected list item. Used internally."
838
+ "name": "title",
839
+ "type": "String",
840
+ "default": "N/A",
841
+ "description": "Describes the content of the dialog."
565
842
  },
566
843
  {
567
- "name": "selected_by_ids",
568
- "type": "Array<Symbol>",
569
- "default": "`[]`",
570
- "description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
844
+ "name": "subtitle",
845
+ "type": "String",
846
+ "default": "`nil`",
847
+ "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
571
848
  },
572
849
  {
573
- "name": "expanded",
850
+ "name": "show_divider",
574
851
  "type": "Boolean",
575
852
  "default": "`false`",
576
- "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
853
+ "description": "Show a divider between the header and body."
577
854
  },
578
855
  {
579
- "name": "sub_item",
856
+ "name": "visually_hide_title",
580
857
  "type": "Boolean",
581
858
  "default": "`false`",
582
- "description": "Whether or not this item is nested under a parent item. Used internally."
859
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
583
860
  },
584
861
  {
585
862
  "name": "system_arguments",
@@ -590,16 +867,24 @@
590
867
  ]
591
868
  },
592
869
  {
593
- "component": "NavList::Section",
870
+ "component": "Dropdown",
594
871
  "status": "alpha",
595
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/section.rb",
596
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/section/default/",
872
+ "a11y_reviewed": false,
873
+ "short_name": "Dropdown",
874
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb",
875
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/default/",
597
876
  "parameters": [
598
877
  {
599
- "name": "selected_item_id",
878
+ "name": "overlay",
600
879
  "type": "Symbol",
601
- "default": "`nil`",
602
- "description": "The ID of the currently selected item. Used internally."
880
+ "default": "`:default`",
881
+ "description": "One of `:dark`, `:default`, or `:none`."
882
+ },
883
+ {
884
+ "name": "with_caret",
885
+ "type": "Boolean",
886
+ "default": "`false`",
887
+ "description": "Whether or not a caret should be rendered in the button."
603
888
  },
604
889
  {
605
890
  "name": "system_arguments",
@@ -610,42 +895,30 @@
610
895
  ]
611
896
  },
612
897
  {
613
- "component": "OcticonSymbols",
614
- "status": "alpha",
615
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/octicon_symbols.rb",
616
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/octicon_symbols/default/",
617
- "parameters": [
618
- {
619
- "name": "icons",
620
- "type": "Array<Hash>",
621
- "default": "`[]`",
622
- "description": "List of icons to render, in the format { symbol: :icon_name, size: :small }"
623
- }
624
- ]
625
- },
626
- {
627
- "component": "SegmentedControl",
898
+ "component": "Dropdown::Menu",
628
899
  "status": "alpha",
629
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb",
630
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/default/",
900
+ "a11y_reviewed": false,
901
+ "short_name": "DropdownMenu",
902
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu.rb",
903
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/default/",
631
904
  "parameters": [
632
905
  {
633
- "name": "hide_labels",
634
- "type": "Boolean",
635
- "default": "`false`",
636
- "description": "Whether to hide the labels and only show the icons"
906
+ "name": "as",
907
+ "type": "Symbol",
908
+ "default": "`:default`",
909
+ "description": "When `as` is `:list`, wraps the menu in a `<ul>` with a `<li>` for each item."
637
910
  },
638
911
  {
639
- "name": "full_width",
640
- "type": "Boolean",
641
- "default": "`false`",
642
- "description": "If the component should be full width"
912
+ "name": "direction",
913
+ "type": "Symbol",
914
+ "default": "`:se`",
915
+ "description": "One of `:e`, `:ne`, `:s`, `:se`, `:sw`, or `:w`.."
643
916
  },
644
917
  {
645
- "name": "size",
646
- "type": "Symbol",
647
- "default": "`:medium`",
648
- "description": "One of `:large`, `:medium`, or `:small`."
918
+ "name": "header",
919
+ "type": "String",
920
+ "default": "`nil`",
921
+ "description": "Header to be displayed above the menu."
649
922
  },
650
923
  {
651
924
  "name": "system_arguments",
@@ -656,15 +929,1235 @@
656
929
  ]
657
930
  },
658
931
  {
659
- "component": "TabContainer",
932
+ "component": "Dropdown::Menu::Item",
660
933
  "status": "alpha",
661
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_container.rb",
662
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_container/default/",
934
+ "a11y_reviewed": false,
935
+ "short_name": "DropdownMenuItem",
936
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu/item.rb",
937
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/item/default/",
663
938
  "parameters": [
664
- {
665
- "name": "system_arguments",
666
- "type": "Hash",
667
- "default": "N/A",
939
+
940
+ ]
941
+ },
942
+ {
943
+ "component": "FormButton",
944
+ "status": "alpha",
945
+ "a11y_reviewed": false,
946
+ "short_name": "FormButton",
947
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/form_button.rb",
948
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/form_button/default/",
949
+ "parameters": [
950
+ {
951
+ "name": "name",
952
+ "type": "String",
953
+ "default": "N/A",
954
+ "description": "Value for the HTML name attribute."
955
+ },
956
+ {
957
+ "name": "id",
958
+ "type": "String",
959
+ "default": "N/A",
960
+ "description": "Value for the HTML id attribute."
961
+ },
962
+ {
963
+ "name": "class",
964
+ "type": "String",
965
+ "default": "N/A",
966
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
967
+ },
968
+ {
969
+ "name": "classes",
970
+ "type": "Array",
971
+ "default": "N/A",
972
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
973
+ },
974
+ {
975
+ "name": "label",
976
+ "type": "String",
977
+ "default": "N/A",
978
+ "description": "Label text displayed above the input."
979
+ },
980
+ {
981
+ "name": "aria",
982
+ "type": "Hash",
983
+ "default": "N/A",
984
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
985
+ },
986
+ {
987
+ "name": "data",
988
+ "type": "Hash",
989
+ "default": "N/A",
990
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
991
+ },
992
+ {
993
+ "name": "system_arguments",
994
+ "type": "Hash",
995
+ "default": "N/A",
996
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
997
+ }
998
+ ]
999
+ },
1000
+ {
1001
+ "component": "FormControl",
1002
+ "status": "alpha",
1003
+ "a11y_reviewed": false,
1004
+ "short_name": "FormControl",
1005
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/form_control.rb",
1006
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/form_control/default/",
1007
+ "parameters": [
1008
+ {
1009
+ "name": "label",
1010
+ "type": "String",
1011
+ "default": "N/A",
1012
+ "description": "Label text displayed above the input."
1013
+ },
1014
+ {
1015
+ "name": "caption",
1016
+ "type": "String",
1017
+ "default": "`nil`",
1018
+ "description": "Describes the field and what sort of input it expects. Displayed below the input. Note that the `caption` slot is also available and takes precedence over this argument when provided."
1019
+ },
1020
+ {
1021
+ "name": "validation_message",
1022
+ "type": "String",
1023
+ "default": "`nil`",
1024
+ "description": "A string displayed in red between the caption and the input indicating the input's contents are invalid."
1025
+ },
1026
+ {
1027
+ "name": "required",
1028
+ "type": "Boolean",
1029
+ "default": "`false`",
1030
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
1031
+ },
1032
+ {
1033
+ "name": "visually_hide_label",
1034
+ "type": "Boolean",
1035
+ "default": "`false`",
1036
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
1037
+ },
1038
+ {
1039
+ "name": "full_width",
1040
+ "type": "Boolean",
1041
+ "default": "`false`",
1042
+ "description": "When set to `true`, the form control will take up all the horizontal space allowed by its container."
1043
+ },
1044
+ {
1045
+ "name": "system_arguments",
1046
+ "type": "Hash",
1047
+ "default": "N/A",
1048
+ "description": "[System arguments](/system-arguments)"
1049
+ }
1050
+ ]
1051
+ },
1052
+ {
1053
+ "component": "HellipButton",
1054
+ "status": "alpha",
1055
+ "a11y_reviewed": false,
1056
+ "short_name": "HellipButton",
1057
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hellip_button.rb",
1058
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hellip_button/default/",
1059
+ "parameters": [
1060
+ {
1061
+ "name": "inline",
1062
+ "type": "Boolean",
1063
+ "default": "`false`",
1064
+ "description": "Whether or not the button is inline."
1065
+ },
1066
+ {
1067
+ "name": "system_arguments",
1068
+ "type": "Hash",
1069
+ "default": "N/A",
1070
+ "description": "[System arguments](/system-arguments)"
1071
+ }
1072
+ ]
1073
+ },
1074
+ {
1075
+ "component": "HiddenTextExpander",
1076
+ "status": "alpha",
1077
+ "a11y_reviewed": false,
1078
+ "short_name": "HiddenTextExpander",
1079
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb",
1080
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander/default/",
1081
+ "parameters": [
1082
+ {
1083
+ "name": "inline",
1084
+ "type": "Boolean",
1085
+ "default": "`false`",
1086
+ "description": "Whether or not the expander is inline."
1087
+ },
1088
+ {
1089
+ "name": "button_arguments",
1090
+ "type": "Hash",
1091
+ "default": "`{}`",
1092
+ "description": "[System arguments](/system-arguments) for the button element."
1093
+ },
1094
+ {
1095
+ "name": "system_arguments",
1096
+ "type": "Hash",
1097
+ "default": "N/A",
1098
+ "description": "[System arguments](/system-arguments)"
1099
+ }
1100
+ ]
1101
+ },
1102
+ {
1103
+ "component": "Image",
1104
+ "status": "alpha",
1105
+ "a11y_reviewed": false,
1106
+ "short_name": "Image",
1107
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb",
1108
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image/default/",
1109
+ "parameters": [
1110
+ {
1111
+ "name": "src",
1112
+ "type": "String",
1113
+ "default": "N/A",
1114
+ "description": "The source url of the image."
1115
+ },
1116
+ {
1117
+ "name": "alt",
1118
+ "type": "String",
1119
+ "default": "N/A",
1120
+ "description": "Specifies an alternate text for the image."
1121
+ },
1122
+ {
1123
+ "name": "lazy",
1124
+ "type": "Boolean",
1125
+ "default": "`false`",
1126
+ "description": "Whether or not to lazily load the image."
1127
+ },
1128
+ {
1129
+ "name": "system_arguments",
1130
+ "type": "Hash",
1131
+ "default": "N/A",
1132
+ "description": "[System arguments](/system-arguments)"
1133
+ }
1134
+ ]
1135
+ },
1136
+ {
1137
+ "component": "ImageCrop",
1138
+ "status": "alpha",
1139
+ "a11y_reviewed": false,
1140
+ "short_name": "ImageCrop",
1141
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb",
1142
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop/default/",
1143
+ "parameters": [
1144
+ {
1145
+ "name": "src",
1146
+ "type": "String",
1147
+ "default": "N/A",
1148
+ "description": "The path of the image to crop."
1149
+ },
1150
+ {
1151
+ "name": "rounded",
1152
+ "type": "Boolean",
1153
+ "default": "`true`",
1154
+ "description": "If the crop mask should be a circle. Defaults to true."
1155
+ },
1156
+ {
1157
+ "name": "system_arguments",
1158
+ "type": "Hash",
1159
+ "default": "N/A",
1160
+ "description": "[System arguments](/system-arguments)"
1161
+ }
1162
+ ]
1163
+ },
1164
+ {
1165
+ "component": "Layout",
1166
+ "status": "alpha",
1167
+ "a11y_reviewed": false,
1168
+ "short_name": "Layout",
1169
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb",
1170
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/default/",
1171
+ "parameters": [
1172
+ {
1173
+ "name": "stacking_breakpoint",
1174
+ "type": "Symbol",
1175
+ "default": "`:md`",
1176
+ "description": "When the `Layout` should change from rows into columns. One of `:lg`, `:md`, or `:sm`."
1177
+ },
1178
+ {
1179
+ "name": "first_in_source",
1180
+ "type": "Symbol",
1181
+ "default": "`:sidebar`",
1182
+ "description": "Which element to render first in the HTML. This will change the keyboard navigation order. One of `:main` or `:sidebar`."
1183
+ },
1184
+ {
1185
+ "name": "gutter",
1186
+ "type": "Symbol",
1187
+ "default": "`:default`",
1188
+ "description": "The amount of space between the main section and the sidebar. One of `:condensed`, `:default`, `:none`, or `:spacious`."
1189
+ },
1190
+ {
1191
+ "name": "system_arguments",
1192
+ "type": "Hash",
1193
+ "default": "N/A",
1194
+ "description": "[System arguments](/system-arguments)"
1195
+ }
1196
+ ]
1197
+ },
1198
+ {
1199
+ "component": "Layout::Main",
1200
+ "status": "alpha",
1201
+ "a11y_reviewed": false,
1202
+ "short_name": "LayoutMain",
1203
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/main.rb",
1204
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/main/default/",
1205
+ "parameters": [
1206
+ {
1207
+ "name": "width",
1208
+ "type": "Symbol",
1209
+ "default": "`:full`",
1210
+ "description": "One of `:full`, `:lg`, `:md`, or `:xl`."
1211
+ },
1212
+ {
1213
+ "name": "system_arguments",
1214
+ "type": "Hash",
1215
+ "default": "N/A",
1216
+ "description": "[System arguments](/system-arguments)"
1217
+ }
1218
+ ]
1219
+ },
1220
+ {
1221
+ "component": "Layout::Sidebar",
1222
+ "status": "alpha",
1223
+ "a11y_reviewed": false,
1224
+ "short_name": "LayoutSidebar",
1225
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/sidebar.rb",
1226
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/sidebar/default/",
1227
+ "parameters": [
1228
+
1229
+ ]
1230
+ },
1231
+ {
1232
+ "component": "Menu",
1233
+ "status": "alpha",
1234
+ "a11y_reviewed": false,
1235
+ "short_name": "Menu",
1236
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/menu.rb",
1237
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/menu/default/",
1238
+ "parameters": [
1239
+ {
1240
+ "name": "system_arguments",
1241
+ "type": "Hash",
1242
+ "default": "N/A",
1243
+ "description": "[System arguments](/system-arguments)"
1244
+ }
1245
+ ]
1246
+ },
1247
+ {
1248
+ "component": "MultiInput",
1249
+ "status": "alpha",
1250
+ "a11y_reviewed": false,
1251
+ "short_name": "MultiInput",
1252
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/multi_input.rb",
1253
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/multi_input/default/",
1254
+ "parameters": [
1255
+ {
1256
+ "name": "name",
1257
+ "type": "String",
1258
+ "default": "N/A",
1259
+ "description": "Value for the HTML name attribute."
1260
+ },
1261
+ {
1262
+ "name": "id",
1263
+ "type": "String",
1264
+ "default": "N/A",
1265
+ "description": "Value for the HTML id attribute."
1266
+ },
1267
+ {
1268
+ "name": "class",
1269
+ "type": "String",
1270
+ "default": "N/A",
1271
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
1272
+ },
1273
+ {
1274
+ "name": "classes",
1275
+ "type": "Array",
1276
+ "default": "N/A",
1277
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
1278
+ },
1279
+ {
1280
+ "name": "caption",
1281
+ "type": "String",
1282
+ "default": "N/A",
1283
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
1284
+ },
1285
+ {
1286
+ "name": "label",
1287
+ "type": "String",
1288
+ "default": "N/A",
1289
+ "description": "Label text displayed above the input."
1290
+ },
1291
+ {
1292
+ "name": "visually_hide_label",
1293
+ "type": "Boolean",
1294
+ "default": "N/A",
1295
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
1296
+ },
1297
+ {
1298
+ "name": "disabled",
1299
+ "type": "Boolean",
1300
+ "default": "N/A",
1301
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
1302
+ },
1303
+ {
1304
+ "name": "hidden",
1305
+ "type": "Boolean",
1306
+ "default": "N/A",
1307
+ "description": "When set to `true`, visually hides the field."
1308
+ },
1309
+ {
1310
+ "name": "invalid",
1311
+ "type": "Boolean",
1312
+ "default": "N/A",
1313
+ "description": "If set to `true`, the input will be rendered with a red border. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
1314
+ },
1315
+ {
1316
+ "name": "validation_message",
1317
+ "type": "String",
1318
+ "default": "N/A",
1319
+ "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
1320
+ },
1321
+ {
1322
+ "name": "label_arguments",
1323
+ "type": "Hash",
1324
+ "default": "N/A",
1325
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
1326
+ },
1327
+ {
1328
+ "name": "scope_name_to_model",
1329
+ "type": "Boolean",
1330
+ "default": "N/A",
1331
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field name. For example, if the field name is `my_field`, Rails will normally emit an HTML name attribute of `model[my_field]`. Setting `scope_name_to_model` to `false` will cause Rails to emit `my_field` instead."
1332
+ },
1333
+ {
1334
+ "name": "scope_id_to_model",
1335
+ "type": "Boolean",
1336
+ "default": "N/A",
1337
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field ID. For example, if the field name is `my_field`, Rails will normally emit an HTML ID attribute of `model_my_field`. Setting `scope_id_to_model` to `false` will cause Rails to emit `my_field` instead."
1338
+ },
1339
+ {
1340
+ "name": "required",
1341
+ "type": "Boolean",
1342
+ "default": "N/A",
1343
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
1344
+ },
1345
+ {
1346
+ "name": "aria",
1347
+ "type": "Hash",
1348
+ "default": "N/A",
1349
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
1350
+ },
1351
+ {
1352
+ "name": "data",
1353
+ "type": "Hash",
1354
+ "default": "N/A",
1355
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
1356
+ },
1357
+ {
1358
+ "name": "system_arguments",
1359
+ "type": "Hash",
1360
+ "default": "N/A",
1361
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
1362
+ }
1363
+ ]
1364
+ },
1365
+ {
1366
+ "component": "NavList",
1367
+ "status": "alpha",
1368
+ "a11y_reviewed": false,
1369
+ "short_name": "NavList",
1370
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
1371
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/default/",
1372
+ "parameters": [
1373
+ {
1374
+ "name": "selected_item_id",
1375
+ "type": "Symbol",
1376
+ "default": "`nil`",
1377
+ "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
1378
+ },
1379
+ {
1380
+ "name": "system_arguments",
1381
+ "type": "Hash",
1382
+ "default": "N/A",
1383
+ "description": "[System arguments](/system-arguments)"
1384
+ }
1385
+ ]
1386
+ },
1387
+ {
1388
+ "component": "NavList::Divider",
1389
+ "status": "alpha",
1390
+ "a11y_reviewed": false,
1391
+ "short_name": "NavListDivider",
1392
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
1393
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
1394
+ "parameters": [
1395
+ {
1396
+ "name": "scheme",
1397
+ "type": "Symbol",
1398
+ "default": "`:subtle`",
1399
+ "description": "Display a background color if scheme is `filled`."
1400
+ },
1401
+ {
1402
+ "name": "system_arguments",
1403
+ "type": "Hash",
1404
+ "default": "N/A",
1405
+ "description": "[System arguments](/system-arguments)"
1406
+ }
1407
+ ]
1408
+ },
1409
+ {
1410
+ "component": "NavList::Group",
1411
+ "status": "alpha",
1412
+ "a11y_reviewed": false,
1413
+ "short_name": "NavListGroup",
1414
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
1415
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
1416
+ "parameters": [
1417
+ {
1418
+ "name": "selected_item_id",
1419
+ "type": "Symbol",
1420
+ "default": "`nil`",
1421
+ "description": "The ID of the currently selected item. Used internally."
1422
+ },
1423
+ {
1424
+ "name": "system_arguments",
1425
+ "type": "Hash",
1426
+ "default": "N/A",
1427
+ "description": "[System arguments](/system-arguments)"
1428
+ }
1429
+ ]
1430
+ },
1431
+ {
1432
+ "component": "NavList::Item",
1433
+ "status": "alpha",
1434
+ "a11y_reviewed": false,
1435
+ "short_name": "NavListItem",
1436
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
1437
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
1438
+ "parameters": [
1439
+ {
1440
+ "name": "selected_item_id",
1441
+ "type": "Symbol",
1442
+ "default": "`nil`",
1443
+ "description": "The ID of the currently selected list item. Used internally."
1444
+ },
1445
+ {
1446
+ "name": "selected_by_ids",
1447
+ "type": "Array<Symbol>",
1448
+ "default": "`[]`",
1449
+ "description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
1450
+ },
1451
+ {
1452
+ "name": "expanded",
1453
+ "type": "Boolean",
1454
+ "default": "`false`",
1455
+ "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
1456
+ },
1457
+ {
1458
+ "name": "sub_item",
1459
+ "type": "Boolean",
1460
+ "default": "`false`",
1461
+ "description": "Whether or not this item is nested under a parent item. Used internally."
1462
+ },
1463
+ {
1464
+ "name": "system_arguments",
1465
+ "type": "Hash",
1466
+ "default": "N/A",
1467
+ "description": "[System arguments](/system-arguments)"
1468
+ }
1469
+ ]
1470
+ },
1471
+ {
1472
+ "component": "Navigation::Tab",
1473
+ "status": "alpha",
1474
+ "a11y_reviewed": false,
1475
+ "short_name": "NavigationTab",
1476
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/navigation/tab.rb",
1477
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/navigation/tab/default/",
1478
+ "parameters": [
1479
+ {
1480
+ "name": "list",
1481
+ "type": "Boolean",
1482
+ "default": "`false`",
1483
+ "description": "Whether the Tab is an item in a `<ul>` list."
1484
+ },
1485
+ {
1486
+ "name": "selected",
1487
+ "type": "Boolean",
1488
+ "default": "`false`",
1489
+ "description": "Whether the Tab is selected or not."
1490
+ },
1491
+ {
1492
+ "name": "with_panel",
1493
+ "type": "Boolean",
1494
+ "default": "`false`",
1495
+ "description": "Whether the Tab has an associated panel."
1496
+ },
1497
+ {
1498
+ "name": "panel_id",
1499
+ "type": "String",
1500
+ "default": "`\"\"`",
1501
+ "description": "Only applies if `with_panel` is `true`. Unique id of panel."
1502
+ },
1503
+ {
1504
+ "name": "icon_classes",
1505
+ "type": "Boolean",
1506
+ "default": "`\"\"`",
1507
+ "description": "Classes that must always be applied to icons."
1508
+ },
1509
+ {
1510
+ "name": "wrapper_arguments",
1511
+ "type": "Hash",
1512
+ "default": "`{}`",
1513
+ "description": "[System arguments](/system-arguments) to be used in the `<li>` wrapper when the tab is an item in a list."
1514
+ },
1515
+ {
1516
+ "name": "system_arguments",
1517
+ "type": "Hash",
1518
+ "default": "N/A",
1519
+ "description": "[System arguments](/system-arguments)"
1520
+ }
1521
+ ]
1522
+ },
1523
+ {
1524
+ "component": "OcticonSymbols",
1525
+ "status": "alpha",
1526
+ "a11y_reviewed": false,
1527
+ "short_name": "OcticonSymbols",
1528
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/octicon_symbols.rb",
1529
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/octicon_symbols/default/",
1530
+ "parameters": [
1531
+ {
1532
+ "name": "icons",
1533
+ "type": "Array<Hash>",
1534
+ "default": "`[]`",
1535
+ "description": "List of icons to render, in the format { symbol: :icon_name, size: :small }"
1536
+ }
1537
+ ]
1538
+ },
1539
+ {
1540
+ "component": "Overlay",
1541
+ "status": "alpha",
1542
+ "a11y_reviewed": false,
1543
+ "short_name": "Overlay",
1544
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay.rb",
1545
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/default/",
1546
+ "parameters": [
1547
+ {
1548
+ "name": "id",
1549
+ "type": "String",
1550
+ "default": "`self.class.generate_id`",
1551
+ "description": "The id of the Overlay."
1552
+ },
1553
+ {
1554
+ "name": "title",
1555
+ "type": "String",
1556
+ "default": "N/A",
1557
+ "description": "Describes the content of the Overlay."
1558
+ },
1559
+ {
1560
+ "name": "subtitle",
1561
+ "type": "String",
1562
+ "default": "`nil`",
1563
+ "description": "Provides dditional context for the Overlay, also setting the `aria-describedby` attribute."
1564
+ },
1565
+ {
1566
+ "name": "popover",
1567
+ "type": "Symbol",
1568
+ "default": "`:auto`",
1569
+ "description": "The popover behaviour. One of `:auto` or `:manual`."
1570
+ },
1571
+ {
1572
+ "name": "size",
1573
+ "type": "Symbol",
1574
+ "default": "`:auto`",
1575
+ "description": "The size of the Overlay. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
1576
+ },
1577
+ {
1578
+ "name": "padding",
1579
+ "type": "Symbol",
1580
+ "default": "`:normal`",
1581
+ "description": "The padding given to the Overlay body. One of `:condensed`, `:none`, or `:normal`."
1582
+ },
1583
+ {
1584
+ "name": "anchor",
1585
+ "type": "String",
1586
+ "default": "`nil`",
1587
+ "description": "An ID of the element to anchor onto. Defaults to the `show_button`."
1588
+ },
1589
+ {
1590
+ "name": "anchor_align",
1591
+ "type": "Symbol",
1592
+ "default": "`:start`",
1593
+ "description": "The anchor alignment of the Overlay. One of `:center`, `:end`, or `:start`."
1594
+ },
1595
+ {
1596
+ "name": "anchor_side",
1597
+ "type": "Symbol",
1598
+ "default": "`:outside_bottom`",
1599
+ "description": "The side to anchor the Overlay to. One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`."
1600
+ },
1601
+ {
1602
+ "name": "anchor_offset",
1603
+ "type": "Symbol",
1604
+ "default": "`:normal`",
1605
+ "description": "The anchor offset to give the Overlay. One of `:normal` or `:spacious`."
1606
+ },
1607
+ {
1608
+ "name": "allow_out_of_bounds",
1609
+ "type": "Boolean",
1610
+ "default": "`false`",
1611
+ "description": "Allow the Overlay to overflow its container."
1612
+ },
1613
+ {
1614
+ "name": "visually_hide_title",
1615
+ "type": "Boolean",
1616
+ "default": "`false`",
1617
+ "description": "If true will hide the heading title, while still making it available to Screen Readers."
1618
+ },
1619
+ {
1620
+ "name": "role",
1621
+ "type": "String",
1622
+ "default": "`nil`",
1623
+ "description": "The ARIA role. One of `nil`, `:dialog`, or `:menu`."
1624
+ },
1625
+ {
1626
+ "name": "system_arguments",
1627
+ "type": "Hash",
1628
+ "default": "N/A",
1629
+ "description": "[System arguments](/system-arguments)"
1630
+ }
1631
+ ]
1632
+ },
1633
+ {
1634
+ "component": "Overlay::Body",
1635
+ "status": "alpha",
1636
+ "a11y_reviewed": false,
1637
+ "short_name": "OverlayBody",
1638
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb",
1639
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/",
1640
+ "parameters": [
1641
+ {
1642
+ "name": "system_arguments",
1643
+ "type": "Hash",
1644
+ "default": "N/A",
1645
+ "description": "[System arguments](/system-arguments)"
1646
+ }
1647
+ ]
1648
+ },
1649
+ {
1650
+ "component": "Overlay::Footer",
1651
+ "status": "alpha",
1652
+ "a11y_reviewed": false,
1653
+ "short_name": "OverlayFooter",
1654
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/footer.rb",
1655
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/footer/default/",
1656
+ "parameters": [
1657
+ {
1658
+ "name": "show_divider",
1659
+ "type": "Boolean",
1660
+ "default": "`false`",
1661
+ "description": "Show a divider between the footer and body."
1662
+ },
1663
+ {
1664
+ "name": "align_content",
1665
+ "type": "Symbol",
1666
+ "default": "`DEFAULT_ALIGN_CONTENT`",
1667
+ "description": "The alginment of contents. One of `:center`, `:end`, or `:start`."
1668
+ },
1669
+ {
1670
+ "name": "system_arguments",
1671
+ "type": "Hash",
1672
+ "default": "N/A",
1673
+ "description": "[System arguments](/system-arguments)"
1674
+ }
1675
+ ]
1676
+ },
1677
+ {
1678
+ "component": "Overlay::Header",
1679
+ "status": "alpha",
1680
+ "a11y_reviewed": false,
1681
+ "short_name": "OverlayHeader",
1682
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/header.rb",
1683
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/header/default/",
1684
+ "parameters": [
1685
+ {
1686
+ "name": "title",
1687
+ "type": "String",
1688
+ "default": "N/A",
1689
+ "description": "Describes the content of the Overlay."
1690
+ },
1691
+ {
1692
+ "name": "subtitle",
1693
+ "type": "String",
1694
+ "default": "`nil`",
1695
+ "description": "Provides dditional context for the Overlay, also setting the `aria-describedby` attribute."
1696
+ },
1697
+ {
1698
+ "name": "size",
1699
+ "type": "Symbol",
1700
+ "default": "`:medium`",
1701
+ "description": "The size of the Header. One of `:large` or `:medium`."
1702
+ },
1703
+ {
1704
+ "name": "divider",
1705
+ "type": "Boolean",
1706
+ "default": "`false`",
1707
+ "description": "Show a divider between the header and body."
1708
+ },
1709
+ {
1710
+ "name": "visually_hide_title",
1711
+ "type": "Boolean",
1712
+ "default": "`false`",
1713
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
1714
+ },
1715
+ {
1716
+ "name": "system_arguments",
1717
+ "type": "Hash",
1718
+ "default": "N/A",
1719
+ "description": "[System arguments](/system-arguments)"
1720
+ }
1721
+ ]
1722
+ },
1723
+ {
1724
+ "component": "RadioButton",
1725
+ "status": "alpha",
1726
+ "a11y_reviewed": false,
1727
+ "short_name": "RadioButton",
1728
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/radio_button.rb",
1729
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/radio_button/default/",
1730
+ "parameters": [
1731
+ {
1732
+ "name": "name",
1733
+ "type": "String",
1734
+ "default": "N/A",
1735
+ "description": "Value for the HTML name attribute."
1736
+ },
1737
+ {
1738
+ "name": "id",
1739
+ "type": "String",
1740
+ "default": "N/A",
1741
+ "description": "Value for the HTML id attribute."
1742
+ },
1743
+ {
1744
+ "name": "class",
1745
+ "type": "String",
1746
+ "default": "N/A",
1747
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
1748
+ },
1749
+ {
1750
+ "name": "classes",
1751
+ "type": "Array",
1752
+ "default": "N/A",
1753
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
1754
+ },
1755
+ {
1756
+ "name": "caption",
1757
+ "type": "String",
1758
+ "default": "N/A",
1759
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
1760
+ },
1761
+ {
1762
+ "name": "label",
1763
+ "type": "String",
1764
+ "default": "N/A",
1765
+ "description": "Label text displayed above the input."
1766
+ },
1767
+ {
1768
+ "name": "visually_hide_label",
1769
+ "type": "Boolean",
1770
+ "default": "N/A",
1771
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
1772
+ },
1773
+ {
1774
+ "name": "disabled",
1775
+ "type": "Boolean",
1776
+ "default": "N/A",
1777
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
1778
+ },
1779
+ {
1780
+ "name": "hidden",
1781
+ "type": "Boolean",
1782
+ "default": "N/A",
1783
+ "description": "When set to `true`, visually hides the field."
1784
+ },
1785
+ {
1786
+ "name": "invalid",
1787
+ "type": "Boolean",
1788
+ "default": "N/A",
1789
+ "description": "If set to `true`, the input will be rendered with a red border. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
1790
+ },
1791
+ {
1792
+ "name": "validation_message",
1793
+ "type": "String",
1794
+ "default": "N/A",
1795
+ "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
1796
+ },
1797
+ {
1798
+ "name": "label_arguments",
1799
+ "type": "Hash",
1800
+ "default": "N/A",
1801
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
1802
+ },
1803
+ {
1804
+ "name": "scope_name_to_model",
1805
+ "type": "Boolean",
1806
+ "default": "N/A",
1807
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field name. For example, if the field name is `my_field`, Rails will normally emit an HTML name attribute of `model[my_field]`. Setting `scope_name_to_model` to `false` will cause Rails to emit `my_field` instead."
1808
+ },
1809
+ {
1810
+ "name": "scope_id_to_model",
1811
+ "type": "Boolean",
1812
+ "default": "N/A",
1813
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field ID. For example, if the field name is `my_field`, Rails will normally emit an HTML ID attribute of `model_my_field`. Setting `scope_id_to_model` to `false` will cause Rails to emit `my_field` instead."
1814
+ },
1815
+ {
1816
+ "name": "required",
1817
+ "type": "Boolean",
1818
+ "default": "N/A",
1819
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
1820
+ },
1821
+ {
1822
+ "name": "aria",
1823
+ "type": "Hash",
1824
+ "default": "N/A",
1825
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
1826
+ },
1827
+ {
1828
+ "name": "data",
1829
+ "type": "Hash",
1830
+ "default": "N/A",
1831
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
1832
+ },
1833
+ {
1834
+ "name": "system_arguments",
1835
+ "type": "Hash",
1836
+ "default": "N/A",
1837
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
1838
+ }
1839
+ ]
1840
+ },
1841
+ {
1842
+ "component": "RadioButtonGroup",
1843
+ "status": "alpha",
1844
+ "a11y_reviewed": false,
1845
+ "short_name": "RadioButtonGroup",
1846
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/radio_button_group.rb",
1847
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/radio_button_group/default/",
1848
+ "parameters": [
1849
+ {
1850
+ "name": "name",
1851
+ "type": "String",
1852
+ "default": "N/A",
1853
+ "description": "Value for the HTML name attribute."
1854
+ },
1855
+ {
1856
+ "name": "label",
1857
+ "type": "String",
1858
+ "default": "N/A",
1859
+ "description": "Label text displayed above the input."
1860
+ },
1861
+ {
1862
+ "name": "hidden",
1863
+ "type": "Boolean",
1864
+ "default": "N/A",
1865
+ "description": "When set to `true`, visually hides the group."
1866
+ },
1867
+ {
1868
+ "name": "caption",
1869
+ "type": "String",
1870
+ "default": "N/A",
1871
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the group."
1872
+ },
1873
+ {
1874
+ "name": "label_arguments",
1875
+ "type": "Hash",
1876
+ "default": "N/A",
1877
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
1878
+ }
1879
+ ]
1880
+ },
1881
+ {
1882
+ "component": "SegmentedControl",
1883
+ "status": "alpha",
1884
+ "a11y_reviewed": true,
1885
+ "short_name": "SegmentedControl",
1886
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb",
1887
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/default/",
1888
+ "parameters": [
1889
+ {
1890
+ "name": "hide_labels",
1891
+ "type": "Boolean",
1892
+ "default": "`false`",
1893
+ "description": "Whether to hide the labels and only show the icons"
1894
+ },
1895
+ {
1896
+ "name": "full_width",
1897
+ "type": "Boolean",
1898
+ "default": "`false`",
1899
+ "description": "If the component should be full width"
1900
+ },
1901
+ {
1902
+ "name": "size",
1903
+ "type": "Symbol",
1904
+ "default": "`:medium`",
1905
+ "description": "One of `:large`, `:medium`, or `:small`."
1906
+ },
1907
+ {
1908
+ "name": "system_arguments",
1909
+ "type": "Hash",
1910
+ "default": "N/A",
1911
+ "description": "[System arguments](/system-arguments)"
1912
+ }
1913
+ ]
1914
+ },
1915
+ {
1916
+ "component": "SegmentedControl::Item",
1917
+ "status": "alpha",
1918
+ "a11y_reviewed": true,
1919
+ "short_name": "SegmentedControlItem",
1920
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control/item.rb",
1921
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/item/default/",
1922
+ "parameters": [
1923
+ {
1924
+ "name": "label",
1925
+ "type": "String",
1926
+ "default": "N/A",
1927
+ "description": "The label to use"
1928
+ },
1929
+ {
1930
+ "name": "selected",
1931
+ "type": "Boolean",
1932
+ "default": "`false`",
1933
+ "description": "Whether the item is selected"
1934
+ },
1935
+ {
1936
+ "name": "icon",
1937
+ "type": "Symbol",
1938
+ "default": "`nil`",
1939
+ "description": "The icon to use"
1940
+ },
1941
+ {
1942
+ "name": "hide_labels",
1943
+ "type": "Symbol",
1944
+ "default": "`false`",
1945
+ "description": "Whether to only show the icon"
1946
+ }
1947
+ ]
1948
+ },
1949
+ {
1950
+ "component": "Select",
1951
+ "status": "alpha",
1952
+ "a11y_reviewed": false,
1953
+ "short_name": "Select",
1954
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/select.rb",
1955
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/select/default/",
1956
+ "parameters": [
1957
+ {
1958
+ "name": "size",
1959
+ "type": "Symbol",
1960
+ "default": "N/A",
1961
+ "description": "The size of the field. One of `:large`, `:medium`, or `:small`."
1962
+ },
1963
+ {
1964
+ "name": "name",
1965
+ "type": "String",
1966
+ "default": "N/A",
1967
+ "description": "Value for the HTML name attribute."
1968
+ },
1969
+ {
1970
+ "name": "id",
1971
+ "type": "String",
1972
+ "default": "N/A",
1973
+ "description": "Value for the HTML id attribute."
1974
+ },
1975
+ {
1976
+ "name": "class",
1977
+ "type": "String",
1978
+ "default": "N/A",
1979
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
1980
+ },
1981
+ {
1982
+ "name": "classes",
1983
+ "type": "Array",
1984
+ "default": "N/A",
1985
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
1986
+ },
1987
+ {
1988
+ "name": "caption",
1989
+ "type": "String",
1990
+ "default": "N/A",
1991
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
1992
+ },
1993
+ {
1994
+ "name": "label",
1995
+ "type": "String",
1996
+ "default": "N/A",
1997
+ "description": "Label text displayed above the input."
1998
+ },
1999
+ {
2000
+ "name": "visually_hide_label",
2001
+ "type": "Boolean",
2002
+ "default": "N/A",
2003
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
2004
+ },
2005
+ {
2006
+ "name": "disabled",
2007
+ "type": "Boolean",
2008
+ "default": "N/A",
2009
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
2010
+ },
2011
+ {
2012
+ "name": "hidden",
2013
+ "type": "Boolean",
2014
+ "default": "N/A",
2015
+ "description": "When set to `true`, visually hides the field."
2016
+ },
2017
+ {
2018
+ "name": "invalid",
2019
+ "type": "Boolean",
2020
+ "default": "N/A",
2021
+ "description": "If set to `true`, the input will be rendered with a red border. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
2022
+ },
2023
+ {
2024
+ "name": "validation_message",
2025
+ "type": "String",
2026
+ "default": "N/A",
2027
+ "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
2028
+ },
2029
+ {
2030
+ "name": "label_arguments",
2031
+ "type": "Hash",
2032
+ "default": "N/A",
2033
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
2034
+ },
2035
+ {
2036
+ "name": "scope_name_to_model",
2037
+ "type": "Boolean",
2038
+ "default": "N/A",
2039
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field name. For example, if the field name is `my_field`, Rails will normally emit an HTML name attribute of `model[my_field]`. Setting `scope_name_to_model` to `false` will cause Rails to emit `my_field` instead."
2040
+ },
2041
+ {
2042
+ "name": "scope_id_to_model",
2043
+ "type": "Boolean",
2044
+ "default": "N/A",
2045
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field ID. For example, if the field name is `my_field`, Rails will normally emit an HTML ID attribute of `model_my_field`. Setting `scope_id_to_model` to `false` will cause Rails to emit `my_field` instead."
2046
+ },
2047
+ {
2048
+ "name": "required",
2049
+ "type": "Boolean",
2050
+ "default": "N/A",
2051
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
2052
+ },
2053
+ {
2054
+ "name": "aria",
2055
+ "type": "Hash",
2056
+ "default": "N/A",
2057
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2058
+ },
2059
+ {
2060
+ "name": "data",
2061
+ "type": "Hash",
2062
+ "default": "N/A",
2063
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
2064
+ },
2065
+ {
2066
+ "name": "system_arguments",
2067
+ "type": "Hash",
2068
+ "default": "N/A",
2069
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
2070
+ },
2071
+ {
2072
+ "name": "multiple",
2073
+ "type": "Boolean",
2074
+ "default": "N/A",
2075
+ "description": "If set to true, the selection will allow multiple choices."
2076
+ },
2077
+ {
2078
+ "name": "include_blank",
2079
+ "type": "Boolean, String",
2080
+ "default": "N/A",
2081
+ "description": "If set to true, an empty option will be created. If set to a string, the string will be used as the option's content and the value will be empty."
2082
+ },
2083
+ {
2084
+ "name": "prompt",
2085
+ "type": "String",
2086
+ "default": "N/A",
2087
+ "description": "Create a prompt option with blank value and the text asking user to select something."
2088
+ }
2089
+ ]
2090
+ },
2091
+ {
2092
+ "component": "SubmitButton",
2093
+ "status": "alpha",
2094
+ "a11y_reviewed": false,
2095
+ "short_name": "SubmitButton",
2096
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/submit_button.rb",
2097
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/submit_button/default/",
2098
+ "parameters": [
2099
+ {
2100
+ "name": "name",
2101
+ "type": "String",
2102
+ "default": "N/A",
2103
+ "description": "Value for the HTML name attribute."
2104
+ },
2105
+ {
2106
+ "name": "id",
2107
+ "type": "String",
2108
+ "default": "N/A",
2109
+ "description": "Value for the HTML id attribute."
2110
+ },
2111
+ {
2112
+ "name": "class",
2113
+ "type": "String",
2114
+ "default": "N/A",
2115
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
2116
+ },
2117
+ {
2118
+ "name": "classes",
2119
+ "type": "Array",
2120
+ "default": "N/A",
2121
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
2122
+ },
2123
+ {
2124
+ "name": "label",
2125
+ "type": "String",
2126
+ "default": "N/A",
2127
+ "description": "Label text displayed above the input."
2128
+ },
2129
+ {
2130
+ "name": "aria",
2131
+ "type": "Hash",
2132
+ "default": "N/A",
2133
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2134
+ },
2135
+ {
2136
+ "name": "data",
2137
+ "type": "Hash",
2138
+ "default": "N/A",
2139
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
2140
+ },
2141
+ {
2142
+ "name": "system_arguments",
2143
+ "type": "Hash",
2144
+ "default": "N/A",
2145
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
2146
+ }
2147
+ ]
2148
+ },
2149
+ {
2150
+ "component": "TabContainer",
2151
+ "status": "alpha",
2152
+ "a11y_reviewed": false,
2153
+ "short_name": "TabContainer",
2154
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_container.rb",
2155
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_container/default/",
2156
+ "parameters": [
2157
+ {
2158
+ "name": "system_arguments",
2159
+ "type": "Hash",
2160
+ "default": "N/A",
668
2161
  "description": "[System arguments](/system-arguments)"
669
2162
  }
670
2163
  ]
@@ -672,6 +2165,8 @@
672
2165
  {
673
2166
  "component": "TabNav",
674
2167
  "status": "alpha",
2168
+ "a11y_reviewed": false,
2169
+ "short_name": "TabNav",
675
2170
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb",
676
2171
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav/default/",
677
2172
  "parameters": [
@@ -704,6 +2199,8 @@
704
2199
  {
705
2200
  "component": "TabPanels",
706
2201
  "status": "alpha",
2202
+ "a11y_reviewed": false,
2203
+ "short_name": "TabPanels",
707
2204
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_panels.rb",
708
2205
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels/default/",
709
2206
  "parameters": [
@@ -728,23 +2225,161 @@
728
2225
  {
729
2226
  "name": "wrapper_arguments",
730
2227
  "type": "Hash",
731
- "default": "`{}`",
732
- "description": "[System arguments](/system-arguments) for the `TabContainer` wrapper."
2228
+ "default": "`{}`",
2229
+ "description": "[System arguments](/system-arguments) for the `TabContainer` wrapper."
2230
+ },
2231
+ {
2232
+ "name": "system_arguments",
2233
+ "type": "Hash",
2234
+ "default": "N/A",
2235
+ "description": "[System arguments](/system-arguments)"
2236
+ }
2237
+ ]
2238
+ },
2239
+ {
2240
+ "component": "TextArea",
2241
+ "status": "alpha",
2242
+ "a11y_reviewed": false,
2243
+ "short_name": "TextArea",
2244
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_area.rb",
2245
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_area/default/",
2246
+ "parameters": [
2247
+ {
2248
+ "name": "full_width",
2249
+ "type": "Boolean",
2250
+ "default": "N/A",
2251
+ "description": "When set to `true`, the field will take up all the horizontal space allowed by its container."
2252
+ },
2253
+ {
2254
+ "name": "name",
2255
+ "type": "String",
2256
+ "default": "N/A",
2257
+ "description": "Value for the HTML name attribute."
2258
+ },
2259
+ {
2260
+ "name": "id",
2261
+ "type": "String",
2262
+ "default": "N/A",
2263
+ "description": "Value for the HTML id attribute."
2264
+ },
2265
+ {
2266
+ "name": "class",
2267
+ "type": "String",
2268
+ "default": "N/A",
2269
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
2270
+ },
2271
+ {
2272
+ "name": "classes",
2273
+ "type": "Array",
2274
+ "default": "N/A",
2275
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
2276
+ },
2277
+ {
2278
+ "name": "caption",
2279
+ "type": "String",
2280
+ "default": "N/A",
2281
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
2282
+ },
2283
+ {
2284
+ "name": "label",
2285
+ "type": "String",
2286
+ "default": "N/A",
2287
+ "description": "Label text displayed above the input."
2288
+ },
2289
+ {
2290
+ "name": "visually_hide_label",
2291
+ "type": "Boolean",
2292
+ "default": "N/A",
2293
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
2294
+ },
2295
+ {
2296
+ "name": "disabled",
2297
+ "type": "Boolean",
2298
+ "default": "N/A",
2299
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
2300
+ },
2301
+ {
2302
+ "name": "hidden",
2303
+ "type": "Boolean",
2304
+ "default": "N/A",
2305
+ "description": "When set to `true`, visually hides the field."
2306
+ },
2307
+ {
2308
+ "name": "invalid",
2309
+ "type": "Boolean",
2310
+ "default": "N/A",
2311
+ "description": "If set to `true`, the input will be rendered with a red border. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
2312
+ },
2313
+ {
2314
+ "name": "validation_message",
2315
+ "type": "String",
2316
+ "default": "N/A",
2317
+ "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
2318
+ },
2319
+ {
2320
+ "name": "label_arguments",
2321
+ "type": "Hash",
2322
+ "default": "N/A",
2323
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
2324
+ },
2325
+ {
2326
+ "name": "scope_name_to_model",
2327
+ "type": "Boolean",
2328
+ "default": "N/A",
2329
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field name. For example, if the field name is `my_field`, Rails will normally emit an HTML name attribute of `model[my_field]`. Setting `scope_name_to_model` to `false` will cause Rails to emit `my_field` instead."
2330
+ },
2331
+ {
2332
+ "name": "scope_id_to_model",
2333
+ "type": "Boolean",
2334
+ "default": "N/A",
2335
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field ID. For example, if the field name is `my_field`, Rails will normally emit an HTML ID attribute of `model_my_field`. Setting `scope_id_to_model` to `false` will cause Rails to emit `my_field` instead."
2336
+ },
2337
+ {
2338
+ "name": "required",
2339
+ "type": "Boolean",
2340
+ "default": "N/A",
2341
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
2342
+ },
2343
+ {
2344
+ "name": "aria",
2345
+ "type": "Hash",
2346
+ "default": "N/A",
2347
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2348
+ },
2349
+ {
2350
+ "name": "data",
2351
+ "type": "Hash",
2352
+ "default": "N/A",
2353
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
733
2354
  },
734
2355
  {
735
2356
  "name": "system_arguments",
736
2357
  "type": "Hash",
737
2358
  "default": "N/A",
738
- "description": "[System arguments](/system-arguments)"
2359
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
739
2360
  }
740
2361
  ]
741
2362
  },
742
2363
  {
743
2364
  "component": "TextField",
744
2365
  "status": "alpha",
2366
+ "a11y_reviewed": false,
2367
+ "short_name": "TextField",
745
2368
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb",
746
2369
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field/default/",
747
2370
  "parameters": [
2371
+ {
2372
+ "name": "size",
2373
+ "type": "Symbol",
2374
+ "default": "N/A",
2375
+ "description": "The size of the field. One of `:large`, `:medium`, or `:small`."
2376
+ },
2377
+ {
2378
+ "name": "full_width",
2379
+ "type": "Boolean",
2380
+ "default": "N/A",
2381
+ "description": "When set to `true`, the field will take up all the horizontal space allowed by its container."
2382
+ },
748
2383
  {
749
2384
  "name": "name",
750
2385
  "type": "String",
@@ -761,19 +2396,19 @@
761
2396
  "name": "class",
762
2397
  "type": "String",
763
2398
  "default": "N/A",
764
- "description": "A list of CSS classes to add to the input. Exists for compatibility with Rails form builders."
2399
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
765
2400
  },
766
2401
  {
767
2402
  "name": "classes",
768
- "type": "String",
2403
+ "type": "Array",
769
2404
  "default": "N/A",
770
- "description": "A list of CSS classes to add to the input. Combined with the `:class` argument."
2405
+ "description": "CSS classes to include in the input's HTML `class` attribute. Combined with the `:class` argument. The list may contain strings, hashes, or `nil` values, and is automatically cleaned up by Primer's [`class_name` helper](https://github.com/primer/view_components/blob/c9cb95c98fee3e2e27f4a10683f555e22285e7f1/app/lib/primer/class_name_helper.rb) (`nils`, falsy entries, and blank strings are ignored)."
771
2406
  },
772
2407
  {
773
2408
  "name": "caption",
774
2409
  "type": "String",
775
2410
  "default": "N/A",
776
- "description": "Caption text to render below the input."
2411
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
777
2412
  },
778
2413
  {
779
2414
  "name": "label",
@@ -785,43 +2420,73 @@
785
2420
  "name": "visually_hide_label",
786
2421
  "type": "Boolean",
787
2422
  "default": "N/A",
788
- "description": "Whether or not to visually hide the label. If `true` the label will be hidden visually but still available to screen readers."
2423
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
789
2424
  },
790
2425
  {
791
- "name": "size",
792
- "type": "Symbol",
2426
+ "name": "disabled",
2427
+ "type": "Boolean",
793
2428
  "default": "N/A",
794
- "description": "The size of the field. One of `:large`, `:medium`, or `:small`."
2429
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
795
2430
  },
796
2431
  {
797
- "name": "show_clear_button",
2432
+ "name": "hidden",
798
2433
  "type": "Boolean",
799
2434
  "default": "N/A",
800
- "description": "Whether or not to include a clear button inside the input that clears the input's contents when clicked."
2435
+ "description": "When set to `true`, visually hides the field."
801
2436
  },
802
2437
  {
803
- "name": "clear_button_id",
2438
+ "name": "invalid",
2439
+ "type": "Boolean",
2440
+ "default": "N/A",
2441
+ "description": "If set to `true`, the input will be rendered with a red border. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
2442
+ },
2443
+ {
2444
+ "name": "validation_message",
804
2445
  "type": "String",
805
2446
  "default": "N/A",
806
- "description": "The HTML id attribute of the clear button."
2447
+ "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
807
2448
  },
808
2449
  {
809
- "name": "full_width",
2450
+ "name": "label_arguments",
2451
+ "type": "Hash",
2452
+ "default": "N/A",
2453
+ "description": "Attributes that will be passed to Rails' `builder.label` method. These can be HTML attributes or any of the other label options Rails supports. They will appear as HTML attributes on the `<label>` tag."
2454
+ },
2455
+ {
2456
+ "name": "scope_name_to_model",
810
2457
  "type": "Boolean",
811
2458
  "default": "N/A",
812
- "description": "Controls whether or not the input takes the full width of its container."
2459
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field name. For example, if the field name is `my_field`, Rails will normally emit an HTML name attribute of `model[my_field]`. Setting `scope_name_to_model` to `false` will cause Rails to emit `my_field` instead."
813
2460
  },
814
2461
  {
815
- "name": "disabled",
2462
+ "name": "scope_id_to_model",
816
2463
  "type": "Boolean",
817
2464
  "default": "N/A",
818
- "description": "Whether or not the input should accept keyboard and mouse input."
2465
+ "description": "Default `true`. When set to `false`, prevents the model name from prefixing the field ID. For example, if the field name is `my_field`, Rails will normally emit an HTML ID attribute of `model_my_field`. Setting `scope_id_to_model` to `false` will cause Rails to emit `my_field` instead."
819
2466
  },
820
2467
  {
821
- "name": "invalid",
2468
+ "name": "required",
822
2469
  "type": "Boolean",
823
2470
  "default": "N/A",
824
- "description": "If `true`, renders the input in a visually invalid state."
2471
+ "description": "Default `false`. When set to `true`, causes an asterisk (*) to appear next to the field's label indicating it is a required field. Note that this option explicitly does _not_ add a `required` HTML attribute. Doing so would enable native browser validations, which are inaccessible and inconsistent with the Primer design system."
2472
+ },
2473
+ {
2474
+ "name": "aria",
2475
+ "type": "Hash",
2476
+ "default": "N/A",
2477
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2478
+ },
2479
+ {
2480
+ "name": "data",
2481
+ "type": "Hash",
2482
+ "default": "N/A",
2483
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
2484
+ },
2485
+ {
2486
+ "name": "system_arguments",
2487
+ "type": "Hash",
2488
+ "default": "N/A",
2489
+ "description": "A hash of attributes passed to the underlying Rails builder methods. These options may mean something special depending on the type of input, otherwise they are emitted as HTML attributes. See the [Rails documentation](https://guides.rubyonrails.org/form_helpers.html) for more information. In addition, the usual Primer utility arguments are accepted in system arguments. For example, passing `mt: 2` will add the `mt-2` class to the input. See the Primer system arguments docs for details."
825
2490
  },
826
2491
  {
827
2492
  "name": "placeholder",
@@ -842,40 +2507,36 @@
842
2507
  "description": "If `true`, uses a monospace font for the input field."
843
2508
  },
844
2509
  {
845
- "name": "leading_visual",
846
- "type": "Hash",
847
- "default": "N/A",
848
- "description": "Renders a leading visual icon before the text field's cursor. The hash will be passed to Primer's [Octicon component](https://primer.style/view-components/components/octicon)."
849
- },
850
- {
851
- "name": "validation_message",
2510
+ "name": "auto_check_src",
852
2511
  "type": "String",
853
2512
  "default": "N/A",
854
- "description": "A validation message to display beneath the input. Implicitly sets `invalid` to `true`."
2513
+ "description": "When provided, makes a request to the given URL whenever the contents of the text field changes. If the server responds with a non-2xx status code, the response body is used as the validation message."
855
2514
  },
856
2515
  {
857
- "name": "label_arguments",
2516
+ "name": "leading_visual",
858
2517
  "type": "Hash",
859
2518
  "default": "N/A",
860
- "description": "System arugments passed to the Rails builder's `#label` method. These arguments will appear as HTML attributes on the `<label>` tag."
2519
+ "description": "Renders a leading visual icon before the text field's cursor. The hash will be passed to Primer's [Octicon](/components/beta/octicon) component."
861
2520
  },
862
2521
  {
863
- "name": "system_arguments",
864
- "type": "Hash",
2522
+ "name": "show_clear_button",
2523
+ "type": "Boolean",
865
2524
  "default": "N/A",
866
- "description": "[System arguments](/system-arguments)"
2525
+ "description": "Whether or not to include a clear button inside the input that clears the input's contents when clicked."
867
2526
  },
868
2527
  {
869
- "name": "block",
870
- "type": "Proc",
2528
+ "name": "clear_button_id",
2529
+ "type": "String",
871
2530
  "default": "N/A",
872
- "description": "Unused."
2531
+ "description": "The HTML id attribute of the clear button."
873
2532
  }
874
2533
  ]
875
2534
  },
876
2535
  {
877
2536
  "component": "ToggleSwitch",
878
2537
  "status": "alpha",
2538
+ "a11y_reviewed": false,
2539
+ "short_name": "ToggleSwitch",
879
2540
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/toggle_switch.rb",
880
2541
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch/default/",
881
2542
  "parameters": [
@@ -926,6 +2587,8 @@
926
2587
  {
927
2588
  "component": "Tooltip",
928
2589
  "status": "alpha",
2590
+ "a11y_reviewed": false,
2591
+ "short_name": "Tooltip",
929
2592
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb",
930
2593
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip/default/",
931
2594
  "parameters": [
@@ -964,6 +2627,8 @@
964
2627
  {
965
2628
  "component": "UnderlineNav",
966
2629
  "status": "alpha",
2630
+ "a11y_reviewed": false,
2631
+ "short_name": "UnderlineNav",
967
2632
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb",
968
2633
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav/default/",
969
2634
  "parameters": [
@@ -1002,6 +2667,8 @@
1002
2667
  {
1003
2668
  "component": "UnderlinePanels",
1004
2669
  "status": "alpha",
2670
+ "a11y_reviewed": false,
2671
+ "short_name": "UnderlinePanels",
1005
2672
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb",
1006
2673
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels/default/",
1007
2674
  "parameters": [
@@ -1037,9 +2704,22 @@
1037
2704
  }
1038
2705
  ]
1039
2706
  },
2707
+ {
2708
+ "component": "Base",
2709
+ "status": "beta",
2710
+ "a11y_reviewed": false,
2711
+ "short_name": "Base",
2712
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/base_component.rb",
2713
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/base/default/",
2714
+ "parameters": [
2715
+
2716
+ ]
2717
+ },
1040
2718
  {
1041
2719
  "component": "AutoComplete",
1042
2720
  "status": "beta",
2721
+ "a11y_reviewed": false,
2722
+ "short_name": "AutoComplete",
1043
2723
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb",
1044
2724
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/default/",
1045
2725
  "parameters": [
@@ -1103,6 +2783,12 @@
1103
2783
  "default": "`false`",
1104
2784
  "description": "Input can be full-width or fit to content"
1105
2785
  },
2786
+ {
2787
+ "name": "width",
2788
+ "type": "String",
2789
+ "default": "`:auto`",
2790
+ "description": "Optional parameter to set max width of results list. One of `:auto`, `:large`, `:medium`, `:small`, `:xlarge`, or `:xxlarge`."
2791
+ },
1106
2792
  {
1107
2793
  "name": "disabled",
1108
2794
  "type": "Boolean",
@@ -1138,6 +2824,8 @@
1138
2824
  {
1139
2825
  "component": "AutoComplete::Item",
1140
2826
  "status": "beta",
2827
+ "a11y_reviewed": false,
2828
+ "short_name": "AutoCompleteItem",
1141
2829
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb",
1142
2830
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item/default/",
1143
2831
  "parameters": [
@@ -1182,6 +2870,8 @@
1182
2870
  {
1183
2871
  "component": "Avatar",
1184
2872
  "status": "beta",
2873
+ "a11y_reviewed": false,
2874
+ "short_name": "Avatar",
1185
2875
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar.rb",
1186
2876
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar/default/",
1187
2877
  "parameters": [
@@ -1226,6 +2916,8 @@
1226
2916
  {
1227
2917
  "component": "AvatarStack",
1228
2918
  "status": "beta",
2919
+ "a11y_reviewed": false,
2920
+ "short_name": "AvatarStack",
1229
2921
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar_stack.rb",
1230
2922
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack/default/",
1231
2923
  "parameters": [
@@ -1264,6 +2956,8 @@
1264
2956
  {
1265
2957
  "component": "BaseButton",
1266
2958
  "status": "beta",
2959
+ "a11y_reviewed": false,
2960
+ "short_name": "BaseButton",
1267
2961
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb",
1268
2962
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button/default/",
1269
2963
  "parameters": [
@@ -1296,6 +2990,8 @@
1296
2990
  {
1297
2991
  "component": "Blankslate",
1298
2992
  "status": "beta",
2993
+ "a11y_reviewed": false,
2994
+ "short_name": "Blankslate",
1299
2995
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb",
1300
2996
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate/default/",
1301
2997
  "parameters": [
@@ -1328,6 +3024,8 @@
1328
3024
  {
1329
3025
  "component": "BorderBox",
1330
3026
  "status": "beta",
3027
+ "a11y_reviewed": false,
3028
+ "short_name": "BorderBox",
1331
3029
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb",
1332
3030
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/default/",
1333
3031
  "parameters": [
@@ -1348,6 +3046,8 @@
1348
3046
  {
1349
3047
  "component": "BorderBox::Header",
1350
3048
  "status": "beta",
3049
+ "a11y_reviewed": false,
3050
+ "short_name": "BorderBoxHeader",
1351
3051
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb",
1352
3052
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header/default/",
1353
3053
  "parameters": [
@@ -1362,6 +3062,8 @@
1362
3062
  {
1363
3063
  "component": "Breadcrumbs",
1364
3064
  "status": "beta",
3065
+ "a11y_reviewed": false,
3066
+ "short_name": "Breadcrumbs",
1365
3067
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb",
1366
3068
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/default/",
1367
3069
  "parameters": [
@@ -1373,9 +3075,22 @@
1373
3075
  }
1374
3076
  ]
1375
3077
  },
3078
+ {
3079
+ "component": "Breadcrumbs::Item",
3080
+ "status": "alpha",
3081
+ "a11y_reviewed": false,
3082
+ "short_name": "BreadcrumbsItem",
3083
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs/item.rb",
3084
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/item/default/",
3085
+ "parameters": [
3086
+
3087
+ ]
3088
+ },
1376
3089
  {
1377
3090
  "component": "Button",
1378
3091
  "status": "beta",
3092
+ "a11y_reviewed": false,
3093
+ "short_name": "Button",
1379
3094
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button.rb",
1380
3095
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button/default/",
1381
3096
  "parameters": [
@@ -1426,6 +3141,8 @@
1426
3141
  {
1427
3142
  "component": "ButtonGroup",
1428
3143
  "status": "beta",
3144
+ "a11y_reviewed": false,
3145
+ "short_name": "ButtonGroup",
1429
3146
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group.rb",
1430
3147
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group/default/",
1431
3148
  "parameters": [
@@ -1452,6 +3169,8 @@
1452
3169
  {
1453
3170
  "component": "ClipboardCopy",
1454
3171
  "status": "beta",
3172
+ "a11y_reviewed": false,
3173
+ "short_name": "ClipboardCopy",
1455
3174
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/clipboard_copy.rb",
1456
3175
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy/default/",
1457
3176
  "parameters": [
@@ -1484,6 +3203,8 @@
1484
3203
  {
1485
3204
  "component": "CloseButton",
1486
3205
  "status": "beta",
3206
+ "a11y_reviewed": false,
3207
+ "short_name": "CloseButton",
1487
3208
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/close_button.rb",
1488
3209
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button/default/",
1489
3210
  "parameters": [
@@ -1504,6 +3225,8 @@
1504
3225
  {
1505
3226
  "component": "Counter",
1506
3227
  "status": "beta",
3228
+ "a11y_reviewed": false,
3229
+ "short_name": "Counter",
1507
3230
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/counter.rb",
1508
3231
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter/default/",
1509
3232
  "parameters": [
@@ -1554,6 +3277,8 @@
1554
3277
  {
1555
3278
  "component": "Details",
1556
3279
  "status": "beta",
3280
+ "a11y_reviewed": false,
3281
+ "short_name": "Details",
1557
3282
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/details.rb",
1558
3283
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details/default/",
1559
3284
  "parameters": [
@@ -1580,6 +3305,8 @@
1580
3305
  {
1581
3306
  "component": "Flash",
1582
3307
  "status": "beta",
3308
+ "a11y_reviewed": false,
3309
+ "short_name": "Flash",
1583
3310
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/flash.rb",
1584
3311
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash/default/",
1585
3312
  "parameters": [
@@ -1624,6 +3351,8 @@
1624
3351
  {
1625
3352
  "component": "Heading",
1626
3353
  "status": "beta",
3354
+ "a11y_reviewed": false,
3355
+ "short_name": "Heading",
1627
3356
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/heading.rb",
1628
3357
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading/default/",
1629
3358
  "parameters": [
@@ -1644,6 +3373,8 @@
1644
3373
  {
1645
3374
  "component": "IconButton",
1646
3375
  "status": "beta",
3376
+ "a11y_reviewed": false,
3377
+ "short_name": "IconButton",
1647
3378
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/icon_button.rb",
1648
3379
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button/default/",
1649
3380
  "parameters": [
@@ -1718,6 +3449,8 @@
1718
3449
  {
1719
3450
  "component": "Label",
1720
3451
  "status": "beta",
3452
+ "a11y_reviewed": false,
3453
+ "short_name": "Label",
1721
3454
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/label.rb",
1722
3455
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label/default/",
1723
3456
  "parameters": [
@@ -1762,6 +3495,8 @@
1762
3495
  {
1763
3496
  "component": "Link",
1764
3497
  "status": "beta",
3498
+ "a11y_reviewed": false,
3499
+ "short_name": "Link",
1765
3500
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
1766
3501
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/",
1767
3502
  "parameters": [
@@ -1806,6 +3541,8 @@
1806
3541
  {
1807
3542
  "component": "Markdown",
1808
3543
  "status": "beta",
3544
+ "a11y_reviewed": false,
3545
+ "short_name": "Markdown",
1809
3546
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/markdown.rb",
1810
3547
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/markdown/default/",
1811
3548
  "parameters": [
@@ -1826,6 +3563,8 @@
1826
3563
  {
1827
3564
  "component": "Octicon",
1828
3565
  "status": "beta",
3566
+ "a11y_reviewed": false,
3567
+ "short_name": "Octicon",
1829
3568
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/octicon.rb",
1830
3569
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/octicon/default/",
1831
3570
  "parameters": [
@@ -1864,6 +3603,8 @@
1864
3603
  {
1865
3604
  "component": "Popover",
1866
3605
  "status": "beta",
3606
+ "a11y_reviewed": false,
3607
+ "short_name": "Popover",
1867
3608
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/popover.rb",
1868
3609
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/popover/default/",
1869
3610
  "parameters": [
@@ -1878,6 +3619,8 @@
1878
3619
  {
1879
3620
  "component": "ProgressBar",
1880
3621
  "status": "beta",
3622
+ "a11y_reviewed": false,
3623
+ "short_name": "ProgressBar",
1881
3624
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/progress_bar.rb",
1882
3625
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/progress_bar/default/",
1883
3626
  "parameters": [
@@ -1898,6 +3641,8 @@
1898
3641
  {
1899
3642
  "component": "RelativeTime",
1900
3643
  "status": "beta",
3644
+ "a11y_reviewed": false,
3645
+ "short_name": "RelativeTime",
1901
3646
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/relative_time.rb",
1902
3647
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/relative_time/default/",
1903
3648
  "parameters": [
@@ -2014,6 +3759,8 @@
2014
3759
  {
2015
3760
  "component": "Spinner",
2016
3761
  "status": "beta",
3762
+ "a11y_reviewed": false,
3763
+ "short_name": "Spinner",
2017
3764
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/spinner.rb",
2018
3765
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/spinner/default/",
2019
3766
  "parameters": [
@@ -2040,6 +3787,8 @@
2040
3787
  {
2041
3788
  "component": "State",
2042
3789
  "status": "beta",
3790
+ "a11y_reviewed": false,
3791
+ "short_name": "State",
2043
3792
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/state.rb",
2044
3793
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/state/default/",
2045
3794
  "parameters": [
@@ -2078,6 +3827,8 @@
2078
3827
  {
2079
3828
  "component": "Subhead",
2080
3829
  "status": "beta",
3830
+ "a11y_reviewed": false,
3831
+ "short_name": "Subhead",
2081
3832
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/subhead.rb",
2082
3833
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/subhead/default/",
2083
3834
  "parameters": [
@@ -2104,6 +3855,8 @@
2104
3855
  {
2105
3856
  "component": "Text",
2106
3857
  "status": "beta",
3858
+ "a11y_reviewed": false,
3859
+ "short_name": "Text",
2107
3860
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb",
2108
3861
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text/default/",
2109
3862
  "parameters": [
@@ -2124,6 +3877,8 @@
2124
3877
  {
2125
3878
  "component": "TimelineItem",
2126
3879
  "status": "beta",
3880
+ "a11y_reviewed": false,
3881
+ "short_name": "TimelineItem",
2127
3882
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/timeline_item.rb",
2128
3883
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/timeline_item/default/",
2129
3884
  "parameters": [
@@ -2141,9 +3896,22 @@
2141
3896
  }
2142
3897
  ]
2143
3898
  },
3899
+ {
3900
+ "component": "TimelineItem::Badge",
3901
+ "status": "beta",
3902
+ "a11y_reviewed": false,
3903
+ "short_name": "TimelineItemBadge",
3904
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/timeline_item/badge.rb",
3905
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/timeline_item/badge/default/",
3906
+ "parameters": [
3907
+
3908
+ ]
3909
+ },
2144
3910
  {
2145
3911
  "component": "Truncate",
2146
3912
  "status": "beta",
3913
+ "a11y_reviewed": false,
3914
+ "short_name": "Truncate",
2147
3915
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb",
2148
3916
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/default/",
2149
3917
  "parameters": [
@@ -2155,9 +3923,128 @@
2155
3923
  }
2156
3924
  ]
2157
3925
  },
3926
+ {
3927
+ "component": "Truncate::TruncateText",
3928
+ "status": "alpha",
3929
+ "a11y_reviewed": false,
3930
+ "short_name": "TruncateTruncateText",
3931
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate/truncate_text.rb",
3932
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/truncate_text/default/",
3933
+ "parameters": [
3934
+
3935
+ ]
3936
+ },
3937
+ {
3938
+ "component": "Blankslate",
3939
+ "status": "deprecated",
3940
+ "a11y_reviewed": false,
3941
+ "short_name": "Blankslate",
3942
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/blankslate_component.rb",
3943
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/blankslate/default/",
3944
+ "parameters": [
3945
+ {
3946
+ "name": "title",
3947
+ "type": "String",
3948
+ "default": "`\"\"`",
3949
+ "description": "Text that appears in a larger bold font."
3950
+ },
3951
+ {
3952
+ "name": "title_tag",
3953
+ "type": "Symbol",
3954
+ "default": "`:h3`",
3955
+ "description": "HTML tag to use for title."
3956
+ },
3957
+ {
3958
+ "name": "icon",
3959
+ "type": "Symbol",
3960
+ "default": "`\"\"`",
3961
+ "description": "Octicon icon to use at top of component."
3962
+ },
3963
+ {
3964
+ "name": "icon_size",
3965
+ "type": "Symbol",
3966
+ "default": "`:medium`",
3967
+ "description": "One of `:xsmall` (`12`), `:small` (`16`), or `:medium` (`24`)."
3968
+ },
3969
+ {
3970
+ "name": "image_src",
3971
+ "type": "String",
3972
+ "default": "`\"\"`",
3973
+ "description": "Image to display."
3974
+ },
3975
+ {
3976
+ "name": "image_alt",
3977
+ "type": "String",
3978
+ "default": "`\" \"`",
3979
+ "description": "Alt text for image."
3980
+ },
3981
+ {
3982
+ "name": "description",
3983
+ "type": "String",
3984
+ "default": "`\"\"`",
3985
+ "description": "Text that appears below the title. Typically a whole sentence."
3986
+ },
3987
+ {
3988
+ "name": "button_text",
3989
+ "type": "String",
3990
+ "default": "`\"\"`",
3991
+ "description": "The text of the button."
3992
+ },
3993
+ {
3994
+ "name": "button_url",
3995
+ "type": "String",
3996
+ "default": "`\"\"`",
3997
+ "description": "The URL where the user will be taken after clicking the button."
3998
+ },
3999
+ {
4000
+ "name": "button_classes",
4001
+ "type": "String",
4002
+ "default": "`\"btn-primary my-3\"`",
4003
+ "description": "Classes to apply to action button"
4004
+ },
4005
+ {
4006
+ "name": "link_text",
4007
+ "type": "String",
4008
+ "default": "`\"\"`",
4009
+ "description": "The text of the link."
4010
+ },
4011
+ {
4012
+ "name": "link_url",
4013
+ "type": "String",
4014
+ "default": "`\"\"`",
4015
+ "description": "The URL where the user will be taken after clicking the link."
4016
+ },
4017
+ {
4018
+ "name": "narrow",
4019
+ "type": "Boolean",
4020
+ "default": "`false`",
4021
+ "description": "Adds a maximum width."
4022
+ },
4023
+ {
4024
+ "name": "large",
4025
+ "type": "Boolean",
4026
+ "default": "`false`",
4027
+ "description": "Increases the font size."
4028
+ },
4029
+ {
4030
+ "name": "spacious",
4031
+ "type": "Boolean",
4032
+ "default": "`false`",
4033
+ "description": "Adds extra padding."
4034
+ },
4035
+ {
4036
+ "name": "system_arguments",
4037
+ "type": "Hash",
4038
+ "default": "N/A",
4039
+ "description": "[System arguments](/system-arguments)"
4040
+ }
4041
+ ]
4042
+ },
2158
4043
  {
2159
4044
  "component": "Box",
2160
4045
  "status": "stable",
4046
+ "a11y_reviewed": false,
4047
+ "short_name": "Box",
2161
4048
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb",
2162
4049
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box/default/",
2163
4050
  "parameters": [
@@ -2172,6 +4059,8 @@
2172
4059
  {
2173
4060
  "component": "Button",
2174
4061
  "status": "deprecated",
4062
+ "a11y_reviewed": false,
4063
+ "short_name": "Button",
2175
4064
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
2176
4065
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button/default/",
2177
4066
  "parameters": [
@@ -2231,9 +4120,33 @@
2231
4120
  }
2232
4121
  ]
2233
4122
  },
4123
+ {
4124
+ "component": "ConditionalWrapper",
4125
+ "status": "alpha",
4126
+ "a11y_reviewed": false,
4127
+ "short_name": "ConditionalWrapper",
4128
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/conditional_wrapper.rb",
4129
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/conditional_wrapper/default/",
4130
+ "parameters": [
4131
+
4132
+ ]
4133
+ },
4134
+ {
4135
+ "component": "Content",
4136
+ "status": "stable",
4137
+ "a11y_reviewed": false,
4138
+ "short_name": "Content",
4139
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/content.rb",
4140
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/content/default/",
4141
+ "parameters": [
4142
+
4143
+ ]
4144
+ },
2234
4145
  {
2235
4146
  "component": "IconButton",
2236
4147
  "status": "deprecated",
4148
+ "a11y_reviewed": false,
4149
+ "short_name": "IconButton",
2237
4150
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb",
2238
4151
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button/default/",
2239
4152
  "parameters": [
@@ -2295,7 +4208,9 @@
2295
4208
  },
2296
4209
  {
2297
4210
  "component": "Layout",
2298
- "status": "alpha",
4211
+ "status": "deprecated",
4212
+ "a11y_reviewed": false,
4213
+ "short_name": "Layout",
2299
4214
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb",
2300
4215
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout/default/",
2301
4216
  "parameters": [
@@ -2325,83 +4240,11 @@
2325
4240
  }
2326
4241
  ]
2327
4242
  },
2328
- {
2329
- "component": "LocalTime",
2330
- "status": "deprecated",
2331
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/local_time.rb",
2332
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/local_time/default/",
2333
- "parameters": [
2334
- {
2335
- "name": "datetime",
2336
- "type": "DateTime",
2337
- "default": "N/A",
2338
- "description": "The date to parse"
2339
- },
2340
- {
2341
- "name": "initial_text",
2342
- "type": "String",
2343
- "default": "`nil`",
2344
- "description": "Text to render before component is initialized"
2345
- },
2346
- {
2347
- "name": "weekday",
2348
- "type": "Symbol",
2349
- "default": "`:short`",
2350
- "description": "One of `:long` or `:short`."
2351
- },
2352
- {
2353
- "name": "year",
2354
- "type": "Symbol",
2355
- "default": "`:numeric`",
2356
- "description": "One of `:2-digit` or `:numeric`."
2357
- },
2358
- {
2359
- "name": "month",
2360
- "type": "Symbol",
2361
- "default": "`:short`",
2362
- "description": "One of `:long` or `:short`."
2363
- },
2364
- {
2365
- "name": "day",
2366
- "type": "Symbol",
2367
- "default": "`:numeric`",
2368
- "description": "One of `:2-digit` or `:numeric`."
2369
- },
2370
- {
2371
- "name": "hour",
2372
- "type": "Symbol",
2373
- "default": "`:numeric`",
2374
- "description": "One of `:2-digit` or `:numeric`."
2375
- },
2376
- {
2377
- "name": "minute",
2378
- "type": "Symbol",
2379
- "default": "`:numeric`",
2380
- "description": "One of `:2-digit` or `:numeric`."
2381
- },
2382
- {
2383
- "name": "second",
2384
- "type": "Symbol",
2385
- "default": "`:numeric`",
2386
- "description": "One of `:2-digit` or `:numeric`."
2387
- },
2388
- {
2389
- "name": "time_zone_name",
2390
- "type": "Symbol",
2391
- "default": "`:short`",
2392
- "description": "One of `:long` or `:short`."
2393
- },
2394
- {
2395
- "name": "system_arguments",
2396
- "type": "Hash",
2397
- "default": "N/A",
2398
- "description": "[System arguments](/system-arguments)"
2399
- }
2400
- ]
2401
- },
2402
4243
  {
2403
4244
  "component": "Navigation::Tab",
2404
- "status": "alpha",
4245
+ "status": "deprecated",
4246
+ "a11y_reviewed": false,
4247
+ "short_name": "NavigationTab",
2405
4248
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb",
2406
4249
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab/default/",
2407
4250
  "parameters": [
@@ -2449,35 +4292,11 @@
2449
4292
  }
2450
4293
  ]
2451
4294
  },
2452
- {
2453
- "component": "TimeAgo",
2454
- "status": "deprecated",
2455
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/time_ago_component.rb",
2456
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago/default/",
2457
- "parameters": [
2458
- {
2459
- "name": "time",
2460
- "type": "Time",
2461
- "default": "N/A",
2462
- "description": "The time to be formatted"
2463
- },
2464
- {
2465
- "name": "micro",
2466
- "type": "Boolean",
2467
- "default": "`false`",
2468
- "description": "If true then the text will be formatted in \"micro\" mode, using as few characters as possible"
2469
- },
2470
- {
2471
- "name": "system_arguments",
2472
- "type": "Hash",
2473
- "default": "N/A",
2474
- "description": "[System arguments](/system-arguments)"
2475
- }
2476
- ]
2477
- },
2478
4295
  {
2479
4296
  "component": "Tooltip",
2480
4297
  "status": "deprecated",
4298
+ "a11y_reviewed": false,
4299
+ "short_name": "Tooltip",
2481
4300
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tooltip.rb",
2482
4301
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip/default/",
2483
4302
  "parameters": [
@@ -2521,7 +4340,9 @@
2521
4340
  },
2522
4341
  {
2523
4342
  "component": "Truncate",
2524
- "status": "beta",
4343
+ "status": "deprecated",
4344
+ "a11y_reviewed": false,
4345
+ "short_name": "Truncate",
2525
4346
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/truncate.rb",
2526
4347
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate/default/",
2527
4348
  "parameters": [