primer_view_components 0.1.6 → 0.1.8

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",
@@ -91,6 +97,13 @@
           }
         ]
       },
+      {
+        "name": "id",
+        "description": "Returns the value of attribute id.",
+        "parameters": [
+
+        ]
+      },
       {
         "name": "select_variant",
         "description": "Returns the value of attribute select_variant.",
@@ -103,6 +116,13 @@
         "description": "Returns the value of attribute role.",
         "parameters": [
 
+        ]
+      },
+      {
+        "name": "post_list_content_block",
+        "description": "Returns the value of attribute post_list_content_block.",
+        "parameters": [
+
         ]
       }
     ],
@@ -260,6 +280,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",
@@ -455,12 +481,6 @@
         "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
         "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
         "parameters": [
-          {
-            "name": "id",
-            "type": "String",
-            "default": "`self.class.generate_id`",
-            "description": "The group's identifier (ID attribute in HTML)."
-          },
           {
             "name": "title",
             "type": "String",
@@ -485,12 +505,6 @@
             "default": "`:subtle`",
             "description": "Display a background color if scheme is `filled`."
           },
-          {
-            "name": "tag",
-            "type": "Integer",
-            "default": "N/A",
-            "description": "Semantic tag for the heading."
-          },
           {
             "name": "system_arguments",
             "type": "Hash",
@@ -503,8 +517,15 @@
         ],
         "methods": [
           {
-            "name": "id",
-            "description": "Returns the value of attribute id.",
+            "name": "title_id",
+            "description": "Returns the value of attribute title_id.",
+            "parameters": [
+
+            ]
+          },
+          {
+            "name": "subtitle_id",
+            "description": "Returns the value of attribute subtitle_id.",
             "parameters": [
 
             ]
@@ -517,9 +538,34 @@
 
         ]
       },
+      {
+        "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.",
+        "description": "Separator with optional text rendered above groups or between individual items.",
         "component": "ActionList::Divider",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -557,7 +603,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 +629,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 +663,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 +679,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": [
       {
@@ -669,13 +750,6 @@
           }
         ]
       },
-      {
-        "name": "items",
-        "description": "Retrieves the list of items.",
-        "parameters": [
-
-        ]
-      },
       {
         "name": "with_divider",
         "description": "Adds a divider to the list.",
@@ -705,6 +779,11 @@
         "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",
@@ -755,6 +834,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",
@@ -775,6 +864,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",
@@ -812,7 +906,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": [
@@ -846,6 +940,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",
@@ -1611,7 +1711,13 @@
       }
     ],
     "methods": [
+      {
+        "name": "id",
+        "description": "The dialog's ID value.",
+        "parameters": [
 
+        ]
+      }
     ],
     "previews": [
       {
@@ -2817,20 +2923,57 @@
     ],
     "slots": [
       {
-        "name": "groups",
-        "description": "Groups. Each group is a list of links and an optional heading.",
+        "name": "heading",
+        "description": null,
+        "parameters": [
+
+        ]
+      },
+      {
+        "name": "items",
+        "description": "Items.",
         "parameters": [
           {
             "name": "system_arguments",
             "type": "Hash",
             "default": "N/A",
-            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Group{{/link_to_component}}."
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
           }
         ]
       }
     ],
     "methods": [
+      {
+        "name": "with_group",
+        "description": "Groups. Each group is a list of links and a (required) heading.",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Group{{/link_to_component}}."
+          }
+        ]
+      },
+      {
+        "name": "with_divider",
+        "description": "Adds a divider to the list of items.",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Divider{{/link_to_component}}."
+          }
+        ]
+      },
+      {
+        "name": "render_outer_list?",
+        "description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
+        "parameters": [
 
+        ]
+      }
     ],
     "previews": [
       {
@@ -2843,6 +2986,11 @@
         "preview_path": "/lookbook/preview/primer/alpha/nav_list/default",
         "name": "default"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/top_level_items",
+        "preview_path": "/lookbook/preview/primer/alpha/nav_list/top_level_items",
+        "name": "top_level_items"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/show_more_item",
         "preview_path": "/lookbook/preview/primer/alpha/nav_list/show_more_item",
@@ -3005,6 +3153,42 @@
 
         ]
       },
+      {
+        "fully_qualified_name": "Primer::Alpha::NavList::Divider",
+        "description": "Separator with optional text rendered above groups or between individual items.",
+        "component": "NavList::Divider",
+        "status": "alpha",
+        "a11y_reviewed": false,
+        "short_name": "NavListDivider",
+        "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
+        "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
+        "parameters": [
+          {
+            "name": "scheme",
+            "type": "Symbol",
+            "default": "`:subtle`",
+            "description": "Display a background color if scheme is `filled`."
+          },
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "{{link_to_system_arguments_docs}}"
+          }
+        ],
+        "slots": [
+
+        ],
+        "methods": [
+
+        ],
+        "previews": [
+
+        ],
+        "subcomponents": [
+
+        ]
+      },
       {
         "fully_qualified_name": "Primer::Alpha::NavList::Group",
         "description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
@@ -5556,13 +5740,7 @@
           }
         ],
         "methods": [
-          {
-            "name": "description_variant_class",
-            "description": "Description variant class.",
-            "parameters": [
 
-            ]
-          }
         ],
         "previews": [
           {
@@ -6440,6 +6618,11 @@
         "preview_path": "/lookbook/preview/primer/beta/button/trailing_action",
         "name": "trailing_action"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/beta/button/trailing_counter",
+        "preview_path": "/lookbook/preview/primer/beta/button/trailing_counter",
+        "name": "trailing_counter"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/beta/button/with_tooltip",
         "preview_path": "/lookbook/preview/primer/beta/button/with_tooltip",
@@ -8315,7 +8498,26 @@
 
     ],
     "previews": [
-
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/playground",
+        "preview_path": "/lookbook/preview/primer/box/playground",
+        "name": "playground"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/default",
+        "preview_path": "/lookbook/preview/primer/box/default",
+        "name": "default"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/border",
+        "preview_path": "/lookbook/preview/primer/box/border",
+        "name": "border"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/border_bottom",
+        "preview_path": "/lookbook/preview/primer/box/border_bottom",
+        "name": "border_bottom"
+      }
     ],
     "subcomponents": [
 

data/static/previews.json

@@ -133,6 +133,11 @@
         "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",
@@ -183,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",
@@ -203,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",
@@ -567,6 +587,34 @@
       }
     ]
   },
+  {
+    "name": "box",
+    "component": "Box",
+    "status": "stable",
+    "lookup_path": "primer/box",
+    "examples": [
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/playground",
+        "preview_path": "/lookbook/preview/primer/box/playground",
+        "name": "playground"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/default",
+        "preview_path": "/lookbook/preview/primer/box/default",
+        "name": "default"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/border",
+        "preview_path": "/lookbook/preview/primer/box/border",
+        "name": "border"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/box/border_bottom",
+        "preview_path": "/lookbook/preview/primer/box/border_bottom",
+        "name": "border_bottom"
+      }
+    ]
+  },
   {
     "name": "breadcrumbs",
     "component": "Breadcrumbs",
@@ -656,6 +704,11 @@
         "preview_path": "/lookbook/preview/primer/beta/button/trailing_action",
         "name": "trailing_action"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/beta/button/trailing_counter",
+        "preview_path": "/lookbook/preview/primer/beta/button/trailing_counter",
+        "name": "trailing_counter"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/beta/button/with_tooltip",
         "preview_path": "/lookbook/preview/primer/beta/button/with_tooltip",
@@ -1298,6 +1351,11 @@
         "preview_path": "/lookbook/preview/primer/alpha/nav_list/default",
         "name": "default"
       },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/top_level_items",
+        "preview_path": "/lookbook/preview/primer/alpha/nav_list/top_level_items",
+        "name": "top_level_items"
+      },
       {
         "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/show_more_item",
         "preview_path": "/lookbook/preview/primer/alpha/nav_list/show_more_item",

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",
@@ -30,6 +31,7 @@
   "Primer::Alpha::Menu": "alpha",
   "Primer::Alpha::MultiInput": "alpha",
   "Primer::Alpha::NavList": "alpha",
+  "Primer::Alpha::NavList::Divider": "alpha",
   "Primer::Alpha::NavList::Group": "alpha",
   "Primer::Alpha::NavList::Item": "alpha",
   "Primer::Alpha::Navigation::Tab": "alpha",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -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
@@ -487,6 +489,8 @@ files:
 - app/components/primer/alpha/nav_list.js
 - app/components/primer/alpha/nav_list.rb
 - app/components/primer/alpha/nav_list.ts
+- app/components/primer/alpha/nav_list/divider.rb
+- app/components/primer/alpha/nav_list/group.html.erb
 - app/components/primer/alpha/nav_list/group.rb
 - app/components/primer/alpha/nav_list/item.html.erb
 - app/components/primer/alpha/nav_list/item.rb
@@ -748,6 +752,7 @@ files:
 - app/forms/submit_button_form.rb
 - app/forms/text_field_and_checkbox_form.rb
 - app/helpers/primer/form_helper.rb
+- app/lib/primer/attributes_helper.rb
 - app/lib/primer/audited/dsl.rb
 - app/lib/primer/class_name_helper.rb
 - app/lib/primer/css/layout.css
@@ -941,7 +946,10 @@ files:
 - 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
@@ -1011,6 +1019,7 @@ files:
 - previews/primer/beta/button_preview/invisible_all_visuals.html.erb
 - previews/primer/beta/button_preview/leading_visual.html.erb
 - previews/primer/beta/button_preview/trailing_action.html.erb
+- previews/primer/beta/button_preview/trailing_counter.html.erb
 - previews/primer/beta/button_preview/trailing_visual.html.erb
 - previews/primer/beta/button_preview/with_tooltip.html.erb
 - previews/primer/beta/clipboard_copy_preview.rb
@@ -1035,6 +1044,7 @@ files:
 - previews/primer/beta/text_preview.rb
 - previews/primer/beta/timeline_item_preview.rb
 - previews/primer/beta/truncate_preview.rb
+- previews/primer/box_preview.rb
 - previews/primer/forms/forms_preview.rb
 - previews/primer/forms/forms_preview/after_content_form.html.erb
 - previews/primer/forms/forms_preview/array_check_box_group_form.html.erb