alert

Die alert-Funktion ist ein Wrapper für die <mdui-dialog>-Komponente. Diese Funktion ersetzt die native window.alert-Funktion des Systems. Mit dieser Funktion können Sie einen Alert-Dialog öffnen, ohne den HTML-Code der Komponente schreiben zu müssen.

Verwendung

Importieren Sie die Funktion nach Bedarf:

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

Beispiel:

öffnen

<mdui-button class="example-button">öffnen</mdui-button>

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

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

  button.addEventListener("click", () => {
    alert({
      headline: "Alert-Titel",
      description: "Alert-Beschreibung",
      confirmText: "OK",
      onConfirm: () => console.log("bestätigt"),
    });
  });
</script>

API

alert(options: Options): Promise<void>

Die alert-Funktion akzeptiert ein Options-Objekt als Argument. Der Rückgabewert ist ein Promise. Wenn der Alert-Dialog durch Klick auf die Bestätigungsschaltfläche geschlossen wird, wird das Promise aufgelöst; wenn er auf andere Weise geschlossen wird, wird das Promise rejected.

Options

Attributname	Typ	Standardwert
`headline`	`string`	-
Titel des Dialogs
`description`	`string`	-
Beschreibungstext des Dialogs
`icon`	`string`	-
Name des Material Icons-Symbols oben im Alert-Dialog
`closeOnEsc`	`boolean`	`false`
Ob der Alert-Dialog durch Drücken der ESC-Taste geschlossen werden soll
`closeOnOverlayClick`	`boolean`	`false`
Ob der Alert-Dialog durch Klicken auf die Overlay-Schicht geschlossen werden soll
`confirmText`	`string`	`OK`
Text der Bestätigungsschaltfläche
`queue`	`string`	-
Name der Warteschlange. Standardmäßig ist die Warteschlange deaktiviert. Bei mehrfachem Aufruf der Funktion werden mehrere Alerts gleichzeitig angezeigt. Sie können hier einen Warteschlangennamen angeben. Alert-Funktionen mit demselben Warteschlangennamen öffnen den nächsten Alert erst, nachdem der vorherige geschlossen wurde. Wenn die Warteschlangennamen der vier Funktionen `dialog()`, `alert()`, `confirm()` und `prompt()` gleich sind, teilen sie sich dieselbe Warteschlange.
`onConfirm`	`(dialog: Dialog) => void \| boolean \| Promise<void>`	-
Wird aufgerufen, wenn auf die Bestätigungsschaltfläche geklickt wird. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz. Standardmäßig wird der Alert nach dem Klicken auf die Bestätigungsschaltfläche geschlossen. Wenn der Rückgabewert `false` ist, wird der Alert nicht geschlossen. Wenn der Rückgabewert ein Promise ist, wird der Alert geschlossen, nachdem das Promise aufgelöst wurde.
`onOpen`	`(dialog: Dialog) => void`	-
Wird aufgerufen, wenn sich der Alert-Dialog öffnet. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz.
`onOpened`	`(dialog: Dialog) => void`	-
Wird aufgerufen, sobald die Öffnungsanimation des Alert-Dialogs abgeschlossen ist. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz.
`onClose`	`(dialog: Dialog) => void`	-
Wird aufgerufen, wenn sich der Alert-Dialog schließt. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz.
`onClosed`	`(dialog: Dialog) => void`	-
Wird aufgerufen, sobald die Schließanimation des Alert-Dialogs abgeschlossen ist. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz.
`onOverlayClick`	`(dialog: Dialog) => void`	-
Wird aufgerufen, wenn auf die Overlay-Schicht geklickt wird. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz.

Vorherige Seite

dialog

Nächste Seite

confirm