ФреймворкJavaScript

Notifier API: показ уведомлений

Отображение уведомлений для пользователей.

Как получить экземпляр редактора

Методы ниже вызываются на редакторе, созданном через new Blok(). Они доступны после того, как разрешится editor.isReady.

TypeScript

// You already hold the instance returned by the constructor.
const editor = new Blok({ holder: 'editor' });
await editor.isReady;

// Call any API method on it.
editor.caret.setToLastBlock('end');

Методы

notifier.show(options)

void

Show a notification message. Supports simple, confirm, and prompt notifications.

Когда использовать

Встроенное уведомление для лёгкой обратной связи. type: 'confirm' или 'prompt' — для ответа да/нет или текста.

Параметры

Параметр	Тип	Обязательный	По умолчанию	Описание
`options`	`NotifierOptions \| ConfirmNotifierOptions \| PromptNotifierOptions`	Обязательный	—	Конфигурация уведомления. Форма зависит от `type`.
`options.message`	`string`	Обязательный	—	Текст уведомления. Может содержать HTML.
`options.type`	`'alert' \| 'confirm' \| 'prompt'`	—	`'alert'`	Тип уведомления. `confirm` и `prompt` добавляют кнопки действий.
`options.style`	`'success' \| 'error'`	—	`undefined`	Встроенный визуальный стиль для уведомлений-алертов.
`options.time`	`number`	—	`8000`	Время автозакрытия в мс для всех типов уведомлений (по умолчанию 8000).
`options.okText`	`string`	—	`'Confirm' / 'Ok'`	Текст кнопки подтверждения/отправки (только для `confirm`/`prompt`).
`options.okHandler`	`(event: Event) => void \| (value: string) => void`	—	`undefined`	Колбэк подтверждения/отправки. Получает событие клика для `confirm` или значение поля для `prompt`. Обязателен для уведомлений типа prompt.
`options.cancelText`	`string`	—	`'Cancel'`	Текст кнопки отмены (только для `confirm`).
`options.cancelHandler`	`(event: Event) => void`	—	`undefined`	Колбэк отмены/закрытия (только для `confirm`).
`options.inputType`	`string`	—	`'text'`	Тип HTML-поля ввода для текстового поля prompt (только для типа prompt).
`options.placeholder`	`string`	—	`undefined`	Текст плейсхолдера для поля ввода prompt (только для типа prompt).
`options.default`	`string`	—	`undefined`	Значение по умолчанию, предзаполненное в поле ввода prompt (только для типа prompt).

Ошибки

Модуль уведомлений не загрузился (например, заблокирован CSP, ошибка динамического импорта).
[Blok] Failed to display notification. Reason: <error>
show() никогда не выбрасывает ошибку и не отклоняет промис — проверьте консоль браузера, так как сбой только логируется, а не передаётся в точку вызова.

TypeScript

// Simple notification
editor.notifier.show({
  message: 'Changes saved',
  style: 'success'
});
// → renders a toast in the corner of the editor; returns nothing to await

// Confirm notification
editor.notifier.show({
  message: 'Delete this block?',
  type: 'confirm',
  okHandler: () => console.log('Confirmed'),
  cancelHandler: () => console.log('Cancelled')
});

// Prompt notification
editor.notifier.show({
  message: 'Enter a title',
  type: 'prompt',
  okHandler: (value) => console.log('Entered:', value)
});