Make logged communications editable inline, like comments #1942
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| import { Controller } from "@hotwired/stimulus"; | ||
|
|
||
| // Connects to data-controller="edit-toggle" | ||
| // | ||
| // Toggles a list of records between read-only view blocks and inline edit forms | ||
| // (used by the comments and communications boxes on the Person / Registration / | ||
| // Scholarship edit forms). Each persisted record renders a `.{view}` block and a | ||
| // hidden `.{edit}` block; clicking the toggle flips which is shown and swaps the | ||
| // button label. | ||
| // | ||
| // Configure the block classes per caller: | ||
| // data-edit-toggle-view-class-value="comment-view" | ||
| // data-edit-toggle-edit-class-value="comment-edit" | ||
| // data-edit-toggle-body-class-value="comment-body" (optional) | ||
| // | ||
| // When a body class is given, leaving edit mode syncs each edit textarea back | ||
| // into the matching truncated `.{body}` span so the view reflects unsaved edits. | ||
| // | ||
| export default class extends Controller { | ||
| static targets = ["editLabel", "viewLabel"]; | ||
| static values = { | ||
| viewClass: { type: String, default: "editable-view" }, | ||
| editClass: { type: String, default: "editable-edit" }, | ||
| bodyClass: { type: String, default: "" }, | ||
| truncate: { type: Number, default: 135 } | ||
| }; | ||
|
|
||
| connect() { | ||
| this.editing = false; | ||
| } | ||
|
|
||
| toggle() { | ||
| this.editing = !this.editing; | ||
|
|
||
| // When leaving edit mode, sync edit textareas into their truncated view. | ||
|
Collaborator
Author
There was a problem hiding this comment. 🤖 From Claude: Generalized from |
||
| if (!this.editing && this.bodyClassValue) { | ||
| this.element.querySelectorAll(".nested-fields").forEach((item) => { | ||
|
Collaborator
There was a problem hiding this comment. This could be a good opportunity to update this controller to use stimulus targets vs. depending on class targets. |
||
| const textarea = item.querySelector(`.${this.editClassValue} textarea`); | ||
| const viewBody = item.querySelector( | ||
| `.${this.viewClassValue} .${this.bodyClassValue}` | ||
| ); | ||
| if (textarea && viewBody) { | ||
| const text = textarea.value; | ||
| const max = this.truncateValue; | ||
| viewBody.textContent = | ||
| text.length > max ? text.substring(0, max - 3) + "..." : text; | ||
| viewBody.title = text; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| this.element | ||
| .querySelectorAll(`.${this.viewClassValue}`) | ||
| .forEach((el) => (el.style.display = this.editing ? "none" : "")); | ||
| this.element | ||
| .querySelectorAll(`.${this.editClassValue}`) | ||
| .forEach((el) => (el.style.display = this.editing ? "" : "none")); | ||
|
|
||
| if (this.hasEditLabelTarget && this.hasViewLabelTarget) { | ||
| this.editLabelTarget.style.display = this.editing ? "none" : ""; | ||
| this.viewLabelTarget.style.display = this.editing ? "" : "none"; | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,14 @@ | ||
| <%# ---- Notifications — communications for this registrant, newest first. | ||
| Automated entries are read-only; manually logged entries addressed to this | ||
| registration can be edited inline (toggle "Edit communications", like the | ||
| comments box) and new ones added, both saved with the registration form. | ||
| Links open in a new tab so unsaved edits aren't lost. ---- %> | ||
| <% registration = f.object %> | ||
| <% email = registration.registrant.preferred_email %> | ||
| <% notifications = email.present? ? Notification.email(email).order(created_at: :desc) : Notification.none %> | ||
| <% new_notifications = registration.notifications.select(&:new_record?) %> | ||
| <% editable_notifications = notifications.select { |n| n.manual_log? && n.noticeable_type == EventRegistration.name && n.noticeable_id == registration.id } %> | ||
| <section class="overflow-hidden rounded-xl border border-gray-200 bg-white shadow-sm" data-controller="edit-toggle" data-edit-toggle-view-class-value="notification-view" data-edit-toggle-edit-class-value="notification-edit"> | ||
| <div class="flex items-center gap-3 border-b border-gray-100 px-4 py-3"> | ||
| <span class="flex h-8 w-8 shrink-0 items-center justify-center rounded-lg <%= DomainTheme.bg_class_for(:users, intensity: 100) %> <%= DomainTheme.text_class_for(:users, intensity: 600) %>"> | ||
| <i class="fa-solid fa-bell"></i> | ||
|
|
@@ -23,40 +25,50 @@ | |
| </div> | ||
|
|
||
| <div class="space-y-3 p-4"> | ||
| <div data-controller="paginated-fields" data-paginated-fields-per-page-value="5" class="space-y-2"> | ||
| <div id="registration-notification-list" class="space-y-2"> | ||
| <% notifications.each do |notification| %> | ||
| <% if editable_notifications.include?(notification) %> | ||
| <%= f.simple_fields_for :notifications, notification do |nf| %> | ||
| <%= render "notifications/notification_fields", f: nf, record: registration %> | ||
| <% end %> | ||
| <% else %> | ||
| <div data-paginated-fields-target="item"> | ||
| <%= render "notifications/notification_row", notification: notification %> | ||
| </div> | ||
| <% end %> | ||
| <% end %> | ||
| <%# New, unsaved entries — re-rendered here on validation error. %> | ||
| <%= f.simple_fields_for :notifications, new_notifications do |nf| %> | ||
| <%= render "notifications/notification_fields", f: nf, record: registration %> | ||
| <% end %> | ||
| </div> | ||
| <div data-paginated-fields-target="nav"></div> | ||
| </div> | ||
|
|
||
| <% if notifications.empty? && new_notifications.empty? %> | ||
| <p class="text-sm text-gray-400"><%= t("communications.none_for_registrant") %></p> | ||
| <% end %> | ||
|
|
||
| <div class="flex items-center justify-between gap-2 border-t border-gray-100 pt-3"> | ||
| <%= link_to_add_association f, :notifications, | ||
| partial: "notifications/notification_fields", | ||
| render_options: { locals: { record: registration } }, | ||
| data: { association_insertion_node: "#registration-notification-list", association_insertion_method: "append" }, | ||
| class: "inline-flex items-center gap-1.5 rounded-md px-2 py-1 text-xs font-medium text-gray-500 transition-colors hover:bg-gray-100 hover:text-gray-700 cursor-pointer" do %> | ||
| <i class="fa-solid fa-plus text-[0.6rem]"></i> | ||
| <%= t("communications.add") %> | ||
| <% end %> | ||
|
|
||
| <% if editable_notifications.any? %> | ||
| <button type="button" | ||
| class="inline-flex items-center gap-1.5 rounded-md px-2 py-1 text-xs font-medium text-gray-500 transition-colors hover:bg-gray-100 hover:text-gray-700 cursor-pointer" | ||
| data-action="click->edit-toggle#toggle"> | ||
| <i class="fa-solid fa-pen text-[0.6rem]"></i> | ||
| <span data-edit-toggle-target="editLabel"><%= t("communications.edit") %></span> | ||
| <span data-edit-toggle-target="viewLabel" style="display:none"><%= t("communications.done_editing") %></span> | ||
| </button> | ||
| <% end %> | ||
| </div> | ||
| </div> | ||
| </section> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,36 @@ | ||
| <%# ---- One manual-log communication, editable inline (mirrors the comment | ||
| edit-mode pattern). A persisted entry renders a read-only `.notification-view` | ||
| row plus a hidden `.notification-edit` form; the shared `edit-toggle` | ||
| controller flips between them. A new, unsaved entry renders the amber add | ||
| form directly. Only manually logged communications addressed to this record | ||
| render through this partial — automated notifications stay read-only in the | ||
| notifications box. A blank sender means the system ("AWBW Portal"). ---- %> | ||
| <% sender_users = User.where(super_user: true).includes(:person).to_a %> | ||
| <% sender_users |= [ current_user ] if current_user %> | ||
| <% sender_options = sender_users.sort_by { |u| u.full_name.to_s.downcase }.map { |u| [ u.full_name, u.id ] } %> | ||
| <% channel_default = Notification::MANUAL_CHANNELS.include?(f.object.channel) ? f.object.channel : "email" %> | ||
| <% record = local_assigns[:record] %> | ||
| <div class="nested-fields" data-paginated-fields-target="item"> | ||
| <%# Record this communication against its parent (the "Record" column in the | ||
| notifications index) — e.g. an event registration or a person. %> | ||
| <% if record %> | ||
| <%= f.hidden_field :noticeable_type, value: record.class.name %> | ||
| <%= f.hidden_field :noticeable_id, value: record.id %> | ||
| <% end %> | ||
|
|
||
| <% if f.object.persisted? %> | ||
| <%= f.hidden_field :id %> | ||
| <div class="notification-view"> | ||
| <%= render "notifications/notification_row", notification: f.object %> | ||
| </div> | ||
| <div class="notification-edit rounded-md border border-amber-200 bg-amber-50 p-3" style="display:none"> | ||
| <%= render "notifications/notification_form", f: f, sender_options: sender_options, | ||
| sender_selected: f.object.sender_id, channel_default: channel_default %> | ||
| </div> | ||
| <% else %> | ||
| <div class="rounded-md border border-amber-200 bg-amber-50 p-3"> | ||
| <%= render "notifications/notification_form", f: f, sender_options: sender_options, | ||
| sender_selected: f.object.sender_id || current_user&.id, channel_default: channel_default %> | ||
| </div> | ||
| <% end %> | ||
| </div> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe these could all be done with stimulus targets instead of setting a class as a selector.