import { Controller } from "stimulus"; // Manage "changed" state for a form with multiple records // // When any elements are changed: // - the element is marked ".changed" // - "actions" element appears // - "changedSummary" element is updated using I18n // - "disableSelector" elements are disabled // - The browser will warn if trying to leave the page // // Supported element types: // - input[type=text] and similar // - input[type=checkbox] // - select (single) - including tom-select // export default class BulkFormController extends Controller { static targets = ["actions", "changedSummary"]; static values = { disableSelector: String, error: Boolean, }; recordElements = {}; connect() { this.submitting = false; this.form = this.element; // Start listening for any changes within the form this.#registerElements(this.form.elements); this.toggleFormChanged(); this.form.addEventListener("submit", this.#registerSubmit.bind(this)); window.addEventListener("beforeunload", this.preventLeavingChangedForm.bind(this)); document.addEventListener("turbo:before-visit", this.preventLeavingChangedForm.bind(this)); // Frustratingly there's no before-frame-visit, and no other events work, so we need to bind to // the frame and listen for any link clicks (maybe other things too). this.turboFrame = this.form.closest("turbo-frame"); if(this.turboFrame){ this.turboFrame.addEventListener("click", this.preventLeavingChangedForm.bind(this)) } } disconnect() { // Make sure to clean up anything that happened outside this.#disableOtherElements(false); window.removeEventListener("beforeunload", this.preventLeavingChangedForm.bind(this)); document.removeEventListener("turbo:before-visit", this.preventLeavingChangedForm.bind(this)); if(this.turboFrame){ this.turboFrame.removeEventListener("click", this.preventLeavingChangedForm.bind(this)); } } // Register any new elements (may be called by another controller after dynamically adding fields) registerElements() { const registeredElements = Object.values(this.recordElements).flat(); // Select only elements that haven't been registered yet const newElements = Array.from(this.form.elements).filter( (n) => !registeredElements.includes(n), ); this.#registerElements(newElements); } toggleChanged(e) { const element = e.target; element.classList.toggle("changed", this.#isChanged(element)); this.toggleFormChanged(); } toggleFormChanged() { // For each record, check if any fields are changed // TODO: optimise basd on current state. if field is changed, but form already changed, no need to update (and vice versa) const changedRecordCount = Object.values(this.recordElements).filter((elements) => elements.some(this.#isChanged), ).length; this.formChanged = changedRecordCount > 0 || this.errorValue; // Show actions this.hasActionsTarget && this.actionsTarget.classList.toggle("hidden", !this.formChanged); this.#disableOtherElements(this.formChanged); // like filters and sorting // Display number of records changed const key = this.hasChangedSummaryTarget && this.changedSummaryTarget.dataset.translationKey; if (key) { // TODO: save processing and only run if changedRecordCount has changed. this.changedSummaryTarget.textContent = I18n.t(key, { count: changedRecordCount }); } } // If navigating away from form, warn to prevent accidental data loss preventLeavingChangedForm(event) { const target = event.target; // Ignore non-navigation events (see above) if(this.turboFrame && this.turboFrame.contains(target) && (target.tagName != "A" || target.dataset.turboFrame != "_self")){ return; } if (this.formChanged && !this.submitting) { // If fired by a custom event (eg Turbo), we need to explicitly ask. // This is skipped on beforeunload. if(confirm(I18n.t("are_you_sure"))){ return; } // Cancel the event event.preventDefault(); // Chrome requires returnValue to be set, but ignores the value. Other browsers may display // this if provided, but let's not create a new translation key, and keep the behaviour // consistent. event.returnValue = ""; } } // private #registerSubmit() { this.submitting = true; } #registerElements(elements) { for (const element of elements) { element.addEventListener("input", this.toggleChanged.bind(this)); // immediately respond to any change // Set up a tree of fields according to their associated record const recordContainer = element.closest("[data-record-id]"); // The JS could be more efficient if this data was added to each element. But I didn't want to pollute the HTML too much. const recordId = recordContainer && recordContainer.dataset.recordId; if (recordId) { this.recordElements[recordId] ||= []; this.recordElements[recordId].push(element); } } } #disableOtherElements(disable) { if (!this.hasDisableSelectorValue) return; this.disableElements ||= document.querySelectorAll(this.disableSelectorValue); if (!this.disableElements) return; this.disableElements.forEach((element) => { element.classList.toggle("disabled-section", disable); // Also disable any form elements let forms = element.tagName == "FORM" ? [element] : element.querySelectorAll("form"); forms && forms.forEach((form) => Array.from(form.elements).forEach((formElement) => (formElement.disabled = disable)), ); }); } #isChanged(element) { if (element.type == "checkbox") { return element.defaultChecked !== undefined && element.checked != element.defaultChecked; } else if (element.type == "select-one") { const defaultSelected = Array.from(element.options).find((opt) => opt.hasAttribute("selected"), ); return element.selectedOptions[0] != defaultSelected; } else { return element.defaultValue !== undefined && element.value != element.defaultValue; } } }