UI
El SDK exporta los tipos para los componentes de UI:
ts
import type {
ToastView,
ToastOptions,
ToastParams,
SwalView,
SwalPromptType,
SwalParams,
SwalPromptOption,
SwalPromptParams,
ModalSize,
ModalOptions,
ModalParams,
SidepanelSize,
SidepanelOptions,
SidepanelParams
} from '@flowlu/miniapp-jssdk'Tipos
ToastView
Vista de la notificación para la clase Toast
| Valor | Descripción |
|---|---|
'success' | Notificación de éxito |
'info' | Notificación informativa |
'warning' | Notificación de advertencia |
'error' | Notificación de error |
ToastOptions
Opciones adicionales de visualización para el método Toast.show()
| Propiedad | Tipo | Descripción |
|---|---|---|
timeOut | number | string | Tiempo de espera de ocultación automática en ms. El valor predeterminado es 3000 |
closeButton | boolean | Mostrar el botón de cerrar. El valor predeterminado es true |
ToastParams
Parámetros del constructor para Toast
| Propiedad | Tipo | Descripción |
|---|---|---|
view | ToastView | Vista de la notificación |
title | any | Título de la notificación |
message | any | Mensaje de la notificación |
options | ToastOptions | Opciones adicionales de visualización para el método Toast.show() |
events | EventCallbacks<ToastEventName> | Manejadores de eventos |
SwalView
Vista del diálogo para la clase Swal
| Valor | Descripción |
|---|---|
'success' | Diálogo de éxito |
'info' | Diálogo informativo |
'warning' | Diálogo de advertencia |
'error' | Diálogo de error |
SwalPromptType
Tipo de campo de entrada para el método Swal.prompt()
| Valor | Descripción |
|---|---|
'input' | Campo de entrada de una sola línea |
'textarea' | Campo de entrada de varias líneas |
'select' | Lista desplegable |
SwalParams
Parámetros del constructor para Swal
| Propiedad | Tipo | Descripción |
|---|---|---|
view | SwalView | Vista del diálogo |
title | string | Título del diálogo |
message | string | Texto del mensaje |
events | EventCallbacks<SwalEventName> | Manejadores de eventos |
SwalPromptOption
Opción de elemento de lista para el tipo 'select' en el método Swal.prompt()
| Propiedad | Tipo | Descripción |
|---|---|---|
value | string | number | Valor de la opción |
title | string | Texto de la opción que se muestra |
SwalPromptParams
Parámetros para el método Swal.prompt()
| Propiedad | Tipo | Descripción |
|---|---|---|
type | SwalPromptType | Tipo de campo de entrada. El valor predeterminado es 'input' |
placeholder | string | Texto de marcador del campo de entrada |
options | SwalPromptOption[] | Lista de opciones para el tipo 'select' |
ModalSize
Tamaño de la ventana modal para la clase Modal
| Valor | Descripción |
|---|---|
'md' | Tamaño mediano |
'lg' | Tamaño grande |
ModalOptions
Opciones adicionales de visualización para el método Modal.show()
| Propiedad | Tipo | Descripción |
|---|---|---|
width | ModalSize | Tamaño de la ventana modal. El valor predeterminado es 'md' |
post | boolean | Abrir la URL mediante POST. El valor predeterminado es true |
ModalParams
Parámetros del constructor para Modal
| Propiedad | Tipo | Descripción |
|---|---|---|
title | string | Título de la ventana modal |
url | string | URL de la página a abrir |
options | ModalOptions | Opciones adicionales de visualización |
events | EventCallbacks<ModalEventName> | Manejadores de eventos |
SidepanelSize
Tamaño del panel lateral para la clase Sidepanel
| Valor | Descripción |
|---|---|
'sm' | Tamaño pequeño |
'md' | Tamaño mediano |
'lg' | Tamaño grande |
SidepanelOptions
Opciones adicionales de visualización para el método Sidepanel.show()
| Propiedad | Tipo | Descripción |
|---|---|---|
width | SidepanelSize | Tamaño del panel lateral. El valor predeterminado es 'md' |
post | boolean | Abrir la URL mediante POST. El valor predeterminado es true |
SidepanelParams
Parámetros del constructor para Sidepanel
| Propiedad | Tipo | Descripción |
|---|---|---|
title | string | Título del panel lateral |
url | string | URL de la página a abrir |
options | SidepanelOptions | Opciones adicionales de visualización |
events | EventCallbacks<SidepanelEventName> | Manejadores de eventos |