primer_view_components 0.1.5 → 0.1.7

data/static/info_arch.json

@@ -45,6 +45,12 @@
         "default": "`:none`",
         "description": "How items may be selected in the list. One of `:multiple`, `:multiple_checkbox`, `:none`, or `:single`."
       },
+      {
+        "name": "form_arguments",
+        "type": "Hash",
+        "default": "`{}`",
+        "description": "Allows an `ActionList` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission. *NOTE*: Consider using an {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} instead of using this feature directly."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",
@@ -260,6 +266,12 @@
             "default": "`{}`",
             "description": "{{link_to_system_arguments_docs}} used to construct the item's anchor or button tag."
           },
+          {
+            "name": "form_arguments",
+            "type": "Hash",
+            "default": "`{}`",
+            "description": "Allows the item to submit a form on click. The URL passed in the `href:` option will be used as the form action. Pass the `method:` option to this hash to control what kind of request is made, One of `:delete`, `:get`, `:head`, `:patch`, `:post`, or `:put`. The `name:` option is required and specifies the desired name of the field that will be included in the params sent to the server on form submission. Specify the `value:` option to send a custom value to the server; otherwise the value of `name:` is sent."
+          },
           {
             "name": "truncate_label",
             "type": "Boolean",
@@ -517,6 +529,31 @@
 
         ]
       },
+      {
+        "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
+        "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
+        "component": "ActionList::FormWrapper",
+        "status": "alpha",
+        "a11y_reviewed": false,
+        "short_name": "ActionListFormWrapper",
+        "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
+        "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
+        "parameters": [
+
+        ],
+        "slots": [
+
+        ],
+        "methods": [
+
+        ],
+        "previews": [
+
+        ],
+        "subcomponents": [
+
+        ]
+      },
       {
         "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
         "description": "Group heading rendered above the group contents.",
@@ -557,7 +594,7 @@
   },
   {
     "fully_qualified_name": "Primer::Alpha::ActionMenu",
-    "description": "The ActionMenu should be used when a user can select a single option triggering an action from a list of items. Primer will automatically nest an `Item` within a presentational `<li>` tag.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. If one isn't selected, a fallback `:span` will be used. To add functionality, use a `.js` class to create the functionality, or an `onclick` handler.",
+    "description": "ActionMenu is used for actions, navigation, to display secondary options, or single/multi select lists. They appear when users interact with buttons, actions, or other controls.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. The default is `:button`.",
     "component": "ActionMenu",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -583,6 +620,12 @@
         "default": "`:outside_bottom`",
         "description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.."
       },
+      {
+        "name": "size",
+        "type": "Symbol",
+        "default": "`:auto`",
+        "description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
+      },
       {
         "name": "src",
         "type": "String",
@@ -611,7 +654,13 @@
         "name": "select_variant",
         "type": "Symbol",
         "default": "`:none`",
-        "description": ". One of `:multiple`, `:none`, or `:single`.."
+        "description": "One of `:multiple`, `:none`, or `:single`."
+      },
+      {
+        "name": "form_arguments",
+        "type": "Hash",
+        "default": "`{}`",
+        "description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission."
       },
       {
         "name": "system_arguments",
@@ -621,7 +670,30 @@
       }
     ],
     "slots": [
-
+      {
+        "name": "show_button",
+        "description": "Button to activate the menu.",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot."
+          }
+        ]
+      },
+      {
+        "name": "items",
+        "description": "Adds a new item to the list.",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
+          }
+        ]
+      }
     ],
     "methods": [
       {
@@ -647,13 +719,13 @@
       },
       {
         "name": "with_show_button",
-        "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}}.",
+        "description": "Button to activate the menu.",
         "parameters": [
           {
-            "name": "icon",
-            "type": "Symbol",
+            "name": "system_arguments",
+            "type": "Hash",
             "default": "N/A",
-            "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}}."
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot."
           }
         ]
       },
@@ -669,13 +741,6 @@
           }
         ]
       },
-      {
-        "name": "items",
-        "description": "Retrieves the list of items.",
-        "parameters": [
-
-        ]
-      },
       {
         "name": "with_divider",
         "description": "Adds a divider to the list.",
@@ -695,11 +760,21 @@
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/playground",
         "name": "playground"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/content_labels",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/content_labels",
+        "name": "content_labels"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/default",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/default",
         "name": "default"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/wide",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/wide",
+        "name": "wide"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_icon_button",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/with_icon_button",
@@ -750,6 +825,16 @@
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/with_actions",
         "name": "with_actions"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/single_select_form",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/single_select_form",
+        "name": "single_select_form"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/multiple_select_form",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/multiple_select_form",
+        "name": "multiple_select_form"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_disabled_items",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/with_disabled_items",
@@ -770,6 +855,11 @@
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/block_description",
         "name": "block_description"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/submitting_forms",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/submitting_forms",
+        "name": "submitting_forms"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/inline_description",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/inline_description",
@@ -807,7 +897,7 @@
             "name": "system_arguments",
             "type": "Hash",
             "default": "N/A",
-            "description": "{{link_to_system_arguments_docs}}"
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList{{/link_to_component}}"
           }
         ],
         "slots": [
@@ -841,6 +931,12 @@
             "name": "with_item",
             "description": "Adds a new item to the list.",
             "parameters": [
+              {
+                "name": "data",
+                "type": "Hash",
+                "default": "`{}`",
+                "description": "When the menu is used as a form input (see the {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} docs), the label is submitted to the server by default. However, if the `data: { value: }` or `\"data-value\":` attribute is provided, it will be sent to the server instead."
+              },
               {
                 "name": "system_arguments",
                 "type": "Hash",
@@ -3347,10 +3443,22 @@
         "description": "Optional button to open the Overlay.",
         "parameters": [
           {
-            "name": "system_arguments",
+            "name": "icon",
+            "type": "String",
+            "default": "N/A",
+            "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."
+          },
+          {
+            "name": "controls",
+            "type": "String",
+            "default": "N/A",
+            "description": "The ID of the menu this button controls. Used internally."
+          },
+          {
+            "name": "button_arguments",
             "type": "Hash",
             "default": "N/A",
-            "description": "The same arguments as {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}}."
+            "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."
           }
         ]
       },
@@ -3364,6 +3472,12 @@
             "default": "N/A",
             "description": "Show a divider between the header and body."
           },
+          {
+            "name": "size",
+            "type": "Symbol",
+            "default": "N/A",
+            "description": "One of One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
+          },
           {
             "name": "visually_hide_title",
             "type": "Boolean",
@@ -5286,6 +5400,12 @@
         "default": "`false`",
         "description": "Input can be full-width or fit to content"
       },
+      {
+        "name": "width",
+        "type": "String",
+        "default": "`:auto`",
+        "description": "Optional parameter to set max width of results list. One of `:auto`, `:large`, `:medium`, `:small`, `:xlarge`, or `:xxlarge`."
+      },
       {
         "name": "disabled",
         "type": "Boolean",
@@ -5527,13 +5647,7 @@
           }
         ],
         "methods": [
-          {
-            "name": "description_variant_class",
-            "description": "Description variant class.",
-            "parameters": [
 
-            ]
-          }
         ],
         "previews": [
           {

data/static/previews.json

@@ -123,11 +123,21 @@
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/playground",
         "name": "playground"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/content_labels",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/content_labels",
+        "name": "content_labels"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/default",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/default",
         "name": "default"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/wide",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/wide",
+        "name": "wide"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_icon_button",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/with_icon_button",
@@ -178,6 +188,16 @@
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/with_actions",
         "name": "with_actions"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/single_select_form",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/single_select_form",
+        "name": "single_select_form"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/multiple_select_form",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/multiple_select_form",
+        "name": "multiple_select_form"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/with_disabled_items",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/with_disabled_items",
@@ -198,6 +218,11 @@
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/block_description",
         "name": "block_description"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/submitting_forms",
+        "preview_path": "/lookbook/preview/primer/alpha/action_menu/submitting_forms",
+        "name": "submitting_forms"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/action_menu/inline_description",
         "preview_path": "/lookbook/preview/primer/alpha/action_menu/inline_description",

data/static/statuses.json

@@ -1,6 +1,7 @@
 {
   "Primer::Alpha::ActionList": "alpha",
   "Primer::Alpha::ActionList::Divider": "alpha",
+  "Primer::Alpha::ActionList::FormWrapper": "alpha",
   "Primer::Alpha::ActionList::Heading": "alpha",
   "Primer::Alpha::ActionList::Item": "alpha",
   "Primer::Alpha::ActionMenu": "alpha",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -146,16 +146,16 @@ dependencies:
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: erblint-github
   requirement: !ruby/object:Gem::Requirement
@@ -401,6 +401,8 @@ files:
 - app/components/primer/alpha/action_list.pcss
 - app/components/primer/alpha/action_list.rb
 - app/components/primer/alpha/action_list/divider.rb
+- app/components/primer/alpha/action_list/form_wrapper.html.erb
+- app/components/primer/alpha/action_list/form_wrapper.rb
 - app/components/primer/alpha/action_list/heading.html.erb
 - app/components/primer/alpha/action_list/heading.rb
 - app/components/primer/alpha/action_list/item.html.erb
@@ -940,7 +942,11 @@ files:
 - previews/primer/alpha/action_list_preview.rb
 - previews/primer/alpha/action_menu_preview.rb
 - previews/primer/alpha/action_menu_preview/align_end.html.erb
+- previews/primer/alpha/action_menu_preview/content_labels.html.erb
+- previews/primer/alpha/action_menu_preview/multiple_select_form.html.erb
 - previews/primer/alpha/action_menu_preview/opens_dialog.html.erb
+- previews/primer/alpha/action_menu_preview/single_select_form.html.erb
+- previews/primer/alpha/action_menu_preview/submitting_forms.html.erb
 - previews/primer/alpha/auto_complete_preview.rb
 - previews/primer/alpha/banner_preview.rb
 - previews/primer/alpha/banner_preview/with_action_button.html.erb