Skip to content

IBX-11005: Added alternative text validation in image assets #1883

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

Open
albozek wants to merge 1 commit into
base: 4.6
Choose a base branch
from
Open

IBX-11005: Added alternative text validation in image assets #1883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions src/bundle/Resources/public/js/scripts/fieldType/ezimage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,8 @@
const dataContainer = this.fieldContainer.querySelector('.ibexa-field-edit__data');
const isFileFieldEmpty = fileField.files && !fileField.files.length && dataContainer && !dataContainer.hasAttribute('hidden');
const { isRequired } = event.target.dataset;
const alreadyIsError = this.fieldContainer.classList.contains(this.classInvalid);
const isEmpty = !event.target.value;
const isError = alreadyIsError || (isEmpty && isRequired && !isFileFieldEmpty);
const isError = isEmpty && isRequired && !isFileFieldEmpty;
const label = event.target.closest(SELECTOR_ALT_WRAPPER).querySelector('.ibexa-data-source__label').innerText;
const result = { isError };

Expand Down
50 changes: 48 additions & 2 deletions src/bundle/Resources/public/js/scripts/fieldType/ezimageasset.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
const SELECTOR_FIELD = '.ibexa-field-edit--ezimageasset';
const SELECTOR_INPUT_FILE = 'input[type="file"]';
const SELECTOR_INPUT_DESTINATION_CONTENT_ID = '.ibexa-data-source__destination-content-id';
const SELECTOR_ALT_WRAPPER = '.ibexa-field-edit-preview__image-alt';
const SELECTOR_INPUT_ALT = '.ibexa-field-edit-preview__image-alt .ibexa-data-source__input';
const EVENT_CANCEL_ERROR = 'ibexa-cancel-errors';
const token = doc.querySelector('meta[name="CSRF-Token"]').content;
const { showErrorNotification } = ibexa.helpers.notification;
const { showSuccessNotification } = ibexa.helpers.notification;
Expand Down Expand Up @@ -158,6 +161,7 @@

this.inputDestinationContentId.value = destinationContentId;
this.inputField.value = '';
previewAlt.dispatchEvent(new CustomEvent(EVENT_CANCEL_ERROR));
this.showPreview();
}

Expand Down Expand Up @@ -227,7 +231,7 @@
super.resetInputField();

this.inputDestinationContentId.value = '';
this.fieldContainer.querySelector('.ibexa-field-edit-preview__image-alt .ibexa-data-source__input').value = '';
this.fieldContainer.querySelector(SELECTOR_INPUT_ALT).value = '';
}

/**
Expand All @@ -244,8 +248,35 @@
}
}

class EzImageAssetFieldValidator extends ibexa.BaseFileFieldValidator {
/**
* Validates the alternative text input
*
* @method validateAltInput
* @param {Event} event
* @returns {Object}
* @memberof EzImageAssetFieldValidator
*/
validateAltInput(event) {
const fileField = this.fieldContainer.querySelector(SELECTOR_INPUT_FILE);
const dataContainer = this.fieldContainer.querySelector('.ibexa-field-edit__data');
const isFileFieldEmpty = fileField.files && !fileField.files.length && dataContainer && !dataContainer.hasAttribute('hidden');
const isRequired = this.fieldContainer.classList.contains('ibexa-field-edit--required');
const isEmpty = !event.target.value.trim();
const isError = isEmpty && isRequired && !isFileFieldEmpty;
const label = event.target.closest(SELECTOR_ALT_WRAPPER).querySelector('.ibexa-data-source__label').innerText;
const result = { isError };

if (isEmpty) {
result.errorMessage = ibexa.errors.emptyField.replace('{fieldName}', label);
}

return result;
}
}

doc.querySelectorAll(SELECTOR_FIELD).forEach((fieldContainer) => {
const validator = new ibexa.BaseFileFieldValidator({
const validator = new EzImageAssetFieldValidator({
classInvalid: 'is-invalid',
fieldContainer,
eventsMap: [
Expand All @@ -272,6 +303,21 @@
errorNodeSelectors: ['.ibexa-form-error'],
invalidStateSelectors: ['.ibexa-field-edit__label'],
},
{
selector: SELECTOR_INPUT_ALT,
eventName: 'blur',
callback: 'validateAltInput',
invalidStateSelectors: ['.ibexa-data-source__field--alternativeText'],
errorNodeSelectors: [`${SELECTOR_ALT_WRAPPER} .ibexa-form-error`],
},
{
isValueValidator: false,
selector: SELECTOR_INPUT_ALT,
eventName: EVENT_CANCEL_ERROR,
callback: 'cancelErrors',
invalidStateSelectors: ['.ibexa-data-source__field--alternativeText'],
errorNodeSelectors: [`${SELECTOR_ALT_WRAPPER} .ibexa-form-error`],
},
],
});

Expand Down
Loading