Skip to content

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

ValorDescripció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()

PropiedadTipoDescripción
timeOutnumber | stringTiempo de espera de ocultación automática en ms. El valor predeterminado es 3000
closeButtonbooleanMostrar el botón de cerrar. El valor predeterminado es true

ToastParams

Parámetros del constructor para Toast

PropiedadTipoDescripción
viewToastViewVista de la notificación
titleanyTítulo de la notificación
messageanyMensaje de la notificación
optionsToastOptionsOpciones adicionales de visualización para el método Toast.show()
eventsEventCallbacks<ToastEventName>Manejadores de eventos

SwalView

Vista del diálogo para la clase Swal

ValorDescripció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()

ValorDescripció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

PropiedadTipoDescripción
viewSwalViewVista del diálogo
titlestringTítulo del diálogo
messagestringTexto del mensaje
eventsEventCallbacks<SwalEventName>Manejadores de eventos

SwalPromptOption

Opción de elemento de lista para el tipo 'select' en el método Swal.prompt()

PropiedadTipoDescripción
valuestring | numberValor de la opción
titlestringTexto de la opción que se muestra

SwalPromptParams

Parámetros para el método Swal.prompt()

PropiedadTipoDescripción
typeSwalPromptTypeTipo de campo de entrada. El valor predeterminado es 'input'
placeholderstringTexto de marcador del campo de entrada
optionsSwalPromptOption[]Lista de opciones para el tipo 'select'

ModalSize

Tamaño de la ventana modal para la clase Modal

ValorDescripción
'md'Tamaño mediano
'lg'Tamaño grande

ModalOptions

Opciones adicionales de visualización para el método Modal.show()

PropiedadTipoDescripción
widthModalSizeTamaño de la ventana modal. El valor predeterminado es 'md'
postbooleanAbrir la URL mediante POST. El valor predeterminado es true

ModalParams

Parámetros del constructor para Modal

PropiedadTipoDescripción
titlestringTítulo de la ventana modal
urlstringURL de la página a abrir
optionsModalOptionsOpciones adicionales de visualización
eventsEventCallbacks<ModalEventName>Manejadores de eventos

SidepanelSize

Tamaño del panel lateral para la clase Sidepanel

ValorDescripció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()

PropiedadTipoDescripción
widthSidepanelSizeTamaño del panel lateral. El valor predeterminado es 'md'
postbooleanAbrir la URL mediante POST. El valor predeterminado es true

SidepanelParams

Parámetros del constructor para Sidepanel

PropiedadTipoDescripción
titlestringTítulo del panel lateral
urlstringURL de la página a abrir
optionsSidepanelOptionsOpciones adicionales de visualización
eventsEventCallbacks<SidepanelEventName>Manejadores de eventos

Publicado bajo la licencia MIT.