alert

Az alert függvény a <mdui-dialog> komponenshez tartozó kényelmi függvény. Ez a függvény a rendszer natív window.alert függvényének helyettesítésére szolgál. A függvény használatával nem kell kézzel megírnia a komponens HTML-kódját, mégis azonnal megnyithat egy figyelmeztetőablakot.

Használat

A függvény importálása:

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

Példa:

megnyitás

<mdui-button class="example-button">megnyitás</mdui-button>

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

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

  button.addEventListener("click", () => {
    alert({
      headline: "Figyelmeztetés címe",
      description: "Figyelmeztetés leírása",
      confirmText: "OK",
      onConfirm: () => console.log("megerősítve"),
    });
  });
</script>

API

alert(options: Options): Promise<void>

Az alert függvény egy Options objektumot fogad paraméterként; visszatérési értéke egy Promise, ha a figyelmeztetőablak a megerősítés gombra kattintva záródott be, a Promise feloldódik, ha más módon, akkor elutasításra kerül.

Options

Attribútum név	Típus	Alapértelmezett érték
`headline`	`string`	-
az alert-ablak címe
`description`	`string`	-
az alert leíró szövege
`icon`	`string`	-
az alert tetején található Material Icons ikon neve
`closeOnEsc`	`boolean`	`false`
bezáródik-e az alert az ESC billentyű lenyomásakor
`closeOnOverlayClick`	`boolean`	`false`
bezáródik-e az alert a takarórétegre kattintva
`confirmText`	`string`	`OK`
a megerősítés gomb szövege
`queue`	`string`	-
Várólista neve. Alapértelmezés szerint nincs várólista, a függvény többszöri meghívásakor egyszerre több alert jelenik meg. Ebben a paraméterben megadhat egy várólista nevet. Az azonos várólistanéven futó alert függvények csak az előző alert bezárása után nyitják meg a következőt. Ha a `dialog()`, `alert()`, `confirm()`, `prompt()` négy függvény várólistaneve megegyezik, akkor ugyanazt a várólistát használják.
`onConfirm`	`(dialog: Dialog) => void \| boolean \| Promise<void>`	-
A megerősítés gombra kattintáskor meghívódó visszahívási függvény. A függvény paramétere a dialog példány, a `this` is a dialog példányra mutat. Alapértelmezés szerint a megerősítés gombra kattintva az alert bezáródik; ha a visszatérési érték `false`, akkor nem záródik be; ha a visszatérési érték egy promise, akkor a promise feloldódása után záródik be.
`onOpen`	`(dialog: Dialog) => void`	-
Az alert nyitásának kezdetekor meghívódó visszahívási függvény. A függvény paramétere a dialog példány, a `this` is a dialog példányra mutat.
`onOpened`	`(dialog: Dialog) => void`	-
Az alert nyitási animációjának befejezésekor meghívódó visszahívási függvény. A függvény paramétere a dialog példány, a `this` is a dialog példányra mutat.
`onClose`	`(dialog: Dialog) => void`	-
Az alert zárásának kezdetekor meghívódó visszahívási függvény. A függvény paramétere a dialog példány, a `this` is a dialog példányra mutat.
`onClosed`	`(dialog: Dialog) => void`	-
Az alert zárási animációjának befejezésekor meghívódó visszahívási függvény. A függvény paramétere a dialog példány, a `this` is a dialog példányra mutat.
`onOverlayClick`	`(dialog: Dialog) => void`	-
A takarórétegre kattintáskor meghívódó visszahívási függvény. A függvény paramétere a dialog példány, a `this` is a dialog példányra mutat.

Előző fejezet

dialog

Következő fejezet

confirm