UI

SDK экспортирует типы для UI компонентов:

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

Типы

ToastView

Вид уведомления класса Toast

Значение	Описание
'success'	Уведомление об успешном действии
'info'	Информационное уведомление
'warning'	Предупреждение
'error'	Уведомление об ошибке

ToastOptions

Дополнительные параметры отображения уведомления методом Toast.show()

Свойство	Тип	Описание
timeOut	number | string	Время автоскрытия уведомления (мс). По умолчанию 3000
closeButton	boolean	Отображать кнопку закрытия. По умолчанию true

ToastParams

Параметры конструктора Toast

Свойство	Тип	Описание
view	ToastView	Вид уведомления
title	any	Заголовок уведомления
message	any	Текст уведомления
options	ToastOptions	Дополнительные параметры отображения уведомления методом Toast.show()
events	EventCallbacks<ToastEventName>	Обработчики событий

SwalView

Вид диалога класса Swal

Значение	Описание
'success'	Диалог об успешном действии
'info'	Информационный диалог
'warning'	Диалог предупреждения
'error'	Диалог ошибки

SwalPromptType

Тип поля ввода для метода Swal.prompt()

Значение	Описание
'input'	Однострочное поле ввода
'textarea'	Многострочное поле ввода
'select'	Выпадающий список

SwalParams

Параметры конструктора Swal

Свойство	Тип	Описание
view	SwalView	Вид диалога
title	string	Заголовок диалога
message	string	Текст сообщения
events	EventCallbacks<SwalEventName>	Обработчики событий

SwalPromptOption

Элемент списка вариантов для типа 'select' метода Swal.prompt()

Свойство	Тип	Описание
value	string | number	Значение варианта
title	string	Отображаемый текст варианта

SwalPromptParams

Параметры метода Swal.prompt()

Свойство	Тип	Описание
type	SwalPromptType	Тип поля ввода. По умолчанию 'input'
placeholder	string	Placeholder для поля ввода
options	SwalPromptOption[]	Список вариантов для типа 'select'

ModalSize

Размер модального окна класса Modal

Значение	Описание
'md'	Средний размер
'lg'	Большой размер

ModalOptions

Дополнительные параметры отображения модального окна методом Modal.show()

Свойство	Тип	Описание
width	ModalSize	Размер модального окна. По умолчанию 'md'
post	boolean	Открывать URL через POST. По умолчанию true

ModalParams

Параметры конструктора Modal

Свойство	Тип	Описание
title	string	Заголовок модального окна
url	string	URL открываемой страницы
options	ModalOptions	Дополнительные параметры отображения
events	EventCallbacks<ModalEventName>	Обработчики событий

SidepanelSize

Размер боковой панели класса Sidepanel

Значение	Описание
'sm'	Малый размер
'md'	Средний размер
'lg'	Большой размер

SidepanelOptions

Дополнительные параметры отображения боковой панели методом Sidepanel.show()

Свойство	Тип	Описание
width	SidepanelSize	Размер боковой панели. По умолчанию 'md'
post	boolean	Открывать URL через POST. По умолчанию true

SidepanelParams

Параметры конструктора Sidepanel

Свойство	Тип	Описание
title	string	Заголовок боковой панели
url	string	URL открываемой страницы
options	SidepanelOptions	Дополнительные параметры отображения
events	EventCallbacks<SidepanelEventName>	Обработчики событий