openproject-primer_view_components 0.14.0 → 0.16.0

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
   module ViewComponents
     module VERSION
       MAJOR = 0
-      MINOR = 14
+      MINOR = 16
       PATCH = 0
 
       STRING = [MAJOR, MINOR, PATCH].join(".")

data/previews/primer/alpha/select_preview.rb

@@ -17,6 +17,7 @@ module Primer
       # @param disabled toggle
       # @param invalid toggle
       # @param validation_message text
+      # @param input_width [Symbol] select [auto, small, medium, large, xlarge, xxlarge]
       def playground(
         name: "my-select-list",
         id: "my-select-list",
@@ -28,7 +29,8 @@ module Primer
         full_width: false,
         disabled: false,
         invalid: false,
-        validation_message: nil
+        validation_message: nil,
+        input_width: nil
       )
         system_arguments = {
           name: name,
@@ -41,7 +43,8 @@ module Primer
           full_width: full_width,
           disabled: disabled,
           invalid: invalid,
-          validation_message: validation_message
+          validation_message: validation_message,
+          input_width: input_width
         }
 
         render(Primer::Alpha::Select.new(**system_arguments)) do |component|

data/previews/primer/alpha/text_field_preview.rb

@@ -23,6 +23,7 @@ module Primer
       # @param inset toggle
       # @param monospace toggle
       # @param leading_visual_icon octicon
+      # @param input_width [Symbol] select [auto, small, medium, large, xlarge, xxlarge]
       def playground(
         name: "my-text-field",
         id: "my-text-field",
@@ -40,7 +41,8 @@ module Primer
         placeholder: nil,
         inset: false,
         monospace: false,
-        leading_visual_icon: nil
+        leading_visual_icon: nil,
+        input_width: nil
       )
         system_arguments = {
           name: name,
@@ -58,7 +60,8 @@ module Primer
           validation_message: validation_message,
           placeholder: placeholder,
           inset: inset,
-          monospace: monospace
+          monospace: monospace,
+          input_width: input_width
         }
 
         if leading_visual_icon

data/previews/primer/forms_preview/custom_width_fields_form.html.erb

@@ -0,0 +1,3 @@
+<%= primer_form_with(url: "/foo") do |f| %>
+  <%= render(CustomWidthFieldsForm.new(f)) %>
+<% end %>

data/previews/primer/forms_preview.rb

@@ -7,6 +7,8 @@ module Primer
 
     def multi_text_field_form; end
 
+    def custom_width_fields_form; end
+
     def text_field_and_checkbox_form; end
 
     def horizontal_form; end

data/previews/primer/open_project/page_header_preview/context_bar_actions.html.erb

@@ -0,0 +1,25 @@
+<%= render(Primer::OpenProject::PageHeader.new) do |component| %>
+  <% component.with_title(tag: :h1) do %>
+    A title
+  <% end %>
+  <% component.with_description do %>
+    A description with actions
+  <% end %>
+  <% component.with_parent_link(href: "#") do %>
+    Parent link
+  <% end %>
+  <% component.with_context_bar_actions do %>
+    <%= render(Primer::Alpha::ActionMenu.new) do |component| %>
+      <% component.with_show_button { "Menu" } %>
+      <% component.with_item(label: "Item", tag: :button, value: "") %>
+      <% component.with_item(
+           label: "Show dialog",
+           tag: :button,
+           content_arguments: { "data-show-dialog-id": "my-dialog" },
+           value: "",
+           scheme: :danger
+         ) %>
+    <% end %>
+  <% end %>
+<% end %>
+

data/previews/primer/open_project/page_header_preview/playground.html.erb

@@ -0,0 +1,32 @@
+<%= render Primer::OpenProject::PageHeader.new do |header| %>
+  <%= header.with_title(variant: variant) { title } %>
+  <%= header.with_description { description } %>
+  <%= header.with_back_button(href: "#", size: back_button_size, 'aria-label': "Back") if with_back_button %>
+  <%= header.with_breadcrumbs(breadcrumb_items) if with_breadcrumbs %>
+  <%= header.with_parent_link(href: "#") { "Parent link" } if with_parent_link %>
+  <% if with_actions %>
+    <% header.with_actions do %>
+      <%= render(Primer::Alpha::ActionMenu.new) do |component| %>
+        <% component.with_show_button { "Menu" } %>
+        <% component.with_item(label: "Item", tag: :button, value: "") %>
+        <% component.with_item(
+             label: "Show dialog",
+             tag: :button,
+             content_arguments: { "data-show-dialog-id": "my-dialog" },
+             value: "",
+             scheme: :danger
+           ) %>
+      <% end %>
+    <% end %>
+  <% end %>
+  <% if with_context_bar_actions %>
+    <% header.with_context_bar_actions do %>
+      <%= render(Primer::Beta::IconButton.new(
+        scheme: :default,
+        size: :small,
+        icon: "pencil",
+        "aria-label": "aria_label"
+      )) %>
+    <% end %>
+  <% end %>
+<% end %>

data/previews/primer/open_project/page_header_preview.rb

@@ -21,22 +21,32 @@ module Primer
       # @param with_back_button [Boolean]
       # @param back_button_size [Symbol] select [small, medium, large]
       # @param with_breadcrumbs [Boolean]
+      # @param with_actions [Boolean]
+      # @param with_context_bar_actions [Boolean]
+      # @param with_parent_link [Boolean]
       def playground(
         variant: :medium,
         title: "Hello",
         description: "Last updated 5 minutes ago by XYZ.",
         with_back_button: false,
         back_button_size: :medium,
-        with_breadcrumbs: false
+        with_breadcrumbs: false,
+        with_actions: false,
+        with_context_bar_actions: false,
+        with_parent_link: false
       )
         breadcrumb_items = [{ href: "/foo", text: "Foo" }, { href: "/bar", text: "Bar" }, "Baz"]
 
-        render(Primer::OpenProject::PageHeader.new) do |header|
-          header.with_title(variant: variant) { title }
-          header.with_description { description }
-          header.with_back_button(href: "#", size: back_button_size, 'aria-label': "Back") if with_back_button
-          header.with_breadcrumbs(breadcrumb_items) if with_breadcrumbs
-        end
+        render_with_template(locals: { variant: variant,
+                                       title: title,
+                                       description: description,
+                                       with_back_button: with_back_button,
+                                       back_button_size: back_button_size,
+                                       with_breadcrumbs: with_breadcrumbs,
+                                       with_parent_link: with_parent_link,
+                                       with_actions: with_actions,
+                                       with_context_bar_actions: with_context_bar_actions,
+                                       breadcrumb_items: breadcrumb_items })
       end
 
       # @label Large
@@ -52,7 +62,11 @@ module Primer
         render_with_template(locals: {})
       end
 
-      # @label With back button
+      # @label With back button (on wide)
+      # **Back button** is only shown on **wider than narrow screens** by default.
+      # If you want to override that behaviour please use the system_argument: **display**
+      # e.g. **component.with\_breadcrumbs(display: [:block, :block])**
+      #
       # @param href [String] text
       # @param size [Symbol] select [small, medium, large]
       # @param icon [String] select ["arrow-left", "chevron-left", "triangle-left"]
@@ -63,7 +77,11 @@ module Primer
         end
       end
 
-      # @label With breadcrumbs
+      # @label With breadcrumbs (on wide)
+      # **Breadcrumbs** are only shown on **wider than narrow screens** by default.
+      # If you want to override that behaviour please use the system_argument: **display**
+      # e.g. **component.with\_breadcrumbs(display: [:block, :block])**
+      #
       def breadcrumbs
         breadcrumb_items = [
           { href: "/foo", text: "Foo" },
@@ -75,6 +93,27 @@ module Primer
           header.with_breadcrumbs(breadcrumb_items)
         end
       end
+
+      # @label With parent link (on narrow)
+      # **Parent link** is only shown on **narrow screens** by default.
+      # If you want to override that behaviour please use the system_argument: **display**
+      # e.g. **component.with\_parent\_link(display: [:block, :block])**
+      #
+      def parent_link
+        render(Primer::OpenProject::PageHeader.new) do |header|
+          header.with_title { "A title" }
+          header.with_parent_link(href: "test") { "Parent link" }
+        end
+      end
+
+      # @label With context bar actions (on narrow)
+      # **Context bar actions** are only shown on **narrow screens** by default.
+      # If you want to override that behaviour please use the system_argument: **display**
+      # e.g. **component.with\_context\_bar\_actions(display: [:block, :block])**
+      #
+      def context_bar_actions
+        render_with_template(locals: {})
+      end
     end
   end
 end

data/static/classes.json

@@ -441,9 +441,18 @@
   "PageHeader-breadcrumbs": [
     "Primer::OpenProject::PageHeader"
   ],
+  "PageHeader-contextBar": [
+    "Primer::OpenProject::PageHeader"
+  ],
+  "PageHeader-contextBarActions": [
+    "Primer::OpenProject::PageHeader"
+  ],
   "PageHeader-description": [
     "Primer::OpenProject::PageHeader"
   ],
+  "PageHeader-parentLink": [
+    "Primer::OpenProject::PageHeader"
+  ],
   "PageHeader-title": [
     "Primer::OpenProject::PageHeader"
   ],

data/static/constants.json

@@ -1370,9 +1370,25 @@
       "medium",
       "large"
     ],
+    "DEFAULT_BACK_BUTTON_DISPLAY": [
+      "none",
+      "flex"
+    ],
     "DEFAULT_BACK_BUTTON_ICON": "arrow-left",
     "DEFAULT_BACK_BUTTON_SIZE": "medium",
+    "DEFAULT_BREADCRUMBS_DISPLAY": [
+      "none",
+      "flex"
+    ],
+    "DEFAULT_CONTEXT_BAR_ACTIONS_DISPLAY": [
+      "block",
+      "none"
+    ],
     "DEFAULT_HEADER_VARIANT": "medium",
+    "DEFAULT_PARENT_LINK_DISPLAY": [
+      "block",
+      "none"
+    ],
     "HEADER_VARIANT_OPTIONS": [
       "large",
       "medium"

data/static/info_arch.json

@@ -15473,9 +15473,21 @@
           }
         ]
       },
+      {
+        "name": "context_bar_actions",
+        "description": "Context Bar Actions\nBy default shown on narrow screens. Can be overridden with system_argument: display",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "{{link_to_system_arguments_docs}}"
+          }
+        ]
+      },
       {
         "name": "back_button",
-        "description": "Optional back button prepend the title",
+        "description": "Optional back button prepend the title\nBy default shown on wider screens. Can be overridden with system_argument: display",
         "parameters": [
           {
             "name": "size",
@@ -15497,9 +15509,21 @@
           }
         ]
       },
+      {
+        "name": "parent_link",
+        "description": "Optional parent link in the context area\nBy default shown on narrow screens. Can be overridden with system_argument: display",
+        "parameters": [
+          {
+            "name": "system_arguments",
+            "type": "Hash",
+            "default": "N/A",
+            "description": "{{link_to_system_arguments_docs}}"
+          }
+        ]
+      },
       {
         "name": "breadcrumbs",
-        "description": "Optional breadcrumbs above the title row",
+        "description": "Optional breadcrumbs above the title row\nBy default shown on wider screens. Can be overridden with system_argument: display",
         "parameters": [
           {
             "name": "items",
@@ -15610,6 +15634,32 @@
             "color-contrast"
           ]
         }
+      },
+      {
+        "preview_path": "primer/open_project/page_header/parent_link",
+        "name": "parent_link",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/open_project/page_header/context_bar_actions",
+        "name": "context_bar_actions",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
       }
     ],
     "subcomponents": [

data/static/previews.json

@@ -4781,6 +4781,32 @@
             "color-contrast"
           ]
         }
+      },
+      {
+        "preview_path": "primer/open_project/page_header/parent_link",
+        "name": "parent_link",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/open_project/page_header/context_bar_actions",
+        "name": "context_bar_actions",
+        "snapshot": "false",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
       }
     ]
   },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openproject-primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - GitHub Open Source
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -493,6 +493,7 @@ files:
 - app/forms/check_box_group_form.rb
 - app/forms/check_box_with_nested_form.rb
 - app/forms/composed_form.rb
+- app/forms/custom_width_fields_form.rb
 - app/forms/example_toggle_switch_form.rb
 - app/forms/example_toggle_switch_form/example_field_caption.html.erb
 - app/forms/first_name_form.rb
@@ -831,6 +832,7 @@ files:
 - previews/primer/forms_preview/check_box_group_form.html.erb
 - previews/primer/forms_preview/check_box_with_nested_form.html.erb
 - previews/primer/forms_preview/composed_form.html.erb
+- previews/primer/forms_preview/custom_width_fields_form.html.erb
 - previews/primer/forms_preview/example_toggle_switch_form.html.erb
 - previews/primer/forms_preview/horizontal_form.html.erb
 - previews/primer/forms_preview/immediate_validation_form.html.erb
@@ -850,6 +852,8 @@ files:
 - previews/primer/open_project/grid_layout_preview.rb
 - previews/primer/open_project/page_header_preview.rb
 - previews/primer/open_project/page_header_preview/actions.html.erb
+- previews/primer/open_project/page_header_preview/context_bar_actions.html.erb
+- previews/primer/open_project/page_header_preview/playground.html.erb
 - previews/primer/url_helpers.rb
 - static/arguments.json
 - static/assets/view-components.svg