Ваш первый виджет Livedeck: от стартового набора до загрузки
Скачайте стартовый набор, измените его, загрузите как ZIP и протестируйте в редакторе.
Стартовый набор — это готовый виджет «Live Feed»: он показывает подарки, подписки и чат в виде карточек и считает лайки. Отталкивайтесь от него, создавая свой.
Что в пакете
manifest.json
Название, версия, размер, разрешения и настройки виджета
index.html
Стартовая страница. Загружает SDK и ваши файлы.
style.css
Внешний вид
app.js
Логика: реагирует на события
README.md
Краткое руководство
| Файл | Назначение |
|---|---|
| manifest.json | Название, версия, размер, разрешения и настройки виджета |
| index.html | Стартовая страница. Загружает SDK и ваши файлы. |
| style.css | Внешний вид |
| app.js | Логика: реагирует на события |
| README.md | Краткое руководство |
Стартовая страница
Каждая стартовая страница загружает SDK по пути /sdk/v1.js. Livedeck отдаёт его по адресу вашего виджета — добавлять его в пакет самому не нужно. Все остальные файлы подключайте по относительным путям.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="style.css">
<!-- Livedeck serves the SDK. Everything else lives in your package. -->
<script src="/sdk/v1.js"></script>
</head>
<body>
<div id="feed"></div>
<script src="app.js"></script>
</body>
</html>Реакция на события
function show(text) {
const line = document.createElement("p");
line.textContent = text; // textContent, never innerHTML: names are viewer text
document.getElementById("feed").prepend(line);
}
livedeck.on("gift", (e) => {
// "@" + e.user.handle (username), e.gift.name, e.count, e.totalDiamonds
show("@" + e.user.handle + " sent " + e.count + "× " + e.gift.name);
});
livedeck.on("follow", (e) => {
show("@" + e.user.handle + " followed you");
});
livedeck.ready(() => {
// The overlay is connected and the settings are here.
document.body.style.color = livedeck.settings.accent;
});Виджет получает только те события, которые запрошены в permissions в manifest.json. Для примера выше это events.gift и events.follow.
Упаковка в ZIP и загрузка
- Повысьте version в manifest.json (например, с 1.0.0 до 1.0.1), чтобы потом различать свои версии.
- Упакуйте файлы в ZIP. manifest.json должен лежать в корне архива или внутри единственной папки, в которой находится всё остальное. Windows: выделите файлы › правый клик › Отправить › Сжатая ZIP-папка. Mac: выделите файлы › правый клик › Сжать.
- В дашборде: Редактор › Мои виджеты › «Загрузить свой». В первый раз вы создадите профиль разработчика и примете правила.
- Примерно через минуту проверка завершится. Не прошла? Вы увидите все причины с файлом и строкой или с измеренным значением. Исправьте и загрузите новый ZIP.
- Разместите виджет на холсте и проверьте его тестовыми кнопками в настройках (подарок, чат, лайки и другое).
Статья была полезной?