Widget Livedeck đầu tiên của bạn: từ starter kit đến khi tải lên
Tải starter kit, chỉnh sửa, tải lên dưới dạng ZIP và thử trong editor.
Starter kit là một widget hoàn chỉnh tên “Live Feed”: nó hiển thị quà, follow và chat dưới dạng thẻ và đếm lượt thích. Hãy dựa vào đó để tạo widget của riêng bạn.
Trong gói có gì
manifest.json
Tên, phiên bản, kích thước, quyền và cài đặt của widget
index.html
Trang khởi động. Tải SDK và các file của bạn.
style.css
Giao diện
app.js
Logic: phản hồi các sự kiện
README.md
Hướng dẫn nhanh
| Tệp | Mục đích |
|---|---|
| manifest.json | Tên, phiên bản, kích thước, quyền và cài đặt của widget |
| index.html | Trang khởi động. Tải SDK và các file của bạn. |
| style.css | Giao diện |
| app.js | Logic: phản hồi các sự kiện |
| README.md | Hướng dẫn nhanh |
Trang khởi động
Mọi trang khởi động đều tải SDK từ đường dẫn /sdk/v1.js. Livedeck cung cấp file này tại địa chỉ widget của bạn; bạn không cần tự đưa nó vào gói. Hãy tải tất cả các file khác bằng đường dẫn tương đối.
<!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>Phản hồi sự kiện
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;
});Widget chỉ nhận những sự kiện mà nó yêu cầu trong mục permissions của manifest.json. Với ví dụ trên, đó là events.gift và events.follow.
Nén ZIP và tải lên
- Tăng version trong manifest.json (ví dụ từ 1.0.0 lên 1.0.1) để sau này bạn phân biệt được các phiên bản.
- Nén các file lại. manifest.json phải nằm ở cấp cao nhất của file ZIP hoặc trong thư mục duy nhất chứa toàn bộ nội dung. Windows: chọn các file › chuột phải › Send to › Compressed (zipped) folder. Mac: chọn các file › chuột phải › Compress.
- Trong dashboard: Editor › My widgets › “Upload your own”. Lần đầu tiên, bạn cần tạo hồ sơ nhà phát triển và chấp nhận các quy định.
- Sau khoảng một phút, quá trình kiểm tra sẽ hoàn tất. Không đạt? Bạn sẽ thấy từng lý do kèm file và dòng, hoặc kèm giá trị đo được. Sửa lỗi rồi tải lên file ZIP mới.
- Đặt widget lên canvas và thử bằng các nút test trong phần cài đặt của nó (quà, chat, lượt thích và nhiều hơn nữa).
Bài viết này có hữu ích không?