primer_view_components 0.1.8 → 0.1.9

data/static/info_arch.json

@@ -2,6 +2,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::ActionList",
     "description": "An ActionList is a styled list of links. It acts as the base component for many\nother menu-type components, including `ActionMenu` and `SelectPanel`, as well as\nthe navigational component `NavList`.\n\nEach item in an action list can be augmented by specifying corresponding leading\nand/or trailing visuals.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "ActionList",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -237,6 +240,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::ActionList::Item",
         "description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "ActionList::Item",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -474,6 +480,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::ActionList::Heading",
         "description": "Heading used to describe each sub list within an action list.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "ActionList::Heading",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -541,6 +550,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
         "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "ActionList::FormWrapper",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -566,6 +578,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
         "description": "Separator with optional text rendered above groups or between individual items.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "ActionList::Divider",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -604,6 +619,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::ActionMenu",
     "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`.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "ActionMenu",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -889,6 +907,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::ActionMenu::List",
         "description": "This component is part of {{#link_to_component}}Primer::Alpha::ActionMenu{{/link_to_component}} and should not be\nused as a standalone component.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "ActionMenu::List",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -967,6 +988,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::AutoComplete",
     "description": "Use `AutoComplete` to provide a user with a list of selectable suggestions that appear when they type into the\ninput field. This list is populated by server search results.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "AutoComplete",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -1096,6 +1120,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::AutoComplete::Item",
         "description": "Use `AutoCompleteItem` to list results of an auto-completed search.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "AutoComplete::Item",
         "status": "deprecated",
         "a11y_reviewed": false,
@@ -1146,6 +1173,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Banner",
     "description": "Use `Banner` to highlight important information.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "Banner",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -1258,6 +1288,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::ButtonMarketing",
     "description": "Use `ButtonMarketing` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "ButtonMarketing",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -1331,6 +1364,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::CheckBox",
     "description": "Check boxes are true/false inputs rendered as `<input type=\"checkbox\">` in HTML.\n\n## Schemes\n\nCheck boxes can submit values to the server using one of two schemes, either `:array`\nor `:boolean` (the default). Check boxes with a scheme of `:boolean` function like normal\nHTML check boxes. If they are checked, a value of \"1\" is sent to the server; if they are\nunchecked, a value of \"0\" is sent to the server. The checked and unchecked values can be\ncustomized via the `:value` and `:unchecked_value` arguments respectively.\n\nWhereas `:boolean` check boxes must have unique names, `:array` check boxes all have the\nsame name. On form submission, Rails will aggregate the values of the check boxes with the\nsame name and provide them to the controller as an array. If `:scheme:` is `:array`, the\n`:value` argument must also be provided. The `:unchecked_value` argument is ignored. If a\ncheck box is checked on submit, its corresponding value will appear in the array. If it is\nnot checked, its value will not appear in the array.\n\n## Caption templates\n\nCaption templates for `:array`-type check boxes work a little differently than they do for\nother input types. Because the name must be the same for all check boxes that make up an\narray, caption template file names are comprised of both the name _and_ the value of each\ncheck box. For example, a check box with the name `foo` and value `bar` must have a caption\ntemplate named `foo_bar_caption.html.erb`.\n\n## Nested Forms\n\nCheck boxes can have \"nested\" forms that are rendered below the caption. A common use-case\nis a form that is hidden until the check box is checked. Nested forms are indented slightly\nto align with the label and caption.\n\nDefine a nested form via the `#nested_form` method, which is expected to return an instance\nof a Primer form (see the usage section below).\n\nAny fields defined in the nested form are submitted along with the parent form's fields.\n\n**NOTE**: Check boxes do not automatically show or hide nested forms. If such behavior is\ndesired, it must be done by hand.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "CheckBox",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -1501,6 +1537,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::CheckBoxGroup",
     "description": "Check box groups consist of one or more related check boxes.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "CheckBoxGroup",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -1586,6 +1625,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Dialog",
     "description": "A `Dialog` is used to remove the user from the main application flow,\nto confirm actions, ask for disambiguation or to present small forms.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Dialog",
     "status": "alpha",
     "a11y_reviewed": true,
@@ -1770,6 +1812,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Dialog::Header",
         "description": "A `Dialog::Header` is a compositional component, used to render the\nHeader of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Dialog::Header",
         "status": "alpha",
         "a11y_reviewed": true,
@@ -1824,6 +1869,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
         "description": "A `Dialog::Footer` is a compositional component, used to render the\nFooter of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Dialog::Footer",
         "status": "alpha",
         "a11y_reviewed": true,
@@ -1860,6 +1908,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Dialog::Body",
         "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Dialog::Body",
         "status": "alpha",
         "a11y_reviewed": true,
@@ -1892,6 +1943,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Dropdown",
     "description": "`Dropdown` is a lightweight context menu for housing navigation and actions.\nThey're great for instances where you don't need the full power (and code) of the SelectMenu.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "Dropdown",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -1997,6 +2051,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Dropdown::Menu::Item",
         "description": "Items to be rendered in the `Dropdown` menu.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Dropdown::Menu::Item",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -2022,6 +2079,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Dropdown::Menu",
         "description": "This component is part of `Dropdown` and should not be\nused as a standalone component.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Dropdown::Menu",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -2095,6 +2155,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::FormButton",
     "description": "A button input rendered using the HTML `<button type=\"button\">` tag.\n\nThis component wraps the Primer button component and supports the same slots and arguments.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "FormButton",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2167,6 +2230,9 @@
   {
     "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.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "FormControl",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2260,6 +2326,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::HellipButton",
     "description": "Use `HellipButton` to render a button with a hellip. Often used for hidden text expanders.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "HellipButton",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2305,6 +2374,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::HiddenTextExpander",
     "description": "Use `HiddenTextExpander` to indicate and toggle hidden text.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "HiddenTextExpander",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2356,6 +2428,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Image",
     "description": "Use `Image` to render images.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Image",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2404,6 +2479,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::ImageCrop",
     "description": "A client-side mechanism to crop images.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "ImageCrop",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2471,6 +2549,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Layout",
     "description": "`Layout` provides foundational patterns for responsive pages.\n`Layout` can be used for simple two-column pages, or it can be nested to provide flexible 3-column experiences.\n On smaller screens, `Layout` uses vertically stacked rows to display content.\n\n`Layout` flows as both column, when there's enough horizontal space to render both `Main` and `Sidebar`side-by-side (on a desktop of tablet device, per instance);\nor it flows as a row, when `Main` and `Sidebar` are stacked vertically (e.g. on a mobile device).\n`Layout` should always work in any screen size.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Layout",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2602,6 +2683,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Layout::Sidebar",
         "description": "The layout's sidebar content.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Layout::Sidebar",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -2627,6 +2711,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Layout::Main",
         "description": "The layout's main content.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Layout::Main",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -2665,6 +2752,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Menu",
     "description": "Use `Menu` to create vertical lists of navigational links.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Menu",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2745,6 +2835,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::MultiInput",
     "description": "Multi inputs are comprised of multiple constituent fields, only one of which is visible\nat a given time. They are designed for situations where constituent inputs are shown or\nhidden based on the value of another field. For example, consider an address form. If\nthe user chooses the USA as the country, the region input should show a list of states\nand US territories; if the user instead chooses Canada, the region input should show a\nlist of Canadian provinces, etc.\n\nUnlike everywhere else in Primer forms, constituent inputs are not directly passed a\n`name` attribute. Instead, developers pass a `name` attribute to the multi input itself.\nThe multi input then automatically assigns each constituent input the same name. This is\ndone so that the multi input looks like a single field from the server's point of view.\nUsing the address form example from earlier, this means only one value - either a US state\nor a Canadian provice - will be submitted to the server under the `region` key.\n\nActually, that's not quite true. Constituent inputs _are_ given a `name`, but it's added to\nthe input as the `data-name` attribute as a way to identify constituent inputs, and will not\nbe sent to the server.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": true,
     "component": "MultiInput",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -2901,6 +2994,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::NavList",
     "description": "`NavList` provides a simple way to render side navigation, i.e. navigation\nthat appears to the left or right side of some main content. Each group in a\nnav list is a list of links.\n\nNav list groups can contain sub items. Rather than navigating to a URL, groups\nwith sub items expand and collapse on click. To indicate this functionality, the\ngroup will automatically render with a trailing chevron icon that changes direction\nwhen the group expands and collapses.\n\nNav list items appear visually active when selected. Each nav item must have one\nor more ID values that determine which item will appear selected. Use the\n`selected_item_id` argument to select the appropriate item.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "NavList",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -3006,6 +3102,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::NavList::Item",
         "description": "Items are rendered as styled links. They can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters. Items are selected by ID. IDs can be specified via the\n`selected_item_ids` argument, which accepts a list of valid IDs for the item. Items can also\nthemselves contain sub items. Sub items are rendered collapsed by default.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": true,
         "component": "NavList::Item",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -3156,6 +3255,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::NavList::Divider",
         "description": "Separator with optional text rendered above groups or between individual items.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "NavList::Divider",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -3192,6 +3294,9 @@
       {
         "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.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": true,
         "component": "NavList::Group",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -3289,6 +3394,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Navigation::Tab",
     "description": "This component is part of navigation components such as `Primer::Alpha::TabNav`\nand `Primer::Alpha::UnderlineNav` and should not be used by itself.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Navigation::Tab",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -3408,6 +3516,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::OcticonSymbols",
     "description": "OcticonSymbols renders a symbol dictionary using a list of {{link_to_octicons}}.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "OcticonSymbols",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -3438,6 +3549,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Overlay",
     "description": "Overlay components codify design patterns related to floating surfaces such\nas dialogs and menus. They are private components intended to be used by\nspecialized components, and mostly contain presentational logic and\nbehavior.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "Overlay",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -3645,12 +3759,20 @@
         "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page",
         "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page",
         "name": "middle_of_page"
+      },
+      {
+        "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page_with_relative_container",
+        "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page_with_relative_container",
+        "name": "middle_of_page_with_relative_container"
       }
     ],
     "subcomponents": [
       {
         "fully_qualified_name": "Primer::Alpha::Overlay::Header",
         "description": "A `Overlay::Header` is a compositional component, used to render the\nHeader of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Overlay::Header",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -3668,7 +3790,13 @@
             "name": "subtitle",
             "type": "String",
             "default": "`nil`",
-            "description": "Provides dditional context for the Overlay, also setting the `aria-describedby` attribute."
+            "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute."
+          },
+          {
+            "name": "overlay_id",
+            "type": "String",
+            "default": "`nil`",
+            "description": "Provides the id of the overlay element so the close button can close it"
           },
           {
             "name": "size",
@@ -3711,6 +3839,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Overlay::Footer",
         "description": "A `Overlay::Footer` is a compositional component, used to render the\nFooter of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Overlay::Footer",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -3753,6 +3884,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::Overlay::Body",
         "description": "A `Overlay::Body` is a compositional component, used to render the\nBody of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Overlay::Body",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -3785,6 +3919,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::RadioButton",
     "description": "Radio buttons represent one of a set of options and are rendered as `<input type=\"radio\">` in HTML.\n**NOTE**: You probably want to use the {{#link_to_component}}Primer::Alpha::RadioButtonGroup{{/link_to_component}}\ncomponent instead, as it allows rendering a group of options.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "RadioButton",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -3931,6 +4068,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::RadioButtonGroup",
     "description": "A group of mutually exclusive radio buttons.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "RadioButtonGroup",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4016,6 +4156,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::SegmentedControl",
     "description": "Use a segmented control to let users select an option from a short list and immediately apply the selection",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "SegmentedControl",
     "status": "alpha",
     "a11y_reviewed": true,
@@ -4106,6 +4249,9 @@
       {
         "fully_qualified_name": "Primer::Alpha::SegmentedControl::Item",
         "description": "SegmentedControl::Item is a private component that is only used by SegmentedControl\nIt wraps the Button and IconButton components to provide the correct styles",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "SegmentedControl::Item",
         "status": "alpha",
         "a11y_reviewed": true,
@@ -4156,6 +4302,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Select",
     "description": "Select lists are single-line text inputs rendered as `<select>` tags in HTML.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "Select",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4343,6 +4492,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::SubmitButton",
     "description": "A submit button input rendered using the HTML `<button type=\"submit\">` tag.\n\nThis component wraps the Primer button component and supports the same slots and arguments.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "SubmitButton",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4415,6 +4567,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::TabContainer",
     "description": "Use `TabContainer` to create tabbed content with keyboard support. This component does not add any styles.\nIt only provides the tab functionality. If you want styled Tabs you can look at {{#link_to_component}}Primer::Alpha::TabNav{{/link_to_component}}.\n\nThis component requires javascript.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "TabContainer",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4445,6 +4600,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::TabNav",
     "description": "Use `TabNav` to style navigation with a tab-based selected state, typically used for navigation placed at the top of the page.\nFor panel navigation, use {{#link_to_component}}Primer::Alpha::TabPanels{{/link_to_component}} instead.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "TabNav",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4541,6 +4699,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::TabPanels",
     "description": "Use `TabPanels` for tabs with panel navigation.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "TabPanels",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4644,6 +4805,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::TextArea",
     "description": "Text areas are multi-line text inputs rendered using the `<textarea>` tag in HTML.",
+    "is_form_component": true,
+    "is_published": false,
+    "requires_js": false,
     "component": "TextArea",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -4796,6 +4960,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::TextField",
     "description": "Text fields are single-line text inputs rendered as `<input type=\"text\">` in HTML.",
+    "is_form_component": true,
+    "is_published": true,
+    "requires_js": false,
     "component": "TextField",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -5011,6 +5178,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::ToggleSwitch",
     "description": "The ToggleSwitch component is a button that toggles between two boolean states. It is meant to be used for\nsettings that should cause an immediate update. If configured with a \"src\" attribute, the component will\nmake a POST request containing data of the form \"value: 0 | 1\".",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "ToggleSwitch",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -5131,6 +5301,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::Tooltip",
     "description": "`Tooltip` only appears on mouse hover or keyboard focus and contain a label or description text. Use tooltips sparingly and as a last resort.\nUse tooltips as a last resort. Please consider [Tooltips alternatives](https://primer.style/design/accessibility/tooltip-alternatives).\n\nWhen using a tooltip, follow the provided guidelines to avoid accessibility issues:\n- Tooltips should contain only **non-essential text**. Tooltips can easily be missed and are not accessible on touch devices so never use tooltips to convey critical information.\n- `Tooltip` should be rendered through the API of {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}}, {{#link_to_component}}Primer::Beta::Link{{/link_to_component}}, or {{#link_to_component}}Primer::IconButton{{/link_to_component}}. Avoid using `Tooltip` a standalone component unless absolutely necessary (and **only** on interactive elements).",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "Tooltip",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -5219,6 +5392,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::UnderlineNav",
     "description": "Use `UnderlineNav` to style navigation links with a minimal\nunderlined selected state, typically placed at the top\nof the page.\n\nFor panel navigation, use {{#link_to_component}}Primer::Alpha::UnderlinePanels{{/link_to_component}} instead.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "UnderlineNav",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -5322,6 +5498,9 @@
   {
     "fully_qualified_name": "Primer::Alpha::UnderlinePanels",
     "description": "Use `UnderlinePanels` to style tabs with an associated panel and an underlined selected state.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "UnderlinePanels",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -5426,6 +5605,9 @@
   {
     "fully_qualified_name": "Primer::Beta::AutoComplete",
     "description": "Use `AutoComplete` to provide a user with a list of selectable suggestions that appear when they type into the\ninput field. This list is populated by server search results.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "AutoComplete",
     "status": "beta",
     "a11y_reviewed": false,
@@ -5657,6 +5839,9 @@
       {
         "fully_qualified_name": "Primer::Beta::AutoComplete::Item",
         "description": "Use `AutoCompleteItem` to list results of an auto-completed search.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "AutoComplete::Item",
         "status": "beta",
         "a11y_reviewed": false,
@@ -5768,6 +5953,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Avatar",
     "description": "`Avatar` can be used to represent users and organizations on GitHub.\n\n- Use the default circle avatar for users, and the square shape\nfor organizations or any other non-human avatars.\n- By default, `Avatar` will render a static `<img>`. To have `Avatar` function as a link, set the `href` which will wrap the `<img>` in a `<a>`.\n- Set `size` to update the height and width of the `Avatar` in pixels.\n- To stack multiple avatars together, use {{#link_to_component}}Primer::Beta::AvatarStack{{/link_to_component}}.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Avatar",
     "status": "beta",
     "a11y_reviewed": false,
@@ -5852,6 +6040,9 @@
   {
     "fully_qualified_name": "Primer::Beta::AvatarStack",
     "description": "Use `AvatarStack` to stack multiple avatars together.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "AvatarStack",
     "status": "beta",
     "a11y_reviewed": false,
@@ -5936,6 +6127,9 @@
   {
     "fully_qualified_name": "Primer::Beta::BaseButton",
     "description": "Use `BaseButton` to render an unstyled `<button>` tag that can be customized.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "BaseButton",
     "status": "beta",
     "a11y_reviewed": false,
@@ -5993,6 +6187,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Blankslate",
     "description": "Use `Blankslate` when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Blankslate",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6167,6 +6364,9 @@
   {
     "fully_qualified_name": "Primer::Beta::BorderBox",
     "description": "`BorderBox` is a Box component with a border.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "BorderBox",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6277,6 +6477,9 @@
       {
         "fully_qualified_name": "Primer::Beta::BorderBox::Header",
         "description": "`BorderBox::Header` is used inside `BorderBox` to render its header slot.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "BorderBox::Header",
         "status": "beta",
         "a11y_reviewed": false,
@@ -6326,6 +6529,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Breadcrumbs",
     "description": "Use `Breadcrumbs` to display page hierarchy.\n\n#### Known issues\n\n##### Responsiveness\n\n`Breadcrumbs` is not optimized for responsive designs.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Breadcrumbs",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6379,6 +6585,9 @@
       {
         "fully_qualified_name": "Primer::Beta::Breadcrumbs::Item",
         "description": "This component is part of `Primer::Beta::Breadcrumbs` and should not be\nused as a standalone component.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Breadcrumbs::Item",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -6443,6 +6652,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Button",
     "description": "Use `Button` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Button",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6636,6 +6848,9 @@
   {
     "fully_qualified_name": "Primer::Beta::ButtonGroup",
     "description": "Use `ButtonGroup` to render a series of buttons.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "ButtonGroup",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6698,6 +6913,9 @@
   {
     "fully_qualified_name": "Primer::Beta::ClipboardCopy",
     "description": "Use `ClipboardCopy` to copy element text content or input values to the clipboard.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "ClipboardCopy",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6765,6 +6983,9 @@
   {
     "fully_qualified_name": "Primer::Beta::CloseButton",
     "description": "Use `CloseButton` to render an `×` without default button styles.\n\n[0]: https://primer.style/view-components/system-arguments#html-attributes",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "CloseButton",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6810,6 +7031,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Counter",
     "description": "Use `Counter` to add a count to navigational elements and buttons.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Counter",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6900,6 +7124,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Details",
     "description": "Use `DetailsComponent` to reveal content after clicking a button.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Details",
     "status": "beta",
     "a11y_reviewed": false,
@@ -6996,6 +7223,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Flash",
     "description": "Use `Flash` to inform users of successful or pending actions.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Flash",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7086,6 +7316,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Heading",
     "description": "`Heading` should be used to communicate page organization and hierarchy.\n\n- Set tag to one of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, `:h6` based on what is appropriate for the page context.\n- Use `Heading` as the title of a section or sub section.\n- Do not use `Heading` for styling alone. For simply styling text, consider using {{#link_to_component}}Primer::Beta::Text{{/link_to_component}} with relevant {{link_to_typography_docs}}\n  such as `font_size` and `font_weight`.\n- Do not jump heading levels. For instance, do not follow a `<h1>` with an `<h3>`. Heading levels should increase by one in ascending order.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Heading",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7131,6 +7364,9 @@
   {
     "fully_qualified_name": "Primer::Beta::IconButton",
     "description": "Use `IconButton` to render Icon-only buttons without the default button styles.\n\n`IconButton` will always render with a tooltip unless the tag is `:summary`.\n`IconButton` will always render with a tooltip unless the tag is `:summary`.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "IconButton",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7240,6 +7476,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Label",
     "description": "Use `Label` to add contextual metadata to a design.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Label",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7324,6 +7563,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Link",
     "description": "Use `Link` for navigating from one page to another. `Link` styles anchor tags with default blue styling and hover text-decoration.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "Link",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7420,6 +7662,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Markdown",
     "description": "Use `Markdown` to wrap markdown content.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Markdown",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7465,6 +7710,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Octicon",
     "description": "`Octicon` renders an {{link_to_octicons}} with {{link_to_system_arguments_docs}}.\n`Octicon` can also be rendered with the `primer_octicon` helper, which accepts the same arguments.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Octicon",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7528,6 +7776,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Popover",
     "description": "Use `Popover` to bring attention to specific user interface elements, typically to suggest an action or to guide users through a new experience.\n\nBy default, the popover renders with absolute positioning, meaning it should usually be wrapped in an element with a relative position in order to be positioned properly. To render the popover with relative positioning, use the relative property.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Popover",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7618,6 +7869,9 @@
   {
     "fully_qualified_name": "Primer::Beta::ProgressBar",
     "description": "Use `ProgressBar` to visualize task completion.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "ProgressBar",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7691,6 +7945,9 @@
   {
     "fully_qualified_name": "Primer::Beta::RelativeTime",
     "description": "Formats a timestamp as a localized string or as relative text that auto-updates in the user's browser.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "RelativeTime",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7847,6 +8104,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Spinner",
     "description": "Use `Spinner` to let users know that content is being loaded.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Spinner",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7898,6 +8158,9 @@
   {
     "fully_qualified_name": "Primer::Beta::State",
     "description": "Use `State` for rendering the status of an item.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "State",
     "status": "beta",
     "a11y_reviewed": false,
@@ -7971,6 +8234,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Subhead",
     "description": "Use `Subhead` as the start of a section. The `:heading` slot will render an `<h2>` font-sized text.\n\n- Optionally set the `:description` slot to render a short description and the `:actions` slot for a related action.\n- Use a succinct, one-line description for the `:description` slot. For longer descriptions, omit the description slot and render a paragraph below the `Subhead`.\n- Use the actions slot to render a related action to the right of the heading. Use {{#link_to_component}}Primer::ButtonComponent{{/link_to_component}} or {{#link_to_component}}Primer::Beta::Link{{/link_to_component}}.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Subhead",
     "status": "beta",
     "a11y_reviewed": false,
@@ -8084,6 +8350,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Text",
     "description": "`Text` is a wrapper component that will apply typography styles to the text inside.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Text",
     "status": "beta",
     "a11y_reviewed": false,
@@ -8129,6 +8398,9 @@
   {
     "fully_qualified_name": "Primer::Beta::TimelineItem",
     "description": "Use `TimelineItem` to display items on a vertical timeline, connected by badge elements.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "TimelineItem",
     "status": "beta",
     "a11y_reviewed": false,
@@ -8212,6 +8484,9 @@
       {
         "fully_qualified_name": "Primer::Beta::TimelineItem::Badge",
         "description": "This component is part of `Primer::Beta::TimelineItem` and should not be\nused as a standalone component.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "TimelineItem::Badge",
         "status": "beta",
         "a11y_reviewed": false,
@@ -8239,6 +8514,9 @@
   {
     "fully_qualified_name": "Primer::Beta::Truncate",
     "description": "Use `Truncate` to shorten overflowing text with an ellipsis.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Truncate",
     "status": "beta",
     "a11y_reviewed": false,
@@ -8319,6 +8597,9 @@
       {
         "fully_qualified_name": "Primer::Beta::Truncate::TruncateText",
         "description": "This component is part of `Primer::Beta::Truncate` and should not be\nused as a standalone component.",
+        "is_form_component": false,
+        "is_published": true,
+        "requires_js": false,
         "component": "Truncate::TruncateText",
         "status": "alpha",
         "a11y_reviewed": false,
@@ -8346,6 +8627,9 @@
   {
     "fully_qualified_name": "Primer::BlankslateComponent",
     "description": "Use `Blankslate` when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Blankslate",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -8477,6 +8761,9 @@
   {
     "fully_qualified_name": "Primer::Box",
     "description": "`Box` is a basic wrapper component for most layout related needs.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Box",
     "status": "stable",
     "a11y_reviewed": false,
@@ -8526,6 +8813,9 @@
   {
     "fully_qualified_name": "Primer::ButtonComponent",
     "description": "Use `Button` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "Button",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -8658,6 +8948,9 @@
   {
     "fully_qualified_name": "Primer::ConditionalWrapper",
     "description": "Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition\nis true, a `Primer::BaseComponent` will render around the content. If the condition is false, only\nthe content is rendered.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "ConditionalWrapper",
     "status": "alpha",
     "a11y_reviewed": false,
@@ -8683,6 +8976,9 @@
   {
     "fully_qualified_name": "Primer::Content",
     "description": "Use `Content` as a helper to render content passed to a slot without adding any tags.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Content",
     "status": "stable",
     "a11y_reviewed": false,
@@ -8708,6 +9004,9 @@
   {
     "fully_qualified_name": "Primer::IconButton",
     "description": "Use `IconButton` to render Icon-only buttons without the default button styles.\n\n`IconButton` will always render with a tooltip unless the tag is `:summary`.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": true,
     "component": "IconButton",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -8786,6 +9085,9 @@
   {
     "fully_qualified_name": "Primer::LayoutComponent",
     "description": "Use `Layout` to build a main/sidebar layout.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Layout",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -8857,6 +9159,9 @@
   {
     "fully_qualified_name": "Primer::Navigation::TabComponent",
     "description": "nodoc",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Navigation::Tab",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -8970,6 +9275,9 @@
   {
     "fully_qualified_name": "Primer::Tooltip",
     "description": "`Tooltip` is a wrapper component that will apply a tooltip to the provided content.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Tooltip",
     "status": "deprecated",
     "a11y_reviewed": false,
@@ -9030,6 +9338,9 @@
   {
     "fully_qualified_name": "Primer::Truncate",
     "description": "Use `Truncate` to shorten overflowing text with an ellipsis.",
+    "is_form_component": false,
+    "is_published": true,
+    "requires_js": false,
     "component": "Truncate",
     "status": "deprecated",
     "a11y_reviewed": false,