[6.1] Subform: add order-changed event

[Fedik]

Pull Request for Issue #45994 .

Summary of Changes

Add subform-order-changed event when order is changed in subform.

Testing Instructions

Apply patch.
Run npm install.
Add subform somewhere, example in Custom HTML module parameters:

<field type="subform" name="subform" label="Subform" multiple="true">
  <form>
    <field type="text" name="text" label="Text"/>
  </form>
</field>

Add in to index.php of Atum template:

$wa->addInlineScript('
 document.addEventListener("subform-order-changed", function(event) {
    console.log("fromPosition: " + event.detail.fromPosition, "toPosition: " + event.detail.toPosition);
 });
', [], ['type' => 'module']);

Open the form with sbform, open browser console.
Try sort the rows in subform, and check console output.

Actual result BEFORE applying this Pull Request

Console is silent

Expected result AFTER applying this Pull Request

In console a message like "fromPosition: 0, toPosition: 1"

Link to documentations

Please select:

• Documentation link for docs.joomla.org:
• No documentation changes for docs.joomla.org needed
• Pull Request link for manual.joomla.org: Subform JavaScript events Manual#579
• No documentation changes for manual.joomla.org needed

[Fedik]

I will rebase to 6.1 when it will be in sync

[ceford]

I have tested this item ✅ successfully on 08a3f52

I found the instructions difficult. As this is a single JavaScript file change the rebuild should be npm run build:js. I used a new instance of Modules: Articles to test as there are already two subforms there. I created two instances of the Test text and moved them up/down. In the Console I needed to select the Logs item to see the message (I am not too familiar with the Console). Got there in the end!

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/46093.}

[muhme]

@Fedik We are sorry, couldn't test it. We applied PR and run npm ci, created custom HTML module with given content, inserted the code in administrator/templates/atum/index.php, reloaded backend page and moved the custom site module around in the list of site modules, but no console log. What could be missing?

[Fedik]

the custom site module around in the list of site modules, but no console log. What could be missing?

Need to move the subform rows from the example 😉
Or any other subform, can also try create Custom field "subfrom" for article, and test it there.

[muhme]

I have tested this item ✅ successfully on 474b6b7

Tested with JBT

• Applied PR with Patch Tester and running npm run build:js
• Inserted the JS-snippet in administrator/templates/atum/index.php in the beginning, after $wa is set
• Created Number field and Text field first and Subform field second with the number and the text field
• in the backend, in the subform field configuration, moving the second field in first place or back, always results in the console log message

  ---

  _{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/46093.}

[richard67]

RTC

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/46093.}

[HLeithner]

@Fedik thanks, could you please create/update documentation in the manual for it?

[Fedik]

There it is:

• Subform JavaScript events Manual#579