@primer/view-components 0.1.6-rc.edfe081c → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@primer/view-components",
3
- "version": "0.1.6-rc.edfe081c",
3
+ "version": "0.1.6",
4
4
  "description": "ViewComponents for the Primer Design System",
5
5
  "main": "app/assets/javascripts/primer_view_components.js",
6
6
  "module": "app/components/primer/primer.js",
@@ -647,13 +647,13 @@
647
647
  },
648
648
  {
649
649
  "name": "with_show_button",
650
- "description": "Button to activate the menu. This may be a {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}} or {{#link_to_component}}Primer::IconButton{{/link_to_component}}.",
650
+ "description": "Button to activate the menu.",
651
651
  "parameters": [
652
652
  {
653
- "name": "icon",
654
- "type": "Symbol",
653
+ "name": "system_arguments",
654
+ "type": "Hash",
655
655
  "default": "N/A",
656
- "description": "Set this to an [Octicon name](https://primer.style/octicons/) when you want to render an `IconButton`. Otherwise, this renders as a {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}}."
656
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot."
657
657
  }
658
658
  ]
659
659
  },
@@ -3352,10 +3352,22 @@
3352
3352
  "description": "Optional button to open the Overlay.",
3353
3353
  "parameters": [
3354
3354
  {
3355
- "name": "system_arguments",
3355
+ "name": "icon",
3356
+ "type": "String",
3357
+ "default": "N/A",
3358
+ "description": "Name of {{link_to_octicons}} to use instead of text. If provided, a {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}} will be rendered. Otherwise a {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} will be rendered."
3359
+ },
3360
+ {
3361
+ "name": "controls",
3362
+ "type": "String",
3363
+ "default": "N/A",
3364
+ "description": "The ID of the menu this button controls. Used internally."
3365
+ },
3366
+ {
3367
+ "name": "button_arguments",
3356
3368
  "type": "Hash",
3357
3369
  "default": "N/A",
3358
- "description": "The same arguments as {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}}."
3370
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Beta::Button{{/link_to_component}} or {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}} depending on the presence of the `icon:` argument."
3359
3371
  }
3360
3372
  ]
3361
3373
  },
@@ -3369,6 +3381,12 @@
3369
3381
  "default": "N/A",
3370
3382
  "description": "Show a divider between the header and body."
3371
3383
  },
3384
+ {
3385
+ "name": "size",
3386
+ "type": "Symbol",
3387
+ "default": "N/A",
3388
+ "description": "One of One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
3389
+ },
3372
3390
  {
3373
3391
  "name": "visually_hide_title",
3374
3392
  "type": "Boolean",