आपका पहला Livedeck widget: starter kit से upload तक
Starter kit download करें, बदलाव करें, ZIP के रूप में upload करें और editor में test करें।
Starter kit "Live Feed" नाम का एक तैयार widget है: यह gifts, follows और chat को cards के रूप में दिखाता है और likes गिनता है। यहीं से अपना widget बनाएँ।
Package में क्या है
manifest.json
Widget का नाम, version, size, permissions और settings
index.html
Start पेज। यह SDK और आपकी files load करता है।
style.css
लुक
app.js
Logic: events पर react करता है
README.md
Quick guide
| फ़ाइल | काम |
|---|---|
| manifest.json | Widget का नाम, version, size, permissions और settings |
| index.html | Start पेज। यह SDK और आपकी files load करता है। |
| style.css | लुक |
| app.js | Logic: events पर react करता है |
| README.md | Quick guide |
स्टार्ट पेज
हर स्टार्ट पेज SDK को /sdk/v1.js पाथ से लोड करता है। Livedeck इसे आपके widget के पते पर देता है; आपको इसे खुद पैकेज में नहीं डालना है। अपनी बाकी सभी फ़ाइलें relative पाथ से लोड करें।
<!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;
});widget को सिर्फ़ वही इवेंट्स मिलते हैं जो वह manifest.json में permissions के तहत माँगता है। ऊपर के उदाहरण में ये events.gift और events.follow हैं।
ZIP बनाएँ और अपलोड करें
- manifest.json में version बढ़ाएँ (जैसे 1.0.0 से 1.0.1), ताकि बाद में आप अपने वर्ज़न अलग-अलग पहचान सकें।
- फ़ाइलों को ZIP करें। manifest.json ZIP में सबसे ऊपर होनी चाहिए या उस एक फ़ोल्डर के अंदर जिसमें सब कुछ है। Windows: फ़ाइलें चुनें › राइट-क्लिक › Send to › Compressed (zipped) folder। Mac: फ़ाइलें चुनें › राइट-क्लिक › Compress।
- डैशबोर्ड में: Editor › My widgets › “Upload your own”। पहली बार आप एक डेवलपर प्रोफ़ाइल बनाते हैं और नियम स्वीकार करते हैं।
- लगभग एक मिनट में जाँच पूरी हो जाती है। पास नहीं हुआ? आपको हर कारण फ़ाइल और लाइन के साथ, या मापी गई वैल्यू के साथ दिखेगा। उसे ठीक करें और नई ZIP अपलोड करें।
- widget को canvas पर रखें और उसकी सेटिंग्स के टेस्ट बटनों (गिफ़्ट, चैट, लाइक्स और भी) से आज़माएँ।
क्या यह लेख मददगार था?