dialog

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

Verwendung

Importieren Sie die Funktion nach Bedarf:

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

Beispiel:

öffnen

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

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

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

  button.addEventListener("click", () => {
    dialog({
      headline: "Dialog-Titel",
      description: "Dialog-Beschreibung",
      actions: [
        {
          text: "Abbrechen",
        },
        {
          text: "OK",
          onClick: () => {
            console.log("bestätigt");
            return false;
          },
        }
      ]
    });
  });
</script>

API

dialog(options: Options): Dialog

Die Funktion akzeptiert ein Options-Objekt als Argument. Der Rückgabewert ist eine Instanz der <mdui-dialog>-Komponente.

Options

Attributname	Typ	Standardwert
`headline`	`string`	-
Titel des Dialogs
`description`	`string`	-
Beschreibungstext des Dialogs
`body`	`string` \| `HTMLElement` \| `JQ<HTMLElement>`	-
Inhalt des Dialog-Bodys. Kann ein HTML-String, ein DOM-Element oder ein JQ-Objekt sein.
`icon`	`string`	-
Name des Material Icons-Symbols oben im Dialog
`closeOnEsc`	`boolean`	`false`
Ob der Dialog durch Drücken der ESC-Taste geschlossen werden soll
`closeOnOverlayClick`	`boolean`	`false`
Ob der Dialog durch Klicken auf die Overlay-Schicht geschlossen werden soll
`actions`	`Action[]`	-
Array der Aktionsbuttons unten
`stackedActions`	`boolean`	`false`
Ob die Aktionsbuttons unten vertikal angeordnet werden sollen
`queue`	`string`	-
Name der Warteschlange. Standardmäßig ist die Warteschlange deaktiviert. Bei mehrfachem Aufruf der Funktion werden mehrere Dialoge gleichzeitig angezeigt. Sie können hier einen Warteschlangennamen angeben. Dialog-Funktionen mit demselben Warteschlangennamen öffnen den nächsten Dialog erst, nachdem der vorherige geschlossen wurde. Wenn die Warteschlangennamen der vier Funktionen `dialog()`, `alert()`, `confirm()` und `prompt()` gleich sind, teilen sie sich dieselbe Warteschlange.
`onOpen`	`(dialog: Dialog) => void`	-
Wird aufgerufen, wenn sich der 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 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 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 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.

Action

Attributname	Typ	Standardwert
`text`	`string`	-
Button-Text
`onClick`	`(dialog: Dialog) => void \| boolean \| Promise<void>`	-
Wird aufgerufen, wenn auf den Button geklickt wird. Der Funktionsparameter ist die Dialog-Instanz, `this` zeigt ebenfalls auf die Dialog-Instanz. Standardmäßig wird der Dialog nach dem Klicken auf den Button geschlossen. Wenn der Rückgabewert `false` ist, wird der Dialog nicht geschlossen. Wenn der Rückgabewert ein Promise ist, wird der Dialog geschlossen, nachdem das Promise aufgelöst wurde.

Vorherige Seite

jq-Bibliothek

Nächste Seite

alert