Fandom Developers Wiki
Advertisement

Toasts позволяет создавать всплывающие уведомления, менее навязчивые, чем стандартные BannerNotifications Фэндома.

Установка[]

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

Функционал библиотеки не будет доступен сразу, но в момент готовности активирует хук. Этот момент можно перехватить с помощью mw.hook:

mw.hook('dev.toasts').add(function(Toasts) {
	/**
	 * Параметр `Toasts` является псевдонимом к `window.dev.toasts`
	 * Запускайте свой код отсюда
	 */
});

У тостов есть свои цвета и иконки. Их можно отобразить, используя следующие методы:

show
Тип: метод
Описание: показывает всплывающее уведомление
Параметры:
  • content - cодержимое уведомления
  • options - объект с настройками тоста
  • type - тип сообщения. Возможные значения: default, info, warning, error и success
  • icon - иконка сообщения. Возможные значения: info, warning, error и success
  • timeout - длительность отображения сообщения в миллисекундах. По умолчанию равна 3000 (три секунды)
info
Тип: метод
Описание: показывает тост с типом info (синий цвет)
Параметры:
  • content - cодержимое уведомления
  • options - объект с настройками тоста
  • icon - иконка сообщения. Возможные значения: info, warning, error и success
  • timeout - длительность отображения сообщения в миллисекундах. По умолчанию равна 3000 (три секунды)
error
Тип: метод
Описание: показывает тост с типом error (красный цвет)
Параметры:
  • content - cодержимое уведомления
  • options - объект с настройками тоста
  • icon - иконка сообщения. Возможные значения: info, warning, error и success
  • timeout - длительность отображения сообщения в миллисекундах. По умолчанию равна 3000 (три секунды)
warning
Тип: метод
Описание: показывает тост с типом warning (желтый цвет)
Параметры:
  • content - cодержимое уведомления
  • options - объект с настройками тоста
  • icon - иконка сообщения. Возможные значения: info, warning, error и success
  • timeout - длительность отображения сообщения в миллисекундах. По умолчанию равна 3000 (три секунды)
success
Тип: метод
Описание: показывает тост с типом success (зеленый цвет)
Параметры:
  • content - cодержимое уведомления
  • options - объект с настройками тоста
  • icon - иконка сообщения. Возможные значения: info, warning, error и success
  • timeout - длительность отображения сообщения в миллисекундах. По умолчанию равна 3000 (три секунды)

Примеры[]

Создает стандартное уведомление и показывает его в течение 5 секунд:

// стандартные уведомления
Toasts.show('Привет, мир!', { timeout: 5000 });
Toasts('Еще раз привет, мир!', { timeout: 5000 });

Создает тосты различных типов:

// показывает информационный тост с иконкой предупреждения на 10 секунд
Toasts.info('3.1415926...', { icon: 'warning', timeout: 10000 });

// уведомление об ошибке без иконки
Toasts.error('Опа, что-то пошло не так!', { icon: 'default' });

// тост с сообщением об успехе
Toasts.success('Поздравляю, ты сделал это!');
Advertisement