Компонент, с помощью которого вы можете реализовать форму обратной связи с отправкой через AJAX-запрос и проверкой полей. Письма после отправки формы будут приходить на E-mail для уведомлений указанный в админ-панели, в разделе Настройки → Карточка магазина.
Обязательный атрибут для обёртки формы обратной связи
<form method="post" action="/client_account/feedback" data-feedback-form-wrapper>
<!-- Код формы -->
</form>
Атрибут для элемента, который содержит сообщение об успешной отправке формы. В качестве значения нужно указать, сколько секунд должен отображаться элемент в случае успешной отправки (получает класс is-show
, который удаляется через указанный промежуток времени).
Важно: по умолчанию элемент не скрыт
<div data-feedback-form-success='{"showTime": 10000}'>Успешно отправлено</div>
Атрибут для блока каждого отдельного поля. Нужен для валидации поля и вывода ошибок в элементе с атрибутом data-feedback-form-field-error
.
<div data-feedback-form-field-area>
<div>Имя</div>
<input
name="name"
data-feedback-form-field='{
"isRequired": true,
"errorMessage": "Неправильно заполнено поле Имя"
}'
type="text"
value="" />
<div data-feedback-form-field-error></div>
</div>
Атрибут поля ввода.
Виды полей определяются по значению атрибута name
. Всего есть несколько видов:
Для всех полей можно передать текст, который будет выводиться в случае ошибки в элементе с атрибутом data-feedback-form-field-error
, а также указать обязательность заполнения поля. По умолчанию обязательными являются только поле from (можно отключить) и чекбокс согласия на обработку персональных данных (нельзя отключить).
<input
name="name"
data-feedback-form-field='{
"isRequired": true,
"errorMessage": "Неправильно заполнено поле Имя"
}'
type="text"
value="" />
Для поля ввода номера в свойствах phoneNumberLength
и secondPhoneNumberLength
можно указать ожидаемое количество цифр.
<input
name="phone"
data-feedback-form-field='{
"isRequired": true,
"errorMessage": "Неправильно заполнено поле Телефон",
"phoneNumberLength": 11,
"secondPhoneNumberLength": 12
}'
type="text"
autocomplete="off"
value="" />
Важно: если нужно сделать несколько отдельных полей для текста, то значения таких полей необходимо будет объединять с помощью JavaScript. Пример реализации можно увидеть в виджете FF2 в любом шаблоне 4 поколения.
Поля from и content можно сделать необязательными, при этом во время отправки формы в них будет прокидываться системный текст. В случае с полем from в него попадёт e-mail владельца магазина, а в поле content будет текст "Сообщение не заполнено".
Элемент для вывода кнопки "Я не робот"
{% if settings.feedback_captcha_enabled %}
<div data-feedback-form-field-area class="feedback__field-area">
<div
data-feedback-form-recaptcha='{
"isRequired": true,
"errorMessage": "{{messages.recaptcha_error | escape }}"
}'
class="feedback__recaptcha"
>
</div>
<div data-feedback-form-field-error class="feedback__field-error"></div>
</div>
{% endif %}
При использовании ReCaptcha v3 посетителю сайта больше не нужно нажимать на чекбокс "Я не робот". Проверка происходит автоматически при отправке формы.
DATA-RECAPTCHA-TYPE
Для использования новой версии в блок с атрибутом data-feedback-form-recaptcha
необходимо добавить атрибут data-recaptcha-type="invisible"
.
DATA-BADGE
В этом атрибуте можно задать где и как должен выводиться блок ReCaptcha. По умолчанию блок выводится в левом нижнем углу экрана (bottomleft
).
Возможные значения: - inline
- блок выводится как в старой версии, но без чекбокса - bottomleft
- фиксированный блок в левом нижнем углу экрана - bottomright
- фиксированный блок в правом нижнем углу экрана
Пример:
{% if settings.feedback_captcha_enabled %}
<div data-feedback-form-field-area class="feedback__field-area">
<div
data-recaptcha-type="invisible"
data-badge="bottomleft"
data-feedback-form-recaptcha='{
"isRequired": true,
"errorMessage": "{{messages.recaptcha_error | escape }}"
}'
class="feedback__recaptcha"
>
</div>
<div data-feedback-form-field-error class="feedback__field-error"></div>
</div>
{% endif %}
Атрибут для кнопки вызова модального окна. При нажатии происходит публикация события EventBus show-modal-feedback:insales:ui_feedback
.
В качестве значения можно передать ID модального окна. Это может быть удобно, если у вас несколько форм в модальных окнах.
<button data-show-feedback-modal='{"modal_id": "123456"}'>Обратная связь</button>
EventBus.subscribe('show-modal-feedback:insales:ui_feedback', (data) => {
console.log(data)
});
data-show-feedback-modal
Пример подписки на событие
EventBus.subscribe('send-feedback:insales:ui_feedback', function (data) {
console.log('Форма успешно отправлена', data);
});
<form method="post" action="/client_account/feedback" data-feedback-form-wrapper>
<div
data-feedback-form-success='{"showTime": 10000}'
class="success-message"
>Успешно отправлено</div>
<div data-feedback-form-field-area>
<div>Телефон</div>
<input
name="phone"
data-feedback-form-field='{
"isRequired": true,
"errorMessage": "Неправильно заполнено поле Телефон",
"phoneNumberLength": 11
}'
type="text"
autocomplete="off"
value="" />
<div data-feedback-form-field-error></div>
</div>
<div data-feedback-form-field-area>
<div>Имя</div>
<input
name="name"
data-feedback-form-field='{
"isRequired": true,
"errorMessage": "Неправильно заполнено поле Имя"
}'
type="text"
value="" />
<div data-feedback-form-field-error></div>
</div>
<div data-feedback-form-field-area>
<div>Текст</div>
<textarea
name="content"
data-feedback-form-field='{"errorMessage": "Неправильно заполнено поле Текст"}'></textarea>
<div data-feedback-form-field-error></div>
</div>
<div data-feedback-form-field-area>
<div>email</div>
<input
name="from"
data-feedback-form-field='{"errorMessage": "Неправильно заполнено поле email"}'
type="text"
value="" />
<div data-feedback-form-field-error></div>
</div>
<div data-feedback-form-field-area>
<label>
<input
data-feedback-form-agree='{"errorMessage": "Необходимо подтвердить согласие"}'
type="checkbox"
name="agree"
value="" />
Согласен на обработку данных
</label>
<div data-feedback-form-field-error></div>
</div>
{% if settings.feedback_captcha_enabled %}
<div data-feedback-form-field-area class="feedback__field-area">
<div data-feedback-form-recaptcha='{
"isRequired": true,
"errorMessage": "{{messages.recaptcha_error | escape }}"
}'
class="feedback__recaptcha"></div>
<div data-feedback-form-field-error class="feedback__field-error"></div>
</div>
{% endif %}
<input type="text" value="Форма обратной связи" name="subject" />
<div>
<button class="button" type="submit">Отправить</button>
</div>
</form>
В кастомных формах обратной связи может встретиться ошибка "Invalid CSRF token". Данная ошибка может быть по причине того, что страницы сайта кэшируются и используется неактуальный токен.
Актуальный хранится в cookies. Пример функции получения актуального токена:
function getCookieByKey(key) {
const name = key + "=";
const decodedCookies = decodeURIComponent(document.cookie);
const cookieArray = decodedCookies.split(';');
for(let i = 0; i < cookieArray.length; i++) {
let cookie = cookieArray[i].trim();
if (cookie.indexOf(name) === 0) {
return cookie.substring(name.length, cookie.length);
}
}
return null;
}
getCookieByKey('x_csrf_token')
В стандартных формах обратной связи common.js учитывает данную особенность и использует корректный актуальный мета-тег.