@quadrosystems/mybb-reactions
v1.2.1
Published
Reactions plugin for quadroboards.ru
Downloads
10,642
Readme
Пример инициализации
<script src="http://127.0.0.1:9000/index.js"></script>
<script>
ReactionsPlugin.setConfig({
includeCategories: ['people', 'foods', 'objects', 'symbols', 'activity'],
customEmojis: [
{
id: '_octocat',
url: 'https://github.githubassets.com/images/icons/emoji/octocat.png',
},
{
id: '_firefox',
url: 'https://i.imgur.com/PlKtE6V.png',
category: 'Browsers',
},
{
id: '_chrome',
url: 'https://i.imgur.com/bZyUbJ9.png',
category: 'Browsers',
},
{
id: '_popcat',
url: 'https://cdn.betterttv.net/emote/5fa8f232eca18f6455c2b2e1/3x',
category: 'Catgifs',
},
{
id: '_catjam',
url: 'https://cdn.betterttv.net/emote/5f1b0186cf6d2144653d2970/3x',
category: 'Catgifs',
},
],
});
</script>
Описание объекта конфигурации
Все свойста объекта конфигурации опциональны.
| Name | Type | Default | Description |
| ---- | :--: | ------- | ----------- |
| debug
| boolean | false | Выводить в консоль доп. инфу для разработчика |
| disable
| boolean | false | Отключить плагин |
| elemSelector
| string | '.post-body'
| CSS-селектор определяющий положение панели реакций внутри поста |
| includeCategories
| Array<string> | ['people', 'nature', 'foods', 'activity', 'places', 'objects', 'symbols', 'flags']
| Категории эмоджи которые будут отображены в пикере. Значение должно быть подмножеством дефолтного списка. |
| customEmojis
| Array<Object> | []
| Массив кастомных эмоджи. |
| customEmojis.*.id
| string | | Айдишник кастомной эмоджи. Должен начинаться с '_'
. (Например: '_popcat'
.) |
| customEmojis.*.url
| string | | Ссылка на изображение формата png или jpeg. Изображение должно быть квадратным. |
| customEmojis.*.category
| string (Optional) | | Кастомная категория. Все кастомные эмоджи с одинаковой категорией будут сгрупированы в отдельные группы. (Все без указанной категории - попадут в отдельную дефолтную группу.) |
| excludeTopicIds
| Array<number> | null | null
| Отключить плагин в топиках с указанным айдишниками. Не может быть использовано одновременно с includeTopicIds
. |
| includeTopicIds
| Array<number> | null | null
| Включить плагин только в топиках с указанным айдишниками. Не может быть использовано одновременно с excludeTopicIds
. |
| excludeForumIds
| Array<number> | null | null
| Отключить плагин на форумах-разделах с указанным айдишниками. Не может быть использовано одновременно с includeForumIds
. |
| includeForumIds
| Array<number> | null | null
| Включить плагин только на форумах-разделах с указанным айдишниками. Не может быть использовано одновременно с excludeForumIds
. |
| excludeForumCategoryIds
| Array<number> | null | null
| Отключить плагин в категориях форумов с указанным айдишниками. Не может быть использовано одновременно с includeForumCategoryIds
. |
| includeForumCategoryIds
| Array<number> | null | null
| Включить плагин только в категориях форумов с указанным айдишниками. Не может быть использовано одновременно с excludeForumCategoryIds
. |
| limitReactionsNumber
| number | 0
| Ограничить кол-во реакций которое может оставить один пользователь. 0 - неограниченно. |
Запуск dev-сервера
PORT=9000 HOST=127.0.0.1 npm run start
Модуль будет доступен по адресу http://127.0.0.1:9000/index.js
.
Не рекомендую выставлять HOST=0.0.0.0
.
Сборка
npm run build
Собранный модуль будет доступен в папке dist
- dist/index.js
.