openproject-primer_view_components 0.11.0 → 0.12.1

data/previews/primer/open_project/grid_layout_preview.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Setup Playground to use all available component props
+# Setup Features to use individual component props and combinations
+
+module Primer
+  module OpenProject
+    # @label GridLayout
+    class GridLayoutPreview < ViewComponent::Preview
+      # @label Playground
+      def playground
+        render(Primer::OpenProject::GridLayout.new(css_class: "grid-layout", tag: :div)) do |component|
+          component.with_area(:area1, bg: :attention, p: 6) do
+            "Block 1"
+          end
+          component.with_area(:area2, bg: :accent, p: 6) do
+            "Block 2"
+          end
+        end
+      end
+
+      # The component can be used for easy layouting of multiple child components.
+      # The component sets classes as well the grid-area definitions. The actual grid template can then be defined a separate CSS file.
+      # @label Default
+      def default
+        render(Primer::OpenProject::GridLayout.new(css_class: "grid-layout", tag: :div)) do |component|
+          component.with_area(:area1, bg: :attention, p: 6) do
+            "Block 1"
+          end
+          component.with_area(:area2, bg: :accent, p: 6) do
+            "Block 2"
+          end
+        end
+      end
+    end
+  end
+end

data/static/arguments.json

@@ -772,6 +772,18 @@
         "default": "N/A",
         "description": "A string describing the field and what sorts of input it expects. Displayed below the group."
       },
+      {
+        "name": "invalid",
+        "type": "Boolean",
+        "default": "N/A",
+        "description": "If set to `true`, the input will be marked as invalid. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
+      },
+      {
+        "name": "validation_message",
+        "type": "String",
+        "default": "N/A",
+        "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
+      },
       {
         "name": "label_arguments",
         "type": "Hash",
@@ -884,6 +896,12 @@
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
     "parameters": [
+      {
+        "name": "id",
+        "type": "String",
+        "default": "N/A",
+        "description": "The HTML element's ID value."
+      },
       {
         "name": "title",
         "type": "String",
@@ -908,6 +926,12 @@
         "default": "`false`",
         "description": "Visually hide the `title` while maintaining a label for assistive technologies."
       },
+      {
+        "name": "variant",
+        "type": "Symbol",
+        "default": "`:medium`",
+        "description": "One of `:large` or `:medium`."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",
@@ -1420,7 +1444,7 @@
   },
   {
     "component": "NavList",
-    "status": "alpha",
+    "status": "deprecated",
     "a11y_reviewed": true,
     "short_name": "NavList",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
@@ -1442,7 +1466,7 @@
   },
   {
     "component": "NavList::Divider",
-    "status": "alpha",
+    "status": "deprecated",
     "a11y_reviewed": false,
     "short_name": "NavListDivider",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
@@ -1464,7 +1488,7 @@
   },
   {
     "component": "NavList::Group",
-    "status": "alpha",
+    "status": "deprecated",
     "a11y_reviewed": true,
     "short_name": "NavListGroup",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
@@ -1486,7 +1510,7 @@
   },
   {
     "component": "NavList::Heading",
-    "status": "alpha",
+    "status": "deprecated",
     "a11y_reviewed": false,
     "short_name": "NavListHeading",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb",
@@ -1520,7 +1544,7 @@
   },
   {
     "component": "NavList::Item",
-    "status": "alpha",
+    "status": "deprecated",
     "a11y_reviewed": false,
     "short_name": "NavListItem",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
@@ -1966,6 +1990,18 @@
         "default": "N/A",
         "description": "A string describing the field and what sorts of input it expects. Displayed below the group."
       },
+      {
+        "name": "invalid",
+        "type": "Boolean",
+        "default": "N/A",
+        "description": "If set to `true`, the input will be marked as invalid. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
+      },
+      {
+        "name": "validation_message",
+        "type": "String",
+        "default": "N/A",
+        "description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
+      },
       {
         "name": "label_arguments",
         "type": "Hash",
@@ -3647,7 +3683,7 @@
       {
         "name": "underline",
         "type": "Boolean",
-        "default": "`true`",
+        "default": "`false`",
         "description": "Whether or not to underline the link."
       },
       {
@@ -3680,6 +3716,146 @@
       }
     ]
   },
+  {
+    "component": "NavList",
+    "status": "beta",
+    "a11y_reviewed": true,
+    "short_name": "NavList",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/default/",
+    "parameters": [
+      {
+        "name": "selected_item_id",
+        "type": "Symbol",
+        "default": "`nil`",
+        "description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "NavList::Divider",
+    "status": "alpha",
+    "a11y_reviewed": false,
+    "short_name": "NavListDivider",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/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": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "NavList::Group",
+    "status": "alpha",
+    "a11y_reviewed": true,
+    "short_name": "NavListGroup",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/",
+    "parameters": [
+      {
+        "name": "selected_item_id",
+        "type": "Symbol",
+        "default": "`nil`",
+        "description": "The ID of the currently selected item. Used internally."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "NavList::Heading",
+    "status": "alpha",
+    "a11y_reviewed": false,
+    "short_name": "NavListHeading",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/heading.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/heading/default/",
+    "parameters": [
+      {
+        "name": "title",
+        "type": "String",
+        "default": "N/A",
+        "description": "The text content of the heading."
+      },
+      {
+        "name": "id",
+        "type": "String",
+        "default": "`self.class.generate_id`",
+        "description": "The value of the ID HTML attribute. Auto-generated by default."
+      },
+      {
+        "name": "heading_level",
+        "type": "Integer",
+        "default": "`2`",
+        "description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "NavList::Item",
+    "status": "alpha",
+    "a11y_reviewed": false,
+    "short_name": "NavListItem",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/item.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/item/default/",
+    "parameters": [
+      {
+        "name": "selected_item_id",
+        "type": "Symbol",
+        "default": "`nil`",
+        "description": "The ID of the currently selected list item. Used internally."
+      },
+      {
+        "name": "selected_by_ids",
+        "type": "Array<Symbol>",
+        "default": "`[]`",
+        "description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
+      },
+      {
+        "name": "expanded",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
+      },
+      {
+        "name": "sub_item",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Whether or not this item is nested under a parent item. Used internally."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "Octicon",
     "status": "beta",
@@ -4477,6 +4653,84 @@
       }
     ]
   },
+  {
+    "component": "OpenProject::FlexLayout",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectFlexLayout",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/flex_layout.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/flex_layout/default/",
+    "parameters": [
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "OpenProject::GridLayout",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectGridLayout",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/grid_layout.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/grid_layout/default/",
+    "parameters": [
+      {
+        "name": "css_class",
+        "type": "String",
+        "default": "N/A",
+        "description": "The basic css class applied on the grid-container"
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
+  {
+    "component": "OpenProject::GridLayout::Area",
+    "status": "open_project",
+    "a11y_reviewed": false,
+    "short_name": "OpenProjectGridLayoutArea",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/grid_layout/area.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/grid_layout/area/default/",
+    "parameters": [
+      {
+        "name": "css_class",
+        "type": "String",
+        "default": "N/A",
+        "description": "The basic css class applied on the grid-container"
+      },
+      {
+        "name": "area_name",
+        "type": "Symbol",
+        "default": "N/A",
+        "description": "The specific area name, used for creating the element class and the \"grid-area\" style"
+      },
+      {
+        "name": "component",
+        "type": "ViewComponent::Base",
+        "default": "`Primer::BaseComponent`",
+        "description": "The instance of the component to be rendered."
+      },
+      {
+        "name": "tag",
+        "type": "Symbol",
+        "default": "`:div`",
+        "description": "One of `:div` or `:span`."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "OpenProject::PageHeader",
     "status": "open_project",

data/static/audited_at.json

@@ -82,6 +82,11 @@
   "Primer::Beta::Label": "",
   "Primer::Beta::Link": "",
   "Primer::Beta::Markdown": "",
+  "Primer::Beta::NavList": "2023-07-10",
+  "Primer::Beta::NavList::Divider": "",
+  "Primer::Beta::NavList::Group": "2023-07-10",
+  "Primer::Beta::NavList::Heading": "",
+  "Primer::Beta::NavList::Item": "",
   "Primer::Beta::Octicon": "",
   "Primer::Beta::Popover": "",
   "Primer::Beta::ProgressBar": "",
@@ -105,6 +110,9 @@
   "Primer::OpenProject::BorderGrid": "",
   "Primer::OpenProject::BorderGrid::Cell": "",
   "Primer::OpenProject::DragHandle": "",
+  "Primer::OpenProject::FlexLayout": "",
+  "Primer::OpenProject::GridLayout": "",
+  "Primer::OpenProject::GridLayout::Area": "",
   "Primer::OpenProject::PageHeader": "",
   "Primer::Tooltip": "",
   "Primer::Truncate": ""

data/static/classes.json

@@ -377,6 +377,9 @@
   "Link--secondary": [
     "Primer::Beta::Link"
   ],
+  "Link--underline": [
+    "Primer::Beta::Link"
+  ],
   "Overlay": [
     "Primer::Alpha::Dialog",
     "Primer::Alpha::Overlay"

data/static/constants.json

@@ -263,6 +263,15 @@
   "Primer::Alpha::Dialog::Footer": {
   },
   "Primer::Alpha::Dialog::Header": {
+    "DEFAULT_VARIANT": "medium",
+    "VARIANT_MAPPINGS": {
+      "medium": "",
+      "large": "Overlay-header--large"
+    },
+    "VARIANT_OPTIONS": [
+      "medium",
+      "large"
+    ]
   },
   "Primer::Alpha::Dropdown": {
     "Menu": "Primer::Alpha::Dropdown::Menu"
@@ -968,6 +977,20 @@
       "td"
     ]
   },
+  "Primer::Beta::NavList": {
+    "Divider": "Primer::Beta::NavList::Divider",
+    "Group": "Primer::Beta::NavList::Group",
+    "Heading": "Primer::Beta::NavList::Heading",
+    "Item": "Primer::Beta::NavList::Item"
+  },
+  "Primer::Beta::NavList::Divider": {
+  },
+  "Primer::Beta::NavList::Group": {
+  },
+  "Primer::Beta::NavList::Heading": {
+  },
+  "Primer::Beta::NavList::Item": {
+  },
   "Primer::Beta::Octicon": {
     "SIZE_DEFAULT": "small",
     "SIZE_MAPPINGS": {
@@ -1313,6 +1336,18 @@
       "medium"
     ]
   },
+  "Primer::OpenProject::FlexLayout": {
+  },
+  "Primer::OpenProject::GridLayout": {
+    "Area": "Primer::OpenProject::GridLayout::Area"
+  },
+  "Primer::OpenProject::GridLayout::Area": {
+    "DEFAULT_TAG": "div",
+    "TAG_OPTIONS": [
+      "div",
+      "span"
+    ]
+  },
   "Primer::OpenProject::PageHeader": {
     "DEFAULT_HEADER_VARIANT": "medium",
     "HEADER_VARIANT_OPTIONS": [