Pacotes
Pacotes
Copiar página
O Lia SDK como pacotes npm. Um puente tipado, um SDK árvore-shakeável e bindings para React, Preact, Vue, Svelte, Solid, Angular e componentes da web.
O tag de script é a forma mais rápida de entrar. Se o seu app tem um passo de compilação, os pacotes npm lhe dão o mesmo SDK com TypeScript tipos, imports que você pode tree-shake, estado que se encaixa no seu framework, e um Lia falso para construir fora do app.
#Qual pacote
| Pacote | Use para |
|---|---|
@lia-labs/sdk | Qualquer app com um bundler, com ou sem framework. |
@lia-labs/sdk-react | React: hooks como useInit, useMainButton, useBackButton. |
@lia-labs/sdk-preact | Preact: os mesmos hooks. |
@lia-labs/sdk-vue | Vue 3: composable retornando refs. |
@lia-labs/sdk-svelte | Svelte 4 e 5: stores. |
@lia-labs/sdk-solid | Sólido: acessores e create* primitivos. |
@lia-labs/sdk-angular | Angular 17 e versões posteriores: inject* funções e sinais. |
@lia-labs/elements | Qualquer página, sem framework: <lia-main-button> e amigos. |
@lia-labs/bridge | As mensagens de baixo nível, para construir sua própria camada. |
Cada pacote do framework re-exporta todo o SDK, então um import é suficiente:
npm install @lia-labs/sdk @lia-labs/sdk-reactimport { pay, useInit, useMainButton } from '@lia-labs/sdk-react';#Como eles se encaixam
- @lia-labs/bridgemensagens do quadro Lia, digitadas:
request('pay', { productId }),on('theme', …). EmockLia(), um Lia falso para construir em um navegador de desktop. - @lia-labs/sdkToda funcionalidade como exportação nomeada (
init,pay,mainButton,cloudStorage…), com as mesmas verificações e códigos de erro que a tag script. Seu estado (tema, idioma, viewport…) é um conjunto de pequenos valores observáveis. - Pacotes de frameworkDelgado: eles transformam esses valores em hooks, refs, stores ou sinais, e vinculam os botões Lia aos seus componentes, mostrados enquanto estão montados e ocultos depois.
#Estado que você pode observar
O SDK'estado é um conjunto de Readable valores: get() lê agora, e subscribe(listener) ouve cada mudança (com o novo e o valor antigo) e retorna uma função que para de ouvir. Eles são atualizados a partir de Lia'eventos após init().
| Valor | Tipo |
|---|---|
player | { id, name } ou null antes init() |
mode | "test", "live" ou null |
language, rtl | A pessoa's idioma em Lia, como |
colorScheme, themeParams | "light" ou "dark", e Lia'cores |
viewport | { height, expanded } |
safeArea, contentSafeArea | { top, bottom, left, right } em px |
display, isFullscreen | Como o app foi aberto e se'borda a borda |
startParam | O que foi usado para abrir, mantido atualizado enquanto estava aberto |
soundOn, notificationsAllowed, notificationsAvailable | A pessoa'opções |
initialized | Se init() respondeu |
Cada pacote do framework tem um hook correspondente, composto, store ou sinal para cada um.
#A tag script ainda funciona
https://api.lialabs.org/sdk/lia-apps-v1.js (o global Lia) é inalterado. Use-o ou os pacotes em uma página, não os dois: ambos ouvem Lia's respostas no mesmo canal, e a segunda a carregar pode't.
#Versões
Os pacotes usam o protocolo do SDK 1.8.1. Um app Lia anterior a um recurso responde unknown_method; veja o registro de alterações.
Traduzido automaticamente. O inglês é a fonte de verdade. Leia em inglês