@primer/view-components 0.14.1-rc.758f7715 → 0.15.0-rc.2eb37d37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/view-components",
-  "version": "0.14.1-rc.758f7715",
+  "version": "0.15.0-rc.2eb37d37",
   "description": "ViewComponents for the Primer Design System",
   "main": "app/assets/javascripts/primer_view_components.js",
   "module": "app/components/primer/primer.js",

package/static/arguments.json

@@ -386,12 +386,97 @@
     ]
   },
   {
-    "component": "ActionMenu::List",
+    "component": "ActionMenu::Group",
     "status": "alpha",
     "a11y_reviewed": true,
+    "short_name": "ActionMenuGroup",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/group.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/group/default/",
+    "parameters": [
+      {
+        "name": "id",
+        "type": "String",
+        "default": "`self.class.generate_id`",
+        "description": "HTML ID value."
+      },
+      {
+        "name": "role",
+        "type": "Boolean",
+        "default": "`nil`",
+        "description": "ARIA role describing the function of the list. listbox and menu are a common values."
+      },
+      {
+        "name": "item_classes",
+        "type": "String",
+        "default": "`nil`",
+        "description": "Additional CSS classes to attach to items."
+      },
+      {
+        "name": "scheme",
+        "type": "Symbol",
+        "default": "`:full`",
+        "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."
+      },
+      {
+        "name": "show_dividers",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Display a divider above each item in the list when it does not follow a header or divider."
+      },
+      {
+        "name": "select_variant",
+        "type": "Symbol",
+        "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 [ActionMenu](/components/alpha/actionmenu) instead of using this feature directly."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "ActionMenu::Heading",
+    "status": "alpha",
+    "a11y_reviewed": false,
+    "short_name": "ActionMenuHeading",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/heading.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/heading/default/",
+    "parameters": [
+
+    ]
+  },
+  {
+    "component": "ActionMenu::List",
+    "status": "alpha",
+    "a11y_reviewed": false,
     "short_name": "ActionMenuList",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb",
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/",
+    "parameters": [
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "The arguments accepted by [ActionMenu::List](/components/alpha/actionmenulist)"
+      }
+    ]
+  },
+  {
+    "component": "ActionMenu::ListWrapper",
+    "status": "alpha",
+    "a11y_reviewed": true,
+    "short_name": "ActionMenuListWrapper",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list_wrapper.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list_wrapper/default/",
     "parameters": [
       {
         "name": "menu_id",

package/static/audited_at.json

@@ -8,7 +8,10 @@
   "Primer::Alpha::ActionList::Heading": "",
   "Primer::Alpha::ActionList::Item": "",
   "Primer::Alpha::ActionMenu": "",
-  "Primer::Alpha::ActionMenu::List": "2023-07-10",
+  "Primer::Alpha::ActionMenu::Group": "2023-07-10",
+  "Primer::Alpha::ActionMenu::Heading": "",
+  "Primer::Alpha::ActionMenu::List": "",
+  "Primer::Alpha::ActionMenu::ListWrapper": "2023-07-10",
   "Primer::Alpha::AutoComplete": "",
   "Primer::Alpha::AutoComplete::Item": "",
   "Primer::Alpha::Banner": "",

package/static/constants.json

@@ -125,13 +125,20 @@
   "Primer::Alpha::ActionMenu": {
     "DEFAULT_PRELOAD": false,
     "DEFAULT_SELECT_VARIANT": "none",
+    "Group": "Primer::Alpha::ActionMenu::Group",
+    "Heading": "Primer::Alpha::ActionMenu::Heading",
     "List": "Primer::Alpha::ActionMenu::List",
+    "ListWrapper": "Primer::Alpha::ActionMenu::ListWrapper",
     "SELECT_VARIANT_OPTIONS": [
       "single",
       "multiple",
       "none"
     ]
   },
+  "Primer::Alpha::ActionMenu::Group": {
+  },
+  "Primer::Alpha::ActionMenu::Heading": {
+  },
   "Primer::Alpha::ActionMenu::List": {
     "DEFAULT_ITEM_TAG": "button",
     "ITEM_TAG_OPTIONS": [
@@ -140,6 +147,8 @@
       "button"
     ]
   },
+  "Primer::Alpha::ActionMenu::ListWrapper": {
+  },
   "Primer::Alpha::AutoComplete": {
     "Item": "Primer::Alpha::AutoComplete::Item"
   },

package/static/info_arch.json

@@ -264,11 +264,17 @@
         "name": "heading",
         "description": "Heading text rendered above the list of items.",
         "parameters": [
+          {
+            "name": "component_klass",
+            "type": "Class",
+            "default": "N/A",
+            "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+          },
           {
             "name": "system_arguments",
             "type": "Hash",
             "default": "N/A",
-            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+            "description": "The arguments accepted by `component_klass`."
           }
         ]
       },
@@ -1374,6 +1380,32 @@
           ]
         }
       },
+      {
+        "preview_path": "primer/alpha/action_menu/with_groups",
+        "name": "with_groups",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/alpha/action_menu/with_items_and_groups",
+        "name": "with_items_and_groups",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
       {
         "preview_path": "primer/alpha/action_menu/wide",
         "name": "wide",
@@ -1684,10 +1716,79 @@
         "requires_js": false,
         "component": "ActionMenu::List",
         "status": "alpha",
-        "a11y_reviewed": true,
+        "a11y_reviewed": false,
         "short_name": "ActionMenuList",
         "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list.rb",
         "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list/default/",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::List{{/link_to_component}}"
+          }
+        ],
+        "slots": [
+
+        ],
+        "methods": [
+          {
+            "name": "items",
+            "description": "Returns the value of attribute items.",
+            "parameters": [
+
+            ]
+          }
+        ],
+        "previews": [
+
+        ],
+        "subcomponents": [
+
+        ]
+      },
+      {
+        "fully_qualified_name": "Primer::Alpha::ActionMenu::Heading",
+        "description": "Heading used to describe groups within an action menu.",
+        "accessibility_docs": null,
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
+        "component": "ActionMenu::Heading",
+        "status": "alpha",
+        "a11y_reviewed": false,
+        "short_name": "ActionMenuHeading",
+        "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/heading.rb",
+        "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/heading/default/",
+        "parameters": [
+
+        ],
+        "slots": [
+
+        ],
+        "methods": [
+
+        ],
+        "previews": [
+
+        ],
+        "subcomponents": [
+
+        ]
+      },
+      {
+        "fully_qualified_name": "Primer::Alpha::ActionMenu::ListWrapper",
+        "description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.",
+        "accessibility_docs": null,
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
+        "component": "ActionMenu::ListWrapper",
+        "status": "alpha",
+        "a11y_reviewed": true,
+        "short_name": "ActionMenuListWrapper",
+        "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/list_wrapper.rb",
+        "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/list_wrapper/default/",
         "parameters": [
           {
             "name": "menu_id",
@@ -1707,11 +1808,17 @@
             "name": "heading",
             "description": "Heading text rendered above the list of items.",
             "parameters": [
+              {
+                "name": "component_klass",
+                "type": "Class",
+                "default": "N/A",
+                "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+              },
               {
                 "name": "system_arguments",
                 "type": "Hash",
                 "default": "N/A",
-                "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+                "description": "The arguments accepted by `component_klass`."
               }
             ]
           },
@@ -1724,69 +1831,115 @@
           }
         ],
         "methods": [
+
+        ],
+        "previews": [
+
+        ],
+        "subcomponents": [
+
+        ]
+      },
+      {
+        "fully_qualified_name": "Primer::Alpha::ActionMenu::Group",
+        "description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.",
+        "accessibility_docs": null,
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
+        "component": "ActionMenu::Group",
+        "status": "alpha",
+        "a11y_reviewed": true,
+        "short_name": "ActionMenuGroup",
+        "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu/group.rb",
+        "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/group/default/",
+        "parameters": [
+          {
+            "name": "id",
+            "type": "String",
+            "default": "`self.class.generate_id`",
+            "description": "HTML ID value."
+          },
+          {
+            "name": "role",
+            "type": "Boolean",
+            "default": "`nil`",
+            "description": "ARIA role describing the function of the list. listbox and menu are a common values."
+          },
+          {
+            "name": "item_classes",
+            "type": "String",
+            "default": "`nil`",
+            "description": "Additional CSS classes to attach to items."
+          },
           {
-            "name": "with_item",
-            "description": "Adds a new item to the list.",
+            "name": "scheme",
+            "type": "Symbol",
+            "default": "`:full`",
+            "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."
+          },
+          {
+            "name": "show_dividers",
+            "type": "Boolean",
+            "default": "`false`",
+            "description": "Display a divider above each item in the list when it does not follow a header or divider."
+          },
+          {
+            "name": "select_variant",
+            "type": "Symbol",
+            "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",
+            "default": "N/A",
+            "description": "{{link_to_system_arguments_docs}}"
+          }
+        ],
+        "slots": [
+          {
+            "name": "heading",
+            "description": "Heading text rendered above the list of items.",
             "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": "component_klass",
+                "type": "Class",
+                "default": "N/A",
+                "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
               },
               {
                 "name": "system_arguments",
                 "type": "Hash",
                 "default": "N/A",
-                "description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
+                "description": "The arguments accepted by `component_klass`."
               }
             ]
           },
           {
-            "name": "with_avatar_item",
-            "description": "Adds an avatar item to the list. Avatar items are a convenient way to accessibly add an item with a leading avatar image.",
+            "name": "items",
+            "description": "Items. Items can be individual items, avatar items, or dividers. See the documentation for `#with_item`, `#with_divider`, and `#with_avatar_item` respectively for more information.",
+            "parameters": [
+
+            ]
+          }
+        ],
+        "methods": [
+          {
+            "name": "with_heading",
+            "description": "Heading text rendered above the list of items.",
             "parameters": [
-              {
-                "name": "src",
-                "type": "String",
-                "default": "N/A",
-                "description": "The source url of the avatar image."
-              },
-              {
-                "name": "username",
-                "type": "String",
-                "default": "N/A",
-                "description": "The username associated with the avatar."
-              },
-              {
-                "name": "full_name",
-                "type": "String",
-                "default": "`nil`",
-                "description": "Optional. The user's full name."
-              },
-              {
-                "name": "full_name_scheme",
-                "type": "Symbol",
-                "default": "`:block`",
-                "description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
-              },
-              {
-                "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": "avatar_arguments",
-                "type": "Hash",
-                "default": "`{}`",
-                "description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}."
-              },
               {
                 "name": "system_arguments",
                 "type": "Hash",
                 "default": "N/A",
-                "description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
+                "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionMenu::Heading{{/link_to_component}}."
               }
             ]
           }
@@ -5266,11 +5419,17 @@
             "name": "heading",
             "description": "Heading text rendered above the list of items.",
             "parameters": [
+              {
+                "name": "component_klass",
+                "type": "Class",
+                "default": "N/A",
+                "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+              },
               {
                 "name": "system_arguments",
                 "type": "Hash",
                 "default": "N/A",
-                "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+                "description": "The arguments accepted by `component_klass`."
               }
             ]
           }
@@ -13191,11 +13350,17 @@
             "name": "heading",
             "description": "Heading text rendered above the list of items.",
             "parameters": [
+              {
+                "name": "component_klass",
+                "type": "Class",
+                "default": "N/A",
+                "description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+              },
               {
                 "name": "system_arguments",
                 "type": "Hash",
                 "default": "N/A",
-                "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
+                "description": "The arguments accepted by `component_klass`."
               }
             ]
           }

package/static/previews.json

@@ -424,6 +424,32 @@
           ]
         }
       },
+      {
+        "preview_path": "primer/alpha/action_menu/with_groups",
+        "name": "with_groups",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/alpha/action_menu/with_items_and_groups",
+        "name": "with_items_and_groups",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
       {
         "preview_path": "primer/alpha/action_menu/wide",
         "name": "wide",

package/static/statuses.json

@@ -8,7 +8,10 @@
   "Primer::Alpha::ActionList::Heading": "alpha",
   "Primer::Alpha::ActionList::Item": "alpha",
   "Primer::Alpha::ActionMenu": "alpha",
+  "Primer::Alpha::ActionMenu::Group": "alpha",
+  "Primer::Alpha::ActionMenu::Heading": "alpha",
   "Primer::Alpha::ActionMenu::List": "alpha",
+  "Primer::Alpha::ActionMenu::ListWrapper": "alpha",
   "Primer::Alpha::AutoComplete": "deprecated",
   "Primer::Alpha::AutoComplete::Item": "deprecated",
   "Primer::Alpha::Banner": "alpha",