Part-DB.Part-DB-server/assets/controllers/helpers/form_cleanup_controller.js

/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import {Controller} from "@hotwired/stimulus";

/**
 * Purpose of this controller is to clean up the form before it is finally submitted. This means empty fields get disabled, so they are not submitted.
 * This is especially useful for GET forms, to prevent very long URLs
 */
export default class extends Controller {

    /**
     * Call during the submit event of the form. This will disable all empty fields, so they are not submitted.
     * @param event
     */
    submit(event) {
        /** Find the form this event belongs to */
        /** @type {HTMLFormElement} */
        const form = event.target.closest('form');

        for(const element of form.elements) {
            if(! element.value) {
                element.disabled = true;
            }

            //Workaround for tristate checkboxes which use a hidden field to store the value
            if ((element.type === 'hidden' || element.type === 'checkbox') && element.value === 'indeterminate') {
                element.disabled = true;
            }
        }
    }

    /**
     * Submits the form with all form elements disabled, so they are not submitted. This is useful for GET forms, to reset the form to not filled state.
     * @param event
     */
    clearAll(event)
    {
        const form = event.target.closest('form');
        for(const element of form.elements) {
            // Do not clear elements with data-no-clear attribute
            if(element.dataset.noClear) {
                continue;
            }

            element.disabled = true;
        }

        form.submit();
    }
}