Skip to content

Toast

Toast — componente de UI para exibição de notificações na interface da plataforma Flowlu.

ts
import { Toast } from '@flowlu/miniapp-jssdk'

Construtor

Cria uma instância de Toast com os parâmetros fornecidos

ts
constructor(params: ToastParams)
ParâmetroTipoDescrição
paramsToastParamsParâmetros de criação da notificação

Propriedades

events

Objeto do tipo EventCallbacks<ToastEventName> com os manipuladores de eventos da notificação

ts
get events(): EventCallbacks
set events(value: EventCallbacks)

message

Texto da mensagem da notificação

ts
message: string

options

Opções de exibição da notificação, do tipo ToastOptions

ts
options: ToastOptions

title

Título da notificação

ts
title: string

view

Visualização da notificação, do tipo ToastView

ts
get view(): ToastView
set view(value: ToastView)

Métodos

clear

Oculta todas as notificações

ts
static clear(): Promise<any>

destroy

Remove inscrições e libera recursos

ts
destroy(): void

show

Exibe a notificação com os valores atuais de view, title, message e options

ts
async show(): Promise<any>

Eventos do método show():

EventoParâmetroTipoDescrição
'onShow'Notificação foi exibida
'onHide'Notificação foi ocultada
'onClose'Notificação foi fechada pelo usuário

Exemplo

ts
import { App, Toast } from '@flowlu/miniapp-jssdk'

await App.initializeFrame()

const toast = new Toast({
  view: 'success',
  title: 'Salvo',
  message: 'Configurações atualizadas com sucesso',
  options: {
    timeOut: 5000
  },
  events: {
    onShow: () => console.log('Notificação exibida'),
    onHide: () => console.log('Notificação ocultada'),
    onClose: () => console.log('Notificação fechada pelo usuário')
  }
})

await toast.show()
js
const App = window.FlowluMiniApp;

await App.initializeFrame();

const toast = new App.Frame.Toast({
  view: 'success',
  title: 'Salvo',
  message: 'Configurações atualizadas com sucesso',
  options: {
    timeOut: 5000
  },
  events: {
    onShow: () => console.log('Notificação exibida'),
    onHide: () => console.log('Notificação ocultada'),
    onClose: () => console.log('Notificação fechada pelo usuário')
  }
});

await toast.show();

Publicado sob a licença MIT.