Skip to content

App

Ponto de entrada principal da biblioteca. Fornece o método para inicializar uma aplicação cliente dentro do iframe da plataforma Flowlu initializeFrame().

ts
import App from '@flowlu/miniapp-jssdk'

Propriedades

Frame

Referência à classe Frame

ts
static Frame: typeof Frame

Métodos

initializeFrame

Inicializa uma miniaplicação dentro do iframe da plataforma Flowlu e retorna uma instância singleton de Frame. Atua como wrapper para Frame.initialize()

ts
static async initializeFrame(params?: FrameParams): Promise<Frame>
ParâmetroTipoDescrição
paramsFrameParamsParâmetros de inicialização

Eventos do método initializeFrame():

EventoParâmetroTipoDescrição
'onReady'Disparado após o carregamento do conteúdo do iframe (DOMContentLoaded), o Frame ser inicializado e o contexto ser recebido, e o conteúdo incorporado ser exibido
contextFrameContextContexto da aplicação

Erros

O método lançará um erro se:

  • a aplicação não estiver sendo executada em um navegador
  • a aplicação não estiver dentro de um iframe
  • o domínio da conta da plataforma não puder ser determinado

Exemplo

ts
import App from '@flowlu/miniapp-jssdk'

const frame = await App.initializeFrame({
  events: {
    onReady: (context) => {
      console.log(`A aplicação está pronta, contexto recebido: ${context}`)
    }
  }
})
js
const App = window.FlowluMiniApp;

const frame = await App.initializeFrame({
  events: {
    onReady: (context) => {
      console.log(`A aplicação está pronta, contexto recebido: ${context}`)
    }
  }
})

Publicado sob a licença MIT.