Перейти к основному содержимому
Версия: Next

Interface: ToastsApi

API для управления всплывающими уведомлениями (toast notifications).

Позволяет показывать короткие информационные, предупредительные и ошибочные сообщения пользователю. Уведомления появляются и автоматически исчезают через несколько секунд.

Использование:

  • Подтверждение успешных операций
  • Уведомления об ошибках и проблемах
  • Информирование о статусе выполнения
  • Предупреждение пользователя

Характеристики:

  • Автоматически исчезают через указанное время
  • Не блокируют работу пользователя
  • Стекуются при наличии нескольких сообщений
  • Поддерживают разные типы (успех, ошибка, предупреждение)

Methods​

showToast()​

showToast(toast): void

Показывает всплывающее уведомление пользователю.

Уведомление отображается через время, указанное в параметрах, а затем автоматически исчезает. Все параметры уведомления передаются в одном объекте.

Parameters​

toast​

CustomToast

Полное описание уведомления (тип CustomToast)

Returns​

void

Remarks​

Поведение:

  • Уведомление появляется в углу экрана (обычно внизу справа)
  • Через указанное время автоматически исчезает
  • Если время не указано, используется стандартный таймаут редактора (обычно 3-5 секунд)
  • Сообщения стекируются если появляются одно за другим

Типы уведомлений:

  • 'error' — красное, для ошибок
  • undefined — нейтральное (серое), для информации

Лучшие практики:

  • Используйте краткие сообщения (до 100 символов)
  • Не показывайте много сообщений одновременно
  • Предложите решение для ошибок
  • Используйте для быстрой обратной связи

Example​

Простое информационное уведомление

editorApi.ui.toasts.showToast({
    id: 'plugin:toast:info',
    content: 'Операция выполняется...'
});

Уведомление об успехе

editorApi.ui.toasts.showToast({
    id: 'plugin:toast:success',
    content: 'Документ успешно сохранён',
    autohideIntervalMs: 3000  // Исчезнет через 3 секунды
});

Сообщение об ошибке с длительным отображением

editorApi.ui.toasts.showToast({
    id: 'plugin:toast:error',
    content: 'Ошибка при подключении к серверу. Проверьте интернет.',
    type: 'error',
    autohideIntervalMs: 10000  // Исчезнет через 10 секунд
});

Предупреждение

editorApi.ui.toasts.showToast({
    id: 'plugin:toast:warning',
    content: 'Внимание: данные не сохранены',
    autohideIntervalMs: 5000
});

Уведомление с HTML разметкой

editorApi.ui.toasts.showToast({
    id: 'plugin:toast:html',
    content: '<strong>Готово!</strong><br>Обработано 150 документов',
    contentType: 'html',
    autohideIntervalMs: 4000
});

See​