Перейти к основному содержимому

Справочник настроек виджетов

Все настройки виджетов 2.0: параметры widgetsConfig, data-атрибуты, значения по умолчанию и соответствующие поля раздела «Виджеты»

Настройки виджетов 2.0 задаются в трёх местах: в разделе Инструменты → Виджеты личного кабинета, в объекте widgetsConfig вызова aplaut.init и data-атрибутами на теге виджета. Если параметр задан и в widgetsConfig, и атрибутом, действует значение из widgetsConfig: оно одно для всех экземпляров виджета на странице.

Где задаются настройки виджета​

ВиджетТегРаздел widgetsConfigЗначение в preloadWidgetsТип в createWidget
Отзывыap-reviewsreviewsreviewsreviews
Форма отзываap-reviews-formreview_formreviewsFormreviewsForm
Вопросы и ответыap-questions-answersquestions_answersquestionsAnswersquestionsAnswers
Галереяap-reviews-gallerygallerygalleryreviewsGallery
AI-сводкаap-reviews-summarysummarysummarysummary
Информерap-informerinline_informerinlineInformerinlineInformer или inlineRating
Сторисap-storiesstoriesstoriesstories
Форма сторисap-stories-formstories_formstoriesFormstoriesForm
Приглашение оставить отзывap-product-review-inviteproducts_review_inviteproductsReviewInviteproductsReviewInvite

Все виджеты доступны без перечисления: preloadWidgets только загружает код виджета заранее, см. справочник JS API.

Имена разделов и параметров можно писать в camelCase или snake_case: виджет приводит их к snake_case. Раздел формы отзыва поэтому называется review_form или reviewForm, а reviewsForm виджет не распознаёт. Вложенный JSON в data-атрибуте не преобразуется, ключи внутри него пишутся в snake_case.

Значение data-атрибута виджет разбирает как JSON: "false" становится логическим значением, "10" числом. Строка, которая не разбирается как JSON, остаётся строкой.

Общие для страницы параметры лежат в разделе general. Параметр useShadow и параметры general data-атрибутами не задаются.

aplaut.init(access_token, {
widgetsConfig: {
general: { enableReply: true },
reviews: { baseSort: "rating:desc", reviewsPerPage: 5 },
},
});

Общие для страницы​

Раздел widgetsConfig.general. В личном кабинете: Виджеты → вкладка Общие → Общие настройки.

ПараметрТипПо умолчаниюОписаниеВ личном кабинете
authStrategyotp, jwtне заданСтратегия аутентификации автора отзыва, вопроса и ответа. Без значения аутентификация не запрашивается. На странице меняется методом aplaut.setAuthStrategyСпособ авторизации покупателя
enableReplybooleanfalseПоказывать ответы на отзывы. Кнопку Ответить задаёт параметр commentingVisibilityПоказывать ответы на отзывы
enableReviewsSummarybooleanfalseБлок AI-сводки внутри виджета отзывов. На отдельный виджет AI-сводки не влияетAI-сводка в списке отзывов
enableJsonLdbooleanfalseРазметка JSON-LD: Product, AggregateRating и Review для отзывов текущей страницы в виджете отзывов, FAQPage для вопросов в виджете вопросов и ответов. Выводится, только если у товара есть отзывы или вопросы. Без параметра разметки нет ни у отзывов, ни у вопросовРазметка JSON-LD
isHashRoutingDisabledbooleanfalseВиджеты не меняют адрес страницы: hash формы #/mps/reviews/new… и параметры галереи ap-gallery-id, ap-review-id, ap-post-id, ap-media-id отключены. Форма открывается кнопкой или aplaut.showReviewForm()Отключить hash-роутинг
isModalHistoryIgnoredbooleanfalseОткрытие модальных окон не добавляет запись в историю браузераИгнорировать историю модальных окон

Параметры всех виджетов​

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
convertToInlineSvgbooleanfalseИконки, которых нет во встроенном наборе, виджет скачивает с get.apltcdn.com запросом fetch и встраивает в разметку как SVG, вместо ссылки на картинку. Нужно, если CSP запрещает этот хост в img-src, или для цвета через currentColor. Информер не поддерживаетdata-convert-to-inline-svgКонвертировать иконки в inline SVG
useShadowbooleantrueВиджет изолирует стили в Shadow DOM. Задаётся на тип виджета целиком, у двух экземпляров одного виджета значение одно. Информер Shadow DOM не использует—Изоляция стилей (Shadow DOM)

Поля раздела Поведение в личном кабинете находятся на вкладке Виджет.

Отзывы​

Раздел widgetsConfig.reviews, тег ap-reviews. Виджет отзывов сам создаёт на странице одну форму отзыва, общую для всех виджетов отзывов. Форма берёт настройки из раздела review_form, а не из атрибутов виджета отзывов.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
supplementPositionleft, right, topleftГде блок с рейтингом и фильтрами стоит относительно спискаdata-supplement-positionПозиция дополнительного контента
reviewsPerPagenumber10Отзывов на странице спискаdata-reviews-per-pageОтзывов на странице
baseSorthelpfulness:desc, created_at:desc, created_at:asc, rating:desc, rating:aschelpfulness:descСортировка при загрузкеdata-base-sortСортировка по умолчанию
modalZIndexnumber10000z-index полноэкранной галереи и окон ответаdata-modal-z-indexZ-index модальных окон
videoProviderkinescope, muxkinescopeПровайдер видео в отзывахdata-video-providerПровайдер видео
summaryKeyPointsLimitnumberвсе тезисыКлючевых тезисов в блоке AI-сводкиdata-summary-key-points-limitЛимит ключевых тезисов
mediaReviewDesktopSizenumber, px144Размер превью в ленте фото и видео над списком отзывов на десктопеdata-media-review-desktop-sizeРазмер медиа в отзыве — десктоп
mediaReviewMobileSizenumber, pxкак у десктопаТо же на мобильныхdata-media-review-mobile-sizeРазмер медиа в отзыве — мобильные
mediaGalleryDesktopSizenumber, px144Размер фото и видео внутри карточки отзыва на десктопеdata-media-gallery-desktop-sizeРазмер плитки галереи — десктоп
mediaGalleryMobileSizenumber, pxкак у десктопаТо же на мобильныхdata-media-gallery-mobile-sizeРазмер плитки галереи — мобильные
isBackgroundCleanbooleanfalsetrue убирает подложку и внутренние отступы у блоков виджетаdata-is-background-cleanЧистый фон
isReplyAuthorNameRequiredbooleantrueИмя автора в ответе на отзыв обязательно. При false имя можно не указывать, и в форме ответа появляется переключатель анонимностиdata-is-reply-author-name-requiredТребовать имя в ответе на отзыв
privacyLinkstring, URLне заданСсылка на правила обработки персональных данных в форме ответа на отзывdata-privacy-linkСсылка на правила ПД
termsAgreementRequiredbooleanfalseФлажок согласия с правилами в форме ответа, без которого ответ не отправляетсяdata-terms-agreement-requiredТребовать согласие с правилами ПД
termsAgreementConfirmedbooleanfalseФлажок согласия отмечен заранее. Действует при termsAgreementRequired: truedata-terms-agreement-confirmedСогласие с правилами ПД по умолчанию
verifyPurchaseStatebooleanfalseФормы отзыва, вопроса и ответа открываются только при переданном номере заказа. Без номера вместо Написать отзыв показывается Добавить в корзину. Запрет на открытие форм действует только из widgetsConfig, атрибут меняет лишь кнопкуdata-verify-purchase-stateОтзыв только после покупки
productPricestring—Цена в карточке товара полноэкранной галереи. Выводится как естьdata-product-priceЦена товара
enableSyndicationSourceLinkbooleanfalseНазвание источника в отзыве из агрегации становится ссылкой на исходный товарdata-enable-syndication-source-linkСсылка на источник синдикации
originalProductUrlTransformsobject—Правила замены ссылок на исходные товары, см. нижеdata-original-product-url-transforms—

Правила для ссылок на исходные товары​

Параметр originalProductUrlTransforms задаёт правила для отзывов, полученных агрегацией. Ключ — идентификатор источника в нижнем регистре, например www.mvideo.ru или ozon.ru: он должен точно совпадать с источником отзыва.

ПараметрТипОписание
remove_syndication_sourcebooleanСкрыть источник в отзывах из этого источника
syndication_source_namestringПоказать вместо имени источника эту строку. Если задан и remove_syndication_source: true, источник скрывается
replacementsмассивПравила замены: pattern — регулярное выражение без флагов, заменяется первое совпадение; replacement — строка замены
originalProductUrlTransforms: {
"www.mvideo.ru": {
replacements: [{ pattern: "rbt\\.ru", replacement: "mvideo.ru" }],
},
"ozon.ru": { remove_syndication_source: true },
"market.yandex.ru": { syndication_source_name: "Маркет" },
}

Правила применяются сверху вниз. Ссылка, ставшая пустой строкой, выводится текстом. Невалидное регулярное выражение приводит к ошибке загрузки списка отзывов. Обратная косая черта удваивается и в JS-строке, и в JSON внутри data-атрибута. Ссылки кликабельны только при enableSyndicationSourceLink: true. В разделе Виджеты этого параметра нет: задайте его в widgetsConfig или атрибутом.

Форма отзыва​

Раздел widgetsConfig.review_form, тег ap-reviews-form. Отдельный тег нужен, только если на странице нет виджета отзывов. Отдельная форма открывается по адресу с hash #/mps/reviews/new/<ID_ТОВАРА>, где ID совпадает с data-context-id формы. Форма внутри виджета отзывов открывается по hash #/mps/reviews/new без ID.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
contextIdstring—ID товара, на который пишется отзывdata-context-id—
modalPersistentbooleanfalseФорма занимает весь экран, её нельзя закрыть кликом вне окна или свайпом. Кнопка Готово на последнем шаге появляется, только если в адресе страницы есть redirect_uri, и ведёт на негоdata-modal-persistentФорма на всю высоту экрана
subscribeToContextChangebooleantrueФорма открывается для товара, выбранного в другом виджете на страницеdata-subscribe-to-context-changeПринимать товар от других виджетов
modalZIndexnumber10000z-index окна формыdata-modal-z-indexZ-index модальных окон
phoneEnabledbooleanfalseПоле телефона в формеdata-phone-enabledПоле телефона
phoneRequiredbooleanfalseТелефон обязателен. Действует при phoneEnabled: truedata-phone-requiredТелефон обязателен
privacyLinkstring, URL#Ссылка на правила обработки персональных данныхdata-privacy-linkСсылка на правила ПД
termsAgreementRequiredbooleanfalseФлажок согласия с правилами, без которого отзыв не отправляетсяdata-terms-agreement-requiredТребовать согласие с правилами ПД
termsAgreementConfirmedbooleanfalseФлажок согласия отмечен заранееdata-terms-agreement-confirmedСогласие с правилами ПД по умолчанию

Поле email показывается и становится обязательным по схеме веб-формы в разделе Админ → Виджеты и формы → Веб-формы. При authStrategy: "otp" поле email показывается и обязательно всегда, при authStrategy: "jwt" полей автора в форме нет. Черновик отзыва хранится в браузере покупателя час после последней правки, метод aplaut.clearFormData() его очищает.

Телефон форма принимает только полностью: +7 и 11 цифр. Пустое обязательное поле подсвечивается сообщением «Введите телефон», неполный номер — «Введите корректный телефон». Эти два сообщения через texts не меняются. Неверный email показывает текст из ключа form.personal.email.invalid.

Шаги формы​

  1. Оценка, текст, фото и видео и вопрос «Порекомендуете товар?». Ответ на вопрос по умолчанию «да», если оценка выше 3.
  2. Данные автора, детальные оценки и характеристики. Шаг есть, только если в схеме веб-формы есть хотя бы что-то из этого. Без него на первом шаге вместо Далее стоит Отправить, а надпись «Шаг N из M» не показывается.
  3. «Спасибо». Если отправка не удалась, форма на этот шаг не переходит и показывает ошибку.

Товар, на который покупатель оставил отзыв, пропадает из списков товаров во всех формах на странице и из окна приглашения оставить отзыв.

Вопросы и ответы​

Раздел widgetsConfig.questions_answers, тег ap-questions-answers.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
questionsPerPagenumber10Вопросов на странице спискаdata-questions-per-pageВопросов на странице
isBackgroundCleanbooleanfalsetrue убирает подложку и внутренние отступы у блоков виджетаdata-is-background-cleanЧистый фон
privacyLinkstring, URLне заданСсылка на правила в формах вопроса и ответаdata-privacy-linkСсылка на правила ПД
termsAgreementRequiredbooleanfalseФлажок согласия в формах обязателенdata-terms-agreement-requiredТребовать согласие с правилами ПД
termsAgreementConfirmedbooleanfalseФлажок согласия отмечен заранееdata-terms-agreement-confirmedСогласие с правилами ПД по умолчанию
modalZIndexnumber10000z-index форм вопроса и ответаdata-modal-z-indexZ-index модальных окон
videoProviderkinescope, muxkinescopeПровайдер видео во вложенияхdata-video-providerПровайдер видео

Галерея​

Раздел widgetsConfig.gallery, тег ap-reviews-gallery. Показывает фото и видео из отзывов товара без списка отзывов. Медиа из сторис в галерею не попадают.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
reviewsPerPagenumber10Сколько отзывов подгружается для карточек в полноэкранном режимеdata-reviews-per-pageОтзывов на странице
baseSortкак у отзывовhelpfulness:descСортировка отзывов в полноэкранном режимеdata-base-sortСортировка по умолчанию
modalZIndexnumber10000z-index полноэкранного режимаdata-modal-z-indexZ-index модальных окон
videoProviderkinescope, muxkinescopeПровайдер видео в полноэкранном режиме. Плитка строит превью только для kinescopedata-video-providerПровайдер видео
productPricestring—Цена в карточке товараdata-product-priceЦена товара
enableSyndicationSourceLinkbooleanfalseСсылка на исходный товар в отзыве из агрегацииdata-enable-syndication-source-linkСсылка на источник синдикации
originalProductUrlTransformsobject—Как у виджета отзывовdata-original-product-url-transforms—

Открытое медиа добавляет в адрес параметры ap-gallery-id, ap-review-id и ap-media-id. Ссылка с ними открывает галерею на том же слайде.

AI-сводка​

Раздел widgetsConfig.summary, тег ap-reviews-summary. Виджет запрашивает сводку по товару сам и не зависит от enableReviewsSummary. Если скрыты и текст, и тезисы, блок не показывается.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
summaryKeyPointsLimitnumberвсе тезисыСколько ключевых тезисов показыватьdata-summary-key-points-limitЛимит ключевых тезисов
isBackgroundCleanbooleanfalsetrue убирает подложку и внутренние отступы блокаdata-is-background-cleanЧистый фон

Информер​

Раздел widgetsConfig.inline_informer, тег ap-informer. В разделе Виджеты тот же виджет доступен под названиями Информер и Рейтинг строкой. Информер не показывается, если у товара в Aplaut нет рейтинга. Информеры на странице запрашивают рейтинги пачками по 30 товаров.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
scrollTargetIdstring—id элемента без #, к которому страница плавно прокручивается по кликуdata-scroll-target-idID блока для прокрутки по клику
shouldHideIfZerobooleanfalseСкрыть информер, если рейтинг после округления равен 0,0data-should-hide-if-zeroСкрывать без отзывов
backgroundbooleantrueПодложка информераdata-backgroundПодложка
countTextexpanded, compactexpandedФормат числа отзывовdata-count-textТекст с числом отзывов
ratingSizeexpanded, compactexpandedФормат рейтинга. Любое значение, кроме expanded, считается compactdata-rating-sizeРазмер рейтинга
keyPointsVisibilitybooleanfalseКлючевые тезисы AI-сводки справа от числа отзывов. Тезисы сменяются раз в 3 секунды, показываются только те, что помещаются в строкуdata-key-points-visibility="true"Ключевые тезисы

Сторис​

Раздел widgetsConfig.stories, тег ap-stories с обязательным data-context-id. Показывает сторис товара — посты с фото и видео — лентой превью. Просмотренные сторис стоят после непросмотренных, отметка о просмотре хранится в браузере покупателя. Открытая сторис добавляет в адрес параметр ap-post-id. В разделе Виджеты виджет называется Истории.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
mediaGalleryDesktopSizenumber, px144Ширина и высота превьюdata-media-gallery-desktop-sizeРазмер плитки галереи — десктоп
modalZIndexnumber10000z-index полноэкранного просмотра и формdata-modal-z-indexZ-index модальных окон
videoProviderkinescope, muxkinescopeПровайдер видео в полноэкранном просмотре. Превью строятся только для kinescopedata-video-providerПровайдер видео
privacyLinkstring, URLне заданСсылка на правила в форме ответаdata-privacy-linkСсылка на правила ПД
termsAgreementRequiredbooleanfalseФлажок согласия в форме ответа обязателенdata-terms-agreement-requiredТребовать согласие с правилами ПД
termsAgreementConfirmedbooleanfalseФлажок согласия отмечен заранееdata-terms-agreement-confirmedСогласие с правилами ПД по умолчанию

Форма сторис​

Раздел widgetsConfig.stories_form, тег ap-stories-form с обязательным data-context-id: без ID товара форма не появляется. Покупатель пишет текст, указывает имя и email, никнейм, платформу, ссылки на аватар и профиль, прикладывает фото или видео и добавляет теги. Форма открывается по адресу с hash #/mps/stories/new, а при isHashRoutingDisabled: true — без hash. Тексты формы лежат в ветке form.stories словаря. В разделе Виджеты виджет называется Форма истории.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
modalPersistentbooleanfalseФорма занимает всю высоту экрана, её нельзя закрыть кликом вне окнаdata-modal-persistentФорма на всю высоту экрана
modalZIndexnumber10000z-index окна формыdata-modal-z-indexZ-index модальных окон
privacyLinkstring, URLне заданСсылка на правила обработки персональных данныхdata-privacy-linkСсылка на правила ПД
termsAgreementRequiredbooleanfalseФлажок согласия с правилами, без которого сторис не отправляетсяdata-terms-agreement-requiredТребовать согласие с правилами ПД
termsAgreementConfirmedbooleanfalseФлажок согласия отмечен заранееdata-terms-agreement-confirmedСогласие с правилами ПД по умолчанию
mediaInputVisibilityvisible, hiddenvisibleЗагрузка фото и видеоdata-media-input-visibilityЭлементы виджета → Форма отзыва → Загрузка фото и видео

Приглашение оставить отзыв​

Раздел widgetsConfig.products_review_invite, тег ap-product-review-invite. На десктопе окно стоит поверх страницы с z-index 99999. На мобильных устройствах окно открывается снизу и показывает до четырёх товаров, параметры положения и productListLimit на него не влияют.

ПараметрТипПо умолчаниюОписаниеData-атрибутВ личном кабинете
positionXleft, center, rightcenterПоложение окна по горизонтали на десктопеdata-position-xПоложение по горизонтали
positionYtop, bottombottomПоложение окна по вертикали на десктопе. Любое значение, кроме top, ставит окно внизdata-position-yПоложение по вертикали
productListLimitnumber1Товаров в окне на десктопе. Общее число товаров выводится внизу окнаdata-product-list-limitТоваров в приглашении
delaySecnumber0Задержка показа при загрузке страницы, в секундах: если окно уже включали и покупатель его не закрывал, а также когда прошёл displayIntervalHours. На вызов aplaut.setProductReviewInviteVisible(true) не влияетdata-delay-secЗадержка показа, сек
displayIntervalHoursnumberне заданЧерез сколько часов после последнего показа закрытое окно появляется снова. 0 и пустое значение отключают повторный показ. На вызов aplaut.setProductReviewInviteVisible(true) не влияет: окно показывается сразуdata-display-interval-hoursИнтервал повторного показа, ч

Без товаров для отзыва окно не показывается ни само, ни по вызову setProductReviewInviteVisible(true).

Видимость элементов​

Параметры видимости принимают visible или hidden и задаются в разделе нужного виджета или атрибутом data-…-visibility. По умолчанию всё видно, кроме счётчика символов. В личном кабинете они находятся на вкладке Виджет в разделе Элементы виджета.

Значение вида hidden:(max-width: 600px) скрывает элемент, пока выполняется media query, и реагирует на изменение размера окна. Исключения — galleryVisibility и addToCartVisibility: они понимают только точное значение hidden.

ПараметрData-атрибутЭлементВиджетыВ личном кабинете
headTitleVisibilitydata-head-title-visibilityЗаголовок виджетаОтзывы, Вопросы и ответыШапка и навигация → Заголовок виджета
ugcContentToggleVisibilitydata-ugc-content-toggle-visibilityПереключатель «все отзывы / этот товар»Отзывы, Вопросы и ответыШапка и навигация → Переключатель «все отзывы / этот товар»
sortVisibilitydata-sort-visibilityСортировкаОтзывыШапка и навигация → Сортировка
filterVisibilitydata-filter-visibilityФильтрОтзывыШапка и навигация → Фильтр
searchVisibilitydata-search-visibilityПоискОтзывы, Вопросы и ответыШапка и навигация → Поиск
buttonIconVisibilitydata-button-icon-visibilityИконки в кнопкахвсе, кроме Информера, AI-сводки и ПриглашенияШапка и навигация → Иконки в кнопках
authorAvatarVisibilitydata-author-avatar-visibilityАватар автораОтзывы, Вопросы и ответы, ГалереяКарточка отзыва → Аватар автора
replyAuthorAvatarVisibilitydata-reply-author-avatar-visibilityАватар автора ответаОтзывы, Вопросы и ответы, Галерея, СторисКарточка отзыва → Аватар автора ответа
commentingVisibilitydata-commenting-visibilityКнопка ОтветитьОтзывы, Вопросы и ответы, Галерея, СторисКарточка отзыва → Ответы на отзыв
reportVisibilitydata-report-visibilityКнопка жалобыОтзывы, Вопросы и ответы, Галерея, СторисКарточка отзыва → Жалоба
syndicationSourceVisibilitydata-syndication-source-visibilityИсточник отзыва из агрегацииОтзывы, ГалереяКарточка отзыва → Источник синдикации
supplierLogoVisibilitydata-supplier-logo-visibilityЛоготип Aplaut: в блоке рейтинга виджета отзывов и в виджете AI-сводкиОтзывы, AI-сводкаКарточка отзыва → Логотип в сводке
summaryTitleVisibilitydata-summary-title-visibilityЗаголовок AI-сводкиОтзывы, AI-сводкаAI-сводка → Заголовок
summaryTextVisibilitydata-summary-text-visibilityТекст AI-сводкиОтзывы, AI-сводкаAI-сводка → Текст сводки
summaryKeyPointsVisibilitydata-summary-key-points-visibilityКлючевые тезисыОтзывы, AI-сводкаAI-сводка → Ключевые тезисы
galleryVisibilitydata-gallery-visibilityЛента превью фото и видео над списком отзывовОтзывыГалерея → Блок галереи
addToCartVisibilitydata-add-to-cart-visibilityКнопка «В корзину» в полноэкранной галерее. Видна, только когда зарегистрирован aplaut.manageOrder({ addToCart })Отзывы, Галерея, СторисГалерея → Кнопка «В корзину»
anonymizationVisibilitydata-anonymization-visibilityПереключатель анонимности в форме отзыва. В ответе на отзыв — только при isReplyAuthorNameRequired: falseОтзывы, Форма отзываФорма отзыва → Переключатель анонимности
mediaInputVisibilitydata-media-input-visibilityЗагрузка фото и видеоФорма отзыва, Форма сторисФорма отзыва → Загрузка фото и видео
reviewsCharacterCountVisibilitydata-reviews-character-count-visibilityСчётчик символов. По умолчанию hiddenФорма отзываФорма отзыва → Счётчик символов
feedbackBlockVisibilitydata-feedback-block-visibilityБлок оценки формы на шаге после отправкиФорма отзываФорма отзыва → Блок обратной связи после отправки

Смотрите также: как настроить виджеты в личном кабинете, справочник темы оформления, справочник JS API виджетов.