alert

Функция alert является обёрткой для компонента <mdui-dialog>. Эта функция заменяет стандартную функцию window.alert. С её помощью вы можете открыть диалоговое окно предупреждения без написания HTML-кода компонента.

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

Импортируйте функцию по мере необходимости:

import { alert } from 'mdui/functions/alert.js';

Пример использования:

open

<mdui-button class="example-button">open</mdui-button>

<script type="module">
  import { alert } from "mdui/functions/alert.js";

  const button = document.querySelector(".example-button");

  button.addEventListener("click", () => {
    alert({
      headline: "Alert Title",
      description: "Alert description",
      confirmText: "OK",
      onConfirm: () => console.log("confirmed"),
    });
  });
</script>

API

alert(options: Options): Promise<void>

Функция alert принимает объект Options в качестве параметра; возвращает Promise. Если диалоговое окно закрыто нажатием кнопки подтверждения, Promise будет выполнен (resolve), если закрыто другим способом — отклонён (reject).

Options

Имя свойства	Тип	Значение по умолчанию
`headline`	`string`	-
Заголовок alert
`description`	`string`	-
Описательный текст alert
`icon`	`string`	-
Название иконки Material Icons в верхней части alert
`closeOnEsc`	`boolean`	`false`
Закрывать ли alert при нажатии клавиши ESC
`closeOnOverlayClick`	`boolean`	`false`
Закрывать ли alert при клике на оверлей
`confirmText`	`string`	`OK`
Текст кнопки подтверждения
`queue`	`string`	-
Имя очереди. По умолчанию очередь не используется; при многократном вызове функции будет одновременно отображаться несколько alert. Вы можете передать имя очереди в этом параметре. Функции alert с одинаковым именем очереди будут открывать следующий alert только после закрытия предыдущего. Если у функций `dialog()`, `alert()`, `confirm()` и `prompt()` указано одно и то же имя очереди, они также будут использовать общую очередь.
`onConfirm`	`(dialog: Dialog) => void \| boolean \| Promise<void>`	-
Функция обратного вызова при нажатии кнопки подтверждения. Параметр функции — экземпляр диалога, `this` также указывает на экземпляр диалога. По умолчанию после нажатия кнопки подтверждения alert закрывается; если возвращается `false`, alert не закрывается; если возвращается promise, alert закроется после его выполнения (resolve).
`onOpen`	`(dialog: Dialog) => void`	-
Функция обратного вызова при начале открытия alert. Параметр функции — экземпляр диалога, `this` также указывает на экземпляр диалога.
`onOpened`	`(dialog: Dialog) => void`	-
Функция обратного вызова по завершении анимации открытия alert. Параметр функции — экземпляр диалога, `this` также указывает на экземпляр диалога.
`onClose`	`(dialog: Dialog) => void`	-
Функция обратного вызова при начале закрытия alert. Параметр функции — экземпляр диалога, `this` также указывает на экземпляр диалога.
`onClosed`	`(dialog: Dialog) => void`	-
Функция обратного вызова по завершении анимации закрытия alert. Параметр функции — экземпляр диалога, `this` также указывает на экземпляр диалога.
`onOverlayClick`	`(dialog: Dialog) => void`	-
Функция обратного вызова при клике на оверлей. Параметр функции — экземпляр диалога, `this` также указывает на экземпляр диалога.

Предыдущая глава

dialog

Следующая глава

confirm