openproject-primer_view_components 0.93.0 → 0.94.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e48940c0021996de6eb9ad0b8f1e44489e89e3056140c3e4f2a5be78432c073
-  data.tar.gz: 95c12fdeb352cb1d407960cfbfe4035d4a1128c8b946443fa182e70bccba87b4
+  metadata.gz: 1926304244eb14ceecf9e3adaec9f5fca51e1d190c8469e88af44405f195a17f
+  data.tar.gz: eeeffe1a4a340e60e10f34f913437021f1ad9a1c88071697b32ab6623f810c8d
 SHA512:
-  metadata.gz: 381f5e7266e0f430811a6b287fdcbbce26729ad669c081155d74fefc9213a5c4b97b6d71115541a8a153e0ecc95d8c01b52d7cef829bc1a12388ef519a608749
-  data.tar.gz: a923bfd97e866e1e927ea4c5750f44fec63e709651452be1f36a11d580d7de106d73fee7f29ba832b35c5bf9f0ed9216b3db795b15a968a903ed2fc95e79b378
+  metadata.gz: '080f8e8920edf48c4c3b553743b9e86f4f7a52f94f4c174acbe39df14affc19da9b8a1cc99d240984cdf128814a3967d02516bb09c5f78dd52850c2e42ff7730'
+  data.tar.gz: 13de414fb9e160638c51530e62ffe70e0c4152ed0ae8af5941dd617ed7d8b565c29a5649f46c7a06e64a6f618363da84a6d7561ee9dfdba3fa5c4bfb2bae5707

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.94.0
+
+### Minor Changes
+
+- [#539](https://github.com/opf/primer_view_components/pull/539) [`3ddf0b2`](https://github.com/opf/primer_view_components/commit/3ddf0b2a460603fafa413e0cba303c3c81c4348b) Thanks [@mrmir](https://github.com/mrmir)! - Add a `:locked` state to the `collapsed` argument of `Primer::OpenProject::CollapsibleSection` to lock the section permanently open and disable the toggle
+
 ## 0.93.0
 
 ### Minor Changes

data/app/components/primer/open_project/collapsible_section.html.erb

@@ -1,8 +1,6 @@
 <%= render(Primer::BaseComponent.new(**@system_arguments)) do %>
   <%= render(Primer::OpenProject::FlexLayout.new) do |flex| %>
-    <%= flex.with_row(classes: "CollapsibleSection--triggerArea",
-                      id: @title_id,
-                      data: { action: "click:collapsible-section#toggle" }) do %>
+    <%= flex.with_row(**trigger_arguments) do %>
       <%= render(Primer::OpenProject::FlexLayout.new(display: :flex, align_items: :center)) do |header| %>
         <%= header.with_column(id: @heading_id) do %>
           <%= title %>
@@ -10,10 +8,12 @@
         <%= header.with_column do %>
           <%= caption %>
         <% end %>
-        <%= header.with_column do %>
-          <%= render(Primer::Beta::Button.new(**@toggle_button_arguments)) do %>
-            <%= render(Primer::Beta::Octicon.new(icon: "chevron-up", hidden: @collapsed, data: { target: "collapsible-section.arrowUp" })) %>
-            <%= render(Primer::Beta::Octicon.new(icon: "chevron-down", hidden: !@collapsed, data: { target: "collapsible-section.arrowDown" })) %>
+        <% if @collapsible %>
+          <%= header.with_column do %>
+            <%= render(Primer::Beta::Button.new(**@toggle_button_arguments)) do %>
+              <%= render(Primer::Beta::Octicon.new(icon: "chevron-up", hidden: @collapsed, data: { target: "collapsible-section.arrowUp" })) %>
+              <%= render(Primer::Beta::Octicon.new(icon: "chevron-down", hidden: !@collapsed, data: { target: "collapsible-section.arrowDown" })) %>
+            <% end %>
           <% end %>
         <% end %>
         <%= header.with_column(flex: 1, text_align: :right) do %>

data/app/components/primer/open_project/collapsible_section.rb

@@ -47,14 +47,19 @@ module Primer
         Primer::BaseComponent.new(tag: :div, **system_arguments)
       }
 
+      COLLAPSED_OPTIONS = [false, true, :locked].freeze
+
       # @param id [String] The unique ID of the collapsible section.
-      # @param collapsed [Boolean] Whether the section is collapsed on initial render.
+      # @param collapsed [Boolean, Symbol] The initial state of the section. `false` renders it open and toggleable, `true` renders it collapsed and toggleable, and `:locked` keeps it permanently open with the toggle disabled.
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
       def initialize(id: self.class.generate_id, collapsed: false, **system_arguments)
+        collapsed = fetch_or_fallback(COLLAPSED_OPTIONS, collapsed, false)
+
         @title_id = "#{id}-title"
         @content_id = "#{id}-content"
         @heading_id = "#{id}-heading"
-        @collapsed = collapsed
+        @collapsible = collapsed != :locked
+        @collapsed = collapsed == true
 
         @system_arguments = deny_tag_argument(**system_arguments)
         @system_arguments[:tag] = "collapsible-section"
@@ -78,6 +83,16 @@ module Primer
 
       private
 
+      def trigger_arguments
+        return { id: @title_id } unless @collapsible
+
+        {
+          classes: "CollapsibleSection--triggerArea",
+          id: @title_id,
+          data: { action: "click:collapsible-section#toggle" }
+        }
+      end
+
       def render?
         raise ArgumentError, "Title must be present" unless title.present?
         raise ArgumentError, "Collapsible content must be present" unless collapsible_content.present?

data/lib/primer/view_components/version.rb

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

data/previews/primer/open_project/collapsible_section_preview/non_collapsible.html.erb

@@ -0,0 +1,10 @@
+<%= render(Primer::OpenProject::CollapsibleSection.new(collapsed: :locked)) do |section| %>
+  <% section.with_title { "Feedback" } %>
+  <% section.with_collapsible_content do %>
+    <%= render(Primer::Alpha::Banner.new(mb: 3)) { "Please take one minute time to answer this question" } %>
+    <%= primer_form_with(url: "/foo") do |f| %>
+      <%= render(RadioButtonGroupForm.new(f)) %>
+    <% end %>
+
+  <% end %>
+<% end %>

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

@@ -1,4 +1,4 @@
-<%= render(Primer::OpenProject::CollapsibleSection.new) do |section| %>
+<%= render(Primer::OpenProject::CollapsibleSection.new(collapsed: collapsed)) do |section| %>
   <% section.with_title { "Advanced settings" } %>
 
   <% if caption.present? %>

data/previews/primer/open_project/collapsible_section_preview.rb

@@ -10,10 +10,12 @@ module Primer
       # @label Playground
       # @param caption [String] text
       # @param show_additional_information [Boolean] toggle
-      def playground(caption: "(optional)", show_additional_information: false)
+      # @param collapsed [String] select ["false", "true", "locked"]
+      def playground(caption: "(optional)", show_additional_information: false, collapsed: "false")
+        collapsed = { "false" => false, "true" => true, "locked" => :locked }.fetch(collapsed)
         render_with_template(
           template: "primer/open_project/collapsible_section_preview/playground",
-          locals: { caption: caption, show_additional_information: show_additional_information}
+          locals: { caption: caption, show_additional_information: show_additional_information, collapsed: collapsed }
         )
       end
 
@@ -53,6 +55,15 @@ module Primer
         )
       end
 
+      # @label Non-collapsible
+      # @snapshot
+      def non_collapsible
+        render_with_template(
+          template: "primer/open_project/collapsible_section_preview/non_collapsible",
+          locals: { }
+        )
+      end
+
       # @label With link in title
       # @hidden
       def with_link_in_title

data/static/arguments.json

@@ -5961,9 +5961,9 @@
       },
       {
         "name": "collapsed",
-        "type": "Boolean",
+        "type": "Boolean, Symbol",
         "default": "`false`",
-        "description": "Whether the section is collapsed on initial render."
+        "description": "The initial state of the section. `false` renders it open and toggleable, `true` renders it collapsed and toggleable, and `:locked` keeps it permanently open with the toggle disabled."
       },
       {
         "name": "system_arguments",

data/static/constants.json

@@ -1747,6 +1747,11 @@
     "GeneratedSlotMethods": "Primer::OpenProject::BorderGrid::Cell::GeneratedSlotMethods"
   },
   "Primer::OpenProject::CollapsibleSection": {
+    "COLLAPSED_OPTIONS": [
+      false,
+      true,
+      "locked"
+    ],
     "GeneratedSlotMethods": "Primer::OpenProject::CollapsibleSection::GeneratedSlotMethods",
     "TITLE_TAG_FALLBACK": "h2",
     "TITLE_TAG_OPTIONS": [

data/static/info_arch.json

@@ -19614,9 +19614,9 @@
       },
       {
         "name": "collapsed",
-        "type": "Boolean",
+        "type": "Boolean, Symbol",
         "default": "`false`",
-        "description": "Whether the section is collapsed on initial render."
+        "description": "The initial state of the section. `false` renders it open and toggleable, `true` renders it collapsed and toggleable, and `:locked` keeps it permanently open with the toggle disabled."
       },
       {
         "name": "system_arguments",
@@ -19748,6 +19748,19 @@
           ]
         }
       },
+      {
+        "preview_path": "primer/open_project/collapsible_section/non_collapsible",
+        "name": "non_collapsible",
+        "snapshot": "true",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
       {
         "preview_path": "primer/open_project/collapsible_section/with_link_in_title",
         "name": "with_link_in_title",

data/static/previews.json

@@ -8824,6 +8824,19 @@
           ]
         }
       },
+      {
+        "preview_path": "primer/open_project/collapsible_section/non_collapsible",
+        "name": "non_collapsible",
+        "snapshot": "true",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
       {
         "preview_path": "primer/open_project/collapsible_section/with_link_in_title",
         "name": "with_link_in_title",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openproject-primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.93.0
+  version: 0.94.0
 platform: ruby
 authors:
 - GitHub Open Source
@@ -1228,6 +1228,7 @@ files:
 - previews/primer/open_project/collapsible_section_preview.rb
 - previews/primer/open_project/collapsible_section_preview/collapsed.html.erb
 - previews/primer/open_project/collapsible_section_preview/default.html.erb
+- previews/primer/open_project/collapsible_section_preview/non_collapsible.html.erb
 - previews/primer/open_project/collapsible_section_preview/playground.html.erb
 - previews/primer/open_project/collapsible_section_preview/with_additional_information.html.erb
 - previews/primer/open_project/collapsible_section_preview/with_caption.html.erb