openproject-primer_view_components 0.53.0 → 0.53.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f312782e514f8c2c795c8391c1a9277a600635907cd9186dd7bed5a6b6542fa
-  data.tar.gz: 4ef1d554d43cd2b2b08745d09946ca59be58f1b533570afaa68fc71a6652dc68
+  metadata.gz: 3a5ebd3e6efce535bd30f0428fd7cdd7771cef126a196dd41ff71519ac80a427
+  data.tar.gz: fec7772667aff0aa82f06cc19740eeb121e3228aa3142645e2c86938e58e57f6
 SHA512:
-  metadata.gz: fdcea5ccb557949c3b6a12573504752263643166eee41e7d8ba5e49c979272b87f3e7462d1e8aa9197906ccf54b606f5e30a19c22ca0ba1213a870792cf00bc2
-  data.tar.gz: f6849d0e9fd667bc0f92e713e16ef0cc07c20459f074cf58b945e1471b947e42eccff9bf09bb2ee95aa0b164fdd094fb5ee8e3c98cc213dba0f0a9ead743a2cc
+  metadata.gz: cb26f8fa7cf53c73d6560c002e1568b6a217c18e4ad462464ed1f510507c7030b63a2986e84c7a1d8d1c64d952d5166226ae5948839ae418d18a94b7489d331a
+  data.tar.gz: ddd1fe830a42b9bfd9fe6918c057d7e90c323e69b68e8233a6555f1732107672d07331358a5519f8d2173e6206e313d37c851bccc12b15b925006f19bf8373c9

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 0.53.1
+
+### Patch Changes
+
+- [#236](https://github.com/opf/primer_view_components/pull/236) [`de1a205`](https://github.com/opf/primer_view_components/commit/de1a205fc5ddfec39373bf579c2a8b2417ad9ca3) Thanks [@myabc](https://github.com/myabc)! - Fix regression: callers unable to set custom button text
+
+- [#237](https://github.com/opf/primer_view_components/pull/237) [`c2c98cf`](https://github.com/opf/primer_view_components/commit/c2c98cfc4bfc6cf62f116016a04015d7404d0a63) Thanks [@myabc](https://github.com/myabc)! - Make DangerDialog title param required: Axe will raise accessibility violations in the absence of a title. We want to ensure best a11y practice, so this change makes it a required param and documents it.
+
+  This is a BREAKING change.
+
+- [#237](https://github.com/opf/primer_view_components/pull/237) [`694bdae`](https://github.com/opf/primer_view_components/commit/694bdae3523774a92632ce7c53c235cdadf29e3f) Thanks [@myabc](https://github.com/myabc)! - Make FeedbackDialog title param required: Axe will raise accessibility violations in the absence of a title. We want to ensure best a11y practice, so this change makes it a required param and documents it.
+
+  This is a BREAKING change.
+
 ## 0.53.0
 
 ### Minor Changes

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

@@ -63,12 +63,14 @@ module Primer
 
       # @param form_arguments [Hash] Allows the dialog to submit a form. Pass EITHER the `builder:` option to this hash to reuse an existing Rails form, or `action:` if you prefer the component to render the form tag itself. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which is created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission.
       # @param id [String] The id of the dialog.
+      # @param title [String] The title of the dialog. Although visually hidden, a label is rendered for assistive technologies.
       # @param confirm_button_text [String] The text of the confirm button. Will default to `I18n.t("button_delete")`, or `I18n.t("button_delete_permanently")` if `confirmation_check_box` slot has been passed to the component.
       # @param cancel_button_text [String] The text of the cancel button. Will default to `I18n.t("button_cancel")`.
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
       def initialize(
         form_arguments: {},
         id: self.class.generate_id,
+        title:,
         confirm_button_text: nil,
         cancel_button_text: nil,
         **system_arguments
@@ -77,6 +79,9 @@ module Primer
         @form_wrapper = FormWrapper.new(**form_arguments)
         @dialog_id = id.to_s
 
+        @confirm_button_text = confirm_button_text
+        @cancel_button_text = cancel_button_text
+
         @system_arguments = system_arguments
         @system_arguments[:id] = @dialog_id
         @system_arguments[:classes] = class_names(
@@ -84,7 +89,7 @@ module Primer
           "DangerDialog"
         )
 
-        @dialog = Primer::Alpha::Dialog.new(title: @system_arguments[:title], subtitle: nil, visually_hide_title: true, **@system_arguments)
+        @dialog = Primer::Alpha::Dialog.new(title: title, subtitle: nil, visually_hide_title: true, **@system_arguments)
       end
 
       delegate :labelledby, :header?, :header, :with_header, :with_header_content,

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

@@ -40,8 +40,9 @@ module Primer
 
       renders_one :footer
 
+      # @param title [String] The title of the dialog. Although visually hidden, a label is rendered for assistive technologies.
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      def initialize(**system_arguments)
+      def initialize(title:, **system_arguments)
         @system_arguments = system_arguments
         @system_arguments[:classes] = class_names(
           system_arguments[:classes],
@@ -49,7 +50,7 @@ module Primer
         )
         @system_arguments[:id] ||= self.class.generate_id
 
-        @dialog = Primer::Alpha::Dialog.new(title: @system_arguments[:title], subtitle: nil, visually_hide_title: true, **@system_arguments)
+        @dialog = Primer::Alpha::Dialog.new(title: title, subtitle: nil, visually_hide_title: true, **@system_arguments)
       end
 
       delegate :header?, :header, :with_header, :with_header_content,

data/lib/primer/view_components/version.rb

@@ -6,7 +6,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 53
-      PATCH = 0
+      PATCH = 1
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

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

@@ -1,4 +1,5 @@
 <%= render(Primer::OpenProject::DangerDialog.new(id: "my-dialog",
+                                                 title: "My dialog",
                                                  confirm_button_text: confirm_button_text,
                                                  cancel_button_text: cancel_button_text)) do |dialog| %>
   <% dialog.with_show_button { "Click me" } %>

data/previews/primer/open_project/danger_dialog_preview/with_additional_details.html.erb

@@ -1,4 +1,4 @@
-<%= render(Primer::OpenProject::DangerDialog.new) do |dialog| %>
+<%= render(Primer::OpenProject::DangerDialog.new(title: "Delete work packages")) do |dialog| %>
   <% dialog.with_show_button { "Click me" } %>
   <% dialog.with_confirmation_message do |message| %>
     <% message.with_heading(tag: :h2).with_content("Delete 5 work packages?") %>

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

@@ -1,4 +1,4 @@
-<%= render(Primer::OpenProject::FeedbackDialog.new(id: "my-dialog")) do |dialog| %>
+<%= render(Primer::OpenProject::FeedbackDialog.new(id: "my-dialog", title: "My dialog")) do |dialog| %>
   <% dialog.with_show_button { "Click me" } %>
   <% dialog.with_feedback_message(icon_arguments: { icon: icon, color: icon_color }, loading: loading_state) do |message| %>
     <% message.with_heading(tag: :h2).with_content("Awesome!") %>

data/previews/primer/open_project/feedback_dialog_preview/with_additional_details.html.erb

@@ -1,4 +1,4 @@
-<%= render(Primer::OpenProject::FeedbackDialog.new) do |dialog| %>
+<%= render(Primer::OpenProject::FeedbackDialog.new(title: "Success message")) do |dialog| %>
   <% dialog.with_show_button { "Click me" } %>
   <% dialog.with_feedback_message do |message| %>
     <% message.with_heading(tag: :h2).with_content("Action successful") %>

data/previews/primer/open_project/feedback_dialog_preview/with_custom_footer.html.erb

@@ -1,4 +1,4 @@
-<%= render(Primer::OpenProject::FeedbackDialog.new(id: "my-dialog")) do |dialog| %>
+<%= render(Primer::OpenProject::FeedbackDialog.new(id: "my-dialog", title: "Custom footer")) do |dialog| %>
   <% dialog.with_show_button { "Click me" } %>
   <% dialog.with_feedback_message do |message| %>
     <% message.with_heading(tag: :h2).with_content("Action successful") %>

data/static/arguments.json

@@ -5131,6 +5131,12 @@
         "default": "`self.class.generate_id`",
         "description": "The id of the dialog."
       },
+      {
+        "name": "title",
+        "type": "String",
+        "default": "N/A",
+        "description": "The title of the dialog. Although visually hidden, a label is rendered for assistive technologies."
+      },
       {
         "name": "confirm_button_text",
         "type": "String",
@@ -5214,6 +5220,12 @@
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/feedback_dialog.rb",
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/feedback_dialog/default/",
     "parameters": [
+      {
+        "name": "title",
+        "type": "String",
+        "default": "N/A",
+        "description": "The title of the dialog. Although visually hidden, a label is rendered for assistive technologies."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",

data/static/info_arch.json

@@ -17532,6 +17532,12 @@
         "default": "`self.class.generate_id`",
         "description": "The id of the dialog."
       },
+      {
+        "name": "title",
+        "type": "String",
+        "default": "N/A",
+        "description": "The title of the dialog. Although visually hidden, a label is rendered for assistive technologies."
+      },
       {
         "name": "confirm_button_text",
         "type": "String",
@@ -17878,6 +17884,12 @@
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/feedback_dialog.rb",
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/feedback_dialog/default/",
     "parameters": [
+      {
+        "name": "title",
+        "type": "String",
+        "default": "N/A",
+        "description": "The title of the dialog. Although visually hidden, a label is rendered for assistive technologies."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openproject-primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.53.1
 platform: ruby
 authors:
 - GitHub Open Source