jekyll-v4-theme-primer 0.11.0 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (263) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -3
  3. data/_layouts/default.html +4 -2
  4. data/_sass/@primer/css/autocomplete/suggester.scss +11 -11
  5. data/_sass/@primer/css/avatars/avatar-parent-child.scss +2 -2
  6. data/_sass/@primer/css/avatars/circle-badge.scss +3 -3
  7. data/_sass/@primer/css/base/base.scss +5 -5
  8. data/_sass/@primer/css/base/kbd.scss +5 -5
  9. data/_sass/@primer/css/base/normalize.scss +3 -2
  10. data/_sass/@primer/css/box/box-overlay.scss +3 -3
  11. data/_sass/@primer/css/branch-name/branch-name.scss +6 -6
  12. data/_sass/@primer/css/buttons/button.scss +63 -63
  13. data/_sass/@primer/css/buttons/misc.scss +26 -26
  14. data/_sass/@primer/css/color-modes/native.scss +4 -2
  15. data/_sass/@primer/css/core/index.scss +0 -1
  16. data/_sass/@primer/css/forms/form-control.scss +18 -18
  17. data/_sass/@primer/css/forms/form-group.scss +31 -30
  18. data/_sass/@primer/css/forms/form-select.scss +1 -1
  19. data/_sass/@primer/css/forms/index.scss +0 -1
  20. data/_sass/@primer/css/forms/input-group.scss +10 -0
  21. data/_sass/@primer/css/forms/radio-group.scss +6 -6
  22. data/_sass/@primer/css/header/header.scss +7 -7
  23. data/_sass/@primer/css/labels/index.scss +0 -1
  24. data/_sass/@primer/css/layout/app-frame.scss +13 -13
  25. data/_sass/@primer/css/layout/page-layout.scss +2 -6
  26. data/_sass/@primer/css/layout/stack.scss +7 -7
  27. data/_sass/@primer/css/markdown/blob-csv.scss +2 -2
  28. data/_sass/@primer/css/markdown/code.scss +3 -3
  29. data/_sass/@primer/css/markdown/footnotes.scss +3 -3
  30. data/_sass/@primer/css/markdown/headings.scss +4 -4
  31. data/_sass/@primer/css/markdown/images.scss +3 -3
  32. data/_sass/@primer/css/markdown/lists.scss +4 -4
  33. data/_sass/@primer/css/markdown/markdown-body.scss +4 -4
  34. data/_sass/@primer/css/markdown/tables.scss +4 -4
  35. data/_sass/@primer/css/marketing/buttons/button.scss +9 -10
  36. data/_sass/@primer/css/marketing/support/variables.scss +15 -0
  37. data/_sass/@primer/css/marketing/utilities/layout.scss +0 -1
  38. data/_sass/@primer/css/navigation/filter-list.scss +8 -8
  39. data/_sass/@primer/css/navigation/sidenav.scss +12 -12
  40. data/_sass/@primer/css/navigation/subnav.scss +9 -9
  41. data/_sass/@primer/css/pagination/pagination.scss +7 -7
  42. data/_sass/@primer/css/primitives/index.scss +9 -9
  43. data/_sass/@primer/css/select-menu/select-menu.scss +41 -41
  44. data/_sass/@primer/css/support/mixins/color-modes.scss +89 -1
  45. data/_sass/@primer/css/support/mixins/misc.scss +8 -8
  46. data/_sass/@primer/css/support/variables/misc.scss +2 -2
  47. data/_sass/@primer/css/support/variables/typography.scss +1 -1
  48. data/_sass/@primer/css/toasts/toasts.scss +17 -17
  49. data/_sass/@primer/css/tooltips/tooltips.scss +9 -62
  50. data/_sass/@primer/css/utilities/borders.scss +9 -9
  51. data/_sass/@primer/css/utilities/box-shadow.scss +8 -4
  52. data/_sass/@primer/css/utilities/colors.scss +59 -60
  53. data/_sass/@primer/css/utilities/details.scss +1 -1
  54. data/_sass/@primer/css/utilities/flexbox.scss +0 -1
  55. data/_sass/@primer/css/utilities/layout.scss +7 -5
  56. data/_sass/@primer/css/utilities/margin.scss +0 -2
  57. data/_sass/@primer/css/utilities/padding.scss +0 -1
  58. data/_sass/@primer/css/utilities/typography.scss +8 -8
  59. data/_sass/@primer/css/utilities/visibility-display.scss +10 -9
  60. data/_sass/@primer/primitives/dist/scss/base/size/size.scss +17 -0
  61. data/_sass/@primer/primitives/dist/scss/base/typography/typography.scss +4 -0
  62. data/_sass/@primer/primitives/dist/scss/colors/_dark.scss +29 -20
  63. data/_sass/@primer/primitives/dist/scss/colors/_dark_colorblind.scss +14 -5
  64. data/_sass/@primer/primitives/dist/scss/colors/_dark_dimmed.scss +14 -5
  65. data/_sass/@primer/primitives/dist/scss/colors/_dark_high_contrast.scss +12 -3
  66. data/_sass/@primer/primitives/dist/scss/colors/_dark_tritanopia.scss +14 -5
  67. data/_sass/@primer/primitives/dist/scss/colors/_light.scss +13 -4
  68. data/_sass/@primer/primitives/dist/scss/colors/_light_colorblind.scss +13 -4
  69. data/_sass/@primer/primitives/dist/scss/colors/_light_high_contrast.scss +13 -4
  70. data/_sass/@primer/primitives/dist/scss/colors/_light_tritanopia.scss +13 -4
  71. data/_sass/@primer/primitives/dist/scss/functional/motion/motion.scss +3 -0
  72. data/_sass/@primer/primitives/dist/scss/functional/size/border.scss +12 -0
  73. data/_sass/@primer/primitives/dist/scss/functional/size/breakpoints.scss +6 -0
  74. data/_sass/@primer/primitives/dist/scss/functional/size/size-coarse.scss +3 -0
  75. data/_sass/@primer/primitives/dist/scss/functional/size/size-fine.scss +3 -0
  76. data/_sass/@primer/primitives/dist/scss/functional/size/size.scss +72 -0
  77. data/_sass/@primer/primitives/dist/scss/functional/size/viewport.scss +6 -0
  78. data/_sass/@primer/primitives/dist/scss/functional/themes/dark-colorblind.scss +503 -0
  79. data/_sass/@primer/primitives/dist/scss/functional/themes/dark-dimmed.scss +503 -0
  80. data/_sass/@primer/primitives/dist/scss/functional/themes/dark-high-contrast.scss +503 -0
  81. data/_sass/@primer/primitives/dist/scss/functional/themes/dark-tritanopia.scss +503 -0
  82. data/_sass/@primer/primitives/dist/scss/functional/themes/dark.scss +503 -0
  83. data/_sass/@primer/primitives/dist/scss/functional/themes/light-colorblind.scss +503 -0
  84. data/_sass/@primer/primitives/dist/scss/functional/themes/light-high-contrast.scss +503 -0
  85. data/_sass/@primer/primitives/dist/scss/functional/themes/light-tritanopia.scss +503 -0
  86. data/_sass/@primer/primitives/dist/scss/functional/themes/light.scss +503 -0
  87. data/_sass/@primer/primitives/dist/scss/functional/typography/typography.scss +45 -0
  88. data/_sass/@primer/primitives/tokens-next-private/scss/base/size/size.scss +17 -21
  89. data/_sass/@primer/primitives/tokens-next-private/scss/base/typography/typography.scss +4 -8
  90. data/_sass/@primer/primitives/tokens-next-private/scss/functional/motion/motion.scss +3 -0
  91. data/_sass/@primer/primitives/tokens-next-private/scss/functional/size/border.scss +12 -16
  92. data/_sass/@primer/primitives/tokens-next-private/scss/functional/size/breakpoints.scss +6 -10
  93. data/_sass/@primer/primitives/tokens-next-private/scss/functional/size/size-coarse.scss +3 -7
  94. data/_sass/@primer/primitives/tokens-next-private/scss/functional/size/size-fine.scss +3 -7
  95. data/_sass/@primer/primitives/tokens-next-private/scss/functional/size/size.scss +72 -51
  96. data/_sass/@primer/primitives/tokens-next-private/scss/functional/size/viewport.scss +6 -19
  97. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/dark-colorblind.scss +503 -391
  98. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/dark-dimmed.scss +503 -391
  99. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/dark-high-contrast.scss +503 -391
  100. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/dark-tritanopia.scss +503 -391
  101. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/dark.scss +503 -391
  102. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/light-colorblind.scss +503 -366
  103. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/light-high-contrast.scss +503 -366
  104. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/light-tritanopia.scss +503 -366
  105. data/_sass/@primer/primitives/tokens-next-private/scss/functional/themes/light.scss +503 -366
  106. data/_sass/@primer/primitives/tokens-next-private/scss/functional/typography/typography.scss +45 -49
  107. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/base/size/size.scss +2 -2
  108. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/base/typography/typography.scss +2 -2
  109. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/border.scss +2 -2
  110. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/breakpoints.scss +2 -2
  111. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/size-coarse.scss +2 -2
  112. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/size-fine.scss +2 -2
  113. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/size.scss +2 -2
  114. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/viewport.scss +2 -2
  115. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/typography/typography.scss +2 -2
  116. data/_sass/@primer/view-components/README.md +1 -1
  117. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/action_bar_element.d.ts +17 -0
  118. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/action_menu/action_menu_element.d.ts +51 -0
  119. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/dropdown/menu.d.ts +1 -0
  120. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/dropdown.d.ts +1 -0
  121. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/image_crop.d.ts +1 -0
  122. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/modal_dialog.d.ts +18 -0
  123. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/segmented_control.d.ts +12 -0
  124. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/tab_container.d.ts +1 -0
  125. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/toggle_switch.d.ts +30 -0
  126. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/tool_tip.d.ts +27 -0
  127. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/alpha/x_banner.d.ts +13 -0
  128. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/anchored_position.d.ts +27 -0
  129. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/beta/auto_complete/auto_complete.d.ts +1 -0
  130. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/beta/clipboard_copy.d.ts +1 -0
  131. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/beta/nav_list.d.ts +17 -0
  132. data/_sass/@primer/view-components/app/{components/primer/alpha/nav_list.d.ts → assets/javascripts/app/components/primer/beta/nav_list_group_element.d.ts} +3 -9
  133. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/dialog_helper.d.ts +15 -0
  134. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/focus_group.d.ts +19 -0
  135. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/primer.d.ts +23 -0
  136. data/_sass/@primer/view-components/app/assets/javascripts/app/components/primer/scrollable_region.d.ts +13 -0
  137. data/_sass/@primer/view-components/app/assets/javascripts/lib/primer/forms/primer_multi_input.d.ts +10 -0
  138. data/_sass/@primer/view-components/app/assets/javascripts/lib/primer/forms/primer_text_field.d.ts +1 -0
  139. data/_sass/@primer/view-components/app/assets/javascripts/lib/primer/forms/toggle_switch_input.d.ts +5 -0
  140. data/_sass/@primer/view-components/app/assets/javascripts/primer_view_components.js +1 -1
  141. data/_sass/@primer/view-components/app/assets/javascripts/primer_view_components.js.map +1 -1
  142. data/_sass/@primer/view-components/app/assets/styles/primer_view_components.css +1 -3
  143. data/_sass/@primer/view-components/app/assets/styles/primer_view_components.css.map +1 -1
  144. data/_sass/@primer/view-components/app/components/primer/alpha/action_bar.css +1 -0
  145. data/_sass/@primer/view-components/app/components/primer/alpha/action_bar.css.json +14 -0
  146. data/_sass/@primer/view-components/app/components/primer/alpha/action_bar_element.d.ts +17 -0
  147. data/_sass/@primer/view-components/app/components/primer/alpha/action_bar_element.js +180 -0
  148. data/_sass/@primer/view-components/app/components/primer/alpha/action_list.css +1 -1
  149. data/_sass/@primer/view-components/app/components/primer/alpha/action_list.css.json +136 -1
  150. data/_sass/@primer/view-components/app/components/primer/alpha/action_menu/action_menu_element.d.ts +51 -0
  151. data/_sass/@primer/view-components/app/components/primer/alpha/action_menu/action_menu_element.js +470 -0
  152. data/_sass/@primer/view-components/app/components/primer/alpha/auto_complete.css +1 -1
  153. data/_sass/@primer/view-components/app/components/primer/alpha/auto_complete.css.json +23 -1
  154. data/_sass/@primer/view-components/app/components/primer/alpha/banner.css +1 -1
  155. data/_sass/@primer/view-components/app/components/primer/alpha/banner.css.json +24 -1
  156. data/_sass/@primer/view-components/app/components/primer/alpha/button_marketing.css +1 -1
  157. data/_sass/@primer/view-components/app/components/primer/alpha/button_marketing.css.json +33 -1
  158. data/_sass/@primer/view-components/app/components/primer/alpha/dialog.css +1 -1
  159. data/_sass/@primer/view-components/app/components/primer/alpha/dialog.css.json +65 -1
  160. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.css +1 -1
  161. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.css.json +40 -1
  162. data/_sass/@primer/view-components/app/components/primer/alpha/layout.css +1 -1
  163. data/_sass/@primer/view-components/app/components/primer/alpha/layout.css.json +80 -1
  164. data/_sass/@primer/view-components/app/components/primer/alpha/menu.css +1 -1
  165. data/_sass/@primer/view-components/app/components/primer/alpha/menu.css.json +28 -1
  166. data/_sass/@primer/view-components/app/components/primer/alpha/modal_dialog.js +50 -27
  167. data/_sass/@primer/view-components/app/components/primer/alpha/overlay.css +1 -0
  168. data/_sass/@primer/view-components/app/components/primer/alpha/overlay.css.json +11 -0
  169. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.css +1 -1
  170. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.css.json +29 -1
  171. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.js +4 -4
  172. data/_sass/@primer/view-components/app/components/primer/alpha/tab_nav.css +1 -1
  173. data/_sass/@primer/view-components/app/components/primer/alpha/tab_nav.css.json +24 -1
  174. data/_sass/@primer/view-components/app/components/primer/alpha/text_field.css +1 -3
  175. data/_sass/@primer/view-components/app/components/primer/alpha/text_field.css.json +144 -1
  176. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.css +1 -1
  177. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.css.json +40 -1
  178. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.d.ts +2 -1
  179. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.js +54 -45
  180. data/_sass/@primer/view-components/app/components/primer/alpha/tool_tip.d.ts +4 -2
  181. data/_sass/@primer/view-components/app/components/primer/alpha/tool_tip.js +159 -72
  182. data/_sass/@primer/view-components/app/components/primer/alpha/underline_nav.css +1 -1
  183. data/_sass/@primer/view-components/app/components/primer/alpha/underline_nav.css.json +28 -1
  184. data/_sass/@primer/view-components/app/components/primer/alpha/x_banner.d.ts +3 -1
  185. data/_sass/@primer/view-components/app/components/primer/alpha/x_banner.js +25 -10
  186. data/_sass/@primer/view-components/app/components/primer/anchored_position.d.ts +27 -0
  187. data/_sass/@primer/view-components/app/components/primer/anchored_position.js +157 -0
  188. data/_sass/@primer/view-components/app/components/primer/beta/avatar.css +1 -1
  189. data/_sass/@primer/view-components/app/components/primer/beta/avatar.css.json +17 -1
  190. data/_sass/@primer/view-components/app/components/primer/beta/avatar_stack.css +1 -1
  191. data/_sass/@primer/view-components/app/components/primer/beta/avatar_stack.css.json +28 -1
  192. data/_sass/@primer/view-components/app/components/primer/beta/blankslate.css +1 -1
  193. data/_sass/@primer/view-components/app/components/primer/beta/blankslate.css.json +23 -1
  194. data/_sass/@primer/view-components/app/components/primer/beta/border_box.css +1 -1
  195. data/_sass/@primer/view-components/app/components/primer/beta/border_box.css.json +54 -1
  196. data/_sass/@primer/view-components/app/components/primer/beta/breadcrumbs.css +1 -1
  197. data/_sass/@primer/view-components/app/components/primer/beta/breadcrumbs.css.json +11 -1
  198. data/_sass/@primer/view-components/app/components/primer/beta/button.css +1 -1
  199. data/_sass/@primer/view-components/app/components/primer/beta/button.css.json +77 -1
  200. data/_sass/@primer/view-components/app/components/primer/beta/button_group.css +1 -0
  201. data/_sass/@primer/view-components/app/components/primer/beta/button_group.css.json +12 -0
  202. data/_sass/@primer/view-components/app/components/primer/beta/counter.css +1 -1
  203. data/_sass/@primer/view-components/app/components/primer/beta/counter.css.json +10 -1
  204. data/_sass/@primer/view-components/app/components/primer/beta/flash.css +1 -1
  205. data/_sass/@primer/view-components/app/components/primer/beta/flash.css.json +27 -1
  206. data/_sass/@primer/view-components/app/components/primer/beta/label.css +1 -1
  207. data/_sass/@primer/view-components/app/components/primer/beta/label.css.json +25 -1
  208. data/_sass/@primer/view-components/app/components/primer/beta/link.css +1 -1
  209. data/_sass/@primer/view-components/app/components/primer/beta/link.css.json +20 -1
  210. data/_sass/@primer/view-components/app/components/primer/beta/nav_list.d.ts +17 -0
  211. data/_sass/@primer/view-components/app/components/primer/beta/nav_list.js +170 -0
  212. data/_sass/@primer/view-components/app/components/primer/beta/nav_list_group_element.d.ts +19 -0
  213. data/_sass/@primer/view-components/app/components/primer/{alpha/nav_list.js → beta/nav_list_group_element.js} +30 -53
  214. data/_sass/@primer/view-components/app/components/primer/beta/popover.css +1 -1
  215. data/_sass/@primer/view-components/app/components/primer/beta/popover.css.json +39 -1
  216. data/_sass/@primer/view-components/app/components/primer/beta/progress_bar.css +1 -1
  217. data/_sass/@primer/view-components/app/components/primer/beta/progress_bar.css.json +10 -1
  218. data/_sass/@primer/view-components/app/components/primer/beta/state.css +1 -1
  219. data/_sass/@primer/view-components/app/components/primer/beta/state.css.json +13 -1
  220. data/_sass/@primer/view-components/app/components/primer/beta/subhead.css +1 -1
  221. data/_sass/@primer/view-components/app/components/primer/beta/subhead.css.json +14 -1
  222. data/_sass/@primer/view-components/app/components/primer/beta/timeline_item.css +1 -1
  223. data/_sass/@primer/view-components/app/components/primer/beta/timeline_item.css.json +16 -1
  224. data/_sass/@primer/view-components/app/components/primer/beta/truncate.css +1 -1
  225. data/_sass/@primer/view-components/app/components/primer/beta/truncate.css.json +12 -1
  226. data/_sass/@primer/view-components/app/components/primer/dialog_helper.d.ts +15 -0
  227. data/_sass/@primer/view-components/app/components/primer/dialog_helper.js +117 -0
  228. data/_sass/@primer/view-components/app/components/primer/focus_group.d.ts +19 -0
  229. data/_sass/@primer/view-components/app/components/primer/focus_group.js +163 -0
  230. data/_sass/@primer/view-components/app/components/primer/primer.d.ts +10 -3
  231. data/_sass/@primer/view-components/app/components/primer/primer.js +10 -3
  232. data/_sass/@primer/view-components/app/components/primer/scrollable_region.d.ts +13 -0
  233. data/_sass/@primer/view-components/app/components/primer/scrollable_region.js +52 -0
  234. data/_sass/@primer/view-components/app/components/primer/truncate.css.json +13 -1
  235. data/_sass/@primer/view-components/lib/primer/forms/primer_multi_input.js +2 -3
  236. data/_sass/@primer/view-components/lib/primer/forms/primer_text_field.js +55 -11
  237. data/_sass/@primer/view-components/lib/primer/forms/toggle_switch_input.js +7 -2
  238. data/_sass/@primer/view-components/package.json +34 -33
  239. data/_sass/@primer/view-components/static/arguments.json +2786 -454
  240. data/_sass/@primer/view-components/static/audited_at.json +39 -24
  241. data/_sass/@primer/view-components/static/classes.json +612 -0
  242. data/_sass/@primer/view-components/static/constants.json +318 -77
  243. data/_sass/@primer/view-components/static/info_arch.json +15698 -0
  244. data/_sass/@primer/view-components/static/previews.json +6814 -0
  245. data/_sass/@primer/view-components/static/statuses.json +41 -26
  246. data/_sass/{jekyll-theme-primer.scss → jekyll-v4-theme-primer.scss} +14 -3
  247. data/_sass/primer.scss +1 -1
  248. data/assets/css/style.scss +1 -1
  249. data/assets/js/github-clipboard-copy-element.js +154 -0
  250. data/assets/js/primer-clipboard-copy.js +106 -0
  251. metadata +77 -18
  252. data/_sass/@primer/css/actionlist/action-list-item-divider.scss +0 -48
  253. data/_sass/@primer/css/actionlist/action-list-item.scss +0 -593
  254. data/_sass/@primer/css/actionlist/action-list-tree.scss +0 -118
  255. data/_sass/@primer/css/actionlist/action-list-variables.scss +0 -8
  256. data/_sass/@primer/css/actionlist/action-list.scss +0 -67
  257. data/_sass/@primer/css/actionlist/index.scss +0 -6
  258. data/_sass/@primer/css/forms/form-validation.scss +0 -265
  259. data/_sass/@primer/css/labels/diffstat.scss +0 -37
  260. data/_sass/@primer/view-components/app/components/primer/time_ago_component.js +0 -1
  261. /data/_sass/@primer/view-components/app/{components/primer/local_time.d.ts → assets/javascripts/app/components/primer/beta/relative_time.d.ts} +0 -0
  262. /data/_sass/@primer/view-components/app/components/primer/{local_time.js → beta/relative_time.d.ts} +0 -0
  263. /data/_sass/@primer/view-components/app/components/primer/{time_ago_component.d.ts → beta/relative_time.js} +0 -0
@@ -1,14 +1,83 @@
1
1
  [
2
+ {
3
+ "component": "ActionBar",
4
+ "status": "alpha",
5
+ "a11y_reviewed": false,
6
+ "short_name": "ActionBar",
7
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar.rb",
8
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/default/",
9
+ "parameters": [
10
+ {
11
+ "name": "size",
12
+ "type": "Symbol",
13
+ "default": "`:medium`",
14
+ "description": "One of `:large`, `:medium`, or `:small`."
15
+ },
16
+ {
17
+ "name": "overflow_menu",
18
+ "type": "Boolean",
19
+ "default": "`true`",
20
+ "description": "Whether to render the overflow menu."
21
+ },
22
+ {
23
+ "name": "system_arguments",
24
+ "type": "Hash",
25
+ "default": "N/A",
26
+ "description": "[System arguments](/system-arguments)"
27
+ }
28
+ ]
29
+ },
30
+ {
31
+ "component": "ActionBar::Divider",
32
+ "status": "alpha",
33
+ "a11y_reviewed": false,
34
+ "short_name": "ActionBarDivider",
35
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/divider.rb",
36
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/divider/default/",
37
+ "parameters": [
38
+
39
+ ]
40
+ },
41
+ {
42
+ "component": "ActionBar::Item",
43
+ "status": "alpha",
44
+ "a11y_reviewed": false,
45
+ "short_name": "ActionBarItem",
46
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/item.rb",
47
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/item/default/",
48
+ "parameters": [
49
+ {
50
+ "name": "item_content",
51
+ "type": "String",
52
+ "default": "N/A",
53
+ "description": "The content to render inside the item."
54
+ },
55
+ {
56
+ "name": "item_arguments",
57
+ "type": "Hash",
58
+ "default": "N/A",
59
+ "description": "[System arguments](/system-arguments)"
60
+ }
61
+ ]
62
+ },
2
63
  {
3
64
  "component": "ActionList",
4
65
  "status": "alpha",
66
+ "a11y_reviewed": true,
67
+ "short_name": "ActionList",
5
68
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb",
6
69
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/default/",
7
70
  "parameters": [
71
+ {
72
+ "name": "id",
73
+ "type": "String",
74
+ "default": "`self.class.generate_id`",
75
+ "description": "HTML ID value."
76
+ },
8
77
  {
9
78
  "name": "role",
10
79
  "type": "Boolean",
11
- "default": "`:list`",
80
+ "default": "`nil`",
12
81
  "description": "ARIA role describing the function of the list. listbox and menu are a common values."
13
82
  },
14
83
  {
@@ -21,7 +90,7 @@
21
90
  "name": "scheme",
22
91
  "type": "Symbol",
23
92
  "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."
93
+ "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
94
  },
26
95
  {
27
96
  "name": "show_dividers",
@@ -29,6 +98,18 @@
29
98
  "default": "`false`",
30
99
  "description": "Display a divider above each item in the list when it does not follow a header or divider."
31
100
  },
101
+ {
102
+ "name": "select_variant",
103
+ "type": "Symbol",
104
+ "default": "`:none`",
105
+ "description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`."
106
+ },
107
+ {
108
+ "name": "form_arguments",
109
+ "type": "Hash",
110
+ "default": "`{}`",
111
+ "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."
112
+ },
32
113
  {
33
114
  "name": "system_arguments",
34
115
  "type": "Hash",
@@ -40,6 +121,8 @@
40
121
  {
41
122
  "component": "ActionList::Divider",
42
123
  "status": "alpha",
124
+ "a11y_reviewed": false,
125
+ "short_name": "ActionListDivider",
43
126
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
44
127
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
45
128
  "parameters": [
@@ -57,24 +140,37 @@
57
140
  }
58
141
  ]
59
142
  },
143
+ {
144
+ "component": "ActionList::FormWrapper",
145
+ "status": "alpha",
146
+ "a11y_reviewed": false,
147
+ "short_name": "ActionListFormWrapper",
148
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
149
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
150
+ "parameters": [
151
+
152
+ ]
153
+ },
60
154
  {
61
155
  "component": "ActionList::Heading",
62
156
  "status": "alpha",
157
+ "a11y_reviewed": false,
158
+ "short_name": "ActionListHeading",
63
159
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
64
160
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
65
161
  "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
162
  {
73
163
  "name": "title",
74
164
  "type": "String",
75
165
  "default": "N/A",
76
166
  "description": "Sub list title."
77
167
  },
168
+ {
169
+ "name": "heading_level",
170
+ "type": "Integer",
171
+ "default": "`3`",
172
+ "description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
173
+ },
78
174
  {
79
175
  "name": "subtitle",
80
176
  "type": "String",
@@ -87,12 +183,6 @@
87
183
  "default": "`:subtle`",
88
184
  "description": "Display a background color if scheme is `filled`."
89
185
  },
90
- {
91
- "name": "tag",
92
- "type": "Symbol",
93
- "default": "`:h3`",
94
- "description": "Semantic tag for the heading."
95
- },
96
186
  {
97
187
  "name": "system_arguments",
98
188
  "type": "Hash",
@@ -104,6 +194,8 @@
104
194
  {
105
195
  "component": "ActionList::Item",
106
196
  "status": "alpha",
197
+ "a11y_reviewed": false,
198
+ "short_name": "ActionListItem",
107
199
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/item.rb",
108
200
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item/default/",
109
201
  "parameters": [
@@ -122,8 +214,14 @@
122
214
  {
123
215
  "name": "label",
124
216
  "type": "String",
125
- "default": "N/A",
126
- "description": "Item label."
217
+ "default": "`nil`",
218
+ "description": "Item label. If no label is provided, content is used."
219
+ },
220
+ {
221
+ "name": "item_id",
222
+ "type": "String",
223
+ "default": "`nil`",
224
+ "description": "An ID that will be attached to the item's `<li>` element as `data-item-id` for distinguishing between items, perhaps in JavaScript."
127
225
  },
128
226
  {
129
227
  "name": "label_classes",
@@ -131,12 +229,24 @@
131
229
  "default": "`nil`",
132
230
  "description": "CSS classes that will be added to the label."
133
231
  },
232
+ {
233
+ "name": "label_arguments",
234
+ "type": "Hash",
235
+ "default": "`{}`",
236
+ "description": "[System arguments](/system-arguments) used to construct the label."
237
+ },
134
238
  {
135
239
  "name": "content_arguments",
136
240
  "type": "Hash",
137
241
  "default": "`{}`",
138
242
  "description": "[System arguments](/system-arguments) used to construct the item's anchor or button tag."
139
243
  },
244
+ {
245
+ "name": "form_arguments",
246
+ "type": "Hash",
247
+ "default": "`{}`",
248
+ "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."
249
+ },
140
250
  {
141
251
  "name": "truncate_label",
142
252
  "type": "Boolean",
@@ -152,7 +262,7 @@
152
262
  {
153
263
  "name": "role",
154
264
  "type": "String",
155
- "default": "`:listitem`",
265
+ "default": "`nil`",
156
266
  "description": "ARIA role describing the function of the item."
157
267
  },
158
268
  {
@@ -177,13 +287,13 @@
177
287
  "name": "description_scheme",
178
288
  "type": "Symbol",
179
289
  "default": "`:block`",
180
- "description": "Display description inline with label, or block on the next line."
290
+ "description": "Display description inline with label, or block on the next line. One of `:block` or `:inline`."
181
291
  },
182
292
  {
183
293
  "name": "active",
184
294
  "type": "Boolean",
185
295
  "default": "`false`",
186
- "description": "Sets an active state on navigational items."
296
+ "description": "If the parent list's `select_variant` is set to `:single` or `:multiple`, causes this item to render checked."
187
297
  },
188
298
  {
189
299
  "name": "on_click",
@@ -206,146 +316,130 @@
206
316
  ]
207
317
  },
208
318
  {
209
- "component": "Banner",
319
+ "component": "ActionMenu",
210
320
  "status": "alpha",
211
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/banner.rb",
212
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/banner/default/",
321
+ "a11y_reviewed": false,
322
+ "short_name": "ActionMenu",
323
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb",
324
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/",
213
325
  "parameters": [
214
326
  {
215
- "name": "full",
216
- "type": "Boolean",
217
- "default": "`false`",
218
- "description": "Whether the component should take up the full width of the screen."
219
- },
220
- {
221
- "name": "full_when_narrow",
222
- "type": "Boolean",
223
- "default": "`false`",
224
- "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
327
+ "name": "menu_id",
328
+ "type": "String",
329
+ "default": "`self.class.generate_id`",
330
+ "description": "Id of the menu."
225
331
  },
226
332
  {
227
- "name": "dismissible",
228
- "type": "Boolean",
229
- "default": "`false`",
230
- "description": "Whether the component can be dismissed with an \"x\" button."
333
+ "name": "anchor_align",
334
+ "type": "Symbol",
335
+ "default": "`:start`",
336
+ "description": "One of `:center`, `:end`, or `:start`.."
231
337
  },
232
338
  {
233
- "name": "description",
234
- "type": "String",
235
- "default": "`nil`",
236
- "description": "Description text rendered underneath the message."
339
+ "name": "anchor_side",
340
+ "type": "Symbol",
341
+ "default": "`:outside_bottom`",
342
+ "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.."
237
343
  },
238
344
  {
239
- "name": "icon",
345
+ "name": "size",
240
346
  "type": "Symbol",
241
- "default": "`nil`",
242
- "description": "The name of an [Octicon](https://primer.style/octicons/) icon to use. If no icon is provided, a default one will be chosen based on the scheme."
347
+ "default": "`:auto`",
348
+ "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
243
349
  },
244
350
  {
245
- "name": "scheme",
246
- "type": "Symbol",
247
- "default": "`:default`",
248
- "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
351
+ "name": "src",
352
+ "type": "String",
353
+ "default": "`nil`",
354
+ "description": "Used with an `include-fragment` element to load menu content from the given source URL."
249
355
  },
250
356
  {
251
- "name": "reappear",
357
+ "name": "preload",
252
358
  "type": "Boolean",
253
359
  "default": "`false`",
254
- "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
360
+ "description": "When true, and src is present, loads the `include-fragment` on trigger hover."
255
361
  },
256
362
  {
257
- "name": "system_arguments",
258
- "type": "Hash",
259
- "default": "N/A",
260
- "description": "[System arguments](/system-arguments)"
261
- }
262
- ]
263
- },
264
- {
265
- "component": "ButtonMarketing",
266
- "status": "alpha",
267
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb",
268
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing/default/",
269
- "parameters": [
270
- {
271
- "name": "scheme",
272
- "type": "Symbol",
273
- "default": "`:default`",
274
- "description": "One of `:default`, `:outline`, `:primary`, or `:transparent`."
363
+ "name": "dynamic_label",
364
+ "type": "Boolean",
365
+ "default": "`false`",
366
+ "description": "Whether or not to display the text of the currently selected item in the show button."
275
367
  },
276
368
  {
277
- "name": "variant",
278
- "type": "Symbol",
279
- "default": "`:default`",
280
- "description": "One of `:default` or `:large`."
369
+ "name": "dynamic_label_prefix",
370
+ "type": "String",
371
+ "default": "`nil`",
372
+ "description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
281
373
  },
282
374
  {
283
- "name": "tag",
375
+ "name": "select_variant",
284
376
  "type": "Symbol",
285
- "default": "`:button`",
286
- "description": "One of `:a` or `:button`."
377
+ "default": "`:none`",
378
+ "description": "One of `:multiple`, `:none`, or `:single`."
287
379
  },
288
380
  {
289
- "name": "type",
290
- "type": "Symbol",
291
- "default": "`:button`",
292
- "description": "One of `:button` or `:submit`."
381
+ "name": "form_arguments",
382
+ "type": "Hash",
383
+ "default": "`{}`",
384
+ "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."
293
385
  },
294
386
  {
295
387
  "name": "system_arguments",
296
388
  "type": "Hash",
297
389
  "default": "N/A",
298
- "description": "[System arguments](/system-arguments)"
390
+ "description": "[System arguments](/system-arguments)."
299
391
  }
300
392
  ]
301
393
  },
302
394
  {
303
- "component": "Dialog",
395
+ "component": "ActionMenu::Group",
304
396
  "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/",
397
+ "a11y_reviewed": true,
398
+ "short_name": "ActionMenuGroup",
399
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/group.rb",
400
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/group/default/",
307
401
  "parameters": [
308
402
  {
309
403
  "name": "id",
310
404
  "type": "String",
311
405
  "default": "`self.class.generate_id`",
312
- "description": "The id of the dialog."
406
+ "description": "HTML ID value."
313
407
  },
314
408
  {
315
- "name": "title",
316
- "type": "String",
317
- "default": "N/A",
318
- "description": "Describes the content of the dialog."
409
+ "name": "role",
410
+ "type": "Boolean",
411
+ "default": "`nil`",
412
+ "description": "ARIA role describing the function of the list. listbox and menu are a common values."
319
413
  },
320
414
  {
321
- "name": "subtitle",
415
+ "name": "item_classes",
322
416
  "type": "String",
323
417
  "default": "`nil`",
324
- "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute."
418
+ "description": "Additional CSS classes to attach to items."
325
419
  },
326
420
  {
327
- "name": "size",
421
+ "name": "scheme",
328
422
  "type": "Symbol",
329
- "default": "`:medium`",
330
- "description": "The size of the dialog. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
423
+ "default": "`:full`",
424
+ "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."
331
425
  },
332
426
  {
333
- "name": "position",
334
- "type": "Symbol",
335
- "default": "`:center`",
336
- "description": "The position of the dialog. One of `:center`, `:left`, or `:right`."
427
+ "name": "show_dividers",
428
+ "type": "Boolean",
429
+ "default": "`false`",
430
+ "description": "Display a divider above each item in the list when it does not follow a header or divider."
337
431
  },
338
432
  {
339
- "name": "position_narrow",
433
+ "name": "select_variant",
340
434
  "type": "Symbol",
341
- "default": "`:inherit`",
342
- "description": "The position of the dialog when narrow. One of `:bottom`, `:fullscreen`, `:inherit`, `:left`, or `:right`."
435
+ "default": "`:none`",
436
+ "description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`."
343
437
  },
344
438
  {
345
- "name": "visually_hide_title",
346
- "type": "Boolean",
347
- "default": "`false`",
348
- "description": "If true will hide the heading title, while still making it available to Screen Readers."
439
+ "name": "form_arguments",
440
+ "type": "Hash",
441
+ "default": "`{}`",
442
+ "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."
349
443
  },
350
444
  {
351
445
  "name": "system_arguments",
@@ -356,100 +450,115 @@
356
450
  ]
357
451
  },
358
452
  {
359
- "component": "Dropdown",
453
+ "component": "ActionMenu::Heading",
360
454
  "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/",
455
+ "a11y_reviewed": false,
456
+ "short_name": "ActionMenuHeading",
457
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/heading.rb",
458
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/heading/default/",
363
459
  "parameters": [
364
- {
365
- "name": "overlay",
366
- "type": "Symbol",
367
- "default": "`:default`",
368
- "description": "One of `:dark`, `:default`, or `:none`."
369
- },
370
- {
371
- "name": "with_caret",
372
- "type": "Boolean",
373
- "default": "`false`",
374
- "description": "Whether or not a caret should be rendered in the button."
375
- },
376
- {
377
- "name": "system_arguments",
378
- "type": "Hash",
379
- "default": "N/A",
380
- "description": "[System arguments](/system-arguments)"
381
- }
460
+
382
461
  ]
383
462
  },
384
463
  {
385
- "component": "HellipButton",
464
+ "component": "ActionMenu::List",
386
465
  "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/",
466
+ "a11y_reviewed": false,
467
+ "short_name": "ActionMenuList",
468
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb",
469
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/",
389
470
  "parameters": [
390
- {
391
- "name": "inline",
392
- "type": "Boolean",
393
- "default": "`false`",
394
- "description": "Whether or not the button is inline."
395
- },
396
471
  {
397
472
  "name": "system_arguments",
398
473
  "type": "Hash",
399
474
  "default": "N/A",
400
- "description": "[System arguments](/system-arguments)"
475
+ "description": "The arguments accepted by [ActionList](/components/alpha/actionlist)"
401
476
  }
402
477
  ]
403
478
  },
404
479
  {
405
- "component": "HiddenTextExpander",
480
+ "component": "ActionMenu::ListWrapper",
406
481
  "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/",
482
+ "a11y_reviewed": true,
483
+ "short_name": "ActionMenuListWrapper",
484
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list_wrapper.rb",
485
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list_wrapper/default/",
409
486
  "parameters": [
410
487
  {
411
- "name": "inline",
412
- "type": "Boolean",
413
- "default": "`false`",
414
- "description": "Whether or not the expander is inline."
415
- },
416
- {
417
- "name": "button_arguments",
418
- "type": "Hash",
419
- "default": "`{}`",
420
- "description": "[System arguments](/system-arguments) for the button element."
488
+ "name": "menu_id",
489
+ "type": "String",
490
+ "default": "N/A",
491
+ "description": "ID of the parent menu."
421
492
  },
422
493
  {
423
494
  "name": "system_arguments",
424
495
  "type": "Hash",
425
496
  "default": "N/A",
426
- "description": "[System arguments](/system-arguments)"
497
+ "description": "The arguments accepted by [ActionList](/components/alpha/actionlist)"
427
498
  }
428
499
  ]
429
500
  },
430
501
  {
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/",
502
+ "component": "AutoComplete",
503
+ "status": "deprecated",
504
+ "a11y_reviewed": false,
505
+ "short_name": "AutoComplete",
506
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/auto_complete.rb",
507
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/auto_complete/default/",
435
508
  "parameters": [
436
509
  {
437
- "name": "src",
510
+ "name": "label_text",
438
511
  "type": "String",
439
512
  "default": "N/A",
440
- "description": "The source url of the image."
513
+ "description": "The label of the input."
441
514
  },
442
515
  {
443
- "name": "alt",
516
+ "name": "src",
444
517
  "type": "String",
445
518
  "default": "N/A",
446
- "description": "Specifies an alternate text for the image."
519
+ "description": "The route to query."
447
520
  },
448
521
  {
449
- "name": "lazy",
522
+ "name": "input_id",
523
+ "type": "String",
524
+ "default": "N/A",
525
+ "description": "Id of the input element."
526
+ },
527
+ {
528
+ "name": "input_name",
529
+ "type": "String",
530
+ "default": "`nil`",
531
+ "description": "Optional name of the input element, defaults to `input_id` when not set."
532
+ },
533
+ {
534
+ "name": "list_id",
535
+ "type": "String",
536
+ "default": "N/A",
537
+ "description": "Id of the list element."
538
+ },
539
+ {
540
+ "name": "with_icon",
450
541
  "type": "Boolean",
451
542
  "default": "`false`",
452
- "description": "Whether or not to lazily load the image."
543
+ "description": "Controls if a search icon is visible, defaults to `false`."
544
+ },
545
+ {
546
+ "name": "is_label_visible",
547
+ "type": "Boolean",
548
+ "default": "`true`",
549
+ "description": "Controls if the label is visible. If `false`, screen reader only text will be added."
550
+ },
551
+ {
552
+ "name": "is_clearable",
553
+ "type": "Boolean",
554
+ "default": "`false`",
555
+ "description": "Adds optional clear button."
556
+ },
557
+ {
558
+ "name": "is_label_inline",
559
+ "type": "Boolean",
560
+ "default": "`false`",
561
+ "description": "Controls if the label is inline. On smaller screens, label will always become stacked."
453
562
  },
454
563
  {
455
564
  "name": "system_arguments",
@@ -460,22 +569,30 @@
460
569
  ]
461
570
  },
462
571
  {
463
- "component": "ImageCrop",
464
- "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/",
572
+ "component": "AutoComplete::Item",
573
+ "status": "deprecated",
574
+ "a11y_reviewed": false,
575
+ "short_name": "AutoCompleteItem",
576
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/auto_complete/item.rb",
577
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/auto_complete/item/default/",
467
578
  "parameters": [
468
579
  {
469
- "name": "src",
580
+ "name": "value",
470
581
  "type": "String",
471
582
  "default": "N/A",
472
- "description": "The path of the image to crop."
583
+ "description": "Value of the item."
473
584
  },
474
585
  {
475
- "name": "rounded",
586
+ "name": "selected",
476
587
  "type": "Boolean",
477
- "default": "`true`",
478
- "description": "If the crop mask should be a circle. Defaults to true."
588
+ "default": "`false`",
589
+ "description": "Whether the item is selected."
590
+ },
591
+ {
592
+ "name": "disabled",
593
+ "type": "Boolean",
594
+ "default": "`false`",
595
+ "description": "Whether the item is disabled."
479
596
  },
480
597
  {
481
598
  "name": "system_arguments",
@@ -486,28 +603,60 @@
486
603
  ]
487
604
  },
488
605
  {
489
- "component": "Layout",
606
+ "component": "Banner",
490
607
  "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/",
608
+ "a11y_reviewed": false,
609
+ "short_name": "Banner",
610
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/banner.rb",
611
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/banner/default/",
493
612
  "parameters": [
494
613
  {
495
- "name": "stacking_breakpoint",
614
+ "name": "tag",
496
615
  "type": "Symbol",
497
- "default": "`:md`",
498
- "description": "When the `Layout` should change from rows into columns. One of `:lg`, `:md`, or `:sm`."
616
+ "default": "`:div`",
617
+ "description": "One of `:div` or `:section`."
499
618
  },
500
619
  {
501
- "name": "first_in_source",
620
+ "name": "full",
621
+ "type": "Boolean",
622
+ "default": "`false`",
623
+ "description": "Whether the component should take up the full width of the screen."
624
+ },
625
+ {
626
+ "name": "full_when_narrow",
627
+ "type": "Boolean",
628
+ "default": "`false`",
629
+ "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
630
+ },
631
+ {
632
+ "name": "dismiss_scheme",
502
633
  "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`."
634
+ "default": "`:none`",
635
+ "description": "Whether the component can be dismissed with an \"x\" button. One of `:hide`, `:none`, or `:remove`."
505
636
  },
506
637
  {
507
- "name": "gutter",
638
+ "name": "dismiss_label",
639
+ "type": "String",
640
+ "default": "`Dismiss`",
641
+ "description": "The aria-label text of the dismiss \"x\" button"
642
+ },
643
+ {
644
+ "name": "description",
645
+ "type": "String",
646
+ "default": "`nil`",
647
+ "description": "Description text rendered underneath the message."
648
+ },
649
+ {
650
+ "name": "icon",
651
+ "type": "Symbol",
652
+ "default": "`nil`",
653
+ "description": "The name of an [Octicon](https://primer.style/octicons/) icon to use. If no icon is provided, a default one will be chosen based on the scheme."
654
+ },
655
+ {
656
+ "name": "scheme",
508
657
  "type": "Symbol",
509
658
  "default": "`:default`",
510
- "description": "The amount of space between the main section and the sidebar. One of `:condensed`, `:default`, `:none`, or `:spacious`."
659
+ "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
511
660
  },
512
661
  {
513
662
  "name": "system_arguments",
@@ -518,11 +667,43 @@
518
667
  ]
519
668
  },
520
669
  {
521
- "component": "Menu",
670
+ "component": "ButtonMarketing",
522
671
  "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/",
672
+ "a11y_reviewed": false,
673
+ "short_name": "ButtonMarketing",
674
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb",
675
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing/default/",
525
676
  "parameters": [
677
+ {
678
+ "name": "scheme",
679
+ "type": "Symbol",
680
+ "default": "`:default`",
681
+ "description": "One of `:default`, `:outline`, `:primary`, or `:transparent`."
682
+ },
683
+ {
684
+ "name": "variant",
685
+ "type": "Symbol",
686
+ "default": "`:default`",
687
+ "description": "One of `:default` or `:large`."
688
+ },
689
+ {
690
+ "name": "tag",
691
+ "type": "Symbol",
692
+ "default": "`:button`",
693
+ "description": "One of `:a` or `:button`."
694
+ },
695
+ {
696
+ "name": "type",
697
+ "type": "Symbol",
698
+ "default": "`:button`",
699
+ "description": "One of `:button` or `:submit`."
700
+ },
701
+ {
702
+ "name": "disabled",
703
+ "type": "Boolean",
704
+ "default": "`false`",
705
+ "description": "Whether or not the button is disabled. If true, this option forces `tag:` to `:button`."
706
+ },
526
707
  {
527
708
  "name": "system_arguments",
528
709
  "type": "Hash",
@@ -532,132 +713,1690 @@
532
713
  ]
533
714
  },
534
715
  {
535
- "component": "NavList",
716
+ "component": "CheckBox",
536
717
  "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/",
718
+ "a11y_reviewed": false,
719
+ "short_name": "CheckBox",
720
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/check_box.rb",
721
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/check_box/default/",
539
722
  "parameters": [
540
723
  {
541
- "name": "selected_item_id",
724
+ "name": "name",
725
+ "type": "String",
726
+ "default": "N/A",
727
+ "description": "Value for the HTML name attribute."
728
+ },
729
+ {
730
+ "name": "id",
731
+ "type": "String",
732
+ "default": "N/A",
733
+ "description": "Value for the HTML id attribute."
734
+ },
735
+ {
736
+ "name": "class",
737
+ "type": "String",
738
+ "default": "N/A",
739
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
740
+ },
741
+ {
742
+ "name": "classes",
743
+ "type": "Array",
744
+ "default": "N/A",
745
+ "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)."
746
+ },
747
+ {
748
+ "name": "caption",
749
+ "type": "String",
750
+ "default": "N/A",
751
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
752
+ },
753
+ {
754
+ "name": "label",
755
+ "type": "String",
756
+ "default": "N/A",
757
+ "description": "Label text displayed above the input."
758
+ },
759
+ {
760
+ "name": "visually_hide_label",
761
+ "type": "Boolean",
762
+ "default": "N/A",
763
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
764
+ },
765
+ {
766
+ "name": "disabled",
767
+ "type": "Boolean",
768
+ "default": "N/A",
769
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
770
+ },
771
+ {
772
+ "name": "hidden",
773
+ "type": "Boolean",
774
+ "default": "N/A",
775
+ "description": "When set to `true`, visually hides the field."
776
+ },
777
+ {
778
+ "name": "invalid",
779
+ "type": "Boolean",
780
+ "default": "N/A",
781
+ "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."
782
+ },
783
+ {
784
+ "name": "validation_message",
785
+ "type": "String",
786
+ "default": "N/A",
787
+ "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."
788
+ },
789
+ {
790
+ "name": "label_arguments",
791
+ "type": "Hash",
792
+ "default": "N/A",
793
+ "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."
794
+ },
795
+ {
796
+ "name": "scope_name_to_model",
797
+ "type": "Boolean",
798
+ "default": "N/A",
799
+ "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."
800
+ },
801
+ {
802
+ "name": "scope_id_to_model",
803
+ "type": "Boolean",
804
+ "default": "N/A",
805
+ "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."
806
+ },
807
+ {
808
+ "name": "required",
809
+ "type": "Boolean",
810
+ "default": "N/A",
811
+ "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."
812
+ },
813
+ {
814
+ "name": "aria",
815
+ "type": "Hash",
816
+ "default": "N/A",
817
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
818
+ },
819
+ {
820
+ "name": "data",
821
+ "type": "Hash",
822
+ "default": "N/A",
823
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
824
+ },
825
+ {
826
+ "name": "system_arguments",
827
+ "type": "Hash",
828
+ "default": "N/A",
829
+ "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."
830
+ },
831
+ {
832
+ "name": "name",
833
+ "type": "String",
834
+ "default": "N/A",
835
+ "description": "Value for the HTML name attribute."
836
+ },
837
+ {
838
+ "name": "value",
839
+ "type": "String",
840
+ "default": "N/A",
841
+ "description": "On form submission, this value will be sent to the server if the check box is checked. Defaults to \"1\"."
842
+ },
843
+ {
844
+ "name": "unchecked_value",
845
+ "type": "String",
846
+ "default": "N/A",
847
+ "description": "On form submission, this value will be sent to the server if the check box is _not_ checked. Defaults to \"0\"."
848
+ },
849
+ {
850
+ "name": "scheme",
542
851
  "type": "Symbol",
543
- "default": "`nil`",
544
- "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
852
+ "default": "N/A",
853
+ "description": "Controls how check box values are submitted to the server. One of `:array` or `:boolean`.."
854
+ }
855
+ ]
856
+ },
857
+ {
858
+ "component": "CheckBoxGroup",
859
+ "status": "alpha",
860
+ "a11y_reviewed": false,
861
+ "short_name": "CheckBoxGroup",
862
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/check_box_group.rb",
863
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/check_box_group/default/",
864
+ "parameters": [
865
+ {
866
+ "name": "name",
867
+ "type": "String",
868
+ "default": "N/A",
869
+ "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."
870
+ },
871
+ {
872
+ "name": "label",
873
+ "type": "String",
874
+ "default": "N/A",
875
+ "description": "Label text displayed above the input."
876
+ },
877
+ {
878
+ "name": "hidden",
879
+ "type": "Boolean",
880
+ "default": "N/A",
881
+ "description": "When set to `true`, visually hides the group."
882
+ },
883
+ {
884
+ "name": "caption",
885
+ "type": "String",
886
+ "default": "N/A",
887
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the group."
888
+ },
889
+ {
890
+ "name": "invalid",
891
+ "type": "Boolean",
892
+ "default": "N/A",
893
+ "description": "If set to `true`, the input will be marked as invalid. 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."
894
+ },
895
+ {
896
+ "name": "validation_message",
897
+ "type": "String",
898
+ "default": "N/A",
899
+ "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."
900
+ },
901
+ {
902
+ "name": "label_arguments",
903
+ "type": "Hash",
904
+ "default": "N/A",
905
+ "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."
906
+ }
907
+ ]
908
+ },
909
+ {
910
+ "component": "Dialog",
911
+ "status": "alpha",
912
+ "a11y_reviewed": true,
913
+ "short_name": "Dialog",
914
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog.rb",
915
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/default/",
916
+ "parameters": [
917
+ {
918
+ "name": "id",
919
+ "type": "String",
920
+ "default": "`self.class.generate_id`",
921
+ "description": "The id of the dialog."
922
+ },
923
+ {
924
+ "name": "title",
925
+ "type": "String",
926
+ "default": "N/A",
927
+ "description": "Describes the content of the dialog."
928
+ },
929
+ {
930
+ "name": "subtitle",
931
+ "type": "String",
932
+ "default": "`nil`",
933
+ "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute."
934
+ },
935
+ {
936
+ "name": "size",
937
+ "type": "Symbol",
938
+ "default": "`:medium`",
939
+ "description": "The size of the dialog. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
940
+ },
941
+ {
942
+ "name": "position",
943
+ "type": "Symbol",
944
+ "default": "`:center`",
945
+ "description": "The position of the dialog. One of `:center`, `:left`, or `:right`."
946
+ },
947
+ {
948
+ "name": "position_narrow",
949
+ "type": "Symbol",
950
+ "default": "`:inherit`",
951
+ "description": "The position of the dialog when narrow. One of `:bottom`, `:fullscreen`, `:inherit`, `:left`, or `:right`."
952
+ },
953
+ {
954
+ "name": "visually_hide_title",
955
+ "type": "Boolean",
956
+ "default": "`false`",
957
+ "description": "If true will hide the heading title, while still making it available to Screen Readers."
958
+ },
959
+ {
960
+ "name": "system_arguments",
961
+ "type": "Hash",
962
+ "default": "N/A",
963
+ "description": "[System arguments](/system-arguments)"
964
+ }
965
+ ]
966
+ },
967
+ {
968
+ "component": "Dialog::Body",
969
+ "status": "alpha",
970
+ "a11y_reviewed": true,
971
+ "short_name": "DialogBody",
972
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
973
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
974
+ "parameters": [
975
+ {
976
+ "name": "system_arguments",
977
+ "type": "Hash",
978
+ "default": "N/A",
979
+ "description": "[System arguments](/system-arguments)"
980
+ }
981
+ ]
982
+ },
983
+ {
984
+ "component": "Dialog::Footer",
985
+ "status": "alpha",
986
+ "a11y_reviewed": true,
987
+ "short_name": "DialogFooter",
988
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
989
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
990
+ "parameters": [
991
+ {
992
+ "name": "show_divider",
993
+ "type": "Boolean",
994
+ "default": "`false`",
995
+ "description": "Show a divider between the footer and body."
996
+ },
997
+ {
998
+ "name": "system_arguments",
999
+ "type": "Hash",
1000
+ "default": "N/A",
1001
+ "description": "[System arguments](/system-arguments)"
1002
+ }
1003
+ ]
1004
+ },
1005
+ {
1006
+ "component": "Dialog::Header",
1007
+ "status": "alpha",
1008
+ "a11y_reviewed": true,
1009
+ "short_name": "DialogHeader",
1010
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
1011
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
1012
+ "parameters": [
1013
+ {
1014
+ "name": "id",
1015
+ "type": "String",
1016
+ "default": "N/A",
1017
+ "description": "The HTML element's ID value."
1018
+ },
1019
+ {
1020
+ "name": "title",
1021
+ "type": "String",
1022
+ "default": "N/A",
1023
+ "description": "Describes the content of the dialog."
1024
+ },
1025
+ {
1026
+ "name": "subtitle",
1027
+ "type": "String",
1028
+ "default": "`nil`",
1029
+ "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute."
1030
+ },
1031
+ {
1032
+ "name": "show_divider",
1033
+ "type": "Boolean",
1034
+ "default": "`false`",
1035
+ "description": "Show a divider between the header and body."
1036
+ },
1037
+ {
1038
+ "name": "visually_hide_title",
1039
+ "type": "Boolean",
1040
+ "default": "`false`",
1041
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
1042
+ },
1043
+ {
1044
+ "name": "variant",
1045
+ "type": "Symbol",
1046
+ "default": "`:medium`",
1047
+ "description": "One of `:large` or `:medium`."
1048
+ },
1049
+ {
1050
+ "name": "system_arguments",
1051
+ "type": "Hash",
1052
+ "default": "N/A",
1053
+ "description": "[System arguments](/system-arguments)"
1054
+ }
1055
+ ]
1056
+ },
1057
+ {
1058
+ "component": "Dropdown",
1059
+ "status": "alpha",
1060
+ "a11y_reviewed": false,
1061
+ "short_name": "Dropdown",
1062
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb",
1063
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/default/",
1064
+ "parameters": [
1065
+ {
1066
+ "name": "overlay",
1067
+ "type": "Symbol",
1068
+ "default": "`:default`",
1069
+ "description": "One of `:dark`, `:default`, or `:none`."
1070
+ },
1071
+ {
1072
+ "name": "with_caret",
1073
+ "type": "Boolean",
1074
+ "default": "`false`",
1075
+ "description": "Whether or not a caret should be rendered in the button."
1076
+ },
1077
+ {
1078
+ "name": "system_arguments",
1079
+ "type": "Hash",
1080
+ "default": "N/A",
1081
+ "description": "[System arguments](/system-arguments)"
1082
+ }
1083
+ ]
1084
+ },
1085
+ {
1086
+ "component": "Dropdown::Menu",
1087
+ "status": "alpha",
1088
+ "a11y_reviewed": false,
1089
+ "short_name": "DropdownMenu",
1090
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu.rb",
1091
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/default/",
1092
+ "parameters": [
1093
+ {
1094
+ "name": "as",
1095
+ "type": "Symbol",
1096
+ "default": "`:default`",
1097
+ "description": "When `as` is `:list`, wraps the menu in a `<ul>` with a `<li>` for each item."
1098
+ },
1099
+ {
1100
+ "name": "direction",
1101
+ "type": "Symbol",
1102
+ "default": "`:se`",
1103
+ "description": "One of `:e`, `:ne`, `:s`, `:se`, `:sw`, or `:w`.."
1104
+ },
1105
+ {
1106
+ "name": "header",
1107
+ "type": "String",
1108
+ "default": "`nil`",
1109
+ "description": "Header to be displayed above the menu."
1110
+ },
1111
+ {
1112
+ "name": "system_arguments",
1113
+ "type": "Hash",
1114
+ "default": "N/A",
1115
+ "description": "[System arguments](/system-arguments)"
1116
+ }
1117
+ ]
1118
+ },
1119
+ {
1120
+ "component": "Dropdown::Menu::Item",
1121
+ "status": "alpha",
1122
+ "a11y_reviewed": false,
1123
+ "short_name": "DropdownMenuItem",
1124
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown/menu/item.rb",
1125
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/menu/item/default/",
1126
+ "parameters": [
1127
+
1128
+ ]
1129
+ },
1130
+ {
1131
+ "component": "FormButton",
1132
+ "status": "alpha",
1133
+ "a11y_reviewed": false,
1134
+ "short_name": "FormButton",
1135
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/form_button.rb",
1136
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/form_button/default/",
1137
+ "parameters": [
1138
+ {
1139
+ "name": "name",
1140
+ "type": "String",
1141
+ "default": "N/A",
1142
+ "description": "Value for the HTML name attribute."
1143
+ },
1144
+ {
1145
+ "name": "id",
1146
+ "type": "String",
1147
+ "default": "N/A",
1148
+ "description": "Value for the HTML id attribute."
1149
+ },
1150
+ {
1151
+ "name": "class",
1152
+ "type": "String",
1153
+ "default": "N/A",
1154
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
1155
+ },
1156
+ {
1157
+ "name": "classes",
1158
+ "type": "Array",
1159
+ "default": "N/A",
1160
+ "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)."
1161
+ },
1162
+ {
1163
+ "name": "label",
1164
+ "type": "String",
1165
+ "default": "N/A",
1166
+ "description": "Label text displayed above the input."
1167
+ },
1168
+ {
1169
+ "name": "aria",
1170
+ "type": "Hash",
1171
+ "default": "N/A",
1172
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
1173
+ },
1174
+ {
1175
+ "name": "data",
1176
+ "type": "Hash",
1177
+ "default": "N/A",
1178
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
1179
+ },
1180
+ {
1181
+ "name": "system_arguments",
1182
+ "type": "Hash",
1183
+ "default": "N/A",
1184
+ "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."
1185
+ }
1186
+ ]
1187
+ },
1188
+ {
1189
+ "component": "FormControl",
1190
+ "status": "alpha",
1191
+ "a11y_reviewed": false,
1192
+ "short_name": "FormControl",
1193
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/form_control.rb",
1194
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/form_control/default/",
1195
+ "parameters": [
1196
+ {
1197
+ "name": "label",
1198
+ "type": "String",
1199
+ "default": "N/A",
1200
+ "description": "Label text displayed above the input."
1201
+ },
1202
+ {
1203
+ "name": "caption",
1204
+ "type": "String",
1205
+ "default": "`nil`",
1206
+ "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."
1207
+ },
1208
+ {
1209
+ "name": "validation_message",
1210
+ "type": "String",
1211
+ "default": "`nil`",
1212
+ "description": "A string displayed in red between the caption and the input indicating the input's contents are invalid."
1213
+ },
1214
+ {
1215
+ "name": "required",
1216
+ "type": "Boolean",
1217
+ "default": "`false`",
1218
+ "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."
1219
+ },
1220
+ {
1221
+ "name": "visually_hide_label",
1222
+ "type": "Boolean",
1223
+ "default": "`false`",
1224
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
1225
+ },
1226
+ {
1227
+ "name": "full_width",
1228
+ "type": "Boolean",
1229
+ "default": "`false`",
1230
+ "description": "When set to `true`, the form control will take up all the horizontal space allowed by its container."
1231
+ },
1232
+ {
1233
+ "name": "system_arguments",
1234
+ "type": "Hash",
1235
+ "default": "N/A",
1236
+ "description": "[System arguments](/system-arguments)"
1237
+ }
1238
+ ]
1239
+ },
1240
+ {
1241
+ "component": "HellipButton",
1242
+ "status": "alpha",
1243
+ "a11y_reviewed": false,
1244
+ "short_name": "HellipButton",
1245
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hellip_button.rb",
1246
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hellip_button/default/",
1247
+ "parameters": [
1248
+ {
1249
+ "name": "inline",
1250
+ "type": "Boolean",
1251
+ "default": "`false`",
1252
+ "description": "Whether or not the button is inline."
1253
+ },
1254
+ {
1255
+ "name": "disabled",
1256
+ "type": "Boolean",
1257
+ "default": "`false`",
1258
+ "description": "Whether or not the button is disabled."
1259
+ },
1260
+ {
1261
+ "name": "system_arguments",
1262
+ "type": "Hash",
1263
+ "default": "N/A",
1264
+ "description": "[System arguments](/system-arguments)"
1265
+ }
1266
+ ]
1267
+ },
1268
+ {
1269
+ "component": "HiddenTextExpander",
1270
+ "status": "alpha",
1271
+ "a11y_reviewed": false,
1272
+ "short_name": "HiddenTextExpander",
1273
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb",
1274
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander/default/",
1275
+ "parameters": [
1276
+ {
1277
+ "name": "inline",
1278
+ "type": "Boolean",
1279
+ "default": "`false`",
1280
+ "description": "Whether or not the expander is inline."
1281
+ },
1282
+ {
1283
+ "name": "button_arguments",
1284
+ "type": "Hash",
1285
+ "default": "`{}`",
1286
+ "description": "[System arguments](/system-arguments) for the button element."
1287
+ },
1288
+ {
1289
+ "name": "system_arguments",
1290
+ "type": "Hash",
1291
+ "default": "N/A",
1292
+ "description": "[System arguments](/system-arguments)"
1293
+ }
1294
+ ]
1295
+ },
1296
+ {
1297
+ "component": "Image",
1298
+ "status": "alpha",
1299
+ "a11y_reviewed": false,
1300
+ "short_name": "Image",
1301
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb",
1302
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image/default/",
1303
+ "parameters": [
1304
+ {
1305
+ "name": "src",
1306
+ "type": "String",
1307
+ "default": "N/A",
1308
+ "description": "The source url of the image."
1309
+ },
1310
+ {
1311
+ "name": "alt",
1312
+ "type": "String",
1313
+ "default": "N/A",
1314
+ "description": "Specifies an alternate text for the image."
1315
+ },
1316
+ {
1317
+ "name": "lazy",
1318
+ "type": "Boolean",
1319
+ "default": "`false`",
1320
+ "description": "Whether or not to lazily load the image."
1321
+ },
1322
+ {
1323
+ "name": "system_arguments",
1324
+ "type": "Hash",
1325
+ "default": "N/A",
1326
+ "description": "[System arguments](/system-arguments)"
1327
+ }
1328
+ ]
1329
+ },
1330
+ {
1331
+ "component": "ImageCrop",
1332
+ "status": "alpha",
1333
+ "a11y_reviewed": false,
1334
+ "short_name": "ImageCrop",
1335
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb",
1336
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop/default/",
1337
+ "parameters": [
1338
+ {
1339
+ "name": "src",
1340
+ "type": "String",
1341
+ "default": "N/A",
1342
+ "description": "The path of the image to crop."
1343
+ },
1344
+ {
1345
+ "name": "rounded",
1346
+ "type": "Boolean",
1347
+ "default": "`true`",
1348
+ "description": "If the crop mask should be a circle. Defaults to true."
1349
+ },
1350
+ {
1351
+ "name": "system_arguments",
1352
+ "type": "Hash",
1353
+ "default": "N/A",
1354
+ "description": "[System arguments](/system-arguments)"
1355
+ }
1356
+ ]
1357
+ },
1358
+ {
1359
+ "component": "Layout",
1360
+ "status": "alpha",
1361
+ "a11y_reviewed": false,
1362
+ "short_name": "Layout",
1363
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb",
1364
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/default/",
1365
+ "parameters": [
1366
+ {
1367
+ "name": "stacking_breakpoint",
1368
+ "type": "Symbol",
1369
+ "default": "`:md`",
1370
+ "description": "When the `Layout` should change from rows into columns. One of `:lg`, `:md`, or `:sm`."
1371
+ },
1372
+ {
1373
+ "name": "first_in_source",
1374
+ "type": "Symbol",
1375
+ "default": "`:sidebar`",
1376
+ "description": "Which element to render first in the HTML. This will change the keyboard navigation order. One of `:main` or `:sidebar`."
1377
+ },
1378
+ {
1379
+ "name": "gutter",
1380
+ "type": "Symbol",
1381
+ "default": "`:default`",
1382
+ "description": "The amount of space between the main section and the sidebar. One of `:condensed`, `:default`, `:none`, or `:spacious`."
1383
+ },
1384
+ {
1385
+ "name": "system_arguments",
1386
+ "type": "Hash",
1387
+ "default": "N/A",
1388
+ "description": "[System arguments](/system-arguments)"
1389
+ }
1390
+ ]
1391
+ },
1392
+ {
1393
+ "component": "Layout::Main",
1394
+ "status": "alpha",
1395
+ "a11y_reviewed": false,
1396
+ "short_name": "LayoutMain",
1397
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/main.rb",
1398
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/main/default/",
1399
+ "parameters": [
1400
+ {
1401
+ "name": "width",
1402
+ "type": "Symbol",
1403
+ "default": "`:full`",
1404
+ "description": "One of `:full`, `:lg`, `:md`, or `:xl`."
1405
+ },
1406
+ {
1407
+ "name": "system_arguments",
1408
+ "type": "Hash",
1409
+ "default": "N/A",
1410
+ "description": "[System arguments](/system-arguments)"
1411
+ }
1412
+ ]
1413
+ },
1414
+ {
1415
+ "component": "Layout::Sidebar",
1416
+ "status": "alpha",
1417
+ "a11y_reviewed": false,
1418
+ "short_name": "LayoutSidebar",
1419
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout/sidebar.rb",
1420
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/sidebar/default/",
1421
+ "parameters": [
1422
+
1423
+ ]
1424
+ },
1425
+ {
1426
+ "component": "Menu",
1427
+ "status": "alpha",
1428
+ "a11y_reviewed": false,
1429
+ "short_name": "Menu",
1430
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/menu.rb",
1431
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/menu/default/",
1432
+ "parameters": [
1433
+ {
1434
+ "name": "system_arguments",
1435
+ "type": "Hash",
1436
+ "default": "N/A",
1437
+ "description": "[System arguments](/system-arguments)"
1438
+ }
1439
+ ]
1440
+ },
1441
+ {
1442
+ "component": "MultiInput",
1443
+ "status": "alpha",
1444
+ "a11y_reviewed": false,
1445
+ "short_name": "MultiInput",
1446
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/multi_input.rb",
1447
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/multi_input/default/",
1448
+ "parameters": [
1449
+ {
1450
+ "name": "name",
1451
+ "type": "String",
1452
+ "default": "N/A",
1453
+ "description": "Value for the HTML name attribute."
1454
+ },
1455
+ {
1456
+ "name": "id",
1457
+ "type": "String",
1458
+ "default": "N/A",
1459
+ "description": "Value for the HTML id attribute."
1460
+ },
1461
+ {
1462
+ "name": "class",
1463
+ "type": "String",
1464
+ "default": "N/A",
1465
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
1466
+ },
1467
+ {
1468
+ "name": "classes",
1469
+ "type": "Array",
1470
+ "default": "N/A",
1471
+ "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)."
1472
+ },
1473
+ {
1474
+ "name": "caption",
1475
+ "type": "String",
1476
+ "default": "N/A",
1477
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
1478
+ },
1479
+ {
1480
+ "name": "label",
1481
+ "type": "String",
1482
+ "default": "N/A",
1483
+ "description": "Label text displayed above the input."
1484
+ },
1485
+ {
1486
+ "name": "visually_hide_label",
1487
+ "type": "Boolean",
1488
+ "default": "N/A",
1489
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
1490
+ },
1491
+ {
1492
+ "name": "disabled",
1493
+ "type": "Boolean",
1494
+ "default": "N/A",
1495
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
1496
+ },
1497
+ {
1498
+ "name": "hidden",
1499
+ "type": "Boolean",
1500
+ "default": "N/A",
1501
+ "description": "When set to `true`, visually hides the field."
1502
+ },
1503
+ {
1504
+ "name": "invalid",
1505
+ "type": "Boolean",
1506
+ "default": "N/A",
1507
+ "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."
1508
+ },
1509
+ {
1510
+ "name": "validation_message",
1511
+ "type": "String",
1512
+ "default": "N/A",
1513
+ "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."
1514
+ },
1515
+ {
1516
+ "name": "label_arguments",
1517
+ "type": "Hash",
1518
+ "default": "N/A",
1519
+ "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."
1520
+ },
1521
+ {
1522
+ "name": "scope_name_to_model",
1523
+ "type": "Boolean",
1524
+ "default": "N/A",
1525
+ "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."
1526
+ },
1527
+ {
1528
+ "name": "scope_id_to_model",
1529
+ "type": "Boolean",
1530
+ "default": "N/A",
1531
+ "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."
1532
+ },
1533
+ {
1534
+ "name": "required",
1535
+ "type": "Boolean",
1536
+ "default": "N/A",
1537
+ "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."
1538
+ },
1539
+ {
1540
+ "name": "aria",
1541
+ "type": "Hash",
1542
+ "default": "N/A",
1543
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
1544
+ },
1545
+ {
1546
+ "name": "data",
1547
+ "type": "Hash",
1548
+ "default": "N/A",
1549
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
1550
+ },
1551
+ {
1552
+ "name": "system_arguments",
1553
+ "type": "Hash",
1554
+ "default": "N/A",
1555
+ "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."
1556
+ }
1557
+ ]
1558
+ },
1559
+ {
1560
+ "component": "NavList",
1561
+ "status": "deprecated",
1562
+ "a11y_reviewed": true,
1563
+ "short_name": "NavList",
1564
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
1565
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/default/",
1566
+ "parameters": [
1567
+ {
1568
+ "name": "selected_item_id",
1569
+ "type": "Symbol",
1570
+ "default": "`nil`",
1571
+ "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
1572
+ },
1573
+ {
1574
+ "name": "system_arguments",
1575
+ "type": "Hash",
1576
+ "default": "N/A",
1577
+ "description": "[System arguments](/system-arguments)"
1578
+ }
1579
+ ]
1580
+ },
1581
+ {
1582
+ "component": "NavList::Divider",
1583
+ "status": "deprecated",
1584
+ "a11y_reviewed": false,
1585
+ "short_name": "NavListDivider",
1586
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
1587
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
1588
+ "parameters": [
1589
+ {
1590
+ "name": "scheme",
1591
+ "type": "Symbol",
1592
+ "default": "`:subtle`",
1593
+ "description": "Display a background color if scheme is `filled`."
1594
+ },
1595
+ {
1596
+ "name": "system_arguments",
1597
+ "type": "Hash",
1598
+ "default": "N/A",
1599
+ "description": "[System arguments](/system-arguments)"
1600
+ }
1601
+ ]
1602
+ },
1603
+ {
1604
+ "component": "NavList::Group",
1605
+ "status": "deprecated",
1606
+ "a11y_reviewed": true,
1607
+ "short_name": "NavListGroup",
1608
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
1609
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
1610
+ "parameters": [
1611
+ {
1612
+ "name": "selected_item_id",
1613
+ "type": "Symbol",
1614
+ "default": "`nil`",
1615
+ "description": "The ID of the currently selected item. Used internally."
1616
+ },
1617
+ {
1618
+ "name": "system_arguments",
1619
+ "type": "Hash",
1620
+ "default": "N/A",
1621
+ "description": "[System arguments](/system-arguments)"
1622
+ }
1623
+ ]
1624
+ },
1625
+ {
1626
+ "component": "NavList::Heading",
1627
+ "status": "deprecated",
1628
+ "a11y_reviewed": false,
1629
+ "short_name": "NavListHeading",
1630
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb",
1631
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/",
1632
+ "parameters": [
1633
+ {
1634
+ "name": "title",
1635
+ "type": "String",
1636
+ "default": "N/A",
1637
+ "description": "The text content of the heading."
1638
+ },
1639
+ {
1640
+ "name": "id",
1641
+ "type": "String",
1642
+ "default": "`self.class.generate_id`",
1643
+ "description": "The value of the ID HTML attribute. Auto-generated by default."
1644
+ },
1645
+ {
1646
+ "name": "heading_level",
1647
+ "type": "Integer",
1648
+ "default": "`2`",
1649
+ "description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
1650
+ },
1651
+ {
1652
+ "name": "system_arguments",
1653
+ "type": "Hash",
1654
+ "default": "N/A",
1655
+ "description": "[System arguments](/system-arguments)"
1656
+ }
1657
+ ]
1658
+ },
1659
+ {
1660
+ "component": "NavList::Item",
1661
+ "status": "deprecated",
1662
+ "a11y_reviewed": false,
1663
+ "short_name": "NavListItem",
1664
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
1665
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
1666
+ "parameters": [
1667
+ {
1668
+ "name": "selected_item_id",
1669
+ "type": "Symbol",
1670
+ "default": "`nil`",
1671
+ "description": "The ID of the currently selected list item. Used internally."
1672
+ },
1673
+ {
1674
+ "name": "selected_by_ids",
1675
+ "type": "Array<Symbol>",
1676
+ "default": "`[]`",
1677
+ "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."
1678
+ },
1679
+ {
1680
+ "name": "expanded",
1681
+ "type": "Boolean",
1682
+ "default": "`false`",
1683
+ "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
1684
+ },
1685
+ {
1686
+ "name": "sub_item",
1687
+ "type": "Boolean",
1688
+ "default": "`false`",
1689
+ "description": "Whether or not this item is nested under a parent item. Used internally."
1690
+ },
1691
+ {
1692
+ "name": "system_arguments",
1693
+ "type": "Hash",
1694
+ "default": "N/A",
1695
+ "description": "[System arguments](/system-arguments)"
1696
+ }
1697
+ ]
1698
+ },
1699
+ {
1700
+ "component": "Navigation::Tab",
1701
+ "status": "alpha",
1702
+ "a11y_reviewed": false,
1703
+ "short_name": "NavigationTab",
1704
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/navigation/tab.rb",
1705
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/navigation/tab/default/",
1706
+ "parameters": [
1707
+ {
1708
+ "name": "list",
1709
+ "type": "Boolean",
1710
+ "default": "`false`",
1711
+ "description": "Whether the Tab is an item in a `<ul>` list."
1712
+ },
1713
+ {
1714
+ "name": "selected",
1715
+ "type": "Boolean",
1716
+ "default": "`false`",
1717
+ "description": "Whether the Tab is selected or not."
1718
+ },
1719
+ {
1720
+ "name": "with_panel",
1721
+ "type": "Boolean",
1722
+ "default": "`false`",
1723
+ "description": "Whether the Tab has an associated panel."
1724
+ },
1725
+ {
1726
+ "name": "panel_id",
1727
+ "type": "String",
1728
+ "default": "`\"\"`",
1729
+ "description": "Only applies if `with_panel` is `true`. Unique id of panel."
1730
+ },
1731
+ {
1732
+ "name": "icon_classes",
1733
+ "type": "Boolean",
1734
+ "default": "`\"\"`",
1735
+ "description": "Classes that must always be applied to icons."
1736
+ },
1737
+ {
1738
+ "name": "wrapper_arguments",
1739
+ "type": "Hash",
1740
+ "default": "`{}`",
1741
+ "description": "[System arguments](/system-arguments) to be used in the `<li>` wrapper when the tab is an item in a list."
1742
+ },
1743
+ {
1744
+ "name": "system_arguments",
1745
+ "type": "Hash",
1746
+ "default": "N/A",
1747
+ "description": "[System arguments](/system-arguments)"
1748
+ }
1749
+ ]
1750
+ },
1751
+ {
1752
+ "component": "OcticonSymbols",
1753
+ "status": "alpha",
1754
+ "a11y_reviewed": false,
1755
+ "short_name": "OcticonSymbols",
1756
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/octicon_symbols.rb",
1757
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/octicon_symbols/default/",
1758
+ "parameters": [
1759
+ {
1760
+ "name": "icons",
1761
+ "type": "Array<Hash>",
1762
+ "default": "`[]`",
1763
+ "description": "List of icons to render, in the format { symbol: :icon_name, size: :small }"
1764
+ }
1765
+ ]
1766
+ },
1767
+ {
1768
+ "component": "Overlay",
1769
+ "status": "alpha",
1770
+ "a11y_reviewed": false,
1771
+ "short_name": "Overlay",
1772
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay.rb",
1773
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/default/",
1774
+ "parameters": [
1775
+ {
1776
+ "name": "id",
1777
+ "type": "String",
1778
+ "default": "`self.class.generate_id`",
1779
+ "description": "The id of the Overlay."
1780
+ },
1781
+ {
1782
+ "name": "title",
1783
+ "type": "String",
1784
+ "default": "N/A",
1785
+ "description": "Describes the content of the Overlay."
1786
+ },
1787
+ {
1788
+ "name": "subtitle",
1789
+ "type": "String",
1790
+ "default": "`nil`",
1791
+ "description": "Provides dditional context for the Overlay, also setting the `aria-describedby` attribute."
1792
+ },
1793
+ {
1794
+ "name": "popover",
1795
+ "type": "Symbol",
1796
+ "default": "`:auto`",
1797
+ "description": "The popover behaviour. One of `:auto` or `:manual`."
1798
+ },
1799
+ {
1800
+ "name": "size",
1801
+ "type": "Symbol",
1802
+ "default": "`:auto`",
1803
+ "description": "The size of the Overlay. One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
1804
+ },
1805
+ {
1806
+ "name": "padding",
1807
+ "type": "Symbol",
1808
+ "default": "`:normal`",
1809
+ "description": "The padding given to the Overlay body. One of `:condensed`, `:none`, or `:normal`."
1810
+ },
1811
+ {
1812
+ "name": "anchor",
1813
+ "type": "String",
1814
+ "default": "`nil`",
1815
+ "description": "An ID of the element to anchor onto. Defaults to the `show_button`."
1816
+ },
1817
+ {
1818
+ "name": "anchor_align",
1819
+ "type": "Symbol",
1820
+ "default": "`:start`",
1821
+ "description": "The anchor alignment of the Overlay. One of `:center`, `:end`, or `:start`."
1822
+ },
1823
+ {
1824
+ "name": "anchor_side",
1825
+ "type": "Symbol",
1826
+ "default": "`:outside_bottom`",
1827
+ "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`."
1828
+ },
1829
+ {
1830
+ "name": "anchor_offset",
1831
+ "type": "Symbol",
1832
+ "default": "`:normal`",
1833
+ "description": "The anchor offset to give the Overlay. One of `:normal` or `:spacious`."
1834
+ },
1835
+ {
1836
+ "name": "allow_out_of_bounds",
1837
+ "type": "Boolean",
1838
+ "default": "`false`",
1839
+ "description": "Allow the Overlay to overflow its container."
1840
+ },
1841
+ {
1842
+ "name": "visually_hide_title",
1843
+ "type": "Boolean",
1844
+ "default": "`false`",
1845
+ "description": "If true will hide the heading title, while still making it available to Screen Readers."
1846
+ },
1847
+ {
1848
+ "name": "role",
1849
+ "type": "String",
1850
+ "default": "`nil`",
1851
+ "description": "The ARIA role. One of `nil`, `:dialog`, or `:menu`."
1852
+ },
1853
+ {
1854
+ "name": "system_arguments",
1855
+ "type": "Hash",
1856
+ "default": "N/A",
1857
+ "description": "[System arguments](/system-arguments)"
1858
+ }
1859
+ ]
1860
+ },
1861
+ {
1862
+ "component": "Overlay::Body",
1863
+ "status": "alpha",
1864
+ "a11y_reviewed": false,
1865
+ "short_name": "OverlayBody",
1866
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/body.rb",
1867
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/body/default/",
1868
+ "parameters": [
1869
+ {
1870
+ "name": "system_arguments",
1871
+ "type": "Hash",
1872
+ "default": "N/A",
1873
+ "description": "[System arguments](/system-arguments)"
1874
+ }
1875
+ ]
1876
+ },
1877
+ {
1878
+ "component": "Overlay::Footer",
1879
+ "status": "alpha",
1880
+ "a11y_reviewed": false,
1881
+ "short_name": "OverlayFooter",
1882
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/footer.rb",
1883
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/footer/default/",
1884
+ "parameters": [
1885
+ {
1886
+ "name": "show_divider",
1887
+ "type": "Boolean",
1888
+ "default": "`false`",
1889
+ "description": "Show a divider between the footer and body."
1890
+ },
1891
+ {
1892
+ "name": "align_content",
1893
+ "type": "Symbol",
1894
+ "default": "`DEFAULT_ALIGN_CONTENT`",
1895
+ "description": "The alginment of contents. One of `:center`, `:end`, or `:start`."
1896
+ },
1897
+ {
1898
+ "name": "system_arguments",
1899
+ "type": "Hash",
1900
+ "default": "N/A",
1901
+ "description": "[System arguments](/system-arguments)"
1902
+ }
1903
+ ]
1904
+ },
1905
+ {
1906
+ "component": "Overlay::Header",
1907
+ "status": "alpha",
1908
+ "a11y_reviewed": false,
1909
+ "short_name": "OverlayHeader",
1910
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/header.rb",
1911
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/header/default/",
1912
+ "parameters": [
1913
+ {
1914
+ "name": "title",
1915
+ "type": "String",
1916
+ "default": "N/A",
1917
+ "description": "Describes the content of the Overlay."
1918
+ },
1919
+ {
1920
+ "name": "subtitle",
1921
+ "type": "String",
1922
+ "default": "`nil`",
1923
+ "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute."
1924
+ },
1925
+ {
1926
+ "name": "overlay_id",
1927
+ "type": "String",
1928
+ "default": "`nil`",
1929
+ "description": "Provides the id of the overlay element so the close button can close it"
1930
+ },
1931
+ {
1932
+ "name": "size",
1933
+ "type": "Symbol",
1934
+ "default": "`:medium`",
1935
+ "description": "The size of the Header. One of `:large` or `:medium`."
1936
+ },
1937
+ {
1938
+ "name": "divider",
1939
+ "type": "Boolean",
1940
+ "default": "`false`",
1941
+ "description": "Show a divider between the header and body."
1942
+ },
1943
+ {
1944
+ "name": "visually_hide_title",
1945
+ "type": "Boolean",
1946
+ "default": "`false`",
1947
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
1948
+ },
1949
+ {
1950
+ "name": "system_arguments",
1951
+ "type": "Hash",
1952
+ "default": "N/A",
1953
+ "description": "[System arguments](/system-arguments)"
1954
+ }
1955
+ ]
1956
+ },
1957
+ {
1958
+ "component": "RadioButton",
1959
+ "status": "alpha",
1960
+ "a11y_reviewed": false,
1961
+ "short_name": "RadioButton",
1962
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/radio_button.rb",
1963
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/radio_button/default/",
1964
+ "parameters": [
1965
+ {
1966
+ "name": "name",
1967
+ "type": "String",
1968
+ "default": "N/A",
1969
+ "description": "Value for the HTML name attribute."
1970
+ },
1971
+ {
1972
+ "name": "id",
1973
+ "type": "String",
1974
+ "default": "N/A",
1975
+ "description": "Value for the HTML id attribute."
1976
+ },
1977
+ {
1978
+ "name": "class",
1979
+ "type": "String",
1980
+ "default": "N/A",
1981
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
1982
+ },
1983
+ {
1984
+ "name": "classes",
1985
+ "type": "Array",
1986
+ "default": "N/A",
1987
+ "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)."
1988
+ },
1989
+ {
1990
+ "name": "caption",
1991
+ "type": "String",
1992
+ "default": "N/A",
1993
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
1994
+ },
1995
+ {
1996
+ "name": "label",
1997
+ "type": "String",
1998
+ "default": "N/A",
1999
+ "description": "Label text displayed above the input."
2000
+ },
2001
+ {
2002
+ "name": "visually_hide_label",
2003
+ "type": "Boolean",
2004
+ "default": "N/A",
2005
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
2006
+ },
2007
+ {
2008
+ "name": "disabled",
2009
+ "type": "Boolean",
2010
+ "default": "N/A",
2011
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
2012
+ },
2013
+ {
2014
+ "name": "hidden",
2015
+ "type": "Boolean",
2016
+ "default": "N/A",
2017
+ "description": "When set to `true`, visually hides the field."
2018
+ },
2019
+ {
2020
+ "name": "invalid",
2021
+ "type": "Boolean",
2022
+ "default": "N/A",
2023
+ "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."
2024
+ },
2025
+ {
2026
+ "name": "validation_message",
2027
+ "type": "String",
2028
+ "default": "N/A",
2029
+ "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."
2030
+ },
2031
+ {
2032
+ "name": "label_arguments",
2033
+ "type": "Hash",
2034
+ "default": "N/A",
2035
+ "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."
2036
+ },
2037
+ {
2038
+ "name": "scope_name_to_model",
2039
+ "type": "Boolean",
2040
+ "default": "N/A",
2041
+ "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."
2042
+ },
2043
+ {
2044
+ "name": "scope_id_to_model",
2045
+ "type": "Boolean",
2046
+ "default": "N/A",
2047
+ "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."
2048
+ },
2049
+ {
2050
+ "name": "required",
2051
+ "type": "Boolean",
2052
+ "default": "N/A",
2053
+ "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."
2054
+ },
2055
+ {
2056
+ "name": "aria",
2057
+ "type": "Hash",
2058
+ "default": "N/A",
2059
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2060
+ },
2061
+ {
2062
+ "name": "data",
2063
+ "type": "Hash",
2064
+ "default": "N/A",
2065
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
2066
+ },
2067
+ {
2068
+ "name": "system_arguments",
2069
+ "type": "Hash",
2070
+ "default": "N/A",
2071
+ "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."
2072
+ }
2073
+ ]
2074
+ },
2075
+ {
2076
+ "component": "RadioButtonGroup",
2077
+ "status": "alpha",
2078
+ "a11y_reviewed": false,
2079
+ "short_name": "RadioButtonGroup",
2080
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/radio_button_group.rb",
2081
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/radio_button_group/default/",
2082
+ "parameters": [
2083
+ {
2084
+ "name": "name",
2085
+ "type": "String",
2086
+ "default": "N/A",
2087
+ "description": "Value for the HTML name attribute."
2088
+ },
2089
+ {
2090
+ "name": "label",
2091
+ "type": "String",
2092
+ "default": "N/A",
2093
+ "description": "Label text displayed above the input."
2094
+ },
2095
+ {
2096
+ "name": "hidden",
2097
+ "type": "Boolean",
2098
+ "default": "N/A",
2099
+ "description": "When set to `true`, visually hides the group."
2100
+ },
2101
+ {
2102
+ "name": "caption",
2103
+ "type": "String",
2104
+ "default": "N/A",
2105
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the group."
2106
+ },
2107
+ {
2108
+ "name": "invalid",
2109
+ "type": "Boolean",
2110
+ "default": "N/A",
2111
+ "description": "If set to `true`, the input will be marked as invalid. 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."
2112
+ },
2113
+ {
2114
+ "name": "validation_message",
2115
+ "type": "String",
2116
+ "default": "N/A",
2117
+ "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."
2118
+ },
2119
+ {
2120
+ "name": "label_arguments",
2121
+ "type": "Hash",
2122
+ "default": "N/A",
2123
+ "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."
2124
+ }
2125
+ ]
2126
+ },
2127
+ {
2128
+ "component": "SegmentedControl",
2129
+ "status": "alpha",
2130
+ "a11y_reviewed": true,
2131
+ "short_name": "SegmentedControl",
2132
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb",
2133
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/default/",
2134
+ "parameters": [
2135
+ {
2136
+ "name": "hide_labels",
2137
+ "type": "Boolean",
2138
+ "default": "`false`",
2139
+ "description": "Whether to hide the labels and only show the icons"
2140
+ },
2141
+ {
2142
+ "name": "full_width",
2143
+ "type": "Boolean",
2144
+ "default": "`false`",
2145
+ "description": "If the component should be full width"
2146
+ },
2147
+ {
2148
+ "name": "size",
2149
+ "type": "Symbol",
2150
+ "default": "`:medium`",
2151
+ "description": "One of `:large`, `:medium`, or `:small`."
2152
+ },
2153
+ {
2154
+ "name": "system_arguments",
2155
+ "type": "Hash",
2156
+ "default": "N/A",
2157
+ "description": "[System arguments](/system-arguments)"
2158
+ }
2159
+ ]
2160
+ },
2161
+ {
2162
+ "component": "SegmentedControl::Item",
2163
+ "status": "alpha",
2164
+ "a11y_reviewed": true,
2165
+ "short_name": "SegmentedControlItem",
2166
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control/item.rb",
2167
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/item/default/",
2168
+ "parameters": [
2169
+ {
2170
+ "name": "label",
2171
+ "type": "String",
2172
+ "default": "N/A",
2173
+ "description": "The label to use"
2174
+ },
2175
+ {
2176
+ "name": "selected",
2177
+ "type": "Boolean",
2178
+ "default": "`false`",
2179
+ "description": "Whether the item is selected"
2180
+ },
2181
+ {
2182
+ "name": "icon",
2183
+ "type": "Symbol",
2184
+ "default": "`nil`",
2185
+ "description": "The icon to use"
2186
+ },
2187
+ {
2188
+ "name": "hide_labels",
2189
+ "type": "Symbol",
2190
+ "default": "`false`",
2191
+ "description": "Whether to only show the icon"
2192
+ }
2193
+ ]
2194
+ },
2195
+ {
2196
+ "component": "Select",
2197
+ "status": "alpha",
2198
+ "a11y_reviewed": false,
2199
+ "short_name": "Select",
2200
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/select.rb",
2201
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/select/default/",
2202
+ "parameters": [
2203
+ {
2204
+ "name": "size",
2205
+ "type": "Symbol",
2206
+ "default": "N/A",
2207
+ "description": "The size of the field. One of `:large`, `:medium`, or `:small`."
2208
+ },
2209
+ {
2210
+ "name": "name",
2211
+ "type": "String",
2212
+ "default": "N/A",
2213
+ "description": "Value for the HTML name attribute."
2214
+ },
2215
+ {
2216
+ "name": "id",
2217
+ "type": "String",
2218
+ "default": "N/A",
2219
+ "description": "Value for the HTML id attribute."
2220
+ },
2221
+ {
2222
+ "name": "class",
2223
+ "type": "String",
2224
+ "default": "N/A",
2225
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
2226
+ },
2227
+ {
2228
+ "name": "classes",
2229
+ "type": "Array",
2230
+ "default": "N/A",
2231
+ "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)."
2232
+ },
2233
+ {
2234
+ "name": "caption",
2235
+ "type": "String",
2236
+ "default": "N/A",
2237
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
2238
+ },
2239
+ {
2240
+ "name": "label",
2241
+ "type": "String",
2242
+ "default": "N/A",
2243
+ "description": "Label text displayed above the input."
2244
+ },
2245
+ {
2246
+ "name": "visually_hide_label",
2247
+ "type": "Boolean",
2248
+ "default": "N/A",
2249
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
2250
+ },
2251
+ {
2252
+ "name": "disabled",
2253
+ "type": "Boolean",
2254
+ "default": "N/A",
2255
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
2256
+ },
2257
+ {
2258
+ "name": "hidden",
2259
+ "type": "Boolean",
2260
+ "default": "N/A",
2261
+ "description": "When set to `true`, visually hides the field."
2262
+ },
2263
+ {
2264
+ "name": "invalid",
2265
+ "type": "Boolean",
2266
+ "default": "N/A",
2267
+ "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."
545
2268
  },
546
2269
  {
547
- "name": "system_arguments",
548
- "type": "Hash",
2270
+ "name": "validation_message",
2271
+ "type": "String",
549
2272
  "default": "N/A",
550
- "description": "[System arguments](/system-arguments)"
551
- }
552
- ]
553
- },
554
- {
555
- "component": "NavList::Item",
556
- "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/",
559
- "parameters": [
2273
+ "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."
2274
+ },
560
2275
  {
561
- "name": "selected_item_id",
562
- "type": "Symbol",
563
- "default": "`nil`",
564
- "description": "The ID of the currently selected list item. Used internally."
2276
+ "name": "label_arguments",
2277
+ "type": "Hash",
2278
+ "default": "N/A",
2279
+ "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."
565
2280
  },
566
2281
  {
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."
2282
+ "name": "scope_name_to_model",
2283
+ "type": "Boolean",
2284
+ "default": "N/A",
2285
+ "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."
571
2286
  },
572
2287
  {
573
- "name": "expanded",
2288
+ "name": "scope_id_to_model",
574
2289
  "type": "Boolean",
575
- "default": "`false`",
576
- "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
2290
+ "default": "N/A",
2291
+ "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."
577
2292
  },
578
2293
  {
579
- "name": "sub_item",
2294
+ "name": "required",
580
2295
  "type": "Boolean",
581
- "default": "`false`",
582
- "description": "Whether or not this item is nested under a parent item. Used internally."
2296
+ "default": "N/A",
2297
+ "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."
583
2298
  },
584
2299
  {
585
- "name": "system_arguments",
2300
+ "name": "aria",
586
2301
  "type": "Hash",
587
2302
  "default": "N/A",
588
- "description": "[System arguments](/system-arguments)"
589
- }
590
- ]
591
- },
592
- {
593
- "component": "NavList::Section",
594
- "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/",
597
- "parameters": [
2303
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2304
+ },
598
2305
  {
599
- "name": "selected_item_id",
600
- "type": "Symbol",
601
- "default": "`nil`",
602
- "description": "The ID of the currently selected item. Used internally."
2306
+ "name": "data",
2307
+ "type": "Hash",
2308
+ "default": "N/A",
2309
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
603
2310
  },
604
2311
  {
605
2312
  "name": "system_arguments",
606
2313
  "type": "Hash",
607
2314
  "default": "N/A",
608
- "description": "[System arguments](/system-arguments)"
609
- }
610
- ]
611
- },
612
- {
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": [
2315
+ "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."
2316
+ },
618
2317
  {
619
- "name": "icons",
620
- "type": "Array<Hash>",
621
- "default": "`[]`",
622
- "description": "List of icons to render, in the format { symbol: :icon_name, size: :small }"
2318
+ "name": "multiple",
2319
+ "type": "Boolean",
2320
+ "default": "N/A",
2321
+ "description": "If set to true, the selection will allow multiple choices."
2322
+ },
2323
+ {
2324
+ "name": "include_blank",
2325
+ "type": "Boolean, String",
2326
+ "default": "N/A",
2327
+ "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."
2328
+ },
2329
+ {
2330
+ "name": "prompt",
2331
+ "type": "String",
2332
+ "default": "N/A",
2333
+ "description": "Create a prompt option with blank value and the text asking user to select something."
623
2334
  }
624
2335
  ]
625
2336
  },
626
2337
  {
627
- "component": "SegmentedControl",
2338
+ "component": "SubmitButton",
628
2339
  "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/",
2340
+ "a11y_reviewed": false,
2341
+ "short_name": "SubmitButton",
2342
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/submit_button.rb",
2343
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/submit_button/default/",
631
2344
  "parameters": [
632
2345
  {
633
- "name": "hide_labels",
634
- "type": "Boolean",
635
- "default": "`false`",
636
- "description": "Whether to hide the labels and only show the icons"
2346
+ "name": "name",
2347
+ "type": "String",
2348
+ "default": "N/A",
2349
+ "description": "Value for the HTML name attribute."
637
2350
  },
638
2351
  {
639
- "name": "full_width",
640
- "type": "Boolean",
641
- "default": "`false`",
642
- "description": "If the component should be full width"
2352
+ "name": "id",
2353
+ "type": "String",
2354
+ "default": "N/A",
2355
+ "description": "Value for the HTML id attribute."
643
2356
  },
644
2357
  {
645
- "name": "size",
646
- "type": "Symbol",
647
- "default": "`:medium`",
648
- "description": "One of `:large`, `:medium`, or `:small`."
2358
+ "name": "class",
2359
+ "type": "String",
2360
+ "default": "N/A",
2361
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
2362
+ },
2363
+ {
2364
+ "name": "classes",
2365
+ "type": "Array",
2366
+ "default": "N/A",
2367
+ "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)."
2368
+ },
2369
+ {
2370
+ "name": "label",
2371
+ "type": "String",
2372
+ "default": "N/A",
2373
+ "description": "Label text displayed above the input."
2374
+ },
2375
+ {
2376
+ "name": "aria",
2377
+ "type": "Hash",
2378
+ "default": "N/A",
2379
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2380
+ },
2381
+ {
2382
+ "name": "data",
2383
+ "type": "Hash",
2384
+ "default": "N/A",
2385
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
649
2386
  },
650
2387
  {
651
2388
  "name": "system_arguments",
652
2389
  "type": "Hash",
653
2390
  "default": "N/A",
654
- "description": "[System arguments](/system-arguments)"
2391
+ "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."
655
2392
  }
656
2393
  ]
657
2394
  },
658
2395
  {
659
2396
  "component": "TabContainer",
660
2397
  "status": "alpha",
2398
+ "a11y_reviewed": false,
2399
+ "short_name": "TabContainer",
661
2400
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_container.rb",
662
2401
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_container/default/",
663
2402
  "parameters": [
@@ -672,6 +2411,8 @@
672
2411
  {
673
2412
  "component": "TabNav",
674
2413
  "status": "alpha",
2414
+ "a11y_reviewed": false,
2415
+ "short_name": "TabNav",
675
2416
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb",
676
2417
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav/default/",
677
2418
  "parameters": [
@@ -704,6 +2445,8 @@
704
2445
  {
705
2446
  "component": "TabPanels",
706
2447
  "status": "alpha",
2448
+ "a11y_reviewed": false,
2449
+ "short_name": "TabPanels",
707
2450
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_panels.rb",
708
2451
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels/default/",
709
2452
  "parameters": [
@@ -740,11 +2483,19 @@
740
2483
  ]
741
2484
  },
742
2485
  {
743
- "component": "TextField",
2486
+ "component": "TextArea",
744
2487
  "status": "alpha",
745
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb",
746
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field/default/",
2488
+ "a11y_reviewed": false,
2489
+ "short_name": "TextArea",
2490
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_area.rb",
2491
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_area/default/",
747
2492
  "parameters": [
2493
+ {
2494
+ "name": "full_width",
2495
+ "type": "Boolean",
2496
+ "default": "N/A",
2497
+ "description": "When set to `true`, the field will take up all the horizontal space allowed by its container."
2498
+ },
748
2499
  {
749
2500
  "name": "name",
750
2501
  "type": "String",
@@ -761,19 +2512,19 @@
761
2512
  "name": "class",
762
2513
  "type": "String",
763
2514
  "default": "N/A",
764
- "description": "A list of CSS classes to add to the input. Exists for compatibility with Rails form builders."
2515
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
765
2516
  },
766
2517
  {
767
2518
  "name": "classes",
768
- "type": "String",
2519
+ "type": "Array",
769
2520
  "default": "N/A",
770
- "description": "A list of CSS classes to add to the input. Combined with the `:class` argument."
2521
+ "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
2522
  },
772
2523
  {
773
2524
  "name": "caption",
774
2525
  "type": "String",
775
2526
  "default": "N/A",
776
- "description": "Caption text to render below the input."
2527
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
777
2528
  },
778
2529
  {
779
2530
  "name": "label",
@@ -785,8 +2536,84 @@
785
2536
  "name": "visually_hide_label",
786
2537
  "type": "Boolean",
787
2538
  "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."
2539
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
2540
+ },
2541
+ {
2542
+ "name": "disabled",
2543
+ "type": "Boolean",
2544
+ "default": "N/A",
2545
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
2546
+ },
2547
+ {
2548
+ "name": "hidden",
2549
+ "type": "Boolean",
2550
+ "default": "N/A",
2551
+ "description": "When set to `true`, visually hides the field."
2552
+ },
2553
+ {
2554
+ "name": "invalid",
2555
+ "type": "Boolean",
2556
+ "default": "N/A",
2557
+ "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."
2558
+ },
2559
+ {
2560
+ "name": "validation_message",
2561
+ "type": "String",
2562
+ "default": "N/A",
2563
+ "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."
2564
+ },
2565
+ {
2566
+ "name": "label_arguments",
2567
+ "type": "Hash",
2568
+ "default": "N/A",
2569
+ "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."
2570
+ },
2571
+ {
2572
+ "name": "scope_name_to_model",
2573
+ "type": "Boolean",
2574
+ "default": "N/A",
2575
+ "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."
2576
+ },
2577
+ {
2578
+ "name": "scope_id_to_model",
2579
+ "type": "Boolean",
2580
+ "default": "N/A",
2581
+ "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."
2582
+ },
2583
+ {
2584
+ "name": "required",
2585
+ "type": "Boolean",
2586
+ "default": "N/A",
2587
+ "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."
2588
+ },
2589
+ {
2590
+ "name": "aria",
2591
+ "type": "Hash",
2592
+ "default": "N/A",
2593
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
2594
+ },
2595
+ {
2596
+ "name": "data",
2597
+ "type": "Hash",
2598
+ "default": "N/A",
2599
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
789
2600
  },
2601
+ {
2602
+ "name": "system_arguments",
2603
+ "type": "Hash",
2604
+ "default": "N/A",
2605
+ "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."
2606
+ }
2607
+ ]
2608
+ },
2609
+ {
2610
+ "component": "TextField",
2611
+ "status": "alpha",
2612
+ "a11y_reviewed": false,
2613
+ "short_name": "TextField",
2614
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb",
2615
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field/default/",
2616
+ "parameters": [
790
2617
  {
791
2618
  "name": "size",
792
2619
  "type": "Symbol",
@@ -794,34 +2621,118 @@
794
2621
  "description": "The size of the field. One of `:large`, `:medium`, or `:small`."
795
2622
  },
796
2623
  {
797
- "name": "show_clear_button",
2624
+ "name": "full_width",
2625
+ "type": "Boolean",
2626
+ "default": "N/A",
2627
+ "description": "When set to `true`, the field will take up all the horizontal space allowed by its container."
2628
+ },
2629
+ {
2630
+ "name": "name",
2631
+ "type": "String",
2632
+ "default": "N/A",
2633
+ "description": "Value for the HTML name attribute."
2634
+ },
2635
+ {
2636
+ "name": "id",
2637
+ "type": "String",
2638
+ "default": "N/A",
2639
+ "description": "Value for the HTML id attribute."
2640
+ },
2641
+ {
2642
+ "name": "class",
2643
+ "type": "String",
2644
+ "default": "N/A",
2645
+ "description": "CSS classes to include in the input's HTML `class` attribute. Exists for compatibility with Rails form builders."
2646
+ },
2647
+ {
2648
+ "name": "classes",
2649
+ "type": "Array",
2650
+ "default": "N/A",
2651
+ "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)."
2652
+ },
2653
+ {
2654
+ "name": "caption",
2655
+ "type": "String",
2656
+ "default": "N/A",
2657
+ "description": "A string describing the field and what sorts of input it expects. Displayed below the input."
2658
+ },
2659
+ {
2660
+ "name": "label",
2661
+ "type": "String",
2662
+ "default": "N/A",
2663
+ "description": "Label text displayed above the input."
2664
+ },
2665
+ {
2666
+ "name": "visually_hide_label",
2667
+ "type": "Boolean",
2668
+ "default": "N/A",
2669
+ "description": "When set to `true`, hides the label. Although the label will be hidden visually, it will still be visible to screen readers."
2670
+ },
2671
+ {
2672
+ "name": "disabled",
2673
+ "type": "Boolean",
2674
+ "default": "N/A",
2675
+ "description": "When set to `true`, the input will not accept keyboard or mouse input."
2676
+ },
2677
+ {
2678
+ "name": "hidden",
2679
+ "type": "Boolean",
2680
+ "default": "N/A",
2681
+ "description": "When set to `true`, visually hides the field."
2682
+ },
2683
+ {
2684
+ "name": "invalid",
2685
+ "type": "Boolean",
2686
+ "default": "N/A",
2687
+ "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."
2688
+ },
2689
+ {
2690
+ "name": "validation_message",
2691
+ "type": "String",
2692
+ "default": "N/A",
2693
+ "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."
2694
+ },
2695
+ {
2696
+ "name": "label_arguments",
2697
+ "type": "Hash",
2698
+ "default": "N/A",
2699
+ "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."
2700
+ },
2701
+ {
2702
+ "name": "scope_name_to_model",
2703
+ "type": "Boolean",
2704
+ "default": "N/A",
2705
+ "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."
2706
+ },
2707
+ {
2708
+ "name": "scope_id_to_model",
798
2709
  "type": "Boolean",
799
2710
  "default": "N/A",
800
- "description": "Whether or not to include a clear button inside the input that clears the input's contents when clicked."
2711
+ "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."
801
2712
  },
802
2713
  {
803
- "name": "clear_button_id",
804
- "type": "String",
2714
+ "name": "required",
2715
+ "type": "Boolean",
805
2716
  "default": "N/A",
806
- "description": "The HTML id attribute of the clear button."
2717
+ "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."
807
2718
  },
808
2719
  {
809
- "name": "full_width",
810
- "type": "Boolean",
2720
+ "name": "aria",
2721
+ "type": "Hash",
811
2722
  "default": "N/A",
812
- "description": "Controls whether or not the input takes the full width of its container."
2723
+ "description": "Key/value pairs that represent Aria attributes and their values. Eg. `aria: { current: true }` becomes `aria-current=\"true\"`."
813
2724
  },
814
2725
  {
815
- "name": "disabled",
816
- "type": "Boolean",
2726
+ "name": "data",
2727
+ "type": "Hash",
817
2728
  "default": "N/A",
818
- "description": "Whether or not the input should accept keyboard and mouse input."
2729
+ "description": "Key/value pairs that represent data attributes and their values. Eg. `data: { foo: \"bar\" }` becomes `data-foo=\"bar\"`."
819
2730
  },
820
2731
  {
821
- "name": "invalid",
822
- "type": "Boolean",
2732
+ "name": "system_arguments",
2733
+ "type": "Hash",
823
2734
  "default": "N/A",
824
- "description": "If `true`, renders the input in a visually invalid state."
2735
+ "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
2736
  },
826
2737
  {
827
2738
  "name": "placeholder",
@@ -842,40 +2753,36 @@
842
2753
  "description": "If `true`, uses a monospace font for the input field."
843
2754
  },
844
2755
  {
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",
2756
+ "name": "auto_check_src",
852
2757
  "type": "String",
853
2758
  "default": "N/A",
854
- "description": "A validation message to display beneath the input. Implicitly sets `invalid` to `true`."
2759
+ "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
2760
  },
856
2761
  {
857
- "name": "label_arguments",
2762
+ "name": "leading_visual",
858
2763
  "type": "Hash",
859
2764
  "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."
2765
+ "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
2766
  },
862
2767
  {
863
- "name": "system_arguments",
864
- "type": "Hash",
2768
+ "name": "show_clear_button",
2769
+ "type": "Boolean",
865
2770
  "default": "N/A",
866
- "description": "[System arguments](/system-arguments)"
2771
+ "description": "Whether or not to include a clear button inside the input that clears the input's contents when clicked."
867
2772
  },
868
2773
  {
869
- "name": "block",
870
- "type": "Proc",
2774
+ "name": "clear_button_id",
2775
+ "type": "String",
871
2776
  "default": "N/A",
872
- "description": "Unused."
2777
+ "description": "The HTML id attribute of the clear button."
873
2778
  }
874
2779
  ]
875
2780
  },
876
2781
  {
877
2782
  "component": "ToggleSwitch",
878
2783
  "status": "alpha",
2784
+ "a11y_reviewed": false,
2785
+ "short_name": "ToggleSwitch",
879
2786
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/toggle_switch.rb",
880
2787
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch/default/",
881
2788
  "parameters": [
@@ -926,6 +2833,8 @@
926
2833
  {
927
2834
  "component": "Tooltip",
928
2835
  "status": "alpha",
2836
+ "a11y_reviewed": false,
2837
+ "short_name": "Tooltip",
929
2838
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb",
930
2839
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip/default/",
931
2840
  "parameters": [
@@ -964,6 +2873,8 @@
964
2873
  {
965
2874
  "component": "UnderlineNav",
966
2875
  "status": "alpha",
2876
+ "a11y_reviewed": false,
2877
+ "short_name": "UnderlineNav",
967
2878
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb",
968
2879
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav/default/",
969
2880
  "parameters": [
@@ -1002,6 +2913,8 @@
1002
2913
  {
1003
2914
  "component": "UnderlinePanels",
1004
2915
  "status": "alpha",
2916
+ "a11y_reviewed": false,
2917
+ "short_name": "UnderlinePanels",
1005
2918
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb",
1006
2919
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels/default/",
1007
2920
  "parameters": [
@@ -1037,9 +2950,22 @@
1037
2950
  }
1038
2951
  ]
1039
2952
  },
2953
+ {
2954
+ "component": "Base",
2955
+ "status": "beta",
2956
+ "a11y_reviewed": false,
2957
+ "short_name": "Base",
2958
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/base_component.rb",
2959
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/base/default/",
2960
+ "parameters": [
2961
+
2962
+ ]
2963
+ },
1040
2964
  {
1041
2965
  "component": "AutoComplete",
1042
2966
  "status": "beta",
2967
+ "a11y_reviewed": false,
2968
+ "short_name": "AutoComplete",
1043
2969
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb",
1044
2970
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/default/",
1045
2971
  "parameters": [
@@ -1103,6 +3029,12 @@
1103
3029
  "default": "`false`",
1104
3030
  "description": "Input can be full-width or fit to content"
1105
3031
  },
3032
+ {
3033
+ "name": "width",
3034
+ "type": "String",
3035
+ "default": "`:auto`",
3036
+ "description": "Optional parameter to set max width of results list. One of `:auto`, `:large`, `:medium`, `:small`, `:xlarge`, or `:xxlarge`."
3037
+ },
1106
3038
  {
1107
3039
  "name": "disabled",
1108
3040
  "type": "Boolean",
@@ -1138,6 +3070,8 @@
1138
3070
  {
1139
3071
  "component": "AutoComplete::Item",
1140
3072
  "status": "beta",
3073
+ "a11y_reviewed": false,
3074
+ "short_name": "AutoCompleteItem",
1141
3075
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb",
1142
3076
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item/default/",
1143
3077
  "parameters": [
@@ -1182,6 +3116,8 @@
1182
3116
  {
1183
3117
  "component": "Avatar",
1184
3118
  "status": "beta",
3119
+ "a11y_reviewed": false,
3120
+ "short_name": "Avatar",
1185
3121
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar.rb",
1186
3122
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar/default/",
1187
3123
  "parameters": [
@@ -1194,14 +3130,14 @@
1194
3130
  {
1195
3131
  "name": "alt",
1196
3132
  "type": "String",
1197
- "default": "N/A",
3133
+ "default": "`nil`",
1198
3134
  "description": "Passed through to alt on img tag."
1199
3135
  },
1200
3136
  {
1201
3137
  "name": "size",
1202
3138
  "type": "Integer",
1203
3139
  "default": "`20`",
1204
- "description": "One of `16`, `20`, `24`, `32`, `40`, `48`, or `80`."
3140
+ "description": "One of `16`, `20`, `24`, `32`, `40`, `48`, `64`, or `80`."
1205
3141
  },
1206
3142
  {
1207
3143
  "name": "shape",
@@ -1226,6 +3162,8 @@
1226
3162
  {
1227
3163
  "component": "AvatarStack",
1228
3164
  "status": "beta",
3165
+ "a11y_reviewed": false,
3166
+ "short_name": "AvatarStack",
1229
3167
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar_stack.rb",
1230
3168
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack/default/",
1231
3169
  "parameters": [
@@ -1264,6 +3202,8 @@
1264
3202
  {
1265
3203
  "component": "BaseButton",
1266
3204
  "status": "beta",
3205
+ "a11y_reviewed": false,
3206
+ "short_name": "BaseButton",
1267
3207
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb",
1268
3208
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button/default/",
1269
3209
  "parameters": [
@@ -1271,7 +3211,7 @@
1271
3211
  "name": "tag",
1272
3212
  "type": "Symbol",
1273
3213
  "default": "`:button`",
1274
- "description": "One of `:a`, `:button`, or `:summary`."
3214
+ "description": "One of `:a`, `:button`, `:clipboard-copy`, or `:summary`."
1275
3215
  },
1276
3216
  {
1277
3217
  "name": "type",
@@ -1285,6 +3225,18 @@
1285
3225
  "default": "`false`",
1286
3226
  "description": "Whether button is full-width with `display: block`."
1287
3227
  },
3228
+ {
3229
+ "name": "disabled",
3230
+ "type": "Boolean",
3231
+ "default": "`false`",
3232
+ "description": "Whether or not the button is disabled. If true, this option forces `tag:` to `:button`."
3233
+ },
3234
+ {
3235
+ "name": "inactive",
3236
+ "type": "Boolean",
3237
+ "default": "`false`",
3238
+ "description": "Whether the button looks visually disabled, but can still accept all the same interactions as an enabled button."
3239
+ },
1288
3240
  {
1289
3241
  "name": "system_arguments",
1290
3242
  "type": "Hash",
@@ -1296,6 +3248,8 @@
1296
3248
  {
1297
3249
  "component": "Blankslate",
1298
3250
  "status": "beta",
3251
+ "a11y_reviewed": false,
3252
+ "short_name": "Blankslate",
1299
3253
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb",
1300
3254
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate/default/",
1301
3255
  "parameters": [
@@ -1328,6 +3282,8 @@
1328
3282
  {
1329
3283
  "component": "BorderBox",
1330
3284
  "status": "beta",
3285
+ "a11y_reviewed": false,
3286
+ "short_name": "BorderBox",
1331
3287
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb",
1332
3288
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/default/",
1333
3289
  "parameters": [
@@ -1348,6 +3304,8 @@
1348
3304
  {
1349
3305
  "component": "BorderBox::Header",
1350
3306
  "status": "beta",
3307
+ "a11y_reviewed": false,
3308
+ "short_name": "BorderBoxHeader",
1351
3309
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb",
1352
3310
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header/default/",
1353
3311
  "parameters": [
@@ -1362,6 +3320,8 @@
1362
3320
  {
1363
3321
  "component": "Breadcrumbs",
1364
3322
  "status": "beta",
3323
+ "a11y_reviewed": false,
3324
+ "short_name": "Breadcrumbs",
1365
3325
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb",
1366
3326
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/default/",
1367
3327
  "parameters": [
@@ -1373,12 +3333,31 @@
1373
3333
  }
1374
3334
  ]
1375
3335
  },
3336
+ {
3337
+ "component": "Breadcrumbs::Item",
3338
+ "status": "alpha",
3339
+ "a11y_reviewed": false,
3340
+ "short_name": "BreadcrumbsItem",
3341
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs/item.rb",
3342
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/item/default/",
3343
+ "parameters": [
3344
+
3345
+ ]
3346
+ },
1376
3347
  {
1377
3348
  "component": "Button",
1378
3349
  "status": "beta",
3350
+ "a11y_reviewed": false,
3351
+ "short_name": "Button",
1379
3352
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button.rb",
1380
3353
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button/default/",
1381
3354
  "parameters": [
3355
+ {
3356
+ "name": "base_button_class",
3357
+ "type": "Class",
3358
+ "default": "`Primer::Beta::BaseButton`",
3359
+ "description": "The button class to render."
3360
+ },
1382
3361
  {
1383
3362
  "name": "scheme",
1384
3363
  "type": "Symbol",
@@ -1407,7 +3386,7 @@
1407
3386
  "name": "tag",
1408
3387
  "type": "Symbol",
1409
3388
  "default": "`:button`",
1410
- "description": "One of `:a`, `:button`, or `:summary`."
3389
+ "description": "One of `:a`, `:button`, `:clipboard-copy`, or `:summary`."
1411
3390
  },
1412
3391
  {
1413
3392
  "name": "type",
@@ -1415,6 +3394,12 @@
1415
3394
  "default": "`:button`",
1416
3395
  "description": "One of `:button`, `:reset`, or `:submit`."
1417
3396
  },
3397
+ {
3398
+ "name": "disabled",
3399
+ "type": "Boolean",
3400
+ "default": "`false`",
3401
+ "description": "Whether or not the button is disabled. If true, this option forces `tag:` to `:button`."
3402
+ },
1418
3403
  {
1419
3404
  "name": "system_arguments",
1420
3405
  "type": "Hash",
@@ -1426,20 +3411,22 @@
1426
3411
  {
1427
3412
  "component": "ButtonGroup",
1428
3413
  "status": "beta",
3414
+ "a11y_reviewed": false,
3415
+ "short_name": "ButtonGroup",
1429
3416
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group.rb",
1430
3417
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group/default/",
1431
3418
  "parameters": [
1432
3419
  {
1433
- "name": "variant",
3420
+ "name": "scheme",
1434
3421
  "type": "Symbol",
1435
- "default": "`nil`",
1436
- "description": "DEPRECATED. One of `:medium` or `:small`."
3422
+ "default": "`:default`",
3423
+ "description": "DEPRECATED. One of `:danger`, `:default`, `:invisible`, `:link`, `:primary`, or `:secondary`."
1437
3424
  },
1438
3425
  {
1439
3426
  "name": "size",
1440
3427
  "type": "Symbol",
1441
3428
  "default": "`:medium`",
1442
- "description": "One of `:medium` or `:small`."
3429
+ "description": "One of `:large`, `:medium`, or `:small`."
1443
3430
  },
1444
3431
  {
1445
3432
  "name": "system_arguments",
@@ -1449,9 +3436,33 @@
1449
3436
  }
1450
3437
  ]
1451
3438
  },
3439
+ {
3440
+ "component": "ButtonGroup::MenuButton",
3441
+ "status": "alpha",
3442
+ "a11y_reviewed": false,
3443
+ "short_name": "ButtonGroupMenuButton",
3444
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group/menu_button.rb",
3445
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group/menu_button/default/",
3446
+ "parameters": [
3447
+ {
3448
+ "name": "menu_arguments",
3449
+ "type": "Hash",
3450
+ "default": "`{}`",
3451
+ "description": "The arguments accepted by [ActionMenu](/components/alpha/actionmenu)."
3452
+ },
3453
+ {
3454
+ "name": "button_arguments",
3455
+ "type": "Hash",
3456
+ "default": "`{}`",
3457
+ "description": "The arguments accepted by [Button](/components/beta/button) or [IconButton](/components/beta/iconbutton), depending on the value of the `icon:` argument."
3458
+ }
3459
+ ]
3460
+ },
1452
3461
  {
1453
3462
  "component": "ClipboardCopy",
1454
3463
  "status": "beta",
3464
+ "a11y_reviewed": false,
3465
+ "short_name": "ClipboardCopy",
1455
3466
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/clipboard_copy.rb",
1456
3467
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy/default/",
1457
3468
  "parameters": [
@@ -1481,9 +3492,73 @@
1481
3492
  }
1482
3493
  ]
1483
3494
  },
3495
+ {
3496
+ "component": "ClipboardCopyBaseButton",
3497
+ "status": "beta",
3498
+ "a11y_reviewed": false,
3499
+ "short_name": "ClipboardCopyBaseButton",
3500
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/clipboard_copy_base_button.rb",
3501
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy_base_button/default/",
3502
+ "parameters": [
3503
+ {
3504
+ "name": "tag",
3505
+ "type": "Symbol",
3506
+ "default": "`:button`",
3507
+ "description": "One of `:a`, `:button`, `:clipboard-copy`, or `:summary`."
3508
+ },
3509
+ {
3510
+ "name": "type",
3511
+ "type": "Symbol",
3512
+ "default": "`:button`",
3513
+ "description": "One of `:button`, `:reset`, or `:submit`."
3514
+ },
3515
+ {
3516
+ "name": "block",
3517
+ "type": "Boolean",
3518
+ "default": "`false`",
3519
+ "description": "Whether button is full-width with `display: block`."
3520
+ },
3521
+ {
3522
+ "name": "disabled",
3523
+ "type": "Boolean",
3524
+ "default": "`false`",
3525
+ "description": "Whether or not the button is disabled. If true, this option forces `tag:` to `:button`."
3526
+ },
3527
+ {
3528
+ "name": "inactive",
3529
+ "type": "Boolean",
3530
+ "default": "`false`",
3531
+ "description": "Whether the button looks visually disabled, but can still accept all the same interactions as an enabled button."
3532
+ },
3533
+ {
3534
+ "name": "system_arguments",
3535
+ "type": "Hash",
3536
+ "default": "N/A",
3537
+ "description": "[System arguments](/system-arguments)"
3538
+ }
3539
+ ]
3540
+ },
3541
+ {
3542
+ "component": "ClipboardCopyButton",
3543
+ "status": "beta",
3544
+ "a11y_reviewed": false,
3545
+ "short_name": "ClipboardCopyButton",
3546
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/clipboard_copy_button.rb",
3547
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy_button/default/",
3548
+ "parameters": [
3549
+ {
3550
+ "name": "system_arguments",
3551
+ "type": "Hash",
3552
+ "default": "N/A",
3553
+ "description": "The arguments accepted by [Button](/components/beta/button) and [ClipboardCopy](/components/beta/clipboardcopy)."
3554
+ }
3555
+ ]
3556
+ },
1484
3557
  {
1485
3558
  "component": "CloseButton",
1486
3559
  "status": "beta",
3560
+ "a11y_reviewed": false,
3561
+ "short_name": "CloseButton",
1487
3562
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/close_button.rb",
1488
3563
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button/default/",
1489
3564
  "parameters": [
@@ -1493,6 +3568,12 @@
1493
3568
  "default": "`:button`",
1494
3569
  "description": "One of `:button` or `:submit`."
1495
3570
  },
3571
+ {
3572
+ "name": "disabled",
3573
+ "type": "Boolean",
3574
+ "default": "`false`",
3575
+ "description": "Whether or not the button is disabled."
3576
+ },
1496
3577
  {
1497
3578
  "name": "system_arguments",
1498
3579
  "type": "Hash",
@@ -1504,6 +3585,8 @@
1504
3585
  {
1505
3586
  "component": "Counter",
1506
3587
  "status": "beta",
3588
+ "a11y_reviewed": false,
3589
+ "short_name": "Counter",
1507
3590
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/counter.rb",
1508
3591
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter/default/",
1509
3592
  "parameters": [
@@ -1554,6 +3637,8 @@
1554
3637
  {
1555
3638
  "component": "Details",
1556
3639
  "status": "beta",
3640
+ "a11y_reviewed": false,
3641
+ "short_name": "Details",
1557
3642
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/details.rb",
1558
3643
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details/default/",
1559
3644
  "parameters": [
@@ -1569,6 +3654,12 @@
1569
3654
  "default": "`false`",
1570
3655
  "description": "Defaults to false. If set to true, it will remove the default caret and remove style from the summary element"
1571
3656
  },
3657
+ {
3658
+ "name": "disabled",
3659
+ "type": "Boolean",
3660
+ "default": "`false`",
3661
+ "description": "Whether or not to disable the summary button."
3662
+ },
1572
3663
  {
1573
3664
  "name": "system_arguments",
1574
3665
  "type": "Hash",
@@ -1579,7 +3670,9 @@
1579
3670
  },
1580
3671
  {
1581
3672
  "component": "Flash",
1582
- "status": "beta",
3673
+ "status": "deprecated",
3674
+ "a11y_reviewed": false,
3675
+ "short_name": "Flash",
1583
3676
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/flash.rb",
1584
3677
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash/default/",
1585
3678
  "parameters": [
@@ -1624,6 +3717,8 @@
1624
3717
  {
1625
3718
  "component": "Heading",
1626
3719
  "status": "beta",
3720
+ "a11y_reviewed": false,
3721
+ "short_name": "Heading",
1627
3722
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/heading.rb",
1628
3723
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading/default/",
1629
3724
  "parameters": [
@@ -1644,6 +3739,8 @@
1644
3739
  {
1645
3740
  "component": "IconButton",
1646
3741
  "status": "beta",
3742
+ "a11y_reviewed": false,
3743
+ "short_name": "IconButton",
1647
3744
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/icon_button.rb",
1648
3745
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button/default/",
1649
3746
  "parameters": [
@@ -1654,10 +3751,10 @@
1654
3751
  "description": "Name of [Octicon](https://primer.style/octicons/) to use."
1655
3752
  },
1656
3753
  {
1657
- "name": "wrapper_arguments",
1658
- "type": "Hash",
1659
- "default": "`{}`",
1660
- "description": "Optional keyword arguments to be passed to the wrapper `<div>` tag."
3754
+ "name": "tag",
3755
+ "type": "Symbol",
3756
+ "default": "N/A",
3757
+ "description": "One of `:a`, `:button`, `:clipboard-copy`, or `:summary`."
1661
3758
  },
1662
3759
  {
1663
3760
  "name": "scheme",
@@ -1672,10 +3769,10 @@
1672
3769
  "description": "One of `:large`, `:medium`, or `:small`."
1673
3770
  },
1674
3771
  {
1675
- "name": "tag",
1676
- "type": "Symbol",
1677
- "default": "N/A",
1678
- "description": "One of `:a`, `:button`, or `:summary`."
3772
+ "name": "disabled",
3773
+ "type": "Boolean",
3774
+ "default": "`false`",
3775
+ "description": "Whether or not the button is disabled. If true, this option forces `tag:` to `:button`."
1679
3776
  },
1680
3777
  {
1681
3778
  "name": "type",
@@ -1718,6 +3815,8 @@
1718
3815
  {
1719
3816
  "component": "Label",
1720
3817
  "status": "beta",
3818
+ "a11y_reviewed": false,
3819
+ "short_name": "Label",
1721
3820
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/label.rb",
1722
3821
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label/default/",
1723
3822
  "parameters": [
@@ -1746,10 +3845,138 @@
1746
3845
  "description": "Whether or not to render this label inline."
1747
3846
  },
1748
3847
  {
1749
- "name": "variant",
3848
+ "name": "variant",
3849
+ "type": "Symbol",
3850
+ "default": "`:none`",
3851
+ "description": "One of `:inline`, `:large`, or `:none`."
3852
+ },
3853
+ {
3854
+ "name": "system_arguments",
3855
+ "type": "Hash",
3856
+ "default": "N/A",
3857
+ "description": "[System arguments](/system-arguments)"
3858
+ }
3859
+ ]
3860
+ },
3861
+ {
3862
+ "component": "Link",
3863
+ "status": "beta",
3864
+ "a11y_reviewed": false,
3865
+ "short_name": "Link",
3866
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
3867
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/",
3868
+ "parameters": [
3869
+ {
3870
+ "name": "href",
3871
+ "type": "String",
3872
+ "default": "`nil`",
3873
+ "description": "URL to be used for the Link. Required. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
3874
+ },
3875
+ {
3876
+ "name": "scheme",
3877
+ "type": "Symbol",
3878
+ "default": "`:default`",
3879
+ "description": "One of `:default`, `:primary`, or `:secondary`."
3880
+ },
3881
+ {
3882
+ "name": "muted",
3883
+ "type": "Boolean",
3884
+ "default": "`false`",
3885
+ "description": "Uses light gray for Link color, and blue on hover."
3886
+ },
3887
+ {
3888
+ "name": "underline",
3889
+ "type": "Boolean",
3890
+ "default": "`false`",
3891
+ "description": "Whether or not to underline the link."
3892
+ },
3893
+ {
3894
+ "name": "system_arguments",
3895
+ "type": "Hash",
3896
+ "default": "N/A",
3897
+ "description": "[System arguments](/system-arguments)"
3898
+ }
3899
+ ]
3900
+ },
3901
+ {
3902
+ "component": "Markdown",
3903
+ "status": "beta",
3904
+ "a11y_reviewed": false,
3905
+ "short_name": "Markdown",
3906
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/markdown.rb",
3907
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/markdown/default/",
3908
+ "parameters": [
3909
+ {
3910
+ "name": "tag",
3911
+ "type": "Symbol",
3912
+ "default": "`:div`",
3913
+ "description": "One of `:article`, `:div`, or `:td`."
3914
+ },
3915
+ {
3916
+ "name": "system_arguments",
3917
+ "type": "Hash",
3918
+ "default": "N/A",
3919
+ "description": "[System arguments](/system-arguments)"
3920
+ }
3921
+ ]
3922
+ },
3923
+ {
3924
+ "component": "NavList",
3925
+ "status": "beta",
3926
+ "a11y_reviewed": true,
3927
+ "short_name": "NavList",
3928
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list.rb",
3929
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/default/",
3930
+ "parameters": [
3931
+ {
3932
+ "name": "selected_item_id",
3933
+ "type": "Symbol",
3934
+ "default": "`nil`",
3935
+ "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
3936
+ },
3937
+ {
3938
+ "name": "system_arguments",
3939
+ "type": "Hash",
3940
+ "default": "N/A",
3941
+ "description": "[System arguments](/system-arguments)"
3942
+ }
3943
+ ]
3944
+ },
3945
+ {
3946
+ "component": "NavList::Divider",
3947
+ "status": "alpha",
3948
+ "a11y_reviewed": false,
3949
+ "short_name": "NavListDivider",
3950
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb",
3951
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/",
3952
+ "parameters": [
3953
+ {
3954
+ "name": "scheme",
3955
+ "type": "Symbol",
3956
+ "default": "`:subtle`",
3957
+ "description": "Display a background color if scheme is `filled`."
3958
+ },
3959
+ {
3960
+ "name": "system_arguments",
3961
+ "type": "Hash",
3962
+ "default": "N/A",
3963
+ "description": "[System arguments](/system-arguments)"
3964
+ }
3965
+ ]
3966
+ },
3967
+ {
3968
+ "component": "NavList::Group",
3969
+ "status": "alpha",
3970
+ "a11y_reviewed": true,
3971
+ "short_name": "NavListGroup",
3972
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb",
3973
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/",
3974
+ "parameters": [
3975
+ {
3976
+ "name": "selected_item_id",
1750
3977
  "type": "Symbol",
1751
- "default": "`:none`",
1752
- "description": "One of `:inline`, `:large`, or `:none`."
3978
+ "default": "`nil`",
3979
+ "description": "The ID of the currently selected item. Used internally."
1753
3980
  },
1754
3981
  {
1755
3982
  "name": "system_arguments",
@@ -1760,40 +3987,30 @@
1760
3987
  ]
1761
3988
  },
1762
3989
  {
1763
- "component": "Link",
1764
- "status": "beta",
1765
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
1766
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/",
3990
+ "component": "NavList::Heading",
3991
+ "status": "alpha",
3992
+ "a11y_reviewed": false,
3993
+ "short_name": "NavListHeading",
3994
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/heading.rb",
3995
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/heading/default/",
1767
3996
  "parameters": [
1768
3997
  {
1769
- "name": "tag",
3998
+ "name": "title",
1770
3999
  "type": "String",
1771
- "default": "`:a`",
1772
- "description": "One of `:a` or `:span`."
4000
+ "default": "N/A",
4001
+ "description": "The text content of the heading."
1773
4002
  },
1774
4003
  {
1775
- "name": "href",
4004
+ "name": "id",
1776
4005
  "type": "String",
1777
- "default": "`nil`",
1778
- "description": "URL to be used for the Link. Required if tag is `:a`. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
1779
- },
1780
- {
1781
- "name": "scheme",
1782
- "type": "Symbol",
1783
- "default": "`:default`",
1784
- "description": "One of `:default`, `:primary`, or `:secondary`."
1785
- },
1786
- {
1787
- "name": "muted",
1788
- "type": "Boolean",
1789
- "default": "`false`",
1790
- "description": "Uses light gray for Link color, and blue on hover."
4006
+ "default": "`self.class.generate_id`",
4007
+ "description": "The value of the ID HTML attribute. Auto-generated by default."
1791
4008
  },
1792
4009
  {
1793
- "name": "underline",
1794
- "type": "Boolean",
1795
- "default": "`true`",
1796
- "description": "Whether or not to underline the link."
4010
+ "name": "heading_level",
4011
+ "type": "Integer",
4012
+ "default": "`2`",
4013
+ "description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
1797
4014
  },
1798
4015
  {
1799
4016
  "name": "system_arguments",
@@ -1804,16 +4021,36 @@
1804
4021
  ]
1805
4022
  },
1806
4023
  {
1807
- "component": "Markdown",
1808
- "status": "beta",
1809
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/markdown.rb",
1810
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/markdown/default/",
4024
+ "component": "NavList::Item",
4025
+ "status": "alpha",
4026
+ "a11y_reviewed": false,
4027
+ "short_name": "NavListItem",
4028
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/item.rb",
4029
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/item/default/",
1811
4030
  "parameters": [
1812
4031
  {
1813
- "name": "tag",
4032
+ "name": "selected_item_id",
1814
4033
  "type": "Symbol",
1815
- "default": "`:div`",
1816
- "description": "One of `:article`, `:div`, or `:td`."
4034
+ "default": "`nil`",
4035
+ "description": "The ID of the currently selected list item. Used internally."
4036
+ },
4037
+ {
4038
+ "name": "selected_by_ids",
4039
+ "type": "Array<Symbol>",
4040
+ "default": "`[]`",
4041
+ "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."
4042
+ },
4043
+ {
4044
+ "name": "expanded",
4045
+ "type": "Boolean",
4046
+ "default": "`false`",
4047
+ "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
4048
+ },
4049
+ {
4050
+ "name": "sub_item",
4051
+ "type": "Boolean",
4052
+ "default": "`false`",
4053
+ "description": "Whether or not this item is nested under a parent item. Used internally."
1817
4054
  },
1818
4055
  {
1819
4056
  "name": "system_arguments",
@@ -1826,6 +4063,8 @@
1826
4063
  {
1827
4064
  "component": "Octicon",
1828
4065
  "status": "beta",
4066
+ "a11y_reviewed": false,
4067
+ "short_name": "Octicon",
1829
4068
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/octicon.rb",
1830
4069
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/octicon/default/",
1831
4070
  "parameters": [
@@ -1864,6 +4103,8 @@
1864
4103
  {
1865
4104
  "component": "Popover",
1866
4105
  "status": "beta",
4106
+ "a11y_reviewed": false,
4107
+ "short_name": "Popover",
1867
4108
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/popover.rb",
1868
4109
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/popover/default/",
1869
4110
  "parameters": [
@@ -1878,6 +4119,8 @@
1878
4119
  {
1879
4120
  "component": "ProgressBar",
1880
4121
  "status": "beta",
4122
+ "a11y_reviewed": false,
4123
+ "short_name": "ProgressBar",
1881
4124
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/progress_bar.rb",
1882
4125
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/progress_bar/default/",
1883
4126
  "parameters": [
@@ -1898,6 +4141,8 @@
1898
4141
  {
1899
4142
  "component": "RelativeTime",
1900
4143
  "status": "beta",
4144
+ "a11y_reviewed": false,
4145
+ "short_name": "RelativeTime",
1901
4146
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/relative_time.rb",
1902
4147
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/relative_time/default/",
1903
4148
  "parameters": [
@@ -2014,6 +4259,8 @@
2014
4259
  {
2015
4260
  "component": "Spinner",
2016
4261
  "status": "beta",
4262
+ "a11y_reviewed": false,
4263
+ "short_name": "Spinner",
2017
4264
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/spinner.rb",
2018
4265
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/spinner/default/",
2019
4266
  "parameters": [
@@ -2040,6 +4287,8 @@
2040
4287
  {
2041
4288
  "component": "State",
2042
4289
  "status": "beta",
4290
+ "a11y_reviewed": false,
4291
+ "short_name": "State",
2043
4292
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/state.rb",
2044
4293
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/state/default/",
2045
4294
  "parameters": [
@@ -2078,6 +4327,8 @@
2078
4327
  {
2079
4328
  "component": "Subhead",
2080
4329
  "status": "beta",
4330
+ "a11y_reviewed": false,
4331
+ "short_name": "Subhead",
2081
4332
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/subhead.rb",
2082
4333
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/subhead/default/",
2083
4334
  "parameters": [
@@ -2104,6 +4355,8 @@
2104
4355
  {
2105
4356
  "component": "Text",
2106
4357
  "status": "beta",
4358
+ "a11y_reviewed": false,
4359
+ "short_name": "Text",
2107
4360
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb",
2108
4361
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text/default/",
2109
4362
  "parameters": [
@@ -2124,6 +4377,8 @@
2124
4377
  {
2125
4378
  "component": "TimelineItem",
2126
4379
  "status": "beta",
4380
+ "a11y_reviewed": false,
4381
+ "short_name": "TimelineItem",
2127
4382
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/timeline_item.rb",
2128
4383
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/timeline_item/default/",
2129
4384
  "parameters": [
@@ -2141,9 +4396,22 @@
2141
4396
  }
2142
4397
  ]
2143
4398
  },
4399
+ {
4400
+ "component": "TimelineItem::Badge",
4401
+ "status": "beta",
4402
+ "a11y_reviewed": false,
4403
+ "short_name": "TimelineItemBadge",
4404
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/timeline_item/badge.rb",
4405
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/timeline_item/badge/default/",
4406
+ "parameters": [
4407
+
4408
+ ]
4409
+ },
2144
4410
  {
2145
4411
  "component": "Truncate",
2146
4412
  "status": "beta",
4413
+ "a11y_reviewed": false,
4414
+ "short_name": "Truncate",
2147
4415
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb",
2148
4416
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/default/",
2149
4417
  "parameters": [
@@ -2155,9 +4423,128 @@
2155
4423
  }
2156
4424
  ]
2157
4425
  },
4426
+ {
4427
+ "component": "Truncate::TruncateText",
4428
+ "status": "alpha",
4429
+ "a11y_reviewed": false,
4430
+ "short_name": "TruncateTruncateText",
4431
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate/truncate_text.rb",
4432
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/truncate_text/default/",
4433
+ "parameters": [
4434
+
4435
+ ]
4436
+ },
4437
+ {
4438
+ "component": "Blankslate",
4439
+ "status": "deprecated",
4440
+ "a11y_reviewed": false,
4441
+ "short_name": "Blankslate",
4442
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/blankslate_component.rb",
4443
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/blankslate/default/",
4444
+ "parameters": [
4445
+ {
4446
+ "name": "title",
4447
+ "type": "String",
4448
+ "default": "`\"\"`",
4449
+ "description": "Text that appears in a larger bold font."
4450
+ },
4451
+ {
4452
+ "name": "title_tag",
4453
+ "type": "Symbol",
4454
+ "default": "`:h3`",
4455
+ "description": "HTML tag to use for title."
4456
+ },
4457
+ {
4458
+ "name": "icon",
4459
+ "type": "Symbol",
4460
+ "default": "`\"\"`",
4461
+ "description": "Octicon icon to use at top of component."
4462
+ },
4463
+ {
4464
+ "name": "icon_size",
4465
+ "type": "Symbol",
4466
+ "default": "`:medium`",
4467
+ "description": "One of `:xsmall` (`12`), `:small` (`16`), or `:medium` (`24`)."
4468
+ },
4469
+ {
4470
+ "name": "image_src",
4471
+ "type": "String",
4472
+ "default": "`\"\"`",
4473
+ "description": "Image to display."
4474
+ },
4475
+ {
4476
+ "name": "image_alt",
4477
+ "type": "String",
4478
+ "default": "`\" \"`",
4479
+ "description": "Alt text for image."
4480
+ },
4481
+ {
4482
+ "name": "description",
4483
+ "type": "String",
4484
+ "default": "`\"\"`",
4485
+ "description": "Text that appears below the title. Typically a whole sentence."
4486
+ },
4487
+ {
4488
+ "name": "button_text",
4489
+ "type": "String",
4490
+ "default": "`\"\"`",
4491
+ "description": "The text of the button."
4492
+ },
4493
+ {
4494
+ "name": "button_url",
4495
+ "type": "String",
4496
+ "default": "`\"\"`",
4497
+ "description": "The URL where the user will be taken after clicking the button."
4498
+ },
4499
+ {
4500
+ "name": "button_classes",
4501
+ "type": "String",
4502
+ "default": "`\"btn-primary my-3\"`",
4503
+ "description": "Classes to apply to action button"
4504
+ },
4505
+ {
4506
+ "name": "link_text",
4507
+ "type": "String",
4508
+ "default": "`\"\"`",
4509
+ "description": "The text of the link."
4510
+ },
4511
+ {
4512
+ "name": "link_url",
4513
+ "type": "String",
4514
+ "default": "`\"\"`",
4515
+ "description": "The URL where the user will be taken after clicking the link."
4516
+ },
4517
+ {
4518
+ "name": "narrow",
4519
+ "type": "Boolean",
4520
+ "default": "`false`",
4521
+ "description": "Adds a maximum width."
4522
+ },
4523
+ {
4524
+ "name": "large",
4525
+ "type": "Boolean",
4526
+ "default": "`false`",
4527
+ "description": "Increases the font size."
4528
+ },
4529
+ {
4530
+ "name": "spacious",
4531
+ "type": "Boolean",
4532
+ "default": "`false`",
4533
+ "description": "Adds extra padding."
4534
+ },
4535
+ {
4536
+ "name": "system_arguments",
4537
+ "type": "Hash",
4538
+ "default": "N/A",
4539
+ "description": "[System arguments](/system-arguments)"
4540
+ }
4541
+ ]
4542
+ },
2158
4543
  {
2159
4544
  "component": "Box",
2160
4545
  "status": "stable",
4546
+ "a11y_reviewed": false,
4547
+ "short_name": "Box",
2161
4548
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb",
2162
4549
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box/default/",
2163
4550
  "parameters": [
@@ -2172,6 +4559,8 @@
2172
4559
  {
2173
4560
  "component": "Button",
2174
4561
  "status": "deprecated",
4562
+ "a11y_reviewed": false,
4563
+ "short_name": "Button",
2175
4564
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
2176
4565
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button/default/",
2177
4566
  "parameters": [
@@ -2197,7 +4586,7 @@
2197
4586
  "name": "tag",
2198
4587
  "type": "Symbol",
2199
4588
  "default": "`:button`",
2200
- "description": "One of `:a`, `:button`, or `:summary`."
4589
+ "description": "One of `:a`, `:button`, `:clipboard-copy`, or `:summary`."
2201
4590
  },
2202
4591
  {
2203
4592
  "name": "type",
@@ -2231,9 +4620,44 @@
2231
4620
  }
2232
4621
  ]
2233
4622
  },
4623
+ {
4624
+ "component": "ConditionalWrapper",
4625
+ "status": "alpha",
4626
+ "a11y_reviewed": false,
4627
+ "short_name": "ConditionalWrapper",
4628
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/conditional_wrapper.rb",
4629
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/conditional_wrapper/default/",
4630
+ "parameters": [
4631
+ {
4632
+ "name": "condition",
4633
+ "type": "Boolean",
4634
+ "default": "N/A",
4635
+ "description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
4636
+ },
4637
+ {
4638
+ "name": "base_component_arguments",
4639
+ "type": "Hash",
4640
+ "default": "N/A",
4641
+ "description": "The arguments to pass to `Primer::BaseComponent`."
4642
+ }
4643
+ ]
4644
+ },
4645
+ {
4646
+ "component": "Content",
4647
+ "status": "stable",
4648
+ "a11y_reviewed": false,
4649
+ "short_name": "Content",
4650
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/content.rb",
4651
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/content/default/",
4652
+ "parameters": [
4653
+
4654
+ ]
4655
+ },
2234
4656
  {
2235
4657
  "component": "IconButton",
2236
4658
  "status": "deprecated",
4659
+ "a11y_reviewed": false,
4660
+ "short_name": "IconButton",
2237
4661
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb",
2238
4662
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button/default/",
2239
4663
  "parameters": [
@@ -2253,7 +4677,7 @@
2253
4677
  "name": "tag",
2254
4678
  "type": "Symbol",
2255
4679
  "default": "N/A",
2256
- "description": "One of `:a`, `:button`, or `:summary`."
4680
+ "description": "One of `:a`, `:button`, `:clipboard-copy`, or `:summary`."
2257
4681
  },
2258
4682
  {
2259
4683
  "name": "type",
@@ -2295,7 +4719,9 @@
2295
4719
  },
2296
4720
  {
2297
4721
  "component": "Layout",
2298
- "status": "alpha",
4722
+ "status": "deprecated",
4723
+ "a11y_reviewed": false,
4724
+ "short_name": "Layout",
2299
4725
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb",
2300
4726
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout/default/",
2301
4727
  "parameters": [
@@ -2325,83 +4751,11 @@
2325
4751
  }
2326
4752
  ]
2327
4753
  },
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
4754
  {
2403
4755
  "component": "Navigation::Tab",
2404
- "status": "alpha",
4756
+ "status": "deprecated",
4757
+ "a11y_reviewed": false,
4758
+ "short_name": "NavigationTab",
2405
4759
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb",
2406
4760
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab/default/",
2407
4761
  "parameters": [
@@ -2449,35 +4803,11 @@
2449
4803
  }
2450
4804
  ]
2451
4805
  },
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
4806
  {
2479
4807
  "component": "Tooltip",
2480
4808
  "status": "deprecated",
4809
+ "a11y_reviewed": false,
4810
+ "short_name": "Tooltip",
2481
4811
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tooltip.rb",
2482
4812
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip/default/",
2483
4813
  "parameters": [
@@ -2521,7 +4851,9 @@
2521
4851
  },
2522
4852
  {
2523
4853
  "component": "Truncate",
2524
- "status": "beta",
4854
+ "status": "deprecated",
4855
+ "a11y_reviewed": false,
4856
+ "short_name": "Truncate",
2525
4857
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/truncate.rb",
2526
4858
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate/default/",
2527
4859
  "parameters": [