Skip to content

Sidepanel

Sidepanel — componente de UI para abrir un panel lateral en la interfaz de la plataforma Flowlu

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

Constructor

Crea una instancia de Sidepanel con los parámetros dados

ts
constructor(params: SidepanelParams)
ParámetroTipoDescripción
paramsSidepanelParamsParámetros de creación del panel lateral

Propiedades

events

Objeto de tipo EventCallbacks<SidepanelEventName> con los manejadores de eventos

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

options

Opciones de visualización del panel lateral de tipo SidepanelOptions

ts
options: SidepanelOptions

title

Título del panel lateral

ts
title: string

url

URL de la página a abrir

ts
url: string

Métodos

destroy

Elimina las suscripciones y libera los recursos

ts
destroy(): void

hide

Cierra el panel lateral de forma programática

ts
async hide(): Promise<any>

show

Abre el panel lateral

ts
async show(): Promise<any>

Eventos del método show():

EventoParámetroTipoDescripción
'onShow'El panel lateral se muestra
'onHide'El panel lateral se oculta
'onClose'El usuario cierra el panel lateral

Ejemplo

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

await App.initializeFrame()

const panel = new Sidepanel({
  title: 'Perfil de usuario',
  url: '/_module/company/view/member/433772?tab=contacts',
  options: {
    width: 'md'
  },
  events: {
    onShow: () => console.log('Panel lateral mostrado'),
    onHide: () => console.log('Panel lateral ocultado'),
    onClose: () => console.log('Panel lateral cerrado por el usuario')
  }
})

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

await App.initializeFrame();

const panel = new App.Frame.Sidepanel({
  title: 'Perfil de usuario',
  url: '/_module/company/view/member/433772?tab=contacts',
  options: {
    width: 'md'
  },
  events: {
    onShow: () => console.log('Panel lateral mostrado'),
    onHide: () => console.log('Panel lateral ocultado'),
    onClose: () => console.log('Panel lateral cerrado por el usuario')
  }
});

await panel.show();

Publicado bajo la licencia MIT.