openproject-primer_view_components 0.52.4 → 0.53.1

data/static/info_arch.json

@@ -17507,18 +17507,18 @@
     ]
   },
   {
-    "fully_qualified_name": "Primer::OpenProject::DangerConfirmationDialog",
+    "fully_qualified_name": "Primer::OpenProject::DangerDialog",
     "description": "A pre-configured dialog for destructive/\"potentially dangerous\" actions",
     "accessibility_docs": null,
     "is_form_component": false,
     "is_published": true,
     "requires_js": false,
-    "component": "OpenProject::DangerConfirmationDialog",
+    "component": "OpenProject::DangerDialog",
     "status": "open_project",
     "a11y_reviewed": false,
-    "short_name": "OpenProjectDangerConfirmationDialog",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/danger_confirmation_dialog.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/danger_confirmation_dialog/default/",
+    "short_name": "OpenProjectDangerDialog",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/danger_dialog.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/danger_dialog/default/",
     "parameters": [
       {
         "name": "form_arguments",
@@ -17532,6 +17532,24 @@
         "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",
+        "default": "`nil`",
+        "description": "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."
+      },
+      {
+        "name": "cancel_button_text",
+        "type": "String",
+        "default": "`nil`",
+        "description": "The text of the cancel button. Will default to `I18n.t(\"button_cancel\")`."
+      },
       {
         "name": "system_arguments",
         "type": "Hash",
@@ -17560,7 +17578,7 @@
       },
       {
         "name": "confirmation_check_box",
-        "description": "A checkbox that the user is required to check in order to continue with the destructive action.\n\nTo render the checkbox label (required), pass a block that returns a String.",
+        "description": "An optional checkbox that the user is required to check in order to continue with the destructive action.\n\nTo render the checkbox label (required), pass a block that returns a String.",
         "parameters": [
           {
             "name": "system_arguments",
@@ -17597,7 +17615,7 @@
     ],
     "previews": [
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/default",
+        "preview_path": "primer/open_project/danger_dialog/default",
         "name": "default",
         "snapshot": "interactive",
         "skip_rules": {
@@ -17610,7 +17628,20 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/playground",
+        "preview_path": "primer/open_project/danger_dialog/with_confirmation_check_box",
+        "name": "with_confirmation_check_box",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/open_project/danger_dialog/playground",
         "name": "playground",
         "snapshot": "false",
         "skip_rules": {
@@ -17623,7 +17654,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form_builder_form",
+        "preview_path": "primer/open_project/danger_dialog/with_form_builder_form",
         "name": "with_form_builder_form",
         "snapshot": "false",
         "skip_rules": {
@@ -17636,7 +17667,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form",
+        "preview_path": "primer/open_project/danger_dialog/with_form",
         "name": "with_form",
         "snapshot": "false",
         "skip_rules": {
@@ -17649,7 +17680,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_additional_details",
+        "preview_path": "primer/open_project/danger_dialog/with_additional_details",
         "name": "with_additional_details",
         "snapshot": "false",
         "skip_rules": {
@@ -17662,7 +17693,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/custom_icon",
+        "preview_path": "primer/open_project/danger_dialog/custom_icon",
         "name": "custom_icon",
         "snapshot": "false",
         "skip_rules": {
@@ -17675,7 +17706,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form_builder_form_test",
+        "preview_path": "primer/open_project/danger_dialog/with_form_builder_form_test",
         "name": "with_form_builder_form_test",
         "snapshot": "false",
         "skip_rules": {
@@ -17688,7 +17719,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form_test",
+        "preview_path": "primer/open_project/danger_dialog/with_form_test",
         "name": "with_form_test",
         "snapshot": "false",
         "skip_rules": {
@@ -17706,18 +17737,18 @@
     ]
   },
   {
-    "fully_qualified_name": "Primer::OpenProject::DangerConfirmationDialog::ConfirmationCheckBox",
-    "description": "This component is part of `Primer::OpenProject::DangerConfirmationDialog`\nand should not be used as a standalone component.",
+    "fully_qualified_name": "Primer::OpenProject::DangerDialog::ConfirmationCheckBox",
+    "description": "This component is part of `Primer::OpenProject::DangerDialog`\nand should not be used as a standalone component.",
     "accessibility_docs": null,
     "is_form_component": false,
     "is_published": true,
     "requires_js": false,
-    "component": "OpenProject::DangerConfirmationDialog::ConfirmationCheckBox",
+    "component": "OpenProject::DangerDialog::ConfirmationCheckBox",
     "status": "open_project",
     "a11y_reviewed": false,
-    "short_name": "OpenProjectDangerConfirmationDialogConfirmationCheckBox",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/danger_confirmation_dialog/confirmation_check_box.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/danger_confirmation_dialog/confirmation_check_box/default/",
+    "short_name": "OpenProjectDangerDialogConfirmationCheckBox",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/danger_dialog/confirmation_check_box.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/danger_dialog/confirmation_check_box/default/",
     "parameters": [
       {
         "name": "check_box_id",
@@ -17752,18 +17783,18 @@
     ]
   },
   {
-    "fully_qualified_name": "Primer::OpenProject::DangerConfirmationDialog::FormWrapper",
-    "description": "Utility component for wrapping DangerConfirmationDialog in a form",
+    "fully_qualified_name": "Primer::OpenProject::DangerDialog::FormWrapper",
+    "description": "Utility component for wrapping DangerDialog in a form",
     "accessibility_docs": null,
     "is_form_component": false,
     "is_published": true,
     "requires_js": false,
-    "component": "OpenProject::DangerConfirmationDialog::FormWrapper",
+    "component": "OpenProject::DangerDialog::FormWrapper",
     "status": "open_project",
     "a11y_reviewed": false,
-    "short_name": "OpenProjectDangerConfirmationDialogFormWrapper",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/danger_confirmation_dialog/form_wrapper.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/danger_confirmation_dialog/form_wrapper/default/",
+    "short_name": "OpenProjectDangerDialogFormWrapper",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/danger_dialog/form_wrapper.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/danger_dialog/form_wrapper/default/",
     "parameters": [
 
     ],
@@ -17853,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",

data/static/previews.json

@@ -3109,13 +3109,13 @@
     ]
   },
   {
-    "name": "danger_confirmation_dialog",
-    "component": "OpenProject::DangerConfirmationDialog",
+    "name": "danger_dialog",
+    "component": "OpenProject::DangerDialog",
     "status": "open_project",
-    "lookup_path": "primer/open_project/danger_confirmation_dialog",
+    "lookup_path": "primer/open_project/danger_dialog",
     "examples": [
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/default",
+        "preview_path": "primer/open_project/danger_dialog/default",
         "name": "default",
         "snapshot": "interactive",
         "skip_rules": {
@@ -3128,7 +3128,20 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/playground",
+        "preview_path": "primer/open_project/danger_dialog/with_confirmation_check_box",
+        "name": "with_confirmation_check_box",
+        "snapshot": "interactive",
+        "skip_rules": {
+          "wont_fix": [
+            "region"
+          ],
+          "will_fix": [
+            "color-contrast"
+          ]
+        }
+      },
+      {
+        "preview_path": "primer/open_project/danger_dialog/playground",
         "name": "playground",
         "snapshot": "false",
         "skip_rules": {
@@ -3141,7 +3154,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form_builder_form",
+        "preview_path": "primer/open_project/danger_dialog/with_form_builder_form",
         "name": "with_form_builder_form",
         "snapshot": "false",
         "skip_rules": {
@@ -3154,7 +3167,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form",
+        "preview_path": "primer/open_project/danger_dialog/with_form",
         "name": "with_form",
         "snapshot": "false",
         "skip_rules": {
@@ -3167,7 +3180,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_additional_details",
+        "preview_path": "primer/open_project/danger_dialog/with_additional_details",
         "name": "with_additional_details",
         "snapshot": "false",
         "skip_rules": {
@@ -3180,7 +3193,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/custom_icon",
+        "preview_path": "primer/open_project/danger_dialog/custom_icon",
         "name": "custom_icon",
         "snapshot": "false",
         "skip_rules": {
@@ -3193,7 +3206,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form_builder_form_test",
+        "preview_path": "primer/open_project/danger_dialog/with_form_builder_form_test",
         "name": "with_form_builder_form_test",
         "snapshot": "false",
         "skip_rules": {
@@ -3206,7 +3219,7 @@
         }
       },
       {
-        "preview_path": "primer/open_project/danger_confirmation_dialog/with_form_test",
+        "preview_path": "primer/open_project/danger_dialog/with_form_test",
         "name": "with_form_test",
         "snapshot": "false",
         "skip_rules": {

data/static/statuses.json

@@ -118,9 +118,9 @@
   "Primer::Navigation::TabComponent": "deprecated",
   "Primer::OpenProject::BorderGrid": "open_project",
   "Primer::OpenProject::BorderGrid::Cell": "open_project",
-  "Primer::OpenProject::DangerConfirmationDialog": "open_project",
-  "Primer::OpenProject::DangerConfirmationDialog::ConfirmationCheckBox": "open_project",
-  "Primer::OpenProject::DangerConfirmationDialog::FormWrapper": "open_project",
+  "Primer::OpenProject::DangerDialog": "open_project",
+  "Primer::OpenProject::DangerDialog::ConfirmationCheckBox": "open_project",
+  "Primer::OpenProject::DangerDialog::FormWrapper": "open_project",
   "Primer::OpenProject::DragHandle": "open_project",
   "Primer::OpenProject::FeedbackDialog": "open_project",
   "Primer::OpenProject::FeedbackMessage": "open_project",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openproject-primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.52.4
+  version: 0.53.1
 platform: ruby
 authors:
 - GitHub Open Source
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -103,7 +103,7 @@ files:
 - app/assets/javascripts/components/primer/beta/relative_time.d.ts
 - app/assets/javascripts/components/primer/dialog_helper.d.ts
 - app/assets/javascripts/components/primer/focus_group.d.ts
-- app/assets/javascripts/components/primer/open_project/danger_confirmation_dialog_form_helper.d.ts
+- app/assets/javascripts/components/primer/open_project/danger_dialog_form_helper.d.ts
 - app/assets/javascripts/components/primer/open_project/page_header_element.d.ts
 - app/assets/javascripts/components/primer/open_project/sub_header_element.d.ts
 - app/assets/javascripts/components/primer/open_project/zen_mode_button.d.ts
@@ -493,14 +493,14 @@ files:
 - app/components/primer/open_project/border_grid.rb
 - app/components/primer/open_project/border_grid/cell.html.erb
 - app/components/primer/open_project/border_grid/cell.rb
-- app/components/primer/open_project/danger_confirmation_dialog.html.erb
-- app/components/primer/open_project/danger_confirmation_dialog.rb
-- app/components/primer/open_project/danger_confirmation_dialog/confirmation_check_box.rb
-- app/components/primer/open_project/danger_confirmation_dialog/form_wrapper.html.erb
-- app/components/primer/open_project/danger_confirmation_dialog/form_wrapper.rb
-- app/components/primer/open_project/danger_confirmation_dialog_form_helper.d.ts
-- app/components/primer/open_project/danger_confirmation_dialog_form_helper.js
-- app/components/primer/open_project/danger_confirmation_dialog_form_helper.ts
+- app/components/primer/open_project/danger_dialog.html.erb
+- app/components/primer/open_project/danger_dialog.rb
+- app/components/primer/open_project/danger_dialog/confirmation_check_box.rb
+- app/components/primer/open_project/danger_dialog/form_wrapper.html.erb
+- app/components/primer/open_project/danger_dialog/form_wrapper.rb
+- app/components/primer/open_project/danger_dialog_form_helper.d.ts
+- app/components/primer/open_project/danger_dialog_form_helper.js
+- app/components/primer/open_project/danger_dialog_form_helper.ts
 - app/components/primer/open_project/drag_handle.css
 - app/components/primer/open_project/drag_handle.css.json
 - app/components/primer/open_project/drag_handle.css.map
@@ -1027,13 +1027,14 @@ files:
 - previews/primer/forms_preview/submit_button_form.html.erb
 - previews/primer/forms_preview/text_field_and_checkbox_form.html.erb
 - previews/primer/open_project/border_grid_preview.rb
-- previews/primer/open_project/danger_confirmation_dialog_preview.rb
-- previews/primer/open_project/danger_confirmation_dialog_preview/playground.html.erb
-- previews/primer/open_project/danger_confirmation_dialog_preview/with_additional_details.html.erb
-- previews/primer/open_project/danger_confirmation_dialog_preview/with_form.html.erb
-- previews/primer/open_project/danger_confirmation_dialog_preview/with_form_builder_form.html.erb
-- previews/primer/open_project/danger_confirmation_dialog_preview/with_form_builder_form_test.html.erb
-- previews/primer/open_project/danger_confirmation_dialog_preview/with_form_test.html.erb
+- previews/primer/open_project/danger_dialog_preview.rb
+- previews/primer/open_project/danger_dialog_preview/deletion_form.rb
+- previews/primer/open_project/danger_dialog_preview/playground.html.erb
+- previews/primer/open_project/danger_dialog_preview/with_additional_details.html.erb
+- previews/primer/open_project/danger_dialog_preview/with_form.html.erb
+- previews/primer/open_project/danger_dialog_preview/with_form_builder_form.html.erb
+- previews/primer/open_project/danger_dialog_preview/with_form_builder_form_test.html.erb
+- previews/primer/open_project/danger_dialog_preview/with_form_test.html.erb
 - previews/primer/open_project/drag_handle_preview.rb
 - previews/primer/open_project/feedback_dialog_preview.rb
 - previews/primer/open_project/feedback_dialog_preview/playground.html.erb

data/app/assets/javascripts/components/primer/open_project/danger_confirmation_dialog_form_helper.d.ts

@@ -1,13 +0,0 @@
-declare class DangerConfirmationDialogFormHelperElement extends HTMLElement {
-    #private;
-    checkbox: HTMLInputElement;
-    get submitButton(): HTMLButtonElement | HTMLInputElement;
-    connectedCallback(): void;
-    toggle(): void;
-}
-declare global {
-    interface Window {
-        DangerConfirmationDialogFormHelperElement: typeof DangerConfirmationDialogFormHelperElement;
-    }
-}
-export {};

data/app/components/primer/open_project/danger_confirmation_dialog_form_helper.d.ts

@@ -1,13 +0,0 @@
-declare class DangerConfirmationDialogFormHelperElement extends HTMLElement {
-    #private;
-    checkbox: HTMLInputElement;
-    get submitButton(): HTMLInputElement | HTMLButtonElement;
-    connectedCallback(): void;
-    toggle(): void;
-}
-declare global {
-    interface Window {
-        DangerConfirmationDialogFormHelperElement: typeof DangerConfirmationDialogFormHelperElement;
-    }
-}
-export {};

data/app/components/primer/open_project/danger_confirmation_dialog_form_helper.ts

@@ -1,36 +0,0 @@
-import {controller, target} from '@github/catalyst'
-
-const SUBMIT_BUTTON_SELECTOR = 'input[type=submit],button[type=submit],button[data-submit-dialog-id]'
-
-@controller
-class DangerConfirmationDialogFormHelperElement extends HTMLElement {
-  @target checkbox: HTMLInputElement
-
-  get submitButton() {
-    return this.querySelector<HTMLInputElement | HTMLButtonElement>(SUBMIT_BUTTON_SELECTOR)!
-  }
-
-  connectedCallback() {
-    this.#reset()
-  }
-
-  toggle(): void {
-    this.submitButton.disabled = !this.checkbox.checked
-  }
-
-  #reset(): void {
-    this.checkbox.checked = false
-    this.toggle()
-  }
-}
-
-declare global {
-  interface Window {
-    DangerConfirmationDialogFormHelperElement: typeof DangerConfirmationDialogFormHelperElement
-  }
-}
-
-if (!window.customElements.get('danger-confirmation-dialog-form-helper')) {
-  window.DangerConfirmationDialogFormHelperElement = DangerConfirmationDialogFormHelperElement
-  window.customElements.define('danger-confirmation-dialog-form-helper', DangerConfirmationDialogFormHelperElement)
-}

data/previews/primer/open_project/danger_confirmation_dialog_preview/with_form_builder_form.html.erb

@@ -1,14 +0,0 @@
-<!-- Use the correct form URL here. -->
-<%= form_with(url: "") do |f| %>
-  <%= render(Primer::OpenProject::DangerConfirmationDialog.new(
-        title: "Delete dialog",
-        form_arguments: { builder: f, name: "confirm_very_dangerous_action" }
-      )) do |dialog| %>
-    <% dialog.with_show_button { "Click me" } %>
-    <% dialog.with_confirmation_message do |message|
-        message.with_heading(tag: :h2).with_content("Permanently delete?")
-        message.with_description_content("This action is not reversible. Please proceed with caution.")
-       end %>
-    <% dialog.with_confirmation_check_box_content("I understand that this deletion cannot be reversed") %>
-  <% end %>
-<% end %>

data/previews/primer/open_project/danger_confirmation_dialog_preview/with_form_builder_form_test.html.erb

@@ -1,13 +0,0 @@
-<%= form_with(url: generic_form_submission_path(route_format)) do |f| %>
-  <%= render(Primer::OpenProject::DangerConfirmationDialog.new(
-        title: "Delete dialog",
-        form_arguments: { builder: f, name: "confirm_very_dangerous_action" }
-      )) do |dialog| %>
-    <% dialog.with_show_button { "Click me" } %>
-    <% dialog.with_confirmation_message do |message|
-        message.with_heading(tag: :h2).with_content("Permanently delete?")
-        message.with_description_content("This action is not reversible. Please proceed with caution.")
-       end %>
-    <% dialog.with_confirmation_check_box_content("I understand that this deletion cannot be reversed") %>
-  <% end %>
-<% end %>