@primer/view-components 0.37.0-rc.8d1a0580 → 0.37.0-rc.a6eb8588

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/view-components",
-  "version": "0.37.0-rc.8d1a0580",
+  "version": "0.37.0-rc.a6eb8588",
   "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

@@ -1253,6 +1253,12 @@
         "default": "`false`",
         "description": "When set to `true`, the form control will take up all the horizontal space allowed by its container."
       },
+      {
+        "name": "label_arguments",
+        "type": "Hash",
+        "default": "`{}`",
+        "description": "HTML attributes to attach to the `<label>` element that labels the input."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",

package/static/info_arch.json

@@ -4279,8 +4279,8 @@
   },
   {
     "fully_qualified_name": "Primer::Alpha::FormControl",
-    "description": "Wraps an input (or arbitrary content) with a label above and a caption and validation message beneath.\nNOTE: This `FormControl` component is designed for wrapping inputs that aren't supported by the Primer\nforms framework.",
-    "accessibility_docs": null,
+    "description": "Wraps an input (or arbitrary content) with a label above and a caption and validation message beneath.\n\nNOTE: This `FormControl` component is designed for wrapping inputs that aren't supported by the Primer\nforms framework.",
+    "accessibility_docs": "Because `FormControl` does not manage the actual `<input>` element, it cannot semantically connect\nthe input and its associated label. For this and other reasons, consumers are highly encouraged to\nuse Primer's pre-made form components like `TextField`, etc, ideally via the Primer forms framework.\n\nUsers of the `FormControl` component will need to manually connect the label using the `for:`\nattribute, eg:\n\n```erb\n<%= form_with(url: \"/path/somewhere\") do |f| %>\n  <%= render(Primer::Alpha::FormControl.new(label_arguments: { for: \"bar\" })) do |component| %>\n    <% component.with_input do |input_arguments| %>\n      <%= f.text_field(:bar, **input_arguments) %>\n    <% end %>\n  <% end %>\n<% end %>\n```\n\nNote that the name of the field, `:bar`, is passed to both the Rails `#text_field` method _and_\nas part of the `label_arguments` passed to the `FormControl` constructor.\n\nSimilarly, `FormControl` cannot automatically connect the `<input>` element to the caption and\nvalidation message elements. The component attempts to mitigate this by including the correct\n`aria-describedby` attribute in the hash it yields to the block passed to `#with_input`. In the\nexample above, `input_arguments[:aria][:describedby]` contains the HTML IDs for both the caption\nand validation message elements, and can be passed directly to Rails' form helper methods. If the\ninput being wrapped is not generated by a Rails form helper, care must be taken to set\n`aria-describedby` manually on the input element.",
     "is_form_component": false,
     "is_published": true,
     "requires_js": false,
@@ -4327,6 +4327,12 @@
         "default": "`false`",
         "description": "When set to `true`, the form control will take up all the horizontal space allowed by its container."
       },
+      {
+        "name": "label_arguments",
+        "type": "Hash",
+        "default": "`{}`",
+        "description": "HTML attributes to attach to the `<label>` element that labels the input."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",
@@ -4351,7 +4357,36 @@
       }
     ],
     "methods": [
+      {
+        "name": "required?",
+        "description": "Whether or not this input is marked as required.",
+        "parameters": [
 
+        ],
+        "return_types": [
+          "Boolean"
+        ]
+      },
+      {
+        "name": "visually_hide_label?",
+        "description": "Whether or not to hide the label visually. The label will still be visible to screen readers.",
+        "parameters": [
+
+        ],
+        "return_types": [
+          "Boolean"
+        ]
+      },
+      {
+        "name": "full_width?",
+        "description": "Whether or not the form control should take up all the horizontal space allowed by its container.",
+        "parameters": [
+
+        ],
+        "return_types": [
+          "Boolean"
+        ]
+      }
     ],
     "previews": [
       {