Skip to content

Refactor option templates #6354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Cyperghost merged 5 commits into from
Jun 19, 2025
Merged

Refactor option templates #6354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e39369b
Remove unnecessary `@` and replace all other `@` with `unsafe:`
Cyperghost Jun 16, 2025
f951924
Use `unsafe:` for encoded string
Cyperghost Jun 16, 2025
8d8f0fc
Replace jQuery Code with plain JavaScript
Cyperghost Jun 16, 2025
43dfeba
Replace jQuery Code with plain JavaScript
Cyperghost Jun 17, 2025
20b47ca
Replace `{…|phrase}` with `{lang}…{/lang}`
Cyperghost Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions com.woltlab.wcf/templates/birthdaySearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
<input type="number" id="{$option->optionName}_age_to" name="values[{$option->optionName}][ageTo]" value="{$valueAgeTo}" placeholder="{lang}wcf.user.birthday.age.to{/lang}" min="0" max="120" class="tiny">

<script data-relocate="true">
$(function() {
$('#{$option->optionName}').parents('dl:eq(0)').find('> dt > label').text('{jslang}wcf.user.birthday.age{/jslang}');
});
{
const input = document.getElementById('{unsafe:$option->optionName|encodeJS}');
if (input) {
const label = input.closest('dl').querySelector(':scope > dt > label');
if (label) {
label.textContent = '{jslang}wcf.user.birthday.age{/jslang}';
}
}
}
</script>
2 changes: 1 addition & 1 deletion com.woltlab.wcf/templates/integerOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<input type="number" id="{$option->optionName}" name="values[{$option->optionName}]" value="{$value}"{if $option->minvalue !== null} min="{$option->minvalue}"{/if}{if $option->maxvalue !== null} max="{$option->maxvalue}"{/if}{if $inputClass} class="{@$inputClass}"{/if}{if $option->required} required{/if}>
<input type="number" id="{$option->optionName}" name="values[{$option->optionName}]" value="{$value}"{if $option->minvalue !== null} min="{$option->minvalue}"{/if}{if $option->maxvalue !== null} max="{$option->maxvalue}"{/if}{if $inputClass} class="{$inputClass}"{/if}{if $option->required} required{/if}>
12 changes: 9 additions & 3 deletions com.woltlab.wcf/templates/messageOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
{include file='shared_wysiwyg' wysiwygSelector=$option->optionName}

<script data-relocate="true">
$(function() {
$('#{$option->optionName}').parents('dl:eq(0)').addClass('wide');
});
{
const textarea = document.getElementById('{unsafe:$option->optionName|encodeJS}');
if (textarea) {
const dl = textarea.closest('dl');
if (dl) {
dl.classList.add('wide');
}
}
}
</script>
4 changes: 2 additions & 2 deletions com.woltlab.wcf/templates/multiSelectOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<select id="{$option->optionName}" name="values[{$option->optionName}][]" multiple size="{if $selectOptions|count > 10}10{else}{@$selectOptions|count}{/if}"{if $option->required} required{/if}>
<select id="{$option->optionName}" name="values[{$option->optionName}][]" multiple size="{if $selectOptions|count > 10}10{else}{$selectOptions|count}{/if}"{if $option->required} required{/if}>
{foreach from=$selectOptions key=key item=selectOption}
<option value="{$key}"{if $key|in_array:$value} selected{/if}>{lang}{@$selectOption}{/lang}</option>
<option value="{$key}"{if $key|in_array:$value} selected{/if}>{lang}{$selectOption}{/lang}</option>
{/foreach}
</select>
21 changes: 10 additions & 11 deletions com.woltlab.wcf/templates/multiSelectSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
<label><input type="checkbox" id="search_{$option->optionName}" name="searchOptions[{$option->optionName}]"{if $searchOption} checked{/if}> {lang}wcf.user.option.searchRadioButtonOption{/lang}</label>
<select id="{$option->optionName}" name="values[{$option->optionName}][]" multiple size="{if $selectOptions|count > 10}10{else}{@$selectOptions|count}{/if}"{if !$searchOption} disabled{/if}{if $option->required} required{/if}>
<select id="{$option->optionName}" name="values[{$option->optionName}][]" multiple size="{if $selectOptions|count > 10}10{else}{$selectOptions|count}{/if}"{if !$searchOption} disabled{/if}{if $option->required} required{/if}>
{foreach from=$selectOptions key=key item=selectOption}
<option value="{$key}"{if $key|in_array:$value} selected{/if}>{lang}{@$selectOption}{/lang}</option>
<option value="{$key}"{if $key|in_array:$value} selected{/if}>{lang}{$selectOption}{/lang}</option>
{/foreach}
</select>

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('#{$option->optionName}').enable();
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const select = document.getElementById('{unsafe:$option->optionName|encodeJS}');
if (checkbox && select) {
checkbox.addEventListener('change', () => {
select.disabled = !checkbox.checked;
});
}
else {
$('#{$option->optionName}').disable();
}
});
});
}
</script>
6 changes: 3 additions & 3 deletions com.woltlab.wcf/templates/optionFieldList.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
{icon name='bolt'}
</span>
{/if}
{$langPrefix|concat:$option->optionName|phrase}
{lang}{$langPrefix}{$option->optionName}{/lang}
</label>
{/if}
</dt>
Expand All @@ -25,11 +25,11 @@
{if $error == 'empty'}
{lang}wcf.global.form.error.empty{/lang}
{else}
{lang}{@$langPrefix}error.{$error}{/lang}
{lang}{$langPrefix}error.{$error}{/lang}
{/if}
</small>
{/if}
<small>{lang __optional=true}{@$langPrefix}{$option->optionName}.description{/lang}</small>
<small>{lang __optional=true}{$langPrefix}{$option->optionName}.description{/lang}</small>
</dd>
</dl>
{/foreach}
2 changes: 1 addition & 1 deletion com.woltlab.wcf/templates/radioButtonOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{foreach name=radioButtons from=$selectOptions key=key item=selectOption}
<label><input {if $tpl.foreach.radioButtons.first}id="{$option->optionName}" {/if}type="radio" name="values[{$option->optionName}]" value="{$key}" {if $value == $key} checked{/if} {if $disableOptions[$key]|isset || $enableOptions[$key]|isset}class="jsEnablesOptions" data-disable-options="[ {$disableOptions[$key]}]" data-enable-options="[ {$enableOptions[$key]}]"{/if}> {lang}{@$selectOption}{/lang}</label>
<label><input {if $tpl.foreach.radioButtons.first}id="{$option->optionName}" {/if}type="radio" name="values[{$option->optionName}]" value="{$key}" {if $value == $key} checked{/if} {if $disableOptions[$key]|isset || $enableOptions[$key]|isset}class="jsEnablesOptions" data-disable-options="[ {$disableOptions[$key]}]" data-enable-options="[ {$enableOptions[$key]}]"{/if}> {lang}{$selectOption}{/lang}</label>
{/foreach}
2 changes: 1 addition & 1 deletion com.woltlab.wcf/templates/selectOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<select id="{$option->optionName}" name="values[{$option->optionName}]"{if $option->required} required{/if}{if $disableOptions || $enableOptions} class="jsEnablesOptions" data-is-boolean="true" data-disable-options="[ {$disableOptions}]" data-enable-options="[ {$enableOptions}]"{/if}>
{if !$allowEmptyValue|empty}<option value="">{lang}wcf.global.noSelection{/lang}</option>{/if}
{foreach from=$selectOptions key=key item=selectOption}
<option value="{$key}"{if $value == $key} selected{/if}>{lang}{@$selectOption}{/lang}</option>
<option value="{$key}"{if $value == $key} selected{/if}>{lang}{$selectOption}{/lang}</option>
{/foreach}
</select>
19 changes: 9 additions & 10 deletions com.woltlab.wcf/templates/selectSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,18 @@
<select id="{$option->optionName}" name="values[{$option->optionName}]"{if !$searchOption} disabled{/if}{if $option->required} required{/if}>
{if !$allowEmptyValue|empty}<option value="">{lang}wcf.global.noSelection{/lang}</option>{/if}
{foreach from=$selectOptions key=key item=selectOption}
<option value="{$key}"{if $value == $key} selected{/if}>{lang}{@$selectOption}{/lang}</option>
<option value="{$key}"{if $value == $key} selected{/if}>{lang}{$selectOption}{/lang}</option>
{/foreach}
</select>

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('#{$option->optionName}').enable();
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const select = document.getElementById('{unsafe:$option->optionName|encodeJS}');
if (checkbox && select) {
checkbox.addEventListener('change', () => {
select.disabled = !checkbox.checked;
});
}
else {
$('#{$option->optionName}').disable();
}
});
});
}
</script>
29 changes: 17 additions & 12 deletions com.woltlab.wcf/templates/shared_booleanSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,21 @@
</ol>

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('#{$option->optionName}').enable();
$('#{$option->optionName}_no').enable();
}
else {
$('#{$option->optionName}').disable();
$('#{$option->optionName}_no').disable();
}
});
});
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const radioYes = document.getElementById('{unsafe:$option->optionName|encodeJS}');
const radioNo = document.getElementById('{unsafe:$option->optionName|encodeJS}_no');

function setEnabled (enabled) {
radioYes.disabled = !enabled;
radioNo.disabled = !enabled;
}

if (checkbox) {
checkbox.addEventListener('change', (event) => {
setEnabled(event.currentTarget.checked);
});
setEnabled(checkbox.checked);
}
}
</script>
2 changes: 1 addition & 1 deletion com.woltlab.wcf/templates/shared_checkboxesOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{foreach from=$selectOptions key=key item=selectOption}
<label><input type="checkbox" name="values[{$option->optionName}][]" value="{$key}" {if $key|in_array:$value} checked{/if} {if $disableOptions[$key]|isset || $enableOptions[$key]|isset}class="jsEnablesOptions" data-disable-options="[ {$disableOptions[$key]}]" data-enable-options="[ {$enableOptions[$key]}]"{/if}> {lang}{@$selectOption}{/lang}</label>
<label><input type="checkbox" name="values[{$option->optionName}][]" value="{$key}" {if $key|in_array:$value} checked{/if} {if $disableOptions[$key]|isset || $enableOptions[$key]|isset}class="jsEnablesOptions" data-disable-options="[ {$disableOptions[$key]}]" data-enable-options="[ {$enableOptions[$key]}]"{/if}> {lang}{$selectOption}{/lang}</label>
{/foreach}
23 changes: 12 additions & 11 deletions com.woltlab.wcf/templates/shared_checkboxesSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
<label><input type="checkbox" id="search_{$option->optionName}" name="searchOptions[{$option->optionName}]"{if $searchOption} checked{/if}> {lang}wcf.user.option.searchRadioButtonOption{/lang}</label>
{foreach from=$selectOptions key=key item=selectOption}
<label><input type="checkbox" name="values[{$option->optionName}][]" value="{$key}" {if $key|in_array:$value} checked{/if}{if !$searchOption} disabled{/if}> {lang}{@$selectOption}{/lang}</label>
<label><input type="checkbox" name="values[{$option->optionName}][]" value="{$key}" {if $key|in_array:$value} checked{/if}{if !$searchOption} disabled{/if}> {lang}{$selectOption}{/lang}</label>
{/foreach}

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('input[name="values[{$option->optionName}][]"]').enable();
}
else {
$('input[name="values[{$option->optionName}][]"]').disable();
}
});
});
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const inputs = document.querySelectorAll('input[name="values[{unsafe:$option->optionName|encodeJS}][]"]');
if (checkbox) {
checkbox.addEventListener('change', () => {
inputs.forEach((input) => {
input.disabled = !checkbox.checked;
});
});
}
}
</script>
2 changes: 1 addition & 1 deletion com.woltlab.wcf/templates/shared_lineBreakSeparatedTextOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
});

new UiItemListLineBreakSeparatedText(
document.getElementById("lineBreakSeparatedTextOption_{@$identifier|encodeJS}")
document.getElementById("lineBreakSeparatedTextOption_{unsafe:$identifier|encodeJS}")
);
});
</script>
21 changes: 11 additions & 10 deletions com.woltlab.wcf/templates/shared_radioButtonSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
<label><input type="checkbox" id="search_{$option->optionName}" name="searchOptions[{$option->optionName}]"{if $searchOption} checked{/if}> {lang}wcf.user.option.searchRadioButtonOption{/lang}</label>
{foreach from=$selectOptions key=key item=selectOption}
<label><input type="radio" name="values[{$option->optionName}]" value="{$key}" {if $value == $key} checked{/if} {if $disableOptions[$key]|isset || $enableOptions[$key]|isset}class="jsEnablesOptions" data-disable-options="[ {$disableOptions[$key]}]" data-enable-options="[ {$enableOptions[$key]}]"{/if}{if !$searchOption} disabled{/if}> {lang}{@$selectOption}{/lang}</label>
<label><input type="radio" name="values[{$option->optionName}]" value="{$key}" {if $value == $key} checked{/if} {if $disableOptions[$key]|isset || $enableOptions[$key]|isset}class="jsEnablesOptions" data-disable-options="[ {$disableOptions[$key]}]" data-enable-options="[ {$enableOptions[$key]}]"{/if}{if !$searchOption} disabled{/if}> {lang}{$selectOption}{/lang}</label>
{/foreach}

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('input[name="values[{$option->optionName}]"]').enable();
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const radioInputs = document.querySelectorAll('input[name="values[{unsafe:$option->optionName|encodeJS}]"]');
if (checkbox) {
checkbox.addEventListener('change', () => {
radioInputs.forEach((input) => {
input.disabled = !checkbox.checked;
});
});
}
else {
$('input[name="values[{$option->optionName}]"]').disable();
}
});
});
}
</script>
2 changes: 1 addition & 1 deletion com.woltlab.wcf/templates/textI18nOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<input type="{@$inputType}" id="{$option->optionName}" name="{$option->optionName}" value="{$i18nPlainValues[$option->optionName]}"{if $option->required} required{/if} class="long">
<input type="{$inputType}" id="{$option->optionName}" name="{$option->optionName}" value="{$i18nPlainValues[$option->optionName]}"{if $option->required} required{/if} class="long">
{include file='shared_multipleLanguageInputJavascript' elementIdentifier=$option->optionName forceSelection=false}
51 changes: 29 additions & 22 deletions com.woltlab.wcf/templates/textSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
<label><input type="checkbox" id="search_{$option->optionName}" name="searchOptions[{$option->optionName}]"{if $searchOption} checked{/if}> {lang}wcf.user.option.searchTextOption{/lang}</label>
<input type="{@$inputType}" id="{$option->optionName}" name="values[{$option->optionName}]" value="{$value}"{if $inputClass} class="{@$inputClass}"{/if}{if !$searchOption} disabled{/if}{if $option->required} required{/if}>
<input type="{$inputType}" id="{$option->optionName}" name="values[{$option->optionName}]" value="{$value}"{if $inputClass} class="{$inputClass}"{/if}{if !$searchOption} disabled{/if}{if $option->required} required{/if}>

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('#{$option->optionName}').enable();

{if $inputType === 'date'}
$('#{$option->optionName}DatePicker').enable();
{/if}
}
else {
$('#{$option->optionName}').disable();

{if $inputType === 'date'}
$('#{$option->optionName}DatePicker').disable();
{/if}
}
});

{if !$searchOption}
$('#{$option->optionName}DatePicker').disable();
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const inputField = document.getElementById('{unsafe:$option->optionName|encodeJS}');
{if $inputType === 'date'}
const datePicker = document.getElementById('{unsafe:$option->optionName|encodeJS}DatePicker');
{/if}
});

if (checkbox) {
checkbox.addEventListener('change', () => {
if (checkbox.checked) {
inputField.disabled = false;

{if $inputType === 'date'}
datePicker.disabled = false;
{/if}
} else {
inputField.disabled = true;

{if $inputType === 'date'}
datePicker.disabled = true;
{/if}
}
});
}

{if !$searchOption && $inputType === 'date'}
datePicker.disabled = true;
{/if}
}
</script>
17 changes: 8 additions & 9 deletions com.woltlab.wcf/templates/textareaSearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
<textarea id="{$option->optionName}" name="values[{$option->optionName}]"{if !$searchOption} disabled{/if} cols="40" rows="10"{if $option->required} required{/if}>{$value}</textarea>

<script data-relocate="true">
$(function() {
$('#search_{$option->optionName}').change(function(event) {
if ($(event.currentTarget).prop('checked')) {
$('#{$option->optionName}').enable();
{
const checkbox = document.getElementById('search_{unsafe:$option->optionName|encodeJS}');
const textarea = document.getElementById('{unsafe:$option->optionName|encodeJS}');
if (checkbox && textarea) {
checkbox.addEventListener('change', () => {
textarea.disabled = !checkbox.checked;
});
}
else {
$('#{$option->optionName}').disable();
}
});
});
}
</script>
2 changes: 1 addition & 1 deletion wcfsetup/install/files/acp/templates/__optionRewriteTest.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

const apps = new Map(Object.entries({
{* this bypasses the route system to force rewritten urls *}
{implode from=$rewriteTestApplications item=$rewriteTestApplication}'{$rewriteTestApplication->getPackage()|encodeJS}': '{$__wcf->getPath($rewriteTestApplication->getAbbreviation())}core-rewrite-test/'{/implode}
{implode from=$rewriteTestApplications item=$rewriteTestApplication}'{unsafe:$rewriteTestApplication->getPackage()|encodeJS}': '{$__wcf->getPath($rewriteTestApplication->getAbbreviation())}core-rewrite-test/'{/implode}
}));

AcpUiOptionRewriteTest.init(apps);
Expand Down
13 changes: 10 additions & 3 deletions wcfsetup/install/files/acp/templates/birthdaySearchableOptionType.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@
<input type="number" id="{$option->optionName}_age_to" name="values[{$option->optionName}][ageTo]" value="{$valueAgeTo}" placeholder="{lang}wcf.user.birthday.age.to{/lang}" min="0" max="120" class="tiny">

<script data-relocate="true">
$(function() {
$('#{$option->optionName}_age_from').parents('dl:eq(0)').find('> dt > label').text('{jslang}wcf.user.birthday.age{/jslang}').attr('for', '{$option->optionName}_age_from');
});
{
const input = document.getElementById('{unsafe:$option->optionName|encodeJS}_age_from');
if (input) {
const label = input.closest('dl').querySelector(':scope > dt > label');
if (label) {
label.textContent = '{jslang}wcf.user.birthday.age{/jslang}';
label.setAttribute('for', '{unsafe:$option->optionName|encodeJS}_age_from');
}
}
}
</script>
Loading