[3.10] Joomla.Showon.initialise API, and make sure that showon initialised only once, fork of 18843

[Fedik]

Pull Request for Issue #18843 and only for J3 .

Summary of Changes

This is fork of #18843, with requested changes.
The code make sure that showon initialised only once, no mater how often Joomla.setUpShowon was called.
This is achieved with extra flag showonInitialised that sets while showon initialisation.

Testing Instructions

Make sure showon still works.

Example, go to global config change "Debug Language" on/off, should downup/hides "Language Display" field.
Also the field "Language Display" will have extra attribute data-showon-initialised

Actual result BEFORE applying this Pull Request

showon works,
the showon field do not have data-showon-initialised

Expected result AFTER applying this Pull Request

showon works,
the showon field do have data-showon-initialised attribute

[richard67]

@Fedik #18843 can be closed, right?

[Fedik]

yeah, I have included changes from that pull

[dgrammatiko]

@Fedik diffing the changes with the v4 version of show on I think you need to rename this to Joomla.Showon.initilise to be called like Joomla.Showon.initilise(field). The initialise in J4 could be a function in the Class with this code (the refactoring should be straight forward):

joomla-cms/build/media_source/system/js/showon.es6.js

Lines 32 to 84 in d49e461

	const jsondata = field.getAttribute('data-showon') || '';
	const showonData = JSON.parse(jsondata);
	let localFields;
	if (showonData.length) {
	localFields = [].slice.call(self.container.querySelectorAll(`[name="${showonData[0].field}"], [name="${showonData[0].field}[]"]`));
	if (!this.fields[showonData[0].field]) {
	this.fields[showonData[0].field] = {
	origin: [],
	targets: [],
	};
	}
	// Add trigger elements
	localFields.forEach((cField) => {
	if (this.fields[showonData[0].field].origin.indexOf(cField) === -1) {
	this.fields[showonData[0].field].origin.push(cField);
	}
	});
	// Add target elements
	this.fields[showonData[0].field].targets.push(field);
	// Data showon can have multiple values
	if (showonData.length > 1) {
	showonData.forEach((value, index) => {
	if (index === 0) {
	return;
	}
	localFields = [].slice.call(self.container.querySelectorAll(`[name="${value.field}"], [name="${value.field}[]"]`));
	if (!this.fields[showonData[0].field]) {
	this.fields[showonData[0].field] = {
	origin: [],
	targets: [],
	};
	}
	// Add trigger elements
	localFields.forEach((cField) => {
	if (this.fields[showonData[0].field].origin.indexOf(cField) === -1) {
	this.fields[showonData[0].field].origin.push(cField);
	}
	});
	// Add target elements
	if (this.fields[showonData[0].field].targets.indexOf(field) === -1) {
	this.fields[showonData[0].field].targets.push(field);
	}
	});
	}

[Fedik]

This only for J3, it should not go to J4,
there already event stuff for such thing:

joomla-cms/build/media_source/system/js/showon.es6.js

Lines 215 to 218 in d49e461

	/**
	* Initialize 'showon' feature when part of the page was updated
	*/
	document.addEventListener('joomla:updated', ({ target }) => {

Only missed check for "double initialisation", I can do it later in another pull.

I do not think that this patch is much needed, but people asked 😉
It can be safely closed, depend what @HLeithner will decide

[HLeithner]

@Fedik would be cool if we have the double initialization added in this pr too. After 2 tests we can merge it in to 3.10 (I think that makes more sense). I don't expect another 3.9 release (hopefully). It also introduces a new API endpoint so 3.10 is a better target.

[Fedik]

would be cool if we have the double initialization added in this pr too

it is here, that why I made this fork:

joomla-cms/media/jui/js/cms-uncompressed.js

Lines 184 to 189 in 0f5956e

	// Set up only once
	if ($target.data('showonInitialised')) {
	return;
	}
	$target.data('showonInitialised', true);

I meant that for J4 will be need a separted PR.

It also introduces a new API endpoint so 3.10 is a better target.

I can remove Joomla.setUpShowon and leave "event" $(document).on('subform-row-add'), I guess most people who need it already use in this way, so it will be "bug fix" 😉

[Fedik]

Okay, so, I have backport Joomla 4 'joomla:updated' stuff for showon, now it can be more easy for transition.
And added Joomla.Showon.initilise as @dgrammatiko suggested, later I will make pull for J4.

Testing the same, make sure showon still work.

Please someone change target branch to joomla-10, or I have to make new PR?

[HLeithner]

I change the branch for you.

But you can do this your self by adding the PR

Thanks for your PR, now we need some tests ;-)

[Fedik]

well, I just broke PR
need some time to fix

okay, I think I need to sync with j 3.10 branch

[Fedik]

@HLeithner can I merge joomla:3.10-dev to my branch for sync? or I need make new

[richard67]

Yes, that will also work.

[HLeithner]

I will upmerge staging

[HLeithner]

so now it's ok again

[richard67]

Yes, looks ok now.

[Fedik]

I have updated testing instruction, and made same changes for joomla 4 #32069

[dgrammatiko]

I have tested this item ✅ successfully on 04e2d9d

---

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

[ghost]

I have tested this item ✅ successfully on 04e2d9d

---

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

[richard67]

RTC

---

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

[zero-24]

@Fedik do we need to add documentation for this change somewhere? And if so what should be documented?

[Fedik]

@zero-24 good question, I have no idea ;)
Do we have any documentation about showon API somwhere? if no, then maybe we need to add.

Technically and partly it is a new feature, to cover edge cases from #18843 , also see comment #18843 (comment)

In J4 we already have events #16016 (I backported it partly here), that handle "dynamic" content changes

[zero-24]

Ok will merge than this heree for 3.10. thanks