Reactions — современная система реакций для MODX 3

Доброе время суток, MODX-еры.

За последнее время в чате сообщества несколько раз поднимался один и тот же вопрос: существует ли для MODX 3 современная система реакций, похожая на GitHub, Telegram или facebook*?

Большинство существующих решений либо давно не обновлялись, либо ограничиваются обычным лайком. Поэтому решил написать новый компонент с нуля.

Reactions — это современная система emoji-реакций для MODX 3 с поддержкой miniShop3, Tickets и любых собственных xPDO-моделей.

Компонент распространяется бесплатно, имеет открытый исходный код и уже доступен в ModStore.

Документация: docs.modx.pro/components/reactions/
GitHub: github.com/modx-pro/Reactions
ModStore: modstore.pro/packages/ecommerce/reactions


Что умеет Reactions

• 👍/👎 реакции или полноценный GitHub-набор.
• Полный набор из 24 emoji.
• Создание собственных типов и наборов реакций.
• Поддержка ресурсов MODX, товаров miniShop3, комментариев Tickets и любых xPDO-классов.
• Несколько вариантов отображения: auto, picker и bar.
• REST API и CLI.
• События MODX и Webhooks (Telegram, Discord, Slack).
• JSON-LD AggregateRating для SEO.
• Рейтинг материалов и «горячие» публикации.
• Несколько способов идентификации пользователей.

Компонент проектировался как универсальное решение, которое можно использовать практически в любом проекте на MODX без привязки к конкретному типу объекта.




Несколько вариантов интерфейса

Можно выбрать наиболее подходящий вариант отображения.

• UpDown — классические 👍 и 👎.
• GitHub — восемь популярных реакций с привычным popover.
• Full — полный набор из 24 emoji.
• Bar — все реакции отображаются сразу.
• Picker — компактный режим с раскрывающимся списком.

При необходимости можно ограничить доступный набор реакций буквально несколькими строками конфигурации.

Поддерживаются любые xPDO-объекты

Reactions не ограничивается ресурсами MODX.

• обычные страницы сайта;
• товары miniShop3;
• комментарии Tickets;
• собственные компоненты;
• любые xPDO-модели.

Достаточно указать класс объекта и его идентификатор.

{'!Reactions' | snippet : [
  'class' => 'msProduct',
  'object' => $_modx->resource.id,
  'set' => 'github',
]}

Headless-first

При разработке сознательно отказался от тяжёлой административной панели.

Все настройки доступны через системные настройки MODX, REST API и CLI. Благодаря этому компонент одинаково хорошо подходит как для классических сайтов, так и для headless-проектов.

Встроенные рейтинги

Кроме обычных реакций доступны готовые сниппеты для формирования рейтингов.

• TopLiked — самые популярные материалы.
• TopRated — рейтинг по количеству лайков и дизлайков.
• Trending — «горячие» публикации по алгоритму Reddit.
• ReactionsSchema — JSON-LD AggregateRating для поисковых систем.

Это позволяет буквально несколькими строками вывести популярные материалы или добавить микроразметку Schema.org.

Безопасность

Особое внимание было уделено защите от накрутки.

• Rate Limit.
• Anti-Bot защита.
• CSRF Protection.
• Origin Check.
• Replay Protection.
• Авторизация, IP, Cookie или Session.

Компонент можно использовать как на небольших корпоративных сайтах, так и на проектах с высокой посещаемостью.

Что дальше

Это только первая стабильная версия компонента.

Если у сообщества появятся интересные идеи — с удовольствием рассмотрю их для следующих релизов.

Почему компонент бесплатный

Мне хотелось сделать современное решение, которое сможет использовать любой разработчик MODX без покупки лицензии.

Поэтому пакет распространяется бесплатно через ModStore, документация открыта, а весь исходный код опубликован на GitHub.

Если компонент оказался полезным и вы хотите поддержать дальнейшую разработку бесплатных компонентов для MODX — буду очень признателен за любую помощь.

Поддержка проекта

• СберБанк — messenger.online.sberbank.ru/sl/kPLh3bewMs93eW9Hl
• Т-Банк — www.tinkoff.ru/sl/2V9U9RrcJZP

Даже небольшая поддержка помогает находить время на развитие Reactions, исправление ошибок, написание документации и создание новых бесплатных компонентов для сообщества.

Полезные ссылки

• Страница компонента в ModStore
• Документация
• GitHub

Буду рад вашим отзывам, предложениям, pull request'ам и сообщениям об ошибках.

Спасибо всем, кто пользуется моими компонентами и помогает их развивать. ❤️