Skip to content

Sidepanel

Sidepanel — componente de UI para abertura de um painel lateral na interface da plataforma Flowlu

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

Construtor

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

ts
constructor(params: SidepanelParams)
ParâmetroTipoDescrição
paramsSidepanelParamsParâmetros de criação do painel lateral

Propriedades

events

Objeto do tipo EventCallbacks<SidepanelEventName> com os manipuladores de eventos

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

options

Opções de exibição do painel lateral, do tipo SidepanelOptions

ts
options: SidepanelOptions

title

Título do painel lateral

ts
title: string

url

URL da página a ser aberta

ts
url: string

Métodos

destroy

Remove inscrições e libera recursos

ts
destroy(): void

hide

Fecha o painel lateral programaticamente

ts
async hide(): Promise<any>

show

Abre o painel lateral

ts
async show(): Promise<any>

Eventos do método show():

EventoParâmetroTipoDescrição
'onShow'Painel lateral foi exibido
'onHide'Painel lateral foi ocultado
'onClose'Painel lateral foi fechado pelo usuário

Exemplo

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

await App.initializeFrame()

const panel = new Sidepanel({
  title: 'Perfil do usuário',
  url: '/_module/company/view/member/433772?tab=contacts',
  options: {
    width: 'md'
  },
  events: {
    onShow: () => console.log('Painel lateral exibido'),
    onHide: () => console.log('Painel lateral ocultado'),
    onClose: () => console.log('Painel lateral fechado pelo usuário')
  }
})

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

await App.initializeFrame();

const panel = new App.Frame.Sidepanel({
  title: 'Perfil do usuário',
  url: '/_module/company/view/member/433772?tab=contacts',
  options: {
    width: 'md'
  },
  events: {
    onShow: () => console.log('Painel lateral exibido'),
    onHide: () => console.log('Painel lateral ocultado'),
    onClose: () => console.log('Painel lateral fechado pelo usuário')
  }
});

await panel.show();

Publicado sob a licença MIT.