Merge pull request #219 from opf/feature/60359-update-feedback_dialog…

…-component-slots [#60359] Harmonise FeedbackDialog slot naming
opf · Jan 13, 2025 · c067441 · c067441
2 parents d1f67d4 + dae6eae
commit c067441
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 29 deletions.
diff --git a/.changeset/short-students-type.md b/.changeset/short-students-type.md
@@ -0,0 +1,5 @@
+---
+'@openproject/primer-view-components': minor
+---
+
+[#60359] Harmonise FeedbackDialog slot naming: renames the `additional_content` slot to `additional_details` to make Feedback Dialog consistent with the newly introduced Danger Confirmation Dialog.
diff --git a/app/components/primer/open_project/feedback_dialog.html.erb b/app/components/primer/open_project/feedback_dialog.html.erb
@@ -1,8 +1,8 @@
 <%= render @dialog do |dialog| %>
   <% dialog.with_body do %>
     <%= feedback_message %>
-    <% if additional_content.present? %>
-      <%= additional_content %>
+    <% if additional_details.present? %>
+      <%= additional_details %>
     <% end %>
   <% end %>
   <% dialog.with_footer do %>

diff --git a/app/components/primer/open_project/feedback_dialog.rb b/app/components/primer/open_project/feedback_dialog.rb
@@ -17,15 +17,15 @@ class FeedbackDialog < Primer::Component
         Primer::OpenProject::FeedbackMessage.new(icon_arguments: icon_arguments, **system_arguments)
       }
 
-      # Optional additional_content like a form input or toast.
+      # Optional additional_details like a form input or toast.
       #
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      renders_one :additional_content, lambda { |**system_arguments|
+      renders_one :additional_details, lambda { |**system_arguments|
         deny_tag_argument(**system_arguments)
         system_arguments[:tag] = :div
         system_arguments[:classes] = class_names(
           system_arguments[:classes],
-          "FeedbackDialog-additionalContent"
+          "FeedbackDialog-additionalDetails"
         )
 
         system_arguments[:display] ||= :flex

diff --git a/previews/primer/open_project/danger_confirmation_dialog_preview/playground.html.erb b/previews/primer/open_project/danger_confirmation_dialog_preview/playground.html.erb
@@ -6,7 +6,7 @@
   <% end %>
   <% if show_additional_details %>
     <% dialog.with_additional_details do %>
-      <%= render(Primer::Alpha::Banner.new) { "Some additional content below" } %>
+      <%= render(Primer::Alpha::Banner.new) { "Some additional details below" } %>
     <% end %>
   <% end %>
   <% dialog.with_confirmation_check_box_content(check_box_text) %>

diff --git a/previews/primer/open_project/feedback_dialog_preview.rb b/previews/primer/open_project/feedback_dialog_preview.rb
@@ -24,19 +24,19 @@ def default
       # @param icon_color [Symbol] select [default, muted, subtle, accent, success, attention, severe, danger, open, closed, done, sponsors, on_emphasis, inherit]
       # @param loading_state [Boolean] toggle
       # @param show_description toggle
-      # @param show_additional_content toggle
+      # @param show_additional_details toggle
       # @param custom_footer toggle
-      def playground(icon: :"check-circle", icon_color: :success, loading_state: false, show_description: true, show_additional_content: false, custom_footer: false)
+      def playground(icon: :"check-circle", icon_color: :success, loading_state: false, show_description: true, show_additional_details: false, custom_footer: false)
         render_with_template(locals: { icon: icon,
                                        icon_color: icon_color,
                                        loading_state: loading_state,
                                        show_description: show_description,
-                                       show_additional_content: show_additional_content,
+                                       show_additional_details: show_additional_details,
                                        custom_footer: custom_footer })
       end
 
-      # @label With additional content
-      def additional_content
+      # @label With additional details
+      def with_additional_details
         render_with_template(locals: {})
       end
 
@@ -52,7 +52,7 @@ def custom_icon
       end
 
       # @label With custom footer
-      def custom_footer
+      def with_custom_footer
         render_with_template(locals: {})
       end
 

diff --git a/previews/primer/open_project/feedback_dialog_preview/playground.html.erb b/previews/primer/open_project/feedback_dialog_preview/playground.html.erb
@@ -4,9 +4,9 @@
     <% message.with_heading(tag: :h2).with_content("Awesome!") %>
     <% message.with_description { "Great! Everything worked well." } if show_description %>
   <% end %>
-  <% if show_additional_content %>
-    <% dialog.with_additional_content(display: :inline) do %>
-      <%= render(Primer::Alpha::Banner.new) { "Some additional content below" } %>
+  <% if show_additional_details %>
+    <% dialog.with_additional_details(display: :inline) do %>
+      <%= render(Primer::Alpha::Banner.new) { "Some additional details below" } %>
       <% end %>
   <% end %>
   <% if custom_footer %>

diff --git a/...ialog_preview/additional_content.html.erb → ..._preview/with_additional_details.html.erb b/...ialog_preview/additional_content.html.erb → ..._preview/with_additional_details.html.erb
@@ -3,7 +3,7 @@
   <% dialog.with_feedback_message do |message| %>
     <% message.with_heading(tag: :h2).with_content("Action successful") %>
   <% end %>
-  <% dialog.with_additional_content do %>
+  <% dialog.with_additional_details do %>
     <% render(Primer::Beta::Text.new) { "You can render whatever component you want here." } %>
   <% end %>
 <% end %>
diff --git a/...ack_dialog_preview/custom_footer.html.erb → ...ialog_preview/with_custom_footer.html.erb b/...ack_dialog_preview/custom_footer.html.erb → ...ialog_preview/with_custom_footer.html.erb
diff --git a/static/info_arch.json b/static/info_arch.json
@@ -17497,8 +17497,8 @@
         ]
       },
       {
-        "name": "additional_content",
-        "description": "Optional additional_content like a form input or toast.",
+        "name": "additional_details",
+        "description": "Optional additional_details like a form input or toast.",
         "parameters": [
           {
             "name": "system_arguments",
@@ -17547,8 +17547,8 @@
         }
       },
       {
-        "preview_path": "primer/open_project/feedback_dialog/additional_content",
-        "name": "additional_content",
+        "preview_path": "primer/open_project/feedback_dialog/with_additional_details",
+        "name": "with_additional_details",
         "snapshot": "false",
         "skip_rules": {
           "wont_fix": [
@@ -17573,8 +17573,8 @@
         }
       },
       {
-        "preview_path": "primer/open_project/feedback_dialog/custom_footer",
-        "name": "custom_footer",
+        "preview_path": "primer/open_project/feedback_dialog/with_custom_footer",
+        "name": "with_custom_footer",
         "snapshot": "false",
         "skip_rules": {
           "wont_fix": [

diff --git a/static/previews.json b/static/previews.json
@@ -3680,8 +3680,8 @@
         }
       },
       {
-        "preview_path": "primer/open_project/feedback_dialog/additional_content",
-        "name": "additional_content",
+        "preview_path": "primer/open_project/feedback_dialog/with_additional_details",
+        "name": "with_additional_details",
         "snapshot": "false",
         "skip_rules": {
           "wont_fix": [
@@ -3706,8 +3706,8 @@
         }
       },
       {
-        "preview_path": "primer/open_project/feedback_dialog/custom_footer",
-        "name": "custom_footer",
+        "preview_path": "primer/open_project/feedback_dialog/with_custom_footer",
+        "name": "with_custom_footer",
         "snapshot": "false",
         "skip_rules": {
           "wont_fix": [

diff --git a/test/components/primer/open_project/feedback_dialog_test.rb b/test/components/primer/open_project/feedback_dialog_test.rb
@@ -19,16 +19,16 @@ def test_renders
     end
   end
 
-  def test_renders_additional_content
+  def test_renders_additional_details
     render_inline(Primer::OpenProject::FeedbackDialog.new) do |dialog|
       dialog.with_feedback_message do |message|
         message.with_heading(tag: :h2) { "Success" }
       end
-      dialog.with_additional_content { "Some additional content" }
+      dialog.with_additional_details { "Some additional details" }
     end
 
     assert_selector("dialog.FeedbackDialog") do
-      assert_selector(".FeedbackDialog-additionalContent", text: "Some additional content")
+      assert_selector(".FeedbackDialog-additionalDetails", text: "Some additional details")
     end
   end