First commit after long time, too much to describe (sorry)

This commit is contained in:
Tammo ter Hark 2026-07-07 16:05:43 +02:00
commit 0508dc1f6f

View file

@ -1,328 +1,328 @@
var ThemeOptions = function(){
var ThemeOptions = function () {
'use strict';
//////////////////
// Define necessary globals
// general_inherit_active is not present at global level
// see: https://github.com/LimeSurvey/LimeSurvey/blob/1cbfa11b081f54763b28364472926b155efea5dc/themes/survey/vanilla/options/options.twig#L71
var inheritPossible = ($('#general_inherit_active').length > 0);
//get option Object from Template configuration options
var optionObject = {'general_inherit': 1};
//get the global form
var globalForm = $('.action_update_options_string_form');
/////////////////
// Define methods run on startup
// #TemplateConfiguration_options is the id of the Options field in advanced option
// getter for generalInherit
var generalInherit = function () {
return $('#TemplateConfiguration_options').val() === 'inherit';
};
//parse the options as set in the advanced form
var parseOptionObject = function () {
// If no general inherit, then pass the value of the "Options" field in advanced option to the object optionObject
if ($('#TemplateConfiguration_options').length > 0 && !generalInherit()) {
try {
optionObject = JSON.parse($('#TemplateConfiguration_options').val());
} catch (e) {
console.ls ? console.ls.error('No valid option field!') : console.log('No valid option field!');
}
}
};
// Show/Hide fields on generalInherit
// To hide a simple option on generalInherit: just add the class "action_hide_on_inherit" to the rows continaing it
var startupGeneralInherit = function () {
if (!inheritPossible) return false;
if (generalInherit()) {
$('#general_inherit_on').prop('checked', true).trigger('change').closest('label').addClass('active');
$('.action_hide_on_inherit').addClass('d-none');
} else {
$('#general_inherit_off').prop('checked', true).trigger('change').closest('label').addClass('active');
}
};
// So this function find the selectors in the forum, and pass their values to the advanced options
var updateFieldSettings = function () {
if ($('#general_inherit_on').prop('checked')) {
$('#TemplateConfiguration_options').val('inherit');
return;
}
globalForm.find('.selector_option_value_field').each(function (i, item) {
//disabled items should be inherit or false
if ($(item).prop('disabled')) {
$(item).val((inheritPossible ? 'inherit' : false));
}
optionObject[$(item).attr('name')] = $(item).val();
});
globalForm.find('.selector_option_radio_field ').each(function (i, item) {
//disabled items should be inherit or false
if ($(item).prop('disabled')) {
$(item).val((inheritPossible ? 'inherit' : false));
}
if ($(item).attr('type') == 'radio') {
if ($(item).prop('checked')) {
optionObject[$(item).attr('name')] = $(item).val();
}
}
});
var newOptionObject = $.extend(true, {}, optionObject);
delete newOptionObject.general_inherit;
$('#TemplateConfiguration_options').val(JSON.stringify(newOptionObject));
};
///////////////
// Utility Methods
// -- small utilities i.g. for images or similar, or very specialized functions
//Parses the option value for an item
var parseOptionValue = function (item, fallbackValue) {
fallbackValue = fallbackValue || false;
// If general inherit, then the value of the dropdown is inherit, else it's the value defined in advanced options
var itemValue = generalInherit() ? 'inherit' : optionObject[$(item).attr('name')];
// If anything goes wrong (manual edit or anything else), we make sure it will have a correct value
if (itemValue == null || itemValue == undefined) {
itemValue = inheritPossible ? 'inherit' : fallbackValue;
optionObject[$(item).attr('name')] = itemValue;
}
return itemValue;
};
//Set value and propagate to bootstrapSwitch
var setAndPropageteToSwitch = function (item) {
$(item).prop('checked', true).trigger('change');
$(item).closest('label').addClass('active');
};
///////////////
// Parser methods
// -- These methods will either parse through existing fields, or set existing fields to their correct values
// Update values in the form to the template options
// selector_option_value_field are the select dropdown (like variations and fonts)
var prepareSelectField = function () {
globalForm.find('.selector_option_value_field').each(function (i, item) {
var itemValue = parseOptionValue(item);
$(item).val(itemValue);
});
};
// Generate the state of switches (On/Off/Inherit)
var parseParentSwitchFields = function () {
globalForm.find('.selector_option_radio_field').each(function (i, item) {
var itemValue = parseOptionValue(item, 'off');
//if it is a radio selector, check it and propagate the change to bootstrapSwitch
if ($(item).val() == itemValue) {
setAndPropageteToSwitch(item);
}
});
};
var prepareFontField = function () {
optionObject.font = optionObject.font || (inheritPossible ? 'inherit' : 'roboto');
if (optionObject.font !== 'inherit') {
$('#simple_edit_options_font').val(optionObject.font);
}
updateFieldSettings();
};
///////////////
// HotSwap methods
// -- These methods connect an input directly to the value in the optionsObject
// Disable dependent inputs when their parents are set to off, or inherit
var hotSwapParentRadioButtons = function () {
// hotswapping the select fields to the radiobuttons
// If an option is set to off, the attached selectors are disabled
$('.selector_radio_childfield').each(function (i, selectorItem) {
$('input[name=' + $(selectorItem).data('parent') + ']').on('change', function () {
if ($(this).val() === 'on' && $(this).prop('checked') == true) {
$(selectorItem).prop('disabled', false);
} else {
$(selectorItem).prop('disabled', true);
}
// disabled this part to always be able to click on "Preview image" button
/*
if ($(selectorItem).hasClass('selector_image_selector')) {
$('button[data-target="#' + $(selectorItem).attr('id') + '"]').prop('disabled', $(selectorItem).val() == 'inherit');
}
*/
});
});
};
// hotswapping the fields
var hotSwapFields = function () {
globalForm.find('.selector_option_value_field').on('change', function (evt) {
updateFieldSettings();
});
globalForm.find('.selector_option_radio_field').on('change', updateFieldSettings);
};
var hotswapGeneralInherit = function () {
//hotswapping the general inherit
$('#general_inherit_on').on('change', function (evt) {
$('#TemplateConfiguration_options').val('inherit');
$('.action_hide_on_inherit').addClass('d-none');
});
$('#general_inherit_off').on('change', function (evt) {
$('.action_hide_on_inherit').removeClass('d-none');
updateFieldSettings();
});
};
var hotswapFontField = function () {
$('#simple_edit_options_font').on('change', function (evt) {
var currentPackageObject = $('#TemplateConfiguration_packages_to_load').val() !== 'inherit'
? JSON.parse($('#TemplateConfiguration_packages_to_load').val())
: $(this).data('inheritvalue');
if ($('#simple_edit_options_font').val() === 'inherit') {
$('#TemplateConfiguration_packages_to_load').val('inherit');
} else {
var selectedFontPackage = $(this).find('option:selected');
var packageName = selectedFontPackage.data('font-package');
var formatedPackageName = 'font-' + packageName;
var filteredAdd = currentPackageObject.add.filter(function (value, index) {
return !(/^font-.*$/.test(String(value)));
});
filteredAdd.push(formatedPackageName);
currentPackageObject.add = filteredAdd;
$('#TemplateConfiguration_packages_to_load').val(JSON.stringify(currentPackageObject));
}
});
};
///////////////
// Event methods
// -- These methods are triggered on events. Please see `bind´ method for more information
var onSaveButtonClickAction = function (evt) {
evt.preventDefault();
if (generalInherit()) {
$('#TemplateConfiguration_options').val('inherit');
$('#template-options-form').trigger('submit'); // submit the form
} else {
//Create a copy of the inherent optionObject
var newOptionObject = $.extend(true, {}, optionObject);
newOptionObject.generalInherit = null;
// Now write the newly created object to the correspondent field as a json string
$('#TemplateConfiguration_options').val(JSON.stringify(newOptionObject));
// And submit the form
// Beware, we are triggering 'submit' directly, which doesn't trigger HTML5 validations.
// No HTML5 validations needed here, so all good.
// If not we would need to add a hidden submit button and trigger a 'click' on it. (see fruity theme).
// Like these: $('#template-options-form').find('button[type=submit]').trigger('click');
$('#template-options-form').trigger('submit');
}
};
///////////////
// Instance methods
var bind = function () {
//if the save button is clicked write everything into the template option field and send the form
$('.action_update_options_string_button, #theme-options--submit').on('click', onSaveButtonClickAction);
//Bind the hotwaps
hotSwapParentRadioButtons();
hotSwapFields();
hotswapGeneralInherit();
hotswapFontField();
};
var run = function () {
parseOptionObject();
startupGeneralInherit();
prepareSelectField();
parseParentSwitchFields();
prepareFontField();
bind();
};
return run;
};
var prepare = function () {
var deferred = $.Deferred();
//activate the bootstrap switch for checkboxes
$('.action_activate_bootstrapswitch').bootstrapSwitch();
var themeOptionStarter = new ThemeOptions();
themeOptionStarter();
setTimeout(function () {
deferred.resolve();
}, 650);
return deferred.promise();
};
$(document).off('pjax:scriptcomplete.templateOptions').on('ready pjax:scriptcomplete.templateOptions', function () {
$('.simple-template-edit-loading').css('display', 'block');
prepare().then(function (runsesolve) {
$('.simple-template-edit-loading').css('display', 'none');
});
$('.selector__open_lightbox').on('click', function (e) {
e.preventDefault();
var imgSrc = $($(this).data('bs-target')).find('option:selected').data('lightbox-src');
var imgTitle = $($(this).data('bs-target')).val();
imgTitle = imgTitle.split('/').pop();
$('#lightbox-modal').find('.selector__title').text(imgTitle);
$('#lightbox-modal').find('.selector__image').attr({'src': imgSrc, 'alt': imgTitle});
$('#lightbox-modal').modal('show');
});
var uploadImageBind = new bindUpload({
form: '#upload_frontend',
input: '#upload_image_frontend',
progress: '#upload_progress_frontend',
onBeforeSend: function () {
$('.simple-template-edit-loading').css('display', 'block');
},
onSuccess: function () {
setTimeout(function () {
$(document).trigger('pjax:load', {url: window.location.href});
}, 2500);
}
});
});
var ThemeOptions = function(){
var ThemeOptions = function () {
'use strict';
//////////////////
// Define necessary globals
// general_inherit_active is not present at global level
// see: https://github.com/LimeSurvey/LimeSurvey/blob/1cbfa11b081f54763b28364472926b155efea5dc/themes/survey/vanilla/options/options.twig#L71
var inheritPossible = ($('#general_inherit_active').length > 0);
//get option Object from Template configuration options
var optionObject = {'general_inherit': 1};
//get the global form
var globalForm = $('.action_update_options_string_form');
/////////////////
// Define methods run on startup
// #TemplateConfiguration_options is the id of the Options field in advanced option
// getter for generalInherit
var generalInherit = function () {
return $('#TemplateConfiguration_options').val() === 'inherit';
};
//parse the options as set in the advanced form
var parseOptionObject = function () {
// If no general inherit, then pass the value of the "Options" field in advanced option to the object optionObject
if ($('#TemplateConfiguration_options').length > 0 && !generalInherit()) {
try {
optionObject = JSON.parse($('#TemplateConfiguration_options').val());
} catch (e) {
console.ls ? console.ls.error('No valid option field!') : console.log('No valid option field!');
}
}
};
// Show/Hide fields on generalInherit
// To hide a simple option on generalInherit: just add the class "action_hide_on_inherit" to the rows continaing it
var startupGeneralInherit = function () {
if (!inheritPossible) return false;
if (generalInherit()) {
$('#general_inherit_on').prop('checked', true).trigger('change').closest('label').addClass('active');
$('.action_hide_on_inherit').addClass('d-none');
} else {
$('#general_inherit_off').prop('checked', true).trigger('change').closest('label').addClass('active');
}
};
// So this function find the selectors in the forum, and pass their values to the advanced options
var updateFieldSettings = function () {
if ($('#general_inherit_on').prop('checked')) {
$('#TemplateConfiguration_options').val('inherit');
return;
}
globalForm.find('.selector_option_value_field').each(function (i, item) {
//disabled items should be inherit or false
if ($(item).prop('disabled')) {
$(item).val((inheritPossible ? 'inherit' : false));
}
optionObject[$(item).attr('name')] = $(item).val();
});
globalForm.find('.selector_option_radio_field ').each(function (i, item) {
//disabled items should be inherit or false
if ($(item).prop('disabled')) {
$(item).val((inheritPossible ? 'inherit' : false));
}
if ($(item).attr('type') == 'radio') {
if ($(item).prop('checked')) {
optionObject[$(item).attr('name')] = $(item).val();
}
}
});
var newOptionObject = $.extend(true, {}, optionObject);
delete newOptionObject.general_inherit;
$('#TemplateConfiguration_options').val(JSON.stringify(newOptionObject));
};
///////////////
// Utility Methods
// -- small utilities i.g. for images or similar, or very specialized functions
//Parses the option value for an item
var parseOptionValue = function (item, fallbackValue) {
fallbackValue = fallbackValue || false;
// If general inherit, then the value of the dropdown is inherit, else it's the value defined in advanced options
var itemValue = generalInherit() ? 'inherit' : optionObject[$(item).attr('name')];
// If anything goes wrong (manual edit or anything else), we make sure it will have a correct value
if (itemValue == null || itemValue == undefined) {
itemValue = inheritPossible ? 'inherit' : fallbackValue;
optionObject[$(item).attr('name')] = itemValue;
}
return itemValue;
};
//Set value and propagate to bootstrapSwitch
var setAndPropageteToSwitch = function (item) {
$(item).prop('checked', true).trigger('change');
$(item).closest('label').addClass('active');
};
///////////////
// Parser methods
// -- These methods will either parse through existing fields, or set existing fields to their correct values
// Update values in the form to the template options
// selector_option_value_field are the select dropdown (like variations and fonts)
var prepareSelectField = function () {
globalForm.find('.selector_option_value_field').each(function (i, item) {
var itemValue = parseOptionValue(item);
$(item).val(itemValue);
});
};
// Generate the state of switches (On/Off/Inherit)
var parseParentSwitchFields = function () {
globalForm.find('.selector_option_radio_field').each(function (i, item) {
var itemValue = parseOptionValue(item, 'off');
//if it is a radio selector, check it and propagate the change to bootstrapSwitch
if ($(item).val() == itemValue) {
setAndPropageteToSwitch(item);
}
});
};
var prepareFontField = function () {
optionObject.font = optionObject.font || (inheritPossible ? 'inherit' : 'roboto');
if (optionObject.font !== 'inherit') {
$('#simple_edit_options_font').val(optionObject.font);
}
updateFieldSettings();
};
///////////////
// HotSwap methods
// -- These methods connect an input directly to the value in the optionsObject
// Disable dependent inputs when their parents are set to off, or inherit
var hotSwapParentRadioButtons = function () {
// hotswapping the select fields to the radiobuttons
// If an option is set to off, the attached selectors are disabled
$('.selector_radio_childfield').each(function (i, selectorItem) {
$('input[name=' + $(selectorItem).data('parent') + ']').on('change', function () {
if ($(this).val() === 'on' && $(this).prop('checked') == true) {
$(selectorItem).prop('disabled', false);
} else {
$(selectorItem).prop('disabled', true);
}
// disabled this part to always be able to click on "Preview image" button
/*
if ($(selectorItem).hasClass('selector_image_selector')) {
$('button[data-target="#' + $(selectorItem).attr('id') + '"]').prop('disabled', $(selectorItem).val() == 'inherit');
}
*/
});
});
};
// hotswapping the fields
var hotSwapFields = function () {
globalForm.find('.selector_option_value_field').on('change', function (evt) {
updateFieldSettings();
});
globalForm.find('.selector_option_radio_field').on('change', updateFieldSettings);
};
var hotswapGeneralInherit = function () {
//hotswapping the general inherit
$('#general_inherit_on').on('change', function (evt) {
$('#TemplateConfiguration_options').val('inherit');
$('.action_hide_on_inherit').addClass('d-none');
});
$('#general_inherit_off').on('change', function (evt) {
$('.action_hide_on_inherit').removeClass('d-none');
updateFieldSettings();
});
};
var hotswapFontField = function () {
$('#simple_edit_options_font').on('change', function (evt) {
var currentPackageObject = $('#TemplateConfiguration_packages_to_load').val() !== 'inherit'
? JSON.parse($('#TemplateConfiguration_packages_to_load').val())
: $(this).data('inheritvalue');
if ($('#simple_edit_options_font').val() === 'inherit') {
$('#TemplateConfiguration_packages_to_load').val('inherit');
} else {
var selectedFontPackage = $(this).find('option:selected');
var packageName = selectedFontPackage.data('font-package');
var formatedPackageName = 'font-' + packageName;
var filteredAdd = currentPackageObject.add.filter(function (value, index) {
return !(/^font-.*$/.test(String(value)));
});
filteredAdd.push(formatedPackageName);
currentPackageObject.add = filteredAdd;
$('#TemplateConfiguration_packages_to_load').val(JSON.stringify(currentPackageObject));
}
});
};
///////////////
// Event methods
// -- These methods are triggered on events. Please see `bind´ method for more information
var onSaveButtonClickAction = function (evt) {
evt.preventDefault();
if (generalInherit()) {
$('#TemplateConfiguration_options').val('inherit');
$('#template-options-form').trigger('submit'); // submit the form
} else {
//Create a copy of the inherent optionObject
var newOptionObject = $.extend(true, {}, optionObject);
newOptionObject.generalInherit = null;
// Now write the newly created object to the correspondent field as a json string
$('#TemplateConfiguration_options').val(JSON.stringify(newOptionObject));
// And submit the form
// Beware, we are triggering 'submit' directly, which doesn't trigger HTML5 validations.
// No HTML5 validations needed here, so all good.
// If not we would need to add a hidden submit button and trigger a 'click' on it. (see fruity theme).
// Like these: $('#template-options-form').find('button[type=submit]').trigger('click');
$('#template-options-form').trigger('submit');
}
};
///////////////
// Instance methods
var bind = function () {
//if the save button is clicked write everything into the template option field and send the form
$('.action_update_options_string_button, #theme-options--submit').on('click', onSaveButtonClickAction);
//Bind the hotwaps
hotSwapParentRadioButtons();
hotSwapFields();
hotswapGeneralInherit();
hotswapFontField();
};
var run = function () {
parseOptionObject();
startupGeneralInherit();
prepareSelectField();
parseParentSwitchFields();
prepareFontField();
bind();
};
return run;
};
var prepare = function () {
var deferred = $.Deferred();
//activate the bootstrap switch for checkboxes
$('.action_activate_bootstrapswitch').bootstrapSwitch();
var themeOptionStarter = new ThemeOptions();
themeOptionStarter();
setTimeout(function () {
deferred.resolve();
}, 650);
return deferred.promise();
};
$(document).off('pjax:scriptcomplete.templateOptions').on('ready pjax:scriptcomplete.templateOptions', function () {
$('.simple-template-edit-loading').css('display', 'block');
prepare().then(function (runsesolve) {
$('.simple-template-edit-loading').css('display', 'none');
});
$('.selector__open_lightbox').on('click', function (e) {
e.preventDefault();
var imgSrc = $($(this).data('bs-target')).find('option:selected').data('lightbox-src');
var imgTitle = $($(this).data('bs-target')).val();
imgTitle = imgTitle.split('/').pop();
$('#lightbox-modal').find('.selector__title').text(imgTitle);
$('#lightbox-modal').find('.selector__image').attr({'src': imgSrc, 'alt': imgTitle});
$('#lightbox-modal').modal('show');
});
var uploadImageBind = new bindUpload({
form: '#upload_frontend',
input: '#upload_image_frontend',
progress: '#upload_progress_frontend',
onBeforeSend: function () {
$('.simple-template-edit-loading').css('display', 'block');
},
onSuccess: function () {
setTimeout(function () {
$(document).trigger('pjax:load', {url: window.location.href});
}, 2500);
}
});
});