jekyll-v4-theme-primer 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (297) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE.md +22 -0
  3. data/README.md +116 -0
  4. data/_includes/.gitkeep +1 -0
  5. data/_includes/head-custom-google-analytics.html +10 -0
  6. data/_includes/head-custom.html +9 -0
  7. data/_includes/theme.html +11 -0
  8. data/_layouts/default.html +29 -0
  9. data/_layouts/home.html +4 -0
  10. data/_layouts/page.html +4 -0
  11. data/_layouts/post.html +4 -0
  12. data/_sass/@primer/css/actionlist/action-list-item-divider.scss +48 -0
  13. data/_sass/@primer/css/actionlist/action-list-item.scss +593 -0
  14. data/_sass/@primer/css/actionlist/action-list-tree.scss +118 -0
  15. data/_sass/@primer/css/actionlist/action-list-variables.scss +8 -0
  16. data/_sass/@primer/css/actionlist/action-list.scss +67 -0
  17. data/_sass/@primer/css/actionlist/index.scss +6 -0
  18. data/_sass/@primer/css/alerts/flash.scss +1 -0
  19. data/_sass/@primer/css/alerts/index.scss +3 -0
  20. data/_sass/@primer/css/autocomplete/autocomplete.scss +1 -0
  21. data/_sass/@primer/css/autocomplete/index.scss +4 -0
  22. data/_sass/@primer/css/autocomplete/suggester.scss +92 -0
  23. data/_sass/@primer/css/avatars/avatar-parent-child.scss +17 -0
  24. data/_sass/@primer/css/avatars/avatar-stack.scss +1 -0
  25. data/_sass/@primer/css/avatars/avatar.scss +1 -0
  26. data/_sass/@primer/css/avatars/circle-badge.scss +55 -0
  27. data/_sass/@primer/css/avatars/index.scss +7 -0
  28. data/_sass/@primer/css/base/base.scss +160 -0
  29. data/_sass/@primer/css/base/index.scss +6 -0
  30. data/_sass/@primer/css/base/kbd.scss +19 -0
  31. data/_sass/@primer/css/base/normalize.scss +381 -0
  32. data/_sass/@primer/css/base/octicons.scss +6 -0
  33. data/_sass/@primer/css/base/typography-base.scss +89 -0
  34. data/_sass/@primer/css/blankslate/blankslate.scss +1 -0
  35. data/_sass/@primer/css/blankslate/index.scss +2 -0
  36. data/_sass/@primer/css/box/box-overlay.scss +42 -0
  37. data/_sass/@primer/css/box/box.scss +1 -0
  38. data/_sass/@primer/css/box/index.scss +3 -0
  39. data/_sass/@primer/css/branch-name/branch-name.scss +31 -0
  40. data/_sass/@primer/css/branch-name/index.scss +3 -0
  41. data/_sass/@primer/css/breadcrumb/breadcrumb.scss +1 -0
  42. data/_sass/@primer/css/breadcrumb/index.scss +3 -0
  43. data/_sass/@primer/css/buttons/button-group.scss +92 -0
  44. data/_sass/@primer/css/buttons/button.scss +340 -0
  45. data/_sass/@primer/css/buttons/index.scss +4 -0
  46. data/_sass/@primer/css/buttons/misc.scss +231 -0
  47. data/_sass/@primer/css/color-modes/index.scss +12 -0
  48. data/_sass/@primer/css/color-modes/native.scss +22 -0
  49. data/_sass/@primer/css/color-modes/themes/dark.scss +6 -0
  50. data/_sass/@primer/css/color-modes/themes/dark_colorblind.scss +6 -0
  51. data/_sass/@primer/css/color-modes/themes/dark_dimmed.scss +6 -0
  52. data/_sass/@primer/css/color-modes/themes/dark_high_contrast.scss +6 -0
  53. data/_sass/@primer/css/color-modes/themes/dark_tritanopia.scss +6 -0
  54. data/_sass/@primer/css/color-modes/themes/light.scss +6 -0
  55. data/_sass/@primer/css/color-modes/themes/light_colorblind.scss +6 -0
  56. data/_sass/@primer/css/color-modes/themes/light_high_contrast.scss +6 -0
  57. data/_sass/@primer/css/color-modes/themes/light_tritanopia.scss +6 -0
  58. data/_sass/@primer/css/core/index.scss +30 -0
  59. data/_sass/@primer/css/dropdown/dropdown.scss +1 -0
  60. data/_sass/@primer/css/dropdown/index.scss +2 -0
  61. data/_sass/@primer/css/forms/FormControl.scss +1 -0
  62. data/_sass/@primer/css/forms/form-control.scss +267 -0
  63. data/_sass/@primer/css/forms/form-group.scss +287 -0
  64. data/_sass/@primer/css/forms/form-select.scss +46 -0
  65. data/_sass/@primer/css/forms/form-validation.scss +369 -0
  66. data/_sass/@primer/css/forms/index.scss +9 -0
  67. data/_sass/@primer/css/forms/input-group.scss +71 -0
  68. data/_sass/@primer/css/forms/radio-group.scss +62 -0
  69. data/_sass/@primer/css/header/header.scss +47 -0
  70. data/_sass/@primer/css/header/index.scss +2 -0
  71. data/_sass/@primer/css/index.scss +19 -0
  72. data/_sass/@primer/css/labels/counters.scss +1 -0
  73. data/_sass/@primer/css/labels/diffstat.scss +37 -0
  74. data/_sass/@primer/css/labels/index.scss +7 -0
  75. data/_sass/@primer/css/labels/issue-labels.scss +23 -0
  76. data/_sass/@primer/css/labels/labels.scss +1 -0
  77. data/_sass/@primer/css/labels/mixins.scss +37 -0
  78. data/_sass/@primer/css/labels/states.scss +1 -0
  79. data/_sass/@primer/css/layout/app-frame.scss +156 -0
  80. data/_sass/@primer/css/layout/container.scss +30 -0
  81. data/_sass/@primer/css/layout/grid-offset.scss +20 -0
  82. data/_sass/@primer/css/layout/grid.scss +65 -0
  83. data/_sass/@primer/css/layout/index.scss +8 -0
  84. data/_sass/@primer/css/layout/layout.scss +1 -0
  85. data/_sass/@primer/css/layout/page-layout.scss +413 -0
  86. data/_sass/@primer/css/layout/stack.scss +220 -0
  87. data/_sass/@primer/css/links/index.scss +3 -0
  88. data/_sass/@primer/css/links/link.scss +60 -0
  89. data/_sass/@primer/css/loaders/index.scss +2 -0
  90. data/_sass/@primer/css/loaders/loaders.scss +19 -0
  91. data/_sass/@primer/css/markdown/blob-csv.scss +29 -0
  92. data/_sass/@primer/css/markdown/code.scss +77 -0
  93. data/_sass/@primer/css/markdown/footnotes.scss +55 -0
  94. data/_sass/@primer/css/markdown/headings.scss +96 -0
  95. data/_sass/@primer/css/markdown/images.scss +130 -0
  96. data/_sass/@primer/css/markdown/index.scss +9 -0
  97. data/_sass/@primer/css/markdown/lists.scss +98 -0
  98. data/_sass/@primer/css/markdown/markdown-body.scss +96 -0
  99. data/_sass/@primer/css/markdown/tables.scss +36 -0
  100. data/_sass/@primer/css/marketing/buttons/button.scss +164 -0
  101. data/_sass/@primer/css/marketing/buttons/index.scss +3 -0
  102. data/_sass/@primer/css/marketing/index.scss +15 -0
  103. data/_sass/@primer/css/marketing/links/index.scss +3 -0
  104. data/_sass/@primer/css/marketing/links/link.scss +50 -0
  105. data/_sass/@primer/css/marketing/support/index.scss +2 -0
  106. data/_sass/@primer/css/marketing/support/variables.scss +127 -0
  107. data/_sass/@primer/css/marketing/type/index.scss +3 -0
  108. data/_sass/@primer/css/marketing/type/typography.scss +118 -0
  109. data/_sass/@primer/css/marketing/utilities/animations.scss +51 -0
  110. data/_sass/@primer/css/marketing/utilities/borders.scss +4 -0
  111. data/_sass/@primer/css/marketing/utilities/filters.scss +3 -0
  112. data/_sass/@primer/css/marketing/utilities/index.scss +6 -0
  113. data/_sass/@primer/css/marketing/utilities/layout.scss +51 -0
  114. data/_sass/@primer/css/navigation/filter-list.scss +82 -0
  115. data/_sass/@primer/css/navigation/index.scss +8 -0
  116. data/_sass/@primer/css/navigation/menu.scss +1 -0
  117. data/_sass/@primer/css/navigation/sidenav.scss +99 -0
  118. data/_sass/@primer/css/navigation/subnav.scss +146 -0
  119. data/_sass/@primer/css/navigation/tabnav.scss +1 -0
  120. data/_sass/@primer/css/navigation/underline-nav.scss +1 -0
  121. data/_sass/@primer/css/overlay/index.scss +2 -0
  122. data/_sass/@primer/css/overlay/overlay.scss +1 -0
  123. data/_sass/@primer/css/pagination/index.scss +3 -0
  124. data/_sass/@primer/css/pagination/pagination.scss +156 -0
  125. data/_sass/@primer/css/popover/index.scss +3 -0
  126. data/_sass/@primer/css/popover/popover.scss +1 -0
  127. data/_sass/@primer/css/primitives/index.scss +10 -0
  128. data/_sass/@primer/css/primitives/temp-typography-tokens.scss +22 -0
  129. data/_sass/@primer/css/product/index.scss +28 -0
  130. data/_sass/@primer/css/progress/index.scss +3 -0
  131. data/_sass/@primer/css/progress/progress.scss +1 -0
  132. data/_sass/@primer/css/select-menu/index.scss +3 -0
  133. data/_sass/@primer/css/select-menu/select-menu.scss +463 -0
  134. data/_sass/@primer/css/subhead/index.scss +3 -0
  135. data/_sass/@primer/css/subhead/subhead.scss +1 -0
  136. data/_sass/@primer/css/support/index.scss +10 -0
  137. data/_sass/@primer/css/support/mixins/color-modes.scss +109 -0
  138. data/_sass/@primer/css/support/mixins/layout.scss +58 -0
  139. data/_sass/@primer/css/support/mixins/misc.scss +73 -0
  140. data/_sass/@primer/css/support/mixins/typography.scss +91 -0
  141. data/_sass/@primer/css/support/variables/layout.scss +230 -0
  142. data/_sass/@primer/css/support/variables/misc.scss +18 -0
  143. data/_sass/@primer/css/support/variables/typography.scss +43 -0
  144. data/_sass/@primer/css/table-object/index.scss +1 -0
  145. data/_sass/@primer/css/table-object/table-object.scss +23 -0
  146. data/_sass/@primer/css/timeline/index.scss +2 -0
  147. data/_sass/@primer/css/timeline/timeline-item.scss +1 -0
  148. data/_sass/@primer/css/toasts/index.scss +2 -0
  149. data/_sass/@primer/css/toasts/toasts.scss +127 -0
  150. data/_sass/@primer/css/toggle-switch/index.scss +2 -0
  151. data/_sass/@primer/css/toggle-switch/toggle-switch.scss +1 -0
  152. data/_sass/@primer/css/tooltips/index.scss +2 -0
  153. data/_sass/@primer/css/tooltips/tooltips.scss +281 -0
  154. data/_sass/@primer/css/truncate/index.scss +2 -0
  155. data/_sass/@primer/css/truncate/truncate.scss +2 -0
  156. data/_sass/@primer/css/utilities/animations.scss +196 -0
  157. data/_sass/@primer/css/utilities/borders.scss +74 -0
  158. data/_sass/@primer/css/utilities/box-shadow.scss +25 -0
  159. data/_sass/@primer/css/utilities/colors.scss +95 -0
  160. data/_sass/@primer/css/utilities/details.scss +105 -0
  161. data/_sass/@primer/css/utilities/flexbox.scss +52 -0
  162. data/_sass/@primer/css/utilities/index.scss +14 -0
  163. data/_sass/@primer/css/utilities/layout.scss +96 -0
  164. data/_sass/@primer/css/utilities/margin.scss +71 -0
  165. data/_sass/@primer/css/utilities/padding.scss +56 -0
  166. data/_sass/@primer/css/utilities/typography.scss +332 -0
  167. data/_sass/@primer/css/utilities/visibility-display.scss +123 -0
  168. data/_sass/@primer/primitives/dist/scss/colors/_dark.scss +443 -0
  169. data/_sass/@primer/primitives/dist/scss/colors/_dark_colorblind.scss +443 -0
  170. data/_sass/@primer/primitives/dist/scss/colors/_dark_dimmed.scss +443 -0
  171. data/_sass/@primer/primitives/dist/scss/colors/_dark_high_contrast.scss +443 -0
  172. data/_sass/@primer/primitives/dist/scss/colors/_dark_tritanopia.scss +443 -0
  173. data/_sass/@primer/primitives/dist/scss/colors/_light.scss +443 -0
  174. data/_sass/@primer/primitives/dist/scss/colors/_light_colorblind.scss +443 -0
  175. data/_sass/@primer/primitives/dist/scss/colors/_light_high_contrast.scss +443 -0
  176. data/_sass/@primer/primitives/dist/scss/colors/_light_tritanopia.scss +443 -0
  177. data/_sass/@primer/primitives/dist/scss/spacing/_normal.scss +11 -0
  178. data/_sass/@primer/primitives/dist/scss/typography/_normal.scss +15 -0
  179. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/base/size/size.scss +21 -0
  180. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/base/typography/typography.scss +8 -0
  181. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/border.scss +14 -0
  182. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/breakpoints.scss +10 -0
  183. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/size-coarse.scss +7 -0
  184. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/size-fine.scss +7 -0
  185. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/size.scss +51 -0
  186. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/size/viewport.scss +10 -0
  187. data/_sass/@primer/primitives/tokens-v2-private/scss/tokens/functional/typography/typography.scss +44 -0
  188. data/_sass/@primer/view-components/LICENSE.txt +21 -0
  189. data/_sass/@primer/view-components/README.md +17 -0
  190. data/_sass/@primer/view-components/app/assets/javascripts/primer_view_components.js +2 -0
  191. data/_sass/@primer/view-components/app/assets/javascripts/primer_view_components.js.map +1 -0
  192. data/_sass/@primer/view-components/app/assets/styles/primer_view_components.css +3 -0
  193. data/_sass/@primer/view-components/app/assets/styles/primer_view_components.css.map +1 -0
  194. data/_sass/@primer/view-components/app/components/primer/alpha/action_list.css +1 -0
  195. data/_sass/@primer/view-components/app/components/primer/alpha/action_list.css.json +1 -0
  196. data/_sass/@primer/view-components/app/components/primer/alpha/auto_complete.css +1 -0
  197. data/_sass/@primer/view-components/app/components/primer/alpha/auto_complete.css.json +1 -0
  198. data/_sass/@primer/view-components/app/components/primer/alpha/banner.css +1 -0
  199. data/_sass/@primer/view-components/app/components/primer/alpha/banner.css.json +1 -0
  200. data/_sass/@primer/view-components/app/components/primer/alpha/button_marketing.css +1 -0
  201. data/_sass/@primer/view-components/app/components/primer/alpha/button_marketing.css.json +1 -0
  202. data/_sass/@primer/view-components/app/components/primer/alpha/dialog.css +1 -0
  203. data/_sass/@primer/view-components/app/components/primer/alpha/dialog.css.json +1 -0
  204. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown/menu.d.ts +1 -0
  205. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown/menu.js +1 -0
  206. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.css +1 -0
  207. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.css.json +1 -0
  208. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.d.ts +1 -0
  209. data/_sass/@primer/view-components/app/components/primer/alpha/dropdown.js +1 -0
  210. data/_sass/@primer/view-components/app/components/primer/alpha/image_crop.d.ts +1 -0
  211. data/_sass/@primer/view-components/app/components/primer/alpha/image_crop.js +1 -0
  212. data/_sass/@primer/view-components/app/components/primer/alpha/layout.css +1 -0
  213. data/_sass/@primer/view-components/app/components/primer/alpha/layout.css.json +1 -0
  214. data/_sass/@primer/view-components/app/components/primer/alpha/menu.css +1 -0
  215. data/_sass/@primer/view-components/app/components/primer/alpha/menu.css.json +1 -0
  216. data/_sass/@primer/view-components/app/components/primer/alpha/modal_dialog.d.ts +18 -0
  217. data/_sass/@primer/view-components/app/components/primer/alpha/modal_dialog.js +150 -0
  218. data/_sass/@primer/view-components/app/components/primer/alpha/nav_list.d.ts +25 -0
  219. data/_sass/@primer/view-components/app/components/primer/alpha/nav_list.js +130 -0
  220. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.css +1 -0
  221. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.css.json +1 -0
  222. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.d.ts +12 -0
  223. data/_sass/@primer/view-components/app/components/primer/alpha/segmented_control.js +47 -0
  224. data/_sass/@primer/view-components/app/components/primer/alpha/tab_nav.css +1 -0
  225. data/_sass/@primer/view-components/app/components/primer/alpha/tab_nav.css.json +1 -0
  226. data/_sass/@primer/view-components/app/components/primer/alpha/text_field.css +3 -0
  227. data/_sass/@primer/view-components/app/components/primer/alpha/text_field.css.json +1 -0
  228. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.css +1 -0
  229. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.css.json +1 -0
  230. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.d.ts +29 -0
  231. data/_sass/@primer/view-components/app/components/primer/alpha/toggle_switch.js +144 -0
  232. data/_sass/@primer/view-components/app/components/primer/alpha/tool_tip.d.ts +25 -0
  233. data/_sass/@primer/view-components/app/components/primer/alpha/tool_tip.js +389 -0
  234. data/_sass/@primer/view-components/app/components/primer/alpha/underline_nav.css +1 -0
  235. data/_sass/@primer/view-components/app/components/primer/alpha/underline_nav.css.json +1 -0
  236. data/_sass/@primer/view-components/app/components/primer/alpha/x_banner.d.ts +11 -0
  237. data/_sass/@primer/view-components/app/components/primer/alpha/x_banner.js +35 -0
  238. data/_sass/@primer/view-components/app/components/primer/beta/auto_complete/auto_complete.d.ts +1 -0
  239. data/_sass/@primer/view-components/app/components/primer/beta/auto_complete/auto_complete.js +1 -0
  240. data/_sass/@primer/view-components/app/components/primer/beta/avatar.css +1 -0
  241. data/_sass/@primer/view-components/app/components/primer/beta/avatar.css.json +1 -0
  242. data/_sass/@primer/view-components/app/components/primer/beta/avatar_stack.css +1 -0
  243. data/_sass/@primer/view-components/app/components/primer/beta/avatar_stack.css.json +1 -0
  244. data/_sass/@primer/view-components/app/components/primer/beta/blankslate.css +1 -0
  245. data/_sass/@primer/view-components/app/components/primer/beta/blankslate.css.json +1 -0
  246. data/_sass/@primer/view-components/app/components/primer/beta/border_box.css +1 -0
  247. data/_sass/@primer/view-components/app/components/primer/beta/border_box.css.json +1 -0
  248. data/_sass/@primer/view-components/app/components/primer/beta/breadcrumbs.css +1 -0
  249. data/_sass/@primer/view-components/app/components/primer/beta/breadcrumbs.css.json +1 -0
  250. data/_sass/@primer/view-components/app/components/primer/beta/button.css +1 -0
  251. data/_sass/@primer/view-components/app/components/primer/beta/button.css.json +1 -0
  252. data/_sass/@primer/view-components/app/components/primer/beta/clipboard_copy.d.ts +1 -0
  253. data/_sass/@primer/view-components/app/components/primer/beta/clipboard_copy.js +43 -0
  254. data/_sass/@primer/view-components/app/components/primer/beta/counter.css +1 -0
  255. data/_sass/@primer/view-components/app/components/primer/beta/counter.css.json +1 -0
  256. data/_sass/@primer/view-components/app/components/primer/beta/flash.css +1 -0
  257. data/_sass/@primer/view-components/app/components/primer/beta/flash.css.json +1 -0
  258. data/_sass/@primer/view-components/app/components/primer/beta/label.css +1 -0
  259. data/_sass/@primer/view-components/app/components/primer/beta/label.css.json +1 -0
  260. data/_sass/@primer/view-components/app/components/primer/beta/link.css +1 -0
  261. data/_sass/@primer/view-components/app/components/primer/beta/link.css.json +1 -0
  262. data/_sass/@primer/view-components/app/components/primer/beta/popover.css +1 -0
  263. data/_sass/@primer/view-components/app/components/primer/beta/popover.css.json +1 -0
  264. data/_sass/@primer/view-components/app/components/primer/beta/progress_bar.css +1 -0
  265. data/_sass/@primer/view-components/app/components/primer/beta/progress_bar.css.json +1 -0
  266. data/_sass/@primer/view-components/app/components/primer/beta/truncate.css +1 -0
  267. data/_sass/@primer/view-components/app/components/primer/beta/truncate.css.json +1 -0
  268. data/_sass/@primer/view-components/app/components/primer/local_time.d.ts +1 -0
  269. data/_sass/@primer/view-components/app/components/primer/local_time.js +1 -0
  270. data/_sass/@primer/view-components/app/components/primer/primer.d.ts +15 -0
  271. data/_sass/@primer/view-components/app/components/primer/primer.js +15 -0
  272. data/_sass/@primer/view-components/app/components/primer/state_component.css +1 -0
  273. data/_sass/@primer/view-components/app/components/primer/state_component.css.json +1 -0
  274. data/_sass/@primer/view-components/app/components/primer/subhead_component.css +1 -0
  275. data/_sass/@primer/view-components/app/components/primer/subhead_component.css.json +1 -0
  276. data/_sass/@primer/view-components/app/components/primer/tab_container_component.d.ts +1 -0
  277. data/_sass/@primer/view-components/app/components/primer/tab_container_component.js +1 -0
  278. data/_sass/@primer/view-components/app/components/primer/time_ago_component.d.ts +1 -0
  279. data/_sass/@primer/view-components/app/components/primer/time_ago_component.js +1 -0
  280. data/_sass/@primer/view-components/app/components/primer/timeline_item_component.css +1 -0
  281. data/_sass/@primer/view-components/app/components/primer/timeline_item_component.css.json +1 -0
  282. data/_sass/@primer/view-components/app/components/primer/truncate.css +1 -0
  283. data/_sass/@primer/view-components/app/components/primer/truncate.css.json +1 -0
  284. data/_sass/@primer/view-components/lib/primer/forms/primer_multi_input.d.ts +10 -0
  285. data/_sass/@primer/view-components/lib/primer/forms/primer_multi_input.js +45 -0
  286. data/_sass/@primer/view-components/lib/primer/forms/primer_text_field.d.ts +1 -0
  287. data/_sass/@primer/view-components/lib/primer/forms/primer_text_field.js +62 -0
  288. data/_sass/@primer/view-components/package.json +95 -0
  289. data/_sass/@primer/view-components/static/arguments.json +2586 -0
  290. data/_sass/@primer/view-components/static/audited_at.json +100 -0
  291. data/_sass/@primer/view-components/static/constants.json +1157 -0
  292. data/_sass/@primer/view-components/static/statuses.json +100 -0
  293. data/_sass/jekyll-theme-primer.scss +8 -0
  294. data/_sass/primer.scss +4 -0
  295. data/_sass/rouge.scss +213 -0
  296. data/assets/css/style.scss +4 -0
  297. metadata +444 -0
@@ -0,0 +1,2586 @@
1
+ [
2
+ {
3
+ "component": "ActionList",
4
+ "status": "alpha",
5
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb",
6
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list_preview/default/",
7
+ "parameters": [
8
+ {
9
+ "name": "role",
10
+ "type": "Boolean",
11
+ "default": "`:list`",
12
+ "description": "ARIA role describing the function of the list. listbox and menu are a common values."
13
+ },
14
+ {
15
+ "name": "item_classes",
16
+ "type": "String",
17
+ "default": "`nil`",
18
+ "description": "Additional CSS classes to attach to items."
19
+ },
20
+ {
21
+ "name": "scheme",
22
+ "type": "Symbol",
23
+ "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."
25
+ },
26
+ {
27
+ "name": "show_dividers",
28
+ "type": "Boolean",
29
+ "default": "`false`",
30
+ "description": "Display a divider above each item in the list when it does not follow a header or divider."
31
+ },
32
+ {
33
+ "name": "system_arguments",
34
+ "type": "Hash",
35
+ "default": "N/A",
36
+ "description": "[System arguments](/system-arguments)"
37
+ }
38
+ ]
39
+ },
40
+ {
41
+ "component": "ActionList::Divider",
42
+ "status": "alpha",
43
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
44
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider_preview/default/",
45
+ "parameters": [
46
+ {
47
+ "name": "scheme",
48
+ "type": "Symbol",
49
+ "default": "`:subtle`",
50
+ "description": "Display a background color if scheme is `filled`."
51
+ },
52
+ {
53
+ "name": "system_arguments",
54
+ "type": "Hash",
55
+ "default": "N/A",
56
+ "description": "[System arguments](/system-arguments)"
57
+ }
58
+ ]
59
+ },
60
+ {
61
+ "component": "ActionList::Heading",
62
+ "status": "alpha",
63
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
64
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading_preview/default/",
65
+ "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
+ {
73
+ "name": "title",
74
+ "type": "String",
75
+ "default": "N/A",
76
+ "description": "Sub list title."
77
+ },
78
+ {
79
+ "name": "subtitle",
80
+ "type": "String",
81
+ "default": "`nil`",
82
+ "description": "Optional sub list description."
83
+ },
84
+ {
85
+ "name": "scheme",
86
+ "type": "Symbol",
87
+ "default": "`:subtle`",
88
+ "description": "Display a background color if scheme is `filled`."
89
+ },
90
+ {
91
+ "name": "tag",
92
+ "type": "Symbol",
93
+ "default": "`:h3`",
94
+ "description": "Semantic tag for the heading."
95
+ },
96
+ {
97
+ "name": "system_arguments",
98
+ "type": "Hash",
99
+ "default": "N/A",
100
+ "description": "[System arguments](/system-arguments)"
101
+ }
102
+ ]
103
+ },
104
+ {
105
+ "component": "ActionList::Item",
106
+ "status": "alpha",
107
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/item.rb",
108
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item_preview/default/",
109
+ "parameters": [
110
+ {
111
+ "name": "list",
112
+ "type": "Primer::Alpha::ActionList",
113
+ "default": "N/A",
114
+ "description": "The list that contains this item. Used internally."
115
+ },
116
+ {
117
+ "name": "parent",
118
+ "type": "Primer::Alpha::ActionList::Item",
119
+ "default": "`nil`",
120
+ "description": "This item's parent item. `nil` if this item is at the root. Used internally."
121
+ },
122
+ {
123
+ "name": "label",
124
+ "type": "String",
125
+ "default": "N/A",
126
+ "description": "Item label."
127
+ },
128
+ {
129
+ "name": "label_classes",
130
+ "type": "String",
131
+ "default": "`nil`",
132
+ "description": "CSS classes that will be added to the label."
133
+ },
134
+ {
135
+ "name": "content_arguments",
136
+ "type": "Hash",
137
+ "default": "`{}`",
138
+ "description": "[System arguments](/system-arguments) used to construct the item's anchor or span tag."
139
+ },
140
+ {
141
+ "name": "truncate_label",
142
+ "type": "Boolean",
143
+ "default": "`false`",
144
+ "description": "Truncate label with ellipsis."
145
+ },
146
+ {
147
+ "name": "href",
148
+ "type": "String",
149
+ "default": "`nil`",
150
+ "description": "Link URL."
151
+ },
152
+ {
153
+ "name": "role",
154
+ "type": "String",
155
+ "default": "`:listitem`",
156
+ "description": "ARIA role describing the function of the item."
157
+ },
158
+ {
159
+ "name": "size",
160
+ "type": "Symbol",
161
+ "default": "`:medium`",
162
+ "description": "Controls block sizing of the item."
163
+ },
164
+ {
165
+ "name": "scheme",
166
+ "type": "Symbol",
167
+ "default": "`:default`",
168
+ "description": "Controls color/style based on behavior."
169
+ },
170
+ {
171
+ "name": "disabled",
172
+ "type": "Boolean",
173
+ "default": "`false`",
174
+ "description": "Disabled items are not clickable and visually dim."
175
+ },
176
+ {
177
+ "name": "description_scheme",
178
+ "type": "Symbol",
179
+ "default": "`:block`",
180
+ "description": "Display description inline with label, or block on the next line."
181
+ },
182
+ {
183
+ "name": "active",
184
+ "type": "Boolean",
185
+ "default": "`false`",
186
+ "description": "Sets an active state on navigational items."
187
+ },
188
+ {
189
+ "name": "on_click",
190
+ "type": "String",
191
+ "default": "`nil`",
192
+ "description": "JavaScript to execute when the item is clicked."
193
+ },
194
+ {
195
+ "name": "id",
196
+ "type": "String",
197
+ "default": "`SecureRandom.hex`",
198
+ "description": "Used internally."
199
+ },
200
+ {
201
+ "name": "system_arguments",
202
+ "type": "Hash",
203
+ "default": "N/A",
204
+ "description": "[System arguments](/system-arguments)"
205
+ }
206
+ ]
207
+ },
208
+ {
209
+ "component": "Banner",
210
+ "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_preview/default/",
213
+ "parameters": [
214
+ {
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."
225
+ },
226
+ {
227
+ "name": "dismissible",
228
+ "type": "Boolean",
229
+ "default": "`false`",
230
+ "description": "Whether the component can be dismissed with an \"x\" button."
231
+ },
232
+ {
233
+ "name": "description",
234
+ "type": "String",
235
+ "default": "`nil`",
236
+ "description": "Description text rendered underneath the message."
237
+ },
238
+ {
239
+ "name": "icon",
240
+ "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."
243
+ },
244
+ {
245
+ "name": "scheme",
246
+ "type": "Symbol",
247
+ "default": "`:default`",
248
+ "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
249
+ },
250
+ {
251
+ "name": "reappear",
252
+ "type": "Boolean",
253
+ "default": "`false`",
254
+ "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
255
+ },
256
+ {
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_preview/default/",
269
+ "parameters": [
270
+ {
271
+ "name": "scheme",
272
+ "type": "Symbol",
273
+ "default": "`:default`",
274
+ "description": "One of `:default`, `:outline`, `:primary`, or `:transparent`."
275
+ },
276
+ {
277
+ "name": "variant",
278
+ "type": "Symbol",
279
+ "default": "`:default`",
280
+ "description": "One of `:default` or `:large`."
281
+ },
282
+ {
283
+ "name": "tag",
284
+ "type": "Symbol",
285
+ "default": "`:button`",
286
+ "description": "One of `:a` or `:button`."
287
+ },
288
+ {
289
+ "name": "type",
290
+ "type": "Symbol",
291
+ "default": "`:button`",
292
+ "description": "One of `:button` or `:submit`."
293
+ },
294
+ {
295
+ "name": "system_arguments",
296
+ "type": "Hash",
297
+ "default": "N/A",
298
+ "description": "[System arguments](/system-arguments)"
299
+ }
300
+ ]
301
+ },
302
+ {
303
+ "component": "Dialog",
304
+ "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_preview/default/",
307
+ "parameters": [
308
+ {
309
+ "name": "id",
310
+ "type": "String",
311
+ "default": "`\"dialog-#{(36**3 + rand(36**4)).to_s(36)}\"`",
312
+ "description": "The id of the dialog."
313
+ },
314
+ {
315
+ "name": "title",
316
+ "type": "String",
317
+ "default": "N/A",
318
+ "description": "Describes the content of the dialog."
319
+ },
320
+ {
321
+ "name": "subtitle",
322
+ "type": "String",
323
+ "default": "`nil`",
324
+ "description": "Provides additional context for the dialog, also setting the `aria-describedby` attribute."
325
+ },
326
+ {
327
+ "name": "size",
328
+ "type": "Symbol",
329
+ "default": "`:medium`",
330
+ "description": "The size of the dialog. One of `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`."
331
+ },
332
+ {
333
+ "name": "position",
334
+ "type": "Symbol",
335
+ "default": "`:center`",
336
+ "description": "The position of the dialog. One of `:center`, `:left`, or `:right`."
337
+ },
338
+ {
339
+ "name": "position_narrow",
340
+ "type": "Symbol",
341
+ "default": "`:inherit`",
342
+ "description": "The position of the dialog when narrow. One of `:bottom`, `:fullscreen`, `:inherit`, `:left`, or `:right`."
343
+ },
344
+ {
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."
349
+ },
350
+ {
351
+ "name": "system_arguments",
352
+ "type": "Hash",
353
+ "default": "N/A",
354
+ "description": "[System arguments](/system-arguments)"
355
+ }
356
+ ]
357
+ },
358
+ {
359
+ "component": "Dropdown",
360
+ "status": "alpha",
361
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb",
362
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown_preview/default/",
363
+ "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
+ }
382
+ ]
383
+ },
384
+ {
385
+ "component": "HiddenTextExpander",
386
+ "status": "alpha",
387
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb",
388
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander_preview/default/",
389
+ "parameters": [
390
+ {
391
+ "name": "inline",
392
+ "type": "Boolean",
393
+ "default": "`false`",
394
+ "description": "Whether or not the expander is inline."
395
+ },
396
+ {
397
+ "name": "button_arguments",
398
+ "type": "Hash",
399
+ "default": "`{}`",
400
+ "description": "[System arguments](/system-arguments) for the button element."
401
+ },
402
+ {
403
+ "name": "system_arguments",
404
+ "type": "Hash",
405
+ "default": "N/A",
406
+ "description": "[System arguments](/system-arguments)"
407
+ }
408
+ ]
409
+ },
410
+ {
411
+ "component": "Image",
412
+ "status": "alpha",
413
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb",
414
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_preview/default/",
415
+ "parameters": [
416
+ {
417
+ "name": "src",
418
+ "type": "String",
419
+ "default": "N/A",
420
+ "description": "The source url of the image."
421
+ },
422
+ {
423
+ "name": "alt",
424
+ "type": "String",
425
+ "default": "N/A",
426
+ "description": "Specifies an alternate text for the image."
427
+ },
428
+ {
429
+ "name": "lazy",
430
+ "type": "Boolean",
431
+ "default": "`false`",
432
+ "description": "Whether or not to lazily load the image."
433
+ },
434
+ {
435
+ "name": "system_arguments",
436
+ "type": "Hash",
437
+ "default": "N/A",
438
+ "description": "[System arguments](/system-arguments)"
439
+ }
440
+ ]
441
+ },
442
+ {
443
+ "component": "ImageCrop",
444
+ "status": "alpha",
445
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb",
446
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop_preview/default/",
447
+ "parameters": [
448
+ {
449
+ "name": "src",
450
+ "type": "String",
451
+ "default": "N/A",
452
+ "description": "The path of the image to crop."
453
+ },
454
+ {
455
+ "name": "rounded",
456
+ "type": "Boolean",
457
+ "default": "`true`",
458
+ "description": "If the crop mask should be a circle. Defaults to true."
459
+ },
460
+ {
461
+ "name": "system_arguments",
462
+ "type": "Hash",
463
+ "default": "N/A",
464
+ "description": "[System arguments](/system-arguments)"
465
+ }
466
+ ]
467
+ },
468
+ {
469
+ "component": "Layout",
470
+ "status": "alpha",
471
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb",
472
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout_preview/default/",
473
+ "parameters": [
474
+ {
475
+ "name": "stacking_breakpoint",
476
+ "type": "Symbol",
477
+ "default": "`:md`",
478
+ "description": "When the `Layout` should change from rows into columns. One of `:lg`, `:md`, or `:sm`."
479
+ },
480
+ {
481
+ "name": "first_in_source",
482
+ "type": "Symbol",
483
+ "default": "`:sidebar`",
484
+ "description": "Which element to render first in the HTML. This will change the keyboard navigation order. One of `:main` or `:sidebar`."
485
+ },
486
+ {
487
+ "name": "gutter",
488
+ "type": "Symbol",
489
+ "default": "`:default`",
490
+ "description": "The amount of space between the main section and the sidebar. One of `:condensed`, `:default`, `:none`, or `:spacious`."
491
+ },
492
+ {
493
+ "name": "system_arguments",
494
+ "type": "Hash",
495
+ "default": "N/A",
496
+ "description": "[System arguments](/system-arguments)"
497
+ }
498
+ ]
499
+ },
500
+ {
501
+ "component": "Menu",
502
+ "status": "alpha",
503
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/menu.rb",
504
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/menu_preview/default/",
505
+ "parameters": [
506
+ {
507
+ "name": "system_arguments",
508
+ "type": "Hash",
509
+ "default": "N/A",
510
+ "description": "[System arguments](/system-arguments)"
511
+ }
512
+ ]
513
+ },
514
+ {
515
+ "component": "NavList",
516
+ "status": "alpha",
517
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
518
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list_preview/default/",
519
+ "parameters": [
520
+ {
521
+ "name": "selected_item_id",
522
+ "type": "Symbol",
523
+ "default": "`nil`",
524
+ "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
525
+ },
526
+ {
527
+ "name": "system_arguments",
528
+ "type": "Hash",
529
+ "default": "N/A",
530
+ "description": "[System arguments](/system-arguments)"
531
+ }
532
+ ]
533
+ },
534
+ {
535
+ "component": "NavList::Item",
536
+ "status": "alpha",
537
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
538
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item_preview/default/",
539
+ "parameters": [
540
+ {
541
+ "name": "selected_item_id",
542
+ "type": "Symbol",
543
+ "default": "`nil`",
544
+ "description": "The ID of the currently selected list item. Used internally."
545
+ },
546
+ {
547
+ "name": "selected_by_ids",
548
+ "type": "Array<Symbol>",
549
+ "default": "`[]`",
550
+ "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."
551
+ },
552
+ {
553
+ "name": "expanded",
554
+ "type": "Boolean",
555
+ "default": "`false`",
556
+ "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
557
+ },
558
+ {
559
+ "name": "sub_item",
560
+ "type": "Boolean",
561
+ "default": "`false`",
562
+ "description": "Whether or not this item is nested under a parent item. Used internally."
563
+ },
564
+ {
565
+ "name": "system_arguments",
566
+ "type": "Hash",
567
+ "default": "N/A",
568
+ "description": "[System arguments](/system-arguments)"
569
+ }
570
+ ]
571
+ },
572
+ {
573
+ "component": "NavList::Section",
574
+ "status": "alpha",
575
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/section.rb",
576
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/section_preview/default/",
577
+ "parameters": [
578
+ {
579
+ "name": "selected_item_id",
580
+ "type": "Symbol",
581
+ "default": "`nil`",
582
+ "description": "The ID of the currently selected item. Used internally."
583
+ },
584
+ {
585
+ "name": "system_arguments",
586
+ "type": "Hash",
587
+ "default": "N/A",
588
+ "description": "[System arguments](/system-arguments)"
589
+ }
590
+ ]
591
+ },
592
+ {
593
+ "component": "OcticonSymbols",
594
+ "status": "alpha",
595
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/octicon_symbols.rb",
596
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/octicon_symbols_preview/default/",
597
+ "parameters": [
598
+ {
599
+ "name": "icons",
600
+ "type": "Array<Hash>",
601
+ "default": "`[]`",
602
+ "description": "List of icons to render, in the format { symbol: :icon_name, size: :small }"
603
+ }
604
+ ]
605
+ },
606
+ {
607
+ "component": "SegmentedControl",
608
+ "status": "alpha",
609
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb",
610
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control_preview/default/",
611
+ "parameters": [
612
+ {
613
+ "name": "hide_labels",
614
+ "type": "Boolean",
615
+ "default": "`false`",
616
+ "description": "Whether to hide the labels and only show the icons"
617
+ },
618
+ {
619
+ "name": "full_width",
620
+ "type": "Boolean",
621
+ "default": "`false`",
622
+ "description": "If the component should be full width"
623
+ },
624
+ {
625
+ "name": "size",
626
+ "type": "Symbol",
627
+ "default": "`:medium`",
628
+ "description": "One of `:large`, `:medium`, or `:small`."
629
+ },
630
+ {
631
+ "name": "system_arguments",
632
+ "type": "Hash",
633
+ "default": "N/A",
634
+ "description": "[System arguments](/system-arguments)"
635
+ }
636
+ ]
637
+ },
638
+ {
639
+ "component": "TabNav",
640
+ "status": "alpha",
641
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb",
642
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav_preview/default/",
643
+ "parameters": [
644
+ {
645
+ "name": "tag",
646
+ "type": "Symbol",
647
+ "default": "`:nav`",
648
+ "description": "One of `:div` or `:nav`."
649
+ },
650
+ {
651
+ "name": "label",
652
+ "type": "String",
653
+ "default": "N/A",
654
+ "description": "Sets an `aria-label` that helps assistive technology users understand the purpose of the links, and distinguish it from similar elements."
655
+ },
656
+ {
657
+ "name": "body_arguments",
658
+ "type": "Hash",
659
+ "default": "`{}`",
660
+ "description": "[System arguments](/system-arguments) for the body wrapper."
661
+ },
662
+ {
663
+ "name": "system_arguments",
664
+ "type": "Hash",
665
+ "default": "N/A",
666
+ "description": "[System arguments](/system-arguments)"
667
+ }
668
+ ]
669
+ },
670
+ {
671
+ "component": "TabPanels",
672
+ "status": "alpha",
673
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_panels.rb",
674
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels_preview/default/",
675
+ "parameters": [
676
+ {
677
+ "name": "label",
678
+ "type": "String",
679
+ "default": "N/A",
680
+ "description": "Sets an `aria-label` that helps assistive technology users understand the purpose of the tabs."
681
+ },
682
+ {
683
+ "name": "align",
684
+ "type": "Symbol",
685
+ "default": "N/A",
686
+ "description": "One of `:left` or `:right`. - Defaults to left"
687
+ },
688
+ {
689
+ "name": "body_arguments",
690
+ "type": "Hash",
691
+ "default": "`{}`",
692
+ "description": "[System arguments](/system-arguments) for the body wrapper."
693
+ },
694
+ {
695
+ "name": "wrapper_arguments",
696
+ "type": "Hash",
697
+ "default": "`{}`",
698
+ "description": "[System arguments](/system-arguments) for the `TabContainer` wrapper."
699
+ },
700
+ {
701
+ "name": "system_arguments",
702
+ "type": "Hash",
703
+ "default": "N/A",
704
+ "description": "[System arguments](/system-arguments)"
705
+ }
706
+ ]
707
+ },
708
+ {
709
+ "component": "TextField",
710
+ "status": "alpha",
711
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb",
712
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field_preview/default/",
713
+ "parameters": [
714
+ {
715
+ "name": "name",
716
+ "type": "String",
717
+ "default": "N/A",
718
+ "description": "Value for the HTML name attribute."
719
+ },
720
+ {
721
+ "name": "id",
722
+ "type": "String",
723
+ "default": "N/A",
724
+ "description": "Value for the HTML id attribute."
725
+ },
726
+ {
727
+ "name": "class",
728
+ "type": "String",
729
+ "default": "N/A",
730
+ "description": "A list of CSS classes to add to the input. Exists for compatibility with Rails form builders."
731
+ },
732
+ {
733
+ "name": "classes",
734
+ "type": "String",
735
+ "default": "N/A",
736
+ "description": "A list of CSS classes to add to the input. Combined with the `:class` argument."
737
+ },
738
+ {
739
+ "name": "caption",
740
+ "type": "String",
741
+ "default": "N/A",
742
+ "description": "Caption text to render below the input."
743
+ },
744
+ {
745
+ "name": "label",
746
+ "type": "String",
747
+ "default": "N/A",
748
+ "description": "Label text displayed above the input."
749
+ },
750
+ {
751
+ "name": "visually_hide_label",
752
+ "type": "Boolean",
753
+ "default": "N/A",
754
+ "description": "Whether or not to visually hide the label. If `true` the label will be hidden visually but still available to screen readers."
755
+ },
756
+ {
757
+ "name": "size",
758
+ "type": "Symbol",
759
+ "default": "N/A",
760
+ "description": "The size of the field. One of `:large`, `:medium`, or `:small`."
761
+ },
762
+ {
763
+ "name": "show_clear_button",
764
+ "type": "Boolean",
765
+ "default": "N/A",
766
+ "description": "Whether or not to include a clear button inside the input that clears the input's contents when clicked."
767
+ },
768
+ {
769
+ "name": "clear_button_id",
770
+ "type": "String",
771
+ "default": "N/A",
772
+ "description": "The HTML id attribute of the clear button."
773
+ },
774
+ {
775
+ "name": "full_width",
776
+ "type": "Boolean",
777
+ "default": "N/A",
778
+ "description": "Controls whether or not the input takes the full width of its container."
779
+ },
780
+ {
781
+ "name": "disabled",
782
+ "type": "Boolean",
783
+ "default": "N/A",
784
+ "description": "Whether or not the input should accept keyboard and mouse input."
785
+ },
786
+ {
787
+ "name": "invalid",
788
+ "type": "Boolean",
789
+ "default": "N/A",
790
+ "description": "If `true`, renders the input in a visually invalid state."
791
+ },
792
+ {
793
+ "name": "placeholder",
794
+ "type": "String",
795
+ "default": "N/A",
796
+ "description": "Placeholder text."
797
+ },
798
+ {
799
+ "name": "inset",
800
+ "type": "Boolean",
801
+ "default": "N/A",
802
+ "description": "If `true`, renders the input in a visually inset state."
803
+ },
804
+ {
805
+ "name": "monospace",
806
+ "type": "Boolean",
807
+ "default": "N/A",
808
+ "description": "If `true`, uses a monospace font for the input field."
809
+ },
810
+ {
811
+ "name": "leading_visual",
812
+ "type": "Hash",
813
+ "default": "N/A",
814
+ "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)."
815
+ },
816
+ {
817
+ "name": "validation_message",
818
+ "type": "String",
819
+ "default": "N/A",
820
+ "description": "A validation message to display beneath the input. Implicitly sets `invalid` to `true`."
821
+ },
822
+ {
823
+ "name": "label_arguments",
824
+ "type": "Hash",
825
+ "default": "N/A",
826
+ "description": "System arugments passed to the Rails builder's `#label` method. These arguments will appear as HTML attributes on the `<label>` tag."
827
+ },
828
+ {
829
+ "name": "system_arguments",
830
+ "type": "Hash",
831
+ "default": "N/A",
832
+ "description": "[System arguments](/system-arguments)"
833
+ },
834
+ {
835
+ "name": "block",
836
+ "type": "Proc",
837
+ "default": "N/A",
838
+ "description": "Unused."
839
+ }
840
+ ]
841
+ },
842
+ {
843
+ "component": "ToggleSwitch",
844
+ "status": "alpha",
845
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/toggle_switch.rb",
846
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch_preview/default/",
847
+ "parameters": [
848
+ {
849
+ "name": "src",
850
+ "type": "String",
851
+ "default": "`nil`",
852
+ "description": "The URL to POST to when the toggle switch is toggled. If `nil`, the toggle switch will not make any requests."
853
+ },
854
+ {
855
+ "name": "csrf_token",
856
+ "type": "String",
857
+ "default": "`nil`",
858
+ "description": "A CSRF token that will be sent to the server as \"authenticity_token\" when the toggle switch is toggled. Unused if `src` is `nil`."
859
+ },
860
+ {
861
+ "name": "checked",
862
+ "type": "Boolean",
863
+ "default": "`false`",
864
+ "description": "Whether the toggle switch is on or off."
865
+ },
866
+ {
867
+ "name": "enabled",
868
+ "type": "Boolean",
869
+ "default": "`true`",
870
+ "description": "Whether or not the toggle switch responds to user input."
871
+ },
872
+ {
873
+ "name": "size",
874
+ "type": "Symbol",
875
+ "default": "`:medium`",
876
+ "description": "What size toggle switch to render. One of `:end` or `:start`."
877
+ },
878
+ {
879
+ "name": "status_label_position",
880
+ "type": "Symbol",
881
+ "default": "`:start`",
882
+ "description": "Which side of the toggle switch to render the status label. One of `:medium` or `:small`."
883
+ },
884
+ {
885
+ "name": "system_arguments",
886
+ "type": "Hash",
887
+ "default": "N/A",
888
+ "description": "[System arguments](/system-arguments)"
889
+ }
890
+ ]
891
+ },
892
+ {
893
+ "component": "Tooltip",
894
+ "status": "alpha",
895
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb",
896
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip_preview/default/",
897
+ "parameters": [
898
+ {
899
+ "name": "for_id",
900
+ "type": "String",
901
+ "default": "N/A",
902
+ "description": "The ID of the element that the tooltip should be attached to."
903
+ },
904
+ {
905
+ "name": "type",
906
+ "type": "Symbol",
907
+ "default": "N/A",
908
+ "description": "One of `:description` or `:label`."
909
+ },
910
+ {
911
+ "name": "direction",
912
+ "type": "Symbol",
913
+ "default": "`:s`",
914
+ "description": "One of `:e`, `:n`, `:ne`, `:nw`, `:s`, `:se`, `:sw`, or `:w`."
915
+ },
916
+ {
917
+ "name": "text",
918
+ "type": "String",
919
+ "default": "N/A",
920
+ "description": "The text content of the tooltip. This should be brief and no longer than a sentence."
921
+ },
922
+ {
923
+ "name": "system_arguments",
924
+ "type": "Hash",
925
+ "default": "N/A",
926
+ "description": "[System arguments](/system-arguments)"
927
+ }
928
+ ]
929
+ },
930
+ {
931
+ "component": "UnderlineNav",
932
+ "status": "alpha",
933
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb",
934
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav_preview/default/",
935
+ "parameters": [
936
+ {
937
+ "name": "tag",
938
+ "type": "Symbol",
939
+ "default": "`:nav`",
940
+ "description": "One of `:div` or `:nav`."
941
+ },
942
+ {
943
+ "name": "label",
944
+ "type": "String",
945
+ "default": "N/A",
946
+ "description": "Sets an `aria-label` that helps assistive technology users understand the purpose of the links, and distinguish it from similar elements."
947
+ },
948
+ {
949
+ "name": "align",
950
+ "type": "Symbol",
951
+ "default": "`:left`",
952
+ "description": "One of `:left` or `:right`. - Defaults to left"
953
+ },
954
+ {
955
+ "name": "body_arguments",
956
+ "type": "Hash",
957
+ "default": "`{}`",
958
+ "description": "[System arguments](/system-arguments) for the body wrapper."
959
+ },
960
+ {
961
+ "name": "system_arguments",
962
+ "type": "Hash",
963
+ "default": "N/A",
964
+ "description": "[System arguments](/system-arguments)"
965
+ }
966
+ ]
967
+ },
968
+ {
969
+ "component": "UnderlinePanels",
970
+ "status": "alpha",
971
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb",
972
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels_preview/default/",
973
+ "parameters": [
974
+ {
975
+ "name": "label",
976
+ "type": "String",
977
+ "default": "N/A",
978
+ "description": "Sets an `aria-label` that helps assistive technology users understand the purpose of the tabs."
979
+ },
980
+ {
981
+ "name": "align",
982
+ "type": "Symbol",
983
+ "default": "`:left`",
984
+ "description": "One of `:left` or `:right`. - Defaults to left"
985
+ },
986
+ {
987
+ "name": "body_arguments",
988
+ "type": "Hash",
989
+ "default": "`{}`",
990
+ "description": "[System arguments](/system-arguments) for the body wrapper."
991
+ },
992
+ {
993
+ "name": "wrapper_arguments",
994
+ "type": "Hash",
995
+ "default": "`{}`",
996
+ "description": "[System arguments](/system-arguments) for the `TabContainer` wrapper."
997
+ },
998
+ {
999
+ "name": "system_arguments",
1000
+ "type": "Hash",
1001
+ "default": "N/A",
1002
+ "description": "[System arguments](/system-arguments)"
1003
+ }
1004
+ ]
1005
+ },
1006
+ {
1007
+ "component": "AutoComplete",
1008
+ "status": "beta",
1009
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb",
1010
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete_preview/default/",
1011
+ "parameters": [
1012
+ {
1013
+ "name": "label_text",
1014
+ "type": "String",
1015
+ "default": "N/A",
1016
+ "description": "The label of the input."
1017
+ },
1018
+ {
1019
+ "name": "src",
1020
+ "type": "String",
1021
+ "default": "N/A",
1022
+ "description": "The route to query."
1023
+ },
1024
+ {
1025
+ "name": "input_id",
1026
+ "type": "String",
1027
+ "default": "N/A",
1028
+ "description": "Id of the input element."
1029
+ },
1030
+ {
1031
+ "name": "input_name",
1032
+ "type": "String",
1033
+ "default": "`nil`",
1034
+ "description": "Optional name of the input element, defaults to `input_id` when not set."
1035
+ },
1036
+ {
1037
+ "name": "list_id",
1038
+ "type": "String",
1039
+ "default": "N/A",
1040
+ "description": "Id of the list element."
1041
+ },
1042
+ {
1043
+ "name": "visually_hide_label",
1044
+ "type": "Boolean",
1045
+ "default": "`false`",
1046
+ "description": "Controls if the label is visible. If `true`, screen reader only text will be added."
1047
+ },
1048
+ {
1049
+ "name": "show_clear_button",
1050
+ "type": "Boolean",
1051
+ "default": "`false`",
1052
+ "description": "Adds optional clear button."
1053
+ },
1054
+ {
1055
+ "name": "system_arguments",
1056
+ "type": "Hash",
1057
+ "default": "N/A",
1058
+ "description": "[System arguments](/system-arguments)"
1059
+ },
1060
+ {
1061
+ "name": "size",
1062
+ "type": "Hash",
1063
+ "default": "`:medium`",
1064
+ "description": "Input size can be small, medium (default), or large"
1065
+ },
1066
+ {
1067
+ "name": "full_width",
1068
+ "type": "Boolean",
1069
+ "default": "`false`",
1070
+ "description": "Input can be full-width or fit to content"
1071
+ },
1072
+ {
1073
+ "name": "disabled",
1074
+ "type": "Boolean",
1075
+ "default": "`false`",
1076
+ "description": "Disabled input"
1077
+ },
1078
+ {
1079
+ "name": "invalid",
1080
+ "type": "Boolean",
1081
+ "default": "`false`",
1082
+ "description": "Invalid input"
1083
+ },
1084
+ {
1085
+ "name": "placeholder",
1086
+ "type": "String",
1087
+ "default": "`nil`",
1088
+ "description": "The placeholder text displayed within the input"
1089
+ },
1090
+ {
1091
+ "name": "inset",
1092
+ "type": "Boolean",
1093
+ "default": "`false`",
1094
+ "description": "subtle input background color"
1095
+ },
1096
+ {
1097
+ "name": "monospace",
1098
+ "type": "Boolean",
1099
+ "default": "`false`",
1100
+ "description": "monospace input font family"
1101
+ }
1102
+ ]
1103
+ },
1104
+ {
1105
+ "component": "AutoComplete::Item",
1106
+ "status": "beta",
1107
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb",
1108
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item_preview/default/",
1109
+ "parameters": [
1110
+ {
1111
+ "name": "value",
1112
+ "type": "String",
1113
+ "default": "N/A",
1114
+ "description": "Value of the item."
1115
+ },
1116
+ {
1117
+ "name": "selected",
1118
+ "type": "Boolean",
1119
+ "default": "`false`",
1120
+ "description": "Whether the item is selected."
1121
+ },
1122
+ {
1123
+ "name": "disabled",
1124
+ "type": "Boolean",
1125
+ "default": "`false`",
1126
+ "description": "Whether the item is disabled."
1127
+ },
1128
+ {
1129
+ "name": "description_variant",
1130
+ "type": "Hash",
1131
+ "default": "`:block`",
1132
+ "description": "Changes the description style. Allowed values are :inline, :block"
1133
+ },
1134
+ {
1135
+ "name": "description",
1136
+ "type": "String",
1137
+ "default": "N/A",
1138
+ "description": "Display description text below label"
1139
+ },
1140
+ {
1141
+ "name": "system_arguments",
1142
+ "type": "Hash",
1143
+ "default": "N/A",
1144
+ "description": "[System arguments](/system-arguments)"
1145
+ }
1146
+ ]
1147
+ },
1148
+ {
1149
+ "component": "Avatar",
1150
+ "status": "beta",
1151
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar.rb",
1152
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_preview/default/",
1153
+ "parameters": [
1154
+ {
1155
+ "name": "src",
1156
+ "type": "String",
1157
+ "default": "N/A",
1158
+ "description": "The source url of the avatar image."
1159
+ },
1160
+ {
1161
+ "name": "alt",
1162
+ "type": "String",
1163
+ "default": "N/A",
1164
+ "description": "Passed through to alt on img tag."
1165
+ },
1166
+ {
1167
+ "name": "size",
1168
+ "type": "Integer",
1169
+ "default": "`20`",
1170
+ "description": "One of `16`, `20`, `24`, `32`, `40`, `48`, or `80`."
1171
+ },
1172
+ {
1173
+ "name": "shape",
1174
+ "type": "Symbol",
1175
+ "default": "`:circle`",
1176
+ "description": "Shape of the avatar. One of `:circle` or `:square`."
1177
+ },
1178
+ {
1179
+ "name": "href",
1180
+ "type": "String",
1181
+ "default": "`nil`",
1182
+ "description": "The URL to link to. If used, component will be wrapped by an `<a>` tag."
1183
+ },
1184
+ {
1185
+ "name": "system_arguments",
1186
+ "type": "Hash",
1187
+ "default": "N/A",
1188
+ "description": "[System arguments](/system-arguments)"
1189
+ }
1190
+ ]
1191
+ },
1192
+ {
1193
+ "component": "AvatarStack",
1194
+ "status": "beta",
1195
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar_stack.rb",
1196
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack_preview/default/",
1197
+ "parameters": [
1198
+ {
1199
+ "name": "tag",
1200
+ "type": "Symbol",
1201
+ "default": "`:div`",
1202
+ "description": "One of `:div` or `:span`."
1203
+ },
1204
+ {
1205
+ "name": "align",
1206
+ "type": "Symbol",
1207
+ "default": "`:left`",
1208
+ "description": "One of `:left` or `:right`."
1209
+ },
1210
+ {
1211
+ "name": "tooltipped",
1212
+ "type": "Boolean",
1213
+ "default": "`false`",
1214
+ "description": "Whether to add a tooltip to the stack or not."
1215
+ },
1216
+ {
1217
+ "name": "body_arguments",
1218
+ "type": "Hash",
1219
+ "default": "`{}`",
1220
+ "description": "Parameters to add to the Body. If `tooltipped` is set, has the same arguments as [Tooltip](/components/tooltip). The default tag is `:div` but can be changed using `tag:` to one of `:div` or `:span`."
1221
+ },
1222
+ {
1223
+ "name": "system_arguments",
1224
+ "type": "Hash",
1225
+ "default": "N/A",
1226
+ "description": "[System arguments](/system-arguments)"
1227
+ }
1228
+ ]
1229
+ },
1230
+ {
1231
+ "component": "BaseButton",
1232
+ "status": "beta",
1233
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb",
1234
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button_preview/default/",
1235
+ "parameters": [
1236
+ {
1237
+ "name": "tag",
1238
+ "type": "Symbol",
1239
+ "default": "`:button`",
1240
+ "description": "One of `:a`, `:button`, or `:summary`."
1241
+ },
1242
+ {
1243
+ "name": "type",
1244
+ "type": "Symbol",
1245
+ "default": "`:button`",
1246
+ "description": "One of `:button`, `:reset`, or `:submit`."
1247
+ },
1248
+ {
1249
+ "name": "block",
1250
+ "type": "Boolean",
1251
+ "default": "`false`",
1252
+ "description": "Whether button is full-width with `display: block`."
1253
+ },
1254
+ {
1255
+ "name": "system_arguments",
1256
+ "type": "Hash",
1257
+ "default": "N/A",
1258
+ "description": "[System arguments](/system-arguments)"
1259
+ }
1260
+ ]
1261
+ },
1262
+ {
1263
+ "component": "Blankslate",
1264
+ "status": "beta",
1265
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb",
1266
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate_preview/default/",
1267
+ "parameters": [
1268
+ {
1269
+ "name": "narrow",
1270
+ "type": "Boolean",
1271
+ "default": "`false`",
1272
+ "description": "Adds a maximum width of `485px` to the Blankslate."
1273
+ },
1274
+ {
1275
+ "name": "spacious",
1276
+ "type": "Boolean",
1277
+ "default": "`false`",
1278
+ "description": "Increases the padding from `32px` to `80px 40px`."
1279
+ },
1280
+ {
1281
+ "name": "border",
1282
+ "type": "Boolean",
1283
+ "default": "`false`",
1284
+ "description": "Adds a border around the Blankslate."
1285
+ },
1286
+ {
1287
+ "name": "system_arguments",
1288
+ "type": "Hash",
1289
+ "default": "N/A",
1290
+ "description": "[System arguments](/system-arguments)"
1291
+ }
1292
+ ]
1293
+ },
1294
+ {
1295
+ "component": "BorderBox",
1296
+ "status": "beta",
1297
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb",
1298
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box_preview/default/",
1299
+ "parameters": [
1300
+ {
1301
+ "name": "padding",
1302
+ "type": "Symbol",
1303
+ "default": "`:default`",
1304
+ "description": "One of `:condensed`, `:default`, or `:spacious`."
1305
+ },
1306
+ {
1307
+ "name": "system_arguments",
1308
+ "type": "Hash",
1309
+ "default": "N/A",
1310
+ "description": "[System arguments](/system-arguments)"
1311
+ }
1312
+ ]
1313
+ },
1314
+ {
1315
+ "component": "BorderBox::Header",
1316
+ "status": "beta",
1317
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb",
1318
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header_preview/default/",
1319
+ "parameters": [
1320
+ {
1321
+ "name": "system_arguments",
1322
+ "type": "Hash",
1323
+ "default": "N/A",
1324
+ "description": "[System arguments](/system-arguments)"
1325
+ }
1326
+ ]
1327
+ },
1328
+ {
1329
+ "component": "Breadcrumbs",
1330
+ "status": "beta",
1331
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb",
1332
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs_preview/default/",
1333
+ "parameters": [
1334
+ {
1335
+ "name": "system_arguments",
1336
+ "type": "Hash",
1337
+ "default": "N/A",
1338
+ "description": "[System arguments](/system-arguments)"
1339
+ }
1340
+ ]
1341
+ },
1342
+ {
1343
+ "component": "Button",
1344
+ "status": "beta",
1345
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button.rb",
1346
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_preview/default/",
1347
+ "parameters": [
1348
+ {
1349
+ "name": "scheme",
1350
+ "type": "Symbol",
1351
+ "default": "`:default`",
1352
+ "description": "One of `:danger`, `:default`, `:invisible`, `:link`, `:primary`, or `:secondary`."
1353
+ },
1354
+ {
1355
+ "name": "size",
1356
+ "type": "Symbol",
1357
+ "default": "`:medium`",
1358
+ "description": "One of `:large`, `:medium`, or `:small`."
1359
+ },
1360
+ {
1361
+ "name": "block",
1362
+ "type": "Boolean",
1363
+ "default": "`false`",
1364
+ "description": "Whether button is full-width with `display: block`."
1365
+ },
1366
+ {
1367
+ "name": "align_content",
1368
+ "type": "Symbol",
1369
+ "default": "`:center`",
1370
+ "description": "One of `:center` or `:start`."
1371
+ },
1372
+ {
1373
+ "name": "tag",
1374
+ "type": "Symbol",
1375
+ "default": "`:button`",
1376
+ "description": "One of `:a`, `:button`, or `:summary`."
1377
+ },
1378
+ {
1379
+ "name": "type",
1380
+ "type": "Symbol",
1381
+ "default": "`:button`",
1382
+ "description": "One of `:button`, `:reset`, or `:submit`."
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": "ButtonGroup",
1394
+ "status": "beta",
1395
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group.rb",
1396
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group_preview/default/",
1397
+ "parameters": [
1398
+ {
1399
+ "name": "variant",
1400
+ "type": "Symbol",
1401
+ "default": "`nil`",
1402
+ "description": "DEPRECATED. One of `:medium` or `:small`."
1403
+ },
1404
+ {
1405
+ "name": "size",
1406
+ "type": "Symbol",
1407
+ "default": "`:medium`",
1408
+ "description": "One of `:medium` or `:small`."
1409
+ },
1410
+ {
1411
+ "name": "system_arguments",
1412
+ "type": "Hash",
1413
+ "default": "N/A",
1414
+ "description": "[System arguments](/system-arguments)"
1415
+ }
1416
+ ]
1417
+ },
1418
+ {
1419
+ "component": "ClipboardCopy",
1420
+ "status": "beta",
1421
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/clipboard_copy.rb",
1422
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy_preview/default/",
1423
+ "parameters": [
1424
+ {
1425
+ "name": "aria-label",
1426
+ "type": "String",
1427
+ "default": "N/A",
1428
+ "description": "String that will be read to screenreaders when the component is focused"
1429
+ },
1430
+ {
1431
+ "name": "value",
1432
+ "type": "String",
1433
+ "default": "`nil`",
1434
+ "description": "Text to copy into the users clipboard when they click the component."
1435
+ },
1436
+ {
1437
+ "name": "for",
1438
+ "type": "String",
1439
+ "default": "N/A",
1440
+ "description": "Element id from where to get the copied value."
1441
+ },
1442
+ {
1443
+ "name": "system_arguments",
1444
+ "type": "Hash",
1445
+ "default": "N/A",
1446
+ "description": "[System arguments](/system-arguments)"
1447
+ }
1448
+ ]
1449
+ },
1450
+ {
1451
+ "component": "CloseButton",
1452
+ "status": "beta",
1453
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/close_button.rb",
1454
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button_preview/default/",
1455
+ "parameters": [
1456
+ {
1457
+ "name": "type",
1458
+ "type": "Symbol",
1459
+ "default": "`:button`",
1460
+ "description": "One of `:button` or `:submit`."
1461
+ },
1462
+ {
1463
+ "name": "system_arguments",
1464
+ "type": "Hash",
1465
+ "default": "N/A",
1466
+ "description": "[System arguments](/system-arguments)"
1467
+ }
1468
+ ]
1469
+ },
1470
+ {
1471
+ "component": "Counter",
1472
+ "status": "beta",
1473
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/counter.rb",
1474
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter_preview/default/",
1475
+ "parameters": [
1476
+ {
1477
+ "name": "count",
1478
+ "type": "Integer, Float::INFINITY, nil",
1479
+ "default": "`0`",
1480
+ "description": "The number to be displayed (e.x. # of issues, pull requests)"
1481
+ },
1482
+ {
1483
+ "name": "scheme",
1484
+ "type": "Symbol",
1485
+ "default": "`:default`",
1486
+ "description": "Color scheme. One of `:default`, `:primary`, or `:secondary`."
1487
+ },
1488
+ {
1489
+ "name": "limit",
1490
+ "type": "Integer, nil",
1491
+ "default": "`5_000`",
1492
+ "description": "Maximum value to display. Pass `nil` for no limit. (e.x. if `count` == 6,000 and `limit` == 5000, counter will display \"5,000+\")"
1493
+ },
1494
+ {
1495
+ "name": "hide_if_zero",
1496
+ "type": "Boolean",
1497
+ "default": "`false`",
1498
+ "description": "If true, a `hidden` attribute is added to the counter if `count` is zero."
1499
+ },
1500
+ {
1501
+ "name": "text",
1502
+ "type": "String",
1503
+ "default": "`\"\"`",
1504
+ "description": "Text to display instead of count."
1505
+ },
1506
+ {
1507
+ "name": "round",
1508
+ "type": "Boolean",
1509
+ "default": "`false`",
1510
+ "description": "Whether to apply our standard rounding logic to value."
1511
+ },
1512
+ {
1513
+ "name": "system_arguments",
1514
+ "type": "Hash",
1515
+ "default": "N/A",
1516
+ "description": "[System arguments](/system-arguments)"
1517
+ }
1518
+ ]
1519
+ },
1520
+ {
1521
+ "component": "Details",
1522
+ "status": "beta",
1523
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/details.rb",
1524
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details_preview/default/",
1525
+ "parameters": [
1526
+ {
1527
+ "name": "overlay",
1528
+ "type": "Symbol",
1529
+ "default": "`:none`",
1530
+ "description": "Dictates the type of overlay to render with. One of `:dark`, `:default`, or `:none`."
1531
+ },
1532
+ {
1533
+ "name": "reset",
1534
+ "type": "Boolean",
1535
+ "default": "`false`",
1536
+ "description": "Defaults to false. If set to true, it will remove the default caret and remove style from the summary element"
1537
+ },
1538
+ {
1539
+ "name": "system_arguments",
1540
+ "type": "Hash",
1541
+ "default": "N/A",
1542
+ "description": "[System arguments](/system-arguments)"
1543
+ }
1544
+ ]
1545
+ },
1546
+ {
1547
+ "component": "Flash",
1548
+ "status": "beta",
1549
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/flash.rb",
1550
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash_preview/default/",
1551
+ "parameters": [
1552
+ {
1553
+ "name": "full",
1554
+ "type": "Boolean",
1555
+ "default": "`false`",
1556
+ "description": "Whether the component should take up the full width of the screen."
1557
+ },
1558
+ {
1559
+ "name": "spacious",
1560
+ "type": "Boolean",
1561
+ "default": "`false`",
1562
+ "description": "Whether to add margin to the bottom of the component."
1563
+ },
1564
+ {
1565
+ "name": "dismissible",
1566
+ "type": "Boolean",
1567
+ "default": "`false`",
1568
+ "description": "Whether the component can be dismissed with an X button."
1569
+ },
1570
+ {
1571
+ "name": "icon",
1572
+ "type": "Symbol",
1573
+ "default": "`nil`",
1574
+ "description": "Name of Octicon icon to use."
1575
+ },
1576
+ {
1577
+ "name": "scheme",
1578
+ "type": "Symbol",
1579
+ "default": "`:default`",
1580
+ "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
1581
+ },
1582
+ {
1583
+ "name": "system_arguments",
1584
+ "type": "Hash",
1585
+ "default": "N/A",
1586
+ "description": "[System arguments](/system-arguments)"
1587
+ }
1588
+ ]
1589
+ },
1590
+ {
1591
+ "component": "Heading",
1592
+ "status": "beta",
1593
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/heading.rb",
1594
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading_preview/default/",
1595
+ "parameters": [
1596
+ {
1597
+ "name": "tag",
1598
+ "type": "String",
1599
+ "default": "N/A",
1600
+ "description": "One of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, or `:h6`."
1601
+ },
1602
+ {
1603
+ "name": "system_arguments",
1604
+ "type": "Hash",
1605
+ "default": "N/A",
1606
+ "description": "[System arguments](/system-arguments)"
1607
+ }
1608
+ ]
1609
+ },
1610
+ {
1611
+ "component": "IconButton",
1612
+ "status": "beta",
1613
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/icon_button.rb",
1614
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button_preview/default/",
1615
+ "parameters": [
1616
+ {
1617
+ "name": "icon",
1618
+ "type": "String",
1619
+ "default": "N/A",
1620
+ "description": "Name of [Octicon](https://primer.style/octicons/) to use."
1621
+ },
1622
+ {
1623
+ "name": "wrapper_arguments",
1624
+ "type": "Hash",
1625
+ "default": "`{}`",
1626
+ "description": "Optional keyword arguments to be passed to the wrapper `<div>` tag."
1627
+ },
1628
+ {
1629
+ "name": "scheme",
1630
+ "type": "Symbol",
1631
+ "default": "`:default`",
1632
+ "description": "One of `:danger`, `:default`, or `:invisible`."
1633
+ },
1634
+ {
1635
+ "name": "size",
1636
+ "type": "Symbol",
1637
+ "default": "`:medium`",
1638
+ "description": "One of `:large`, `:medium`, or `:small`."
1639
+ },
1640
+ {
1641
+ "name": "tag",
1642
+ "type": "Symbol",
1643
+ "default": "N/A",
1644
+ "description": "One of `:a`, `:button`, or `:summary`."
1645
+ },
1646
+ {
1647
+ "name": "type",
1648
+ "type": "Symbol",
1649
+ "default": "N/A",
1650
+ "description": "One of `:button`, `:reset`, or `:submit`."
1651
+ },
1652
+ {
1653
+ "name": "aria-label",
1654
+ "type": "String",
1655
+ "default": "N/A",
1656
+ "description": "String that can be read by assistive technology. A label should be short and concise. See the accessibility section for more information."
1657
+ },
1658
+ {
1659
+ "name": "aria-description",
1660
+ "type": "String",
1661
+ "default": "N/A",
1662
+ "description": "String that can be read by assistive technology. A description can be longer as it is intended to provide more context and information. See the accessibility section for more information."
1663
+ },
1664
+ {
1665
+ "name": "show_tooltip",
1666
+ "type": "Boolean",
1667
+ "default": "`true`",
1668
+ "description": "Whether or not to show a tooltip when this button is hovered. Tooltips should only be hidden if the aria label is redundant, i.e. if the icon has a widely understood definition."
1669
+ },
1670
+ {
1671
+ "name": "tooltip_direction",
1672
+ "type": "Symbol",
1673
+ "default": "`:s`",
1674
+ "description": "One of `:e`, `:n`, `:ne`, `:nw`, `:s`, `:se`, `:sw`, or `:w`."
1675
+ },
1676
+ {
1677
+ "name": "system_arguments",
1678
+ "type": "Hash",
1679
+ "default": "N/A",
1680
+ "description": "[System arguments](/system-arguments)"
1681
+ }
1682
+ ]
1683
+ },
1684
+ {
1685
+ "component": "Label",
1686
+ "status": "beta",
1687
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/label.rb",
1688
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label_preview/default/",
1689
+ "parameters": [
1690
+ {
1691
+ "name": "tag",
1692
+ "type": "Symbol",
1693
+ "default": "`:span`",
1694
+ "description": "One of `:a`, `:div`, `:span`, or `:summary`."
1695
+ },
1696
+ {
1697
+ "name": "scheme",
1698
+ "type": "Symbol",
1699
+ "default": "`:default`",
1700
+ "description": "One of `:accent`, `:attention`, `:danger`, `:default`, `:done`, `:info`, `:orange`, `:primary`, `:purple`, `:secondary`, `:severe`, `:sponsors`, `:success`, or `:warning`."
1701
+ },
1702
+ {
1703
+ "name": "size",
1704
+ "type": "Symbol",
1705
+ "default": "`:medium`",
1706
+ "description": "One of `:large` or `:medium`."
1707
+ },
1708
+ {
1709
+ "name": "inline",
1710
+ "type": "Boolean",
1711
+ "default": "`false`",
1712
+ "description": "Whether or not to render this label inline."
1713
+ },
1714
+ {
1715
+ "name": "variant",
1716
+ "type": "Symbol",
1717
+ "default": "`:none`",
1718
+ "description": "One of `:inline`, `:large`, or `:none`."
1719
+ },
1720
+ {
1721
+ "name": "system_arguments",
1722
+ "type": "Hash",
1723
+ "default": "N/A",
1724
+ "description": "[System arguments](/system-arguments)"
1725
+ }
1726
+ ]
1727
+ },
1728
+ {
1729
+ "component": "Link",
1730
+ "status": "beta",
1731
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
1732
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link_preview/default/",
1733
+ "parameters": [
1734
+ {
1735
+ "name": "tag",
1736
+ "type": "String",
1737
+ "default": "`:a`",
1738
+ "description": "One of `:a` or `:span`."
1739
+ },
1740
+ {
1741
+ "name": "href",
1742
+ "type": "String",
1743
+ "default": "`nil`",
1744
+ "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."
1745
+ },
1746
+ {
1747
+ "name": "scheme",
1748
+ "type": "Symbol",
1749
+ "default": "`:default`",
1750
+ "description": "One of `:default`, `:primary`, or `:secondary`."
1751
+ },
1752
+ {
1753
+ "name": "muted",
1754
+ "type": "Boolean",
1755
+ "default": "`false`",
1756
+ "description": "Uses light gray for Link color, and blue on hover."
1757
+ },
1758
+ {
1759
+ "name": "underline",
1760
+ "type": "Boolean",
1761
+ "default": "`true`",
1762
+ "description": "Whether or not to underline the link."
1763
+ },
1764
+ {
1765
+ "name": "system_arguments",
1766
+ "type": "Hash",
1767
+ "default": "N/A",
1768
+ "description": "[System arguments](/system-arguments)"
1769
+ }
1770
+ ]
1771
+ },
1772
+ {
1773
+ "component": "Markdown",
1774
+ "status": "beta",
1775
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/markdown.rb",
1776
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/markdown_preview/default/",
1777
+ "parameters": [
1778
+ {
1779
+ "name": "tag",
1780
+ "type": "Symbol",
1781
+ "default": "`:div`",
1782
+ "description": "One of `:article`, `:div`, or `:td`."
1783
+ },
1784
+ {
1785
+ "name": "system_arguments",
1786
+ "type": "Hash",
1787
+ "default": "N/A",
1788
+ "description": "[System arguments](/system-arguments)"
1789
+ }
1790
+ ]
1791
+ },
1792
+ {
1793
+ "component": "Octicon",
1794
+ "status": "beta",
1795
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/octicon.rb",
1796
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/octicon_preview/default/",
1797
+ "parameters": [
1798
+ {
1799
+ "name": "icon_name",
1800
+ "type": "Symbol, String",
1801
+ "default": "`nil`",
1802
+ "description": "Name of [Octicon](https://primer.style/octicons/) to use."
1803
+ },
1804
+ {
1805
+ "name": "icon",
1806
+ "type": "Symbol, String",
1807
+ "default": "`nil`",
1808
+ "description": "Name of [Octicon](https://primer.style/octicons/) to use."
1809
+ },
1810
+ {
1811
+ "name": "size",
1812
+ "type": "Symbol",
1813
+ "default": "`:small`",
1814
+ "description": "One of `:xsmall` (`12`), `:small` (`16`), or `:medium` (`24`)."
1815
+ },
1816
+ {
1817
+ "name": "use_symbol",
1818
+ "type": "Boolean",
1819
+ "default": "`false`",
1820
+ "description": "EXPERIMENTAL (May change or be removed) - Set to true when using with [OcticonSymbols](/components/alpha/octiconsymbols)."
1821
+ },
1822
+ {
1823
+ "name": "system_arguments",
1824
+ "type": "Hash",
1825
+ "default": "N/A",
1826
+ "description": "[System arguments](/system-arguments)"
1827
+ }
1828
+ ]
1829
+ },
1830
+ {
1831
+ "component": "Popover",
1832
+ "status": "beta",
1833
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/popover.rb",
1834
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/popover_preview/default/",
1835
+ "parameters": [
1836
+ {
1837
+ "name": "system_arguments",
1838
+ "type": "Hash",
1839
+ "default": "N/A",
1840
+ "description": "[System arguments](/system-arguments)"
1841
+ }
1842
+ ]
1843
+ },
1844
+ {
1845
+ "component": "ProgressBar",
1846
+ "status": "beta",
1847
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/progress_bar.rb",
1848
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/progress_bar_preview/default/",
1849
+ "parameters": [
1850
+ {
1851
+ "name": "size",
1852
+ "type": "Symbol",
1853
+ "default": "`:default`",
1854
+ "description": "One of `:default`, `:large`, or `:small`. Increases height."
1855
+ },
1856
+ {
1857
+ "name": "system_arguments",
1858
+ "type": "Hash",
1859
+ "default": "N/A",
1860
+ "description": "[System arguments](/system-arguments)"
1861
+ }
1862
+ ]
1863
+ },
1864
+ {
1865
+ "component": "RelativeTime",
1866
+ "status": "beta",
1867
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/relative_time.rb",
1868
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/relative_time_preview/default/",
1869
+ "parameters": [
1870
+ {
1871
+ "name": "datetime",
1872
+ "type": "Time",
1873
+ "default": "N/A",
1874
+ "description": "The time to be formatted."
1875
+ },
1876
+ {
1877
+ "name": "tense",
1878
+ "type": "Symbol",
1879
+ "default": "`:auto`",
1880
+ "description": "Which tense to use. One of `:auto`, `:future`, or `:past`."
1881
+ },
1882
+ {
1883
+ "name": "prefix",
1884
+ "type": "sring",
1885
+ "default": "`nil`",
1886
+ "description": "What to prefix the relative ime display with."
1887
+ },
1888
+ {
1889
+ "name": "second",
1890
+ "type": "Symbol",
1891
+ "default": "`SECOND_DEFAULT`",
1892
+ "description": "What format seconds should take. One of `nil`, `:numeric`, or `:two_digit`."
1893
+ },
1894
+ {
1895
+ "name": "minute",
1896
+ "type": "Symbol",
1897
+ "default": "`MINUTE_DEFAULT`",
1898
+ "description": "What format minues should take. One of `nil`, `:numeric`, or `:two_digit`."
1899
+ },
1900
+ {
1901
+ "name": "hour",
1902
+ "type": "Symbol",
1903
+ "default": "`HOUR_DEFAULT`",
1904
+ "description": "What format hours should take. One of `nil`, `:numeric`, or `:two_digit`."
1905
+ },
1906
+ {
1907
+ "name": "weekday",
1908
+ "type": "Symbol",
1909
+ "default": "`WEEKDAY_DEFAULT`",
1910
+ "description": "What format weekdays should take. One of `nil`, `:long`, `:narrow`, or `:short`."
1911
+ },
1912
+ {
1913
+ "name": "day",
1914
+ "type": "Symbol",
1915
+ "default": "`DAY_DEFAULT`",
1916
+ "description": "What format days should take. One of `nil`, `:numeric`, or `:two_digit`."
1917
+ },
1918
+ {
1919
+ "name": "month",
1920
+ "type": "Symbol",
1921
+ "default": "`MONTH_DEFAULT`",
1922
+ "description": "What format months should take. One of `nil`, `:long`, `:narrow`, `:numeric`, `:short`, or `:two_digit`."
1923
+ },
1924
+ {
1925
+ "name": "year",
1926
+ "type": "Symbol",
1927
+ "default": "`YEAR_DEFAULT`",
1928
+ "description": "What format years should take. One of `nil`, `:numeric`, or `:two_digit`."
1929
+ },
1930
+ {
1931
+ "name": "time_zone_name",
1932
+ "type": "Symbol",
1933
+ "default": "`TIMEZONENAME_DEFAULT`",
1934
+ "description": "What format the time zone should take. One of `nil`, `:long`, `:long_generic`, `:long_offset`, `:short`, `:short_generic`, or `:short_offset`."
1935
+ },
1936
+ {
1937
+ "name": "threshold",
1938
+ "type": "string",
1939
+ "default": "`nil`",
1940
+ "description": "The threshold, in ISO-8601 'durations' format, at which relative time displays become absolute."
1941
+ },
1942
+ {
1943
+ "name": "precision",
1944
+ "type": "Symbol",
1945
+ "default": "`PRECISION_DEFAULT`",
1946
+ "description": "The precision elapsed time should display. One of `nil`, `:day`, `:hour`, `:minute`, `:month`, `:second`, or `:year`."
1947
+ },
1948
+ {
1949
+ "name": "format",
1950
+ "type": "Symbol",
1951
+ "default": "`nil`",
1952
+ "description": "The format the display should take. One of `:auto`, `:elapsed`, or `:micro`."
1953
+ },
1954
+ {
1955
+ "name": "lang",
1956
+ "type": "string",
1957
+ "default": "`nil`",
1958
+ "description": "The language to use."
1959
+ },
1960
+ {
1961
+ "name": "title",
1962
+ "type": "string",
1963
+ "default": "`nil`",
1964
+ "description": "Provide a custom title to the element."
1965
+ },
1966
+ {
1967
+ "name": "system_arguments",
1968
+ "type": "Hash",
1969
+ "default": "N/A",
1970
+ "description": "[System arguments](/system-arguments)"
1971
+ }
1972
+ ]
1973
+ },
1974
+ {
1975
+ "component": "Spinner",
1976
+ "status": "beta",
1977
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/spinner.rb",
1978
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/spinner_preview/default/",
1979
+ "parameters": [
1980
+ {
1981
+ "name": "size",
1982
+ "type": "Symbol",
1983
+ "default": "`:medium`",
1984
+ "description": "One of `[:large, 64]`, `[:medium, 32]`, or `[:small, 16]`."
1985
+ },
1986
+ {
1987
+ "name": "style",
1988
+ "type": "String",
1989
+ "default": "`box-sizing: content-box; color: var(--color-icon-primary);`",
1990
+ "description": "Custom element styles."
1991
+ },
1992
+ {
1993
+ "name": "system_arguments",
1994
+ "type": "Hash",
1995
+ "default": "N/A",
1996
+ "description": "[System arguments](/system-arguments)"
1997
+ }
1998
+ ]
1999
+ },
2000
+ {
2001
+ "component": "Text",
2002
+ "status": "beta",
2003
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb",
2004
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text_preview/default/",
2005
+ "parameters": [
2006
+ {
2007
+ "name": "tag",
2008
+ "type": "Symbol",
2009
+ "default": "`:span`",
2010
+ "description": ""
2011
+ },
2012
+ {
2013
+ "name": "system_arguments",
2014
+ "type": "Hash",
2015
+ "default": "N/A",
2016
+ "description": "[System arguments](/system-arguments)"
2017
+ }
2018
+ ]
2019
+ },
2020
+ {
2021
+ "component": "Truncate",
2022
+ "status": "beta",
2023
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb",
2024
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate_preview/default/",
2025
+ "parameters": [
2026
+ {
2027
+ "name": "system_arguments",
2028
+ "type": "Hash",
2029
+ "default": "N/A",
2030
+ "description": "[System arguments](/system-arguments)"
2031
+ }
2032
+ ]
2033
+ },
2034
+ {
2035
+ "component": "Box",
2036
+ "status": "stable",
2037
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb",
2038
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box_preview/default/",
2039
+ "parameters": [
2040
+ {
2041
+ "name": "system_arguments",
2042
+ "type": "Hash",
2043
+ "default": "N/A",
2044
+ "description": "[System arguments](/system-arguments)"
2045
+ }
2046
+ ]
2047
+ },
2048
+ {
2049
+ "component": "Button",
2050
+ "status": "deprecated",
2051
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
2052
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button_preview/default/",
2053
+ "parameters": [
2054
+ {
2055
+ "name": "scheme",
2056
+ "type": "Symbol",
2057
+ "default": "`:default`",
2058
+ "description": "One of `:danger`, `:default`, `:invisible`, `:link`, `:outline`, or `:primary`."
2059
+ },
2060
+ {
2061
+ "name": "variant",
2062
+ "type": "Symbol",
2063
+ "default": "`nil`",
2064
+ "description": "DEPRECATED. One of `:medium` or `:small`."
2065
+ },
2066
+ {
2067
+ "name": "size",
2068
+ "type": "Symbol",
2069
+ "default": "`:medium`",
2070
+ "description": "One of `:medium` or `:small`."
2071
+ },
2072
+ {
2073
+ "name": "tag",
2074
+ "type": "Symbol",
2075
+ "default": "`:button`",
2076
+ "description": "One of `:a`, `:button`, or `:summary`."
2077
+ },
2078
+ {
2079
+ "name": "type",
2080
+ "type": "Symbol",
2081
+ "default": "`:button`",
2082
+ "description": "One of `:button`, `:reset`, or `:submit`."
2083
+ },
2084
+ {
2085
+ "name": "group_item",
2086
+ "type": "Boolean",
2087
+ "default": "`false`",
2088
+ "description": "Whether button is part of a ButtonGroup."
2089
+ },
2090
+ {
2091
+ "name": "block",
2092
+ "type": "Boolean",
2093
+ "default": "`false`",
2094
+ "description": "Whether button is full-width with `display: block`."
2095
+ },
2096
+ {
2097
+ "name": "dropdown",
2098
+ "type": "Boolean",
2099
+ "default": "`false`",
2100
+ "description": "Whether or not to render a dropdown caret."
2101
+ },
2102
+ {
2103
+ "name": "system_arguments",
2104
+ "type": "Hash",
2105
+ "default": "N/A",
2106
+ "description": "[System arguments](/system-arguments)"
2107
+ }
2108
+ ]
2109
+ },
2110
+ {
2111
+ "component": "DropdownMenu",
2112
+ "status": "deprecated",
2113
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/dropdown_menu_component.rb",
2114
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown_menu_preview/default/",
2115
+ "parameters": [
2116
+ {
2117
+ "name": "direction",
2118
+ "type": "Symbol",
2119
+ "default": "`:se`",
2120
+ "description": "One of `:e`, `:ne`, `:s`, `:se`, `:sw`, or `:w`."
2121
+ },
2122
+ {
2123
+ "name": "scheme",
2124
+ "type": "Symbol",
2125
+ "default": "`:default`",
2126
+ "description": "Pass `:dark` for dark mode theming"
2127
+ },
2128
+ {
2129
+ "name": "header",
2130
+ "type": "String",
2131
+ "default": "`nil`",
2132
+ "description": "Optional string to display as the header"
2133
+ },
2134
+ {
2135
+ "name": "system_arguments",
2136
+ "type": "Hash",
2137
+ "default": "N/A",
2138
+ "description": "[System arguments](/system-arguments)"
2139
+ }
2140
+ ]
2141
+ },
2142
+ {
2143
+ "component": "HellipButton",
2144
+ "status": "alpha",
2145
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/hellip_button.rb",
2146
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/hellip_button_preview/default/",
2147
+ "parameters": [
2148
+ {
2149
+ "name": "inline",
2150
+ "type": "Boolean",
2151
+ "default": "`false`",
2152
+ "description": "Whether or not the button is inline."
2153
+ },
2154
+ {
2155
+ "name": "system_arguments",
2156
+ "type": "Hash",
2157
+ "default": "N/A",
2158
+ "description": "[System arguments](/system-arguments)"
2159
+ }
2160
+ ]
2161
+ },
2162
+ {
2163
+ "component": "IconButton",
2164
+ "status": "deprecated",
2165
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb",
2166
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button_preview/default/",
2167
+ "parameters": [
2168
+ {
2169
+ "name": "scheme",
2170
+ "type": "Symbol",
2171
+ "default": "`:default`",
2172
+ "description": "One of `:danger` or `:default`."
2173
+ },
2174
+ {
2175
+ "name": "icon",
2176
+ "type": "String",
2177
+ "default": "N/A",
2178
+ "description": "Name of [Octicon](https://primer.style/octicons/) to use."
2179
+ },
2180
+ {
2181
+ "name": "tag",
2182
+ "type": "Symbol",
2183
+ "default": "N/A",
2184
+ "description": "One of `:a`, `:button`, or `:summary`."
2185
+ },
2186
+ {
2187
+ "name": "type",
2188
+ "type": "Symbol",
2189
+ "default": "N/A",
2190
+ "description": "One of `:button`, `:reset`, or `:submit`."
2191
+ },
2192
+ {
2193
+ "name": "aria-label",
2194
+ "type": "String",
2195
+ "default": "N/A",
2196
+ "description": "String that can be read by assistive technology. A label should be short and concise. See the accessibility section for more information."
2197
+ },
2198
+ {
2199
+ "name": "aria-description",
2200
+ "type": "String",
2201
+ "default": "N/A",
2202
+ "description": "String that can be read by assistive technology. A description can be longer as it is intended to provide more context and information. See the accessibility section for more information."
2203
+ },
2204
+ {
2205
+ "name": "tooltip_direction",
2206
+ "type": "Symbol",
2207
+ "default": "`:s`",
2208
+ "description": "One of `:e`, `:n`, `:ne`, `:nw`, `:s`, `:se`, `:sw`, or `:w`."
2209
+ },
2210
+ {
2211
+ "name": "box",
2212
+ "type": "Boolean",
2213
+ "default": "`false`",
2214
+ "description": "Whether the button is in a [BorderBox](/components/beta/borderbox). If `true`, the button will have the `Box-btn-octicon` class."
2215
+ },
2216
+ {
2217
+ "name": "system_arguments",
2218
+ "type": "Hash",
2219
+ "default": "N/A",
2220
+ "description": "[System arguments](/system-arguments)"
2221
+ }
2222
+ ]
2223
+ },
2224
+ {
2225
+ "component": "Layout",
2226
+ "status": "alpha",
2227
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb",
2228
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout_preview/default/",
2229
+ "parameters": [
2230
+ {
2231
+ "name": "responsive",
2232
+ "type": "Boolean",
2233
+ "default": "`false`",
2234
+ "description": "Whether to collapse layout to a single column at smaller widths."
2235
+ },
2236
+ {
2237
+ "name": "side",
2238
+ "type": "Symbol",
2239
+ "default": "`:right`",
2240
+ "description": "Which side to display the sidebar on. One of `:left` or `:right`."
2241
+ },
2242
+ {
2243
+ "name": "sidebar_col",
2244
+ "type": "Integer",
2245
+ "default": "`3`",
2246
+ "description": "Sidebar column width."
2247
+ },
2248
+ {
2249
+ "name": "system_arguments",
2250
+ "type": "Hash",
2251
+ "default": "N/A",
2252
+ "description": "[System arguments](/system-arguments)"
2253
+ }
2254
+ ]
2255
+ },
2256
+ {
2257
+ "component": "LocalTime",
2258
+ "status": "deprecated",
2259
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/local_time.rb",
2260
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/local_time_preview/default/",
2261
+ "parameters": [
2262
+ {
2263
+ "name": "datetime",
2264
+ "type": "DateTime",
2265
+ "default": "N/A",
2266
+ "description": "The date to parse"
2267
+ },
2268
+ {
2269
+ "name": "initial_text",
2270
+ "type": "String",
2271
+ "default": "`nil`",
2272
+ "description": "Text to render before component is initialized"
2273
+ },
2274
+ {
2275
+ "name": "weekday",
2276
+ "type": "Symbol",
2277
+ "default": "`:short`",
2278
+ "description": "One of `:long` or `:short`."
2279
+ },
2280
+ {
2281
+ "name": "year",
2282
+ "type": "Symbol",
2283
+ "default": "`:numeric`",
2284
+ "description": "One of `:2-digit` or `:numeric`."
2285
+ },
2286
+ {
2287
+ "name": "month",
2288
+ "type": "Symbol",
2289
+ "default": "`:short`",
2290
+ "description": "One of `:long` or `:short`."
2291
+ },
2292
+ {
2293
+ "name": "day",
2294
+ "type": "Symbol",
2295
+ "default": "`:numeric`",
2296
+ "description": "One of `:2-digit` or `:numeric`."
2297
+ },
2298
+ {
2299
+ "name": "hour",
2300
+ "type": "Symbol",
2301
+ "default": "`:numeric`",
2302
+ "description": "One of `:2-digit` or `:numeric`."
2303
+ },
2304
+ {
2305
+ "name": "minute",
2306
+ "type": "Symbol",
2307
+ "default": "`:numeric`",
2308
+ "description": "One of `:2-digit` or `:numeric`."
2309
+ },
2310
+ {
2311
+ "name": "second",
2312
+ "type": "Symbol",
2313
+ "default": "`:numeric`",
2314
+ "description": "One of `:2-digit` or `:numeric`."
2315
+ },
2316
+ {
2317
+ "name": "time_zone_name",
2318
+ "type": "Symbol",
2319
+ "default": "`:short`",
2320
+ "description": "One of `:long` or `:short`."
2321
+ },
2322
+ {
2323
+ "name": "system_arguments",
2324
+ "type": "Hash",
2325
+ "default": "N/A",
2326
+ "description": "[System arguments](/system-arguments)"
2327
+ }
2328
+ ]
2329
+ },
2330
+ {
2331
+ "component": "Navigation::Tab",
2332
+ "status": "alpha",
2333
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb",
2334
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab_preview/default/",
2335
+ "parameters": [
2336
+ {
2337
+ "name": "list",
2338
+ "type": "Boolean",
2339
+ "default": "`false`",
2340
+ "description": "Whether the Tab is an item in a `<ul>` list."
2341
+ },
2342
+ {
2343
+ "name": "selected",
2344
+ "type": "Boolean",
2345
+ "default": "`false`",
2346
+ "description": "Whether the Tab is selected or not."
2347
+ },
2348
+ {
2349
+ "name": "with_panel",
2350
+ "type": "Boolean",
2351
+ "default": "`false`",
2352
+ "description": "Whether the Tab has an associated panel."
2353
+ },
2354
+ {
2355
+ "name": "panel_id",
2356
+ "type": "String",
2357
+ "default": "`\"\"`",
2358
+ "description": "Only applies if `with_panel` is `true`. Unique id of panel."
2359
+ },
2360
+ {
2361
+ "name": "icon_classes",
2362
+ "type": "Boolean",
2363
+ "default": "`\"\"`",
2364
+ "description": "Classes that must always be applied to icons."
2365
+ },
2366
+ {
2367
+ "name": "wrapper_arguments",
2368
+ "type": "Hash",
2369
+ "default": "`{}`",
2370
+ "description": "[System arguments](/system-arguments) to be used in the `<li>` wrapper when the tab is an item in a list."
2371
+ },
2372
+ {
2373
+ "name": "system_arguments",
2374
+ "type": "Hash",
2375
+ "default": "N/A",
2376
+ "description": "[System arguments](/system-arguments)"
2377
+ }
2378
+ ]
2379
+ },
2380
+ {
2381
+ "component": "State",
2382
+ "status": "beta",
2383
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/state_component.rb",
2384
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/state_preview/default/",
2385
+ "parameters": [
2386
+ {
2387
+ "name": "title",
2388
+ "type": "String",
2389
+ "default": "N/A",
2390
+ "description": "`title` HTML attribute."
2391
+ },
2392
+ {
2393
+ "name": "scheme",
2394
+ "type": "Symbol",
2395
+ "default": "`:default`",
2396
+ "description": "Background color. One of `:closed`, `:default`, `:green`, `:merged`, `:open`, `:purple`, or `:red`."
2397
+ },
2398
+ {
2399
+ "name": "tag",
2400
+ "type": "Symbol",
2401
+ "default": "`:span`",
2402
+ "description": "HTML tag for element. One of `:div` or `:span`."
2403
+ },
2404
+ {
2405
+ "name": "size",
2406
+ "type": "Symbol",
2407
+ "default": "`:default`",
2408
+ "description": "One of `:default` or `:small`."
2409
+ },
2410
+ {
2411
+ "name": "system_arguments",
2412
+ "type": "Hash",
2413
+ "default": "N/A",
2414
+ "description": "[System arguments](/system-arguments)"
2415
+ }
2416
+ ]
2417
+ },
2418
+ {
2419
+ "component": "Subhead",
2420
+ "status": "beta",
2421
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/subhead_component.rb",
2422
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/subhead_preview/default/",
2423
+ "parameters": [
2424
+ {
2425
+ "name": "spacious",
2426
+ "type": "Boolean",
2427
+ "default": "`false`",
2428
+ "description": "Whether to add spacing to the Subhead."
2429
+ },
2430
+ {
2431
+ "name": "hide_border",
2432
+ "type": "Boolean",
2433
+ "default": "`false`",
2434
+ "description": "Whether to hide the border under the heading."
2435
+ },
2436
+ {
2437
+ "name": "system_arguments",
2438
+ "type": "Hash",
2439
+ "default": "N/A",
2440
+ "description": "[System arguments](/system-arguments)"
2441
+ }
2442
+ ]
2443
+ },
2444
+ {
2445
+ "component": "TabContainer",
2446
+ "status": "alpha",
2447
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tab_container_component.rb",
2448
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tab_container_preview/default/",
2449
+ "parameters": [
2450
+ {
2451
+ "name": "system_arguments",
2452
+ "type": "Hash",
2453
+ "default": "N/A",
2454
+ "description": "[System arguments](/system-arguments)"
2455
+ }
2456
+ ]
2457
+ },
2458
+ {
2459
+ "component": "TimeAgo",
2460
+ "status": "deprecated",
2461
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/time_ago_component.rb",
2462
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago_preview/default/",
2463
+ "parameters": [
2464
+ {
2465
+ "name": "time",
2466
+ "type": "Time",
2467
+ "default": "N/A",
2468
+ "description": "The time to be formatted"
2469
+ },
2470
+ {
2471
+ "name": "micro",
2472
+ "type": "Boolean",
2473
+ "default": "`false`",
2474
+ "description": "If true then the text will be formatted in \"micro\" mode, using as few characters as possible"
2475
+ },
2476
+ {
2477
+ "name": "system_arguments",
2478
+ "type": "Hash",
2479
+ "default": "N/A",
2480
+ "description": "[System arguments](/system-arguments)"
2481
+ }
2482
+ ]
2483
+ },
2484
+ {
2485
+ "component": "TimelineItem",
2486
+ "status": "beta",
2487
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/timeline_item_component.rb",
2488
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/timeline_item_preview/default/",
2489
+ "parameters": [
2490
+ {
2491
+ "name": "condensed",
2492
+ "type": "Boolean",
2493
+ "default": "`false`",
2494
+ "description": "Reduce the vertical padding and remove the background from the badge item. Most commonly used in commits."
2495
+ },
2496
+ {
2497
+ "name": "system_arguments",
2498
+ "type": "Hash",
2499
+ "default": "N/A",
2500
+ "description": "[System arguments](/system-arguments)"
2501
+ }
2502
+ ]
2503
+ },
2504
+ {
2505
+ "component": "Tooltip",
2506
+ "status": "deprecated",
2507
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tooltip.rb",
2508
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip_preview/default/",
2509
+ "parameters": [
2510
+ {
2511
+ "name": "label",
2512
+ "type": "String",
2513
+ "default": "N/A",
2514
+ "description": "the text to appear in the tooltip"
2515
+ },
2516
+ {
2517
+ "name": "direction",
2518
+ "type": "String",
2519
+ "default": "`:n`",
2520
+ "description": "Direction of the tooltip. One of `:e`, `:n`, `:ne`, `:nw`, `:s`, `:se`, `:sw`, or `:w`."
2521
+ },
2522
+ {
2523
+ "name": "align",
2524
+ "type": "String",
2525
+ "default": "`:default`",
2526
+ "description": "Align tooltips to the left or right of an element, combined with a `direction` to specify north or south. One of `:default`, `:left_1`, `:left_2`, `:right_1`, or `:right_2`."
2527
+ },
2528
+ {
2529
+ "name": "multiline",
2530
+ "type": "Boolean",
2531
+ "default": "`false`",
2532
+ "description": "Use this when you have long content"
2533
+ },
2534
+ {
2535
+ "name": "no_delay",
2536
+ "type": "Boolean",
2537
+ "default": "`false`",
2538
+ "description": "By default the tooltips have a slight delay before appearing. Set true to override this"
2539
+ },
2540
+ {
2541
+ "name": "system_arguments",
2542
+ "type": "Hash",
2543
+ "default": "N/A",
2544
+ "description": "[System arguments](/system-arguments)"
2545
+ }
2546
+ ]
2547
+ },
2548
+ {
2549
+ "component": "Truncate",
2550
+ "status": "beta",
2551
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/truncate.rb",
2552
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate_preview/default/",
2553
+ "parameters": [
2554
+ {
2555
+ "name": "tag",
2556
+ "type": "Symbol",
2557
+ "default": "`:div`",
2558
+ "description": "One of `:div`, `:p`, `:span`, or `:strong`."
2559
+ },
2560
+ {
2561
+ "name": "inline",
2562
+ "type": "Boolean",
2563
+ "default": "`false`",
2564
+ "description": "Whether the element is inline (or inline-block)."
2565
+ },
2566
+ {
2567
+ "name": "expandable",
2568
+ "type": "Boolean",
2569
+ "default": "`false`",
2570
+ "description": "Whether the entire string should be revealed on hover. Can only be used in conjunction with `inline`."
2571
+ },
2572
+ {
2573
+ "name": "max_width",
2574
+ "type": "Integer",
2575
+ "default": "`nil`",
2576
+ "description": "Sets the max-width of the text."
2577
+ },
2578
+ {
2579
+ "name": "system_arguments",
2580
+ "type": "Hash",
2581
+ "default": "N/A",
2582
+ "description": "[System arguments](/system-arguments)"
2583
+ }
2584
+ ]
2585
+ }
2586
+ ]