UI

O SDK exporta tipos para os componentes de UI:

import type {
  ToastView,
  ToastOptions,
  ToastParams,
  SwalView,
  SwalPromptType,
  SwalParams,
  SwalPromptOption,
  SwalPromptParams,
  ModalSize,
  ModalOptions,
  ModalParams,
  SidepanelSize,
  SidepanelOptions,
  SidepanelParams
} from '@flowlu/miniapp-jssdk'

Tipos

ToastView

Visualização da notificação para a classe Toast

Valor	Descrição
'success'	Notificação de sucesso
'info'	Notificação informativa
'warning'	Notificação de aviso
'error'	Notificação de erro

ToastOptions

Opções adicionais de exibição para o método Toast.show()

Propriedade	Tipo	Descrição
timeOut	number | string	Tempo para ocultar automaticamente, em ms. O padrão é 3000
closeButton	boolean	Exibir botão de fechar. O padrão é true

ToastParams

Parâmetros do construtor de Toast

Propriedade	Tipo	Descrição
view	ToastView	Visualização da notificação
title	any	Título da notificação
message	any	Mensagem da notificação
options	ToastOptions	Opções adicionais de exibição para o método Toast.show()
events	EventCallbacks<ToastEventName>	Manipuladores de eventos

SwalView

Visualização da janela para a classe Swal

Valor	Descrição
'success'	Janela de sucesso
'info'	Janela informativa
'warning'	Janela de aviso
'error'	Janela de erro

SwalPromptType

Tipo do campo de entrada para o método Swal.prompt()

Valor	Descrição
'input'	Campo de entrada de linha única
'textarea'	Campo de entrada multilinha
'select'	Lista suspensa

SwalParams

Parâmetros do construtor de Swal

Propriedade	Tipo	Descrição
view	SwalView	Visualização da janela
title	string	Título da janela
message	string	Texto da mensagem
events	EventCallbacks<SwalEventName>	Manipuladores de eventos

SwalPromptOption

Opção de item da lista para o tipo 'select' no método Swal.prompt()

Propriedade	Tipo	Descrição
value	string | number	Valor da opção
title	string	Texto exibido da opção

SwalPromptParams

Parâmetros do método Swal.prompt()

Propriedade	Tipo	Descrição
type	SwalPromptType	Tipo do campo de entrada. O padrão é 'input'
placeholder	string	Placeholder do campo de entrada
options	SwalPromptOption[]	Lista de opções para o tipo 'select'

ModalSize

Tamanho da janela modal para a classe Modal

Valor	Descrição
'md'	Tamanho médio
'lg'	Tamanho grande

ModalOptions

Opções adicionais de exibição para o método Modal.show()

Propriedade	Tipo	Descrição
width	ModalSize	Tamanho da janela modal. O padrão é 'md'
post	boolean	Abrir URL via POST. O padrão é true

ModalParams

Parâmetros do construtor de Modal

Propriedade	Tipo	Descrição
title	string	Título da janela modal
url	string	URL da página a ser aberta
options	ModalOptions	Opções adicionais de exibição
events	EventCallbacks<ModalEventName>	Manipuladores de eventos

SidepanelSize

Tamanho do painel lateral para a classe Sidepanel

Valor	Descrição
'sm'	Tamanho pequeno
'md'	Tamanho médio
'lg'	Tamanho grande

SidepanelOptions

Opções adicionais de exibição para o método Sidepanel.show()

Propriedade	Tipo	Descrição
width	SidepanelSize	Tamanho do painel lateral. O padrão é 'md'
post	boolean	Abrir URL via POST. O padrão é true

SidepanelParams

Parâmetros do construtor de Sidepanel

Propriedade	Tipo	Descrição
title	string	Título do painel lateral
url	string	URL da página a ser aberta
options	SidepanelOptions	Opções adicionais de exibição
events	EventCallbacks<SidepanelEventName>	Manipuladores de eventos