Gói
@lia-labs/sdk
Sao chép trang
Cái Lia SDK cho các ứng dụng có bước xây dựng. Mỗi tính năng dưới dạng xuất có kiểu, có thể được cắt nhỏ, với cùng các kiểm tra và mã lỗi như thẻ script, và trạng thái bạn có thể theo dõi.
npm install @lia-labs/sdk#Bắt đầu
import { init, isLia, mockLia, ready } from '@lia-labs/sdk';
if (!isLia()) mockLia(); // building in a desktop browser
const me = await init();
render(me);
ready();init(options?) gọi Lia một lần và trả lời với cùng kết quả như Lia.init(); gọi lại nó sẽ trả về kết quả đầu tiên. Nó cũng:
- giữ
--lia-*CSS biến hiện tại trên trang của bạn (tắt bằng{ cssVars: false }, hoặc gọibindCssVars()bản thân bạn), - thiết lập trang của bạn's
langvàdirtừ người'ngôn ngữ (tắt bằng{ documentLanguage: false }), - giữ nguyên SDK's trạng thái hiện tại từ Lia'sự kiện.
#Từ thẻ script đến imports
Tất cả trên thẻ script's Lia đối tượng là một xuất tên ở đây, với cùng các tham số, câu trả lời và mã lỗi. Chỉ nhập những gì bạn cần; phần còn lại sẽ không có trong gói của bạn.
| Thẻ kịch bản | @lia-labs/sdk |
|---|---|
Lia.init(), Lia.ready(), Lia.session(), Lia.close() | init(), ready(), session(), close() |
Lia.pay(id, opts), Lia.charges(), Lia.onCharge(fn) | pay(id, opts), charges(), onCharge(fn) |
Lia.showAd(opts) và các tiện ích nhanh, Lia.onAd(fn) | showAd(opts), showRewardedAd(), showRewardedInterstitialAd(), showInterstitialAd(), onAd(fn) |
Lia.showBanner(opts), Lia.hideBanner(), Lia.banner, Lia.onBanner(fn), Lia.showNativeAd(opts), Lia.hideNativeAd(), Lia.nativeAd, Lia.onNativeAd(fn) | showBanner(opts), hideBanner(), banner, onBanner(fn), showNativeAd(opts), hideNativeAd(), nativeAd, onNativeAd(fn); cũng holdBanner(position), cho thấy một lần cho đến khi hàm mà nó trả về được gọi |
Lia.requestNotifications() | requestNotifications() |
Lia.inviteFriend(opts), Lia.inviteLink(p), Lia.share(text) | inviteFriend(opts), inviteLink(p), share(text) |
Lia.confirm, Lia.showPopup, Lia.showAlert, Lia.showConfirm, Lia.toast | Cùng tên |
Lia.expand(), Lia.requestFullscreen(), Lia.exitFullscreen() | Cùng tên |
Lia.enableExpand() … Lia.disableClosingConfirmation() | Cùng tên |
Lia.setBackgroundColor(c), Lia.setHeaderColor(c) | Cùng tên |
Lia.mainButton, Lia.secondaryButton, Lia.backButton, Lia.settingsButton | mainButton, secondaryButton, backButton, settingsButton |
Lia.haptic, Lia.scanQr, Lia.copyText, Lia.readClipboard, Lia.openLink, Lia.openLiaLink | Cùng tên |
Lia.submitScore, Lia.leaderboard | Cùng tên |
Lia.cloudStorage, Lia.deviceStorage, Lia.secureStorage, Lia.biometric | Cùng tên |
Lia.accelerometer, Lia.gyroscope, Lia.deviceOrientation | Cùng tên, với reading và isStarted xem |
Lia.on(event, fn), Lia.off, Lia.onPause, Lia.onResume | on(event, fn), off, once, onAny, onPause, onResume |
Lia.language, Lia.theme, Lia.viewport và các thuộc tính khác | language.get(), themeParams.get(), viewport.get() và phần còn lại |
Mỗi phương pháp's các nút quay lại và cài đặt. Tham khảo SDK.
#Trạng thái xem
import { colorScheme, language, viewport } from '@lia-labs/sdk';
language.get(); // "en"
const stop = colorScheme.subscribe((scheme, previous) => repaint(scheme));
viewport.subscribe(({ height }) => resizeCanvas(height));Một người nghe chỉ nghe các thay đổi (không bao giờ khi đăng ký) và subscribe trả về hàm dừng riêng của nó. Bạn có thể tạo hàm của riêng mình bằng signal(initial) và computed(sources, fn).
#Nút
Các nút hoạt động như trên thẻ script, và cũng cho bạn biết trạng thái của chúng:
import { mainButton } from '@lia-labs/sdk';
mainButton.setParams({ text: 'Buy for 5 LIA', isVisible: true });
const stop = mainButton.onClick(buy);
mainButton.state.subscribe((s) => console.log(s.isProgressVisible));setParams nhận tên camelCase: text, color, textColor, isVisible, isActive, isProgressVisible, hasShineEffect, position. onClick trả về một hàm dừng lắng nghe. backButton.isVisible và settingsButton.isVisible có thể được theo dõi nữa.
Để hiển thị nút chỉ khi một phần trang của bạn đang trên màn hình, controlBottomButton(button, options) và controlHeaderButton(button, onClick) cho bạn update(…) và dispose() (dispose ẩn nó). Các gói khung sử dụng những điều này.
#Lỗi
Mỗi thất bại là một LiaError với một code, cùng các mã như tag script. isLiaError(error, 'cancelled') kiểm tra một.
import { isLiaError, pay } from '@lia-labs/sdk';
try {
await pay('extra-lives', { idempotencyKey: orderId });
} catch (error) {
if (isLiaError(error, 'cancelled')) return;
throw error;
}Các tham số được kiểm tra trước khi bất kỳ thứ gì đến Lia, và các kiểm tra đó từ chối lời hứa (hoặc ném, đối với các cuộc gọi ít ỏi mà không'trả về một cái).
#Không có bộ đóng gói
Gói cũng có một script build đặt mọi thứ trên window.liaSdk:
<script src="https://unpkg.com/@lia-labs/sdk/dist/index.global.js"></script>
<script>
liaSdk.init().then(function (me) { liaSdk.ready(); });
</script>Sử dụng đây hoặc thẻ script gốc trên một trang, không phải cả hai.
#TypeScript
Tất cả đều có kiểu dữ liệu, bao gồm mỗi phương pháp'các tham số và câu trả lời của bạn, và mọi sự kiện'dữ liệu (Methods, Events, InitResult, ThemeParams, Charge, AdResult và phần còn lại được xuất).
Được dịch tự động. Tiếng Anh là nguồn tin cậy. Đọc bằng tiếng Anh