confirm

A confirm függvény a <mdui-dialog> komponenshez tartozó kényelmi függvény. Ez a függvény funkcionalitásában a rendszer natív window.confirm függvényét helyettesíti. A függvény használatával nem kell kézzel megírnia a komponens HTML-kódját, mégis azonnal megnyithat egy megerősítőablakot.

Használat

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

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

Példa:

megnyitás

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

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

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

  button.addEventListener("click", () => {
    confirm({
      headline: "Megerősítés címe",
      description: "Megerősítés leírása",
      confirmText: "OK",
      cancelText: "Mégse",
      onConfirm: () => console.log("megerősítve"),
      onCancel: () => console.log("megszakítva"),
    });
  });
</script>

API

confirm(options: Options): Promise<void>

A függvény egy Options objektumot vár paraméterként; visszatérési értéke egy Promise, amely a megerősítés gombra kattintva oldódik fel, más esetben elutasításra kerül.

Options

Attribútum név	Típus	Alapértelmezett érték
`headline`	`string`	-
a confirm-ablak címe
`description`	`string`	-
a confirm leíró szövege
`icon`	`string`	-
a confirm tetején található Material Icons ikon neve
`closeOnEsc`	`boolean`	`false`
bezáródik-e a confirm az ESC billentyű lenyomásakor
`closeOnOverlayClick`	`boolean`	`false`
bezáródik-e a confirm a takarórétegre kattintva
`confirmText`	`string`	`OK`
a megerősítés gomb szövege
`cancelText`	`string`	`Cancel`
a megszakítás gomb szövege
`stackedActions`	`boolean`	`false`
függőlegesen rendezi-e az alsó műveleti gombokat
`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 confirm jelenik meg. Ebben a paraméterben megadhat egy várólista nevet. Az azonos várólistanéven futó confirm függvények csak az előző confirm 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 a confirm 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.
`onCancel`	`(dialog: Dialog) => void \| boolean \| Promise<void>`	-
A megszakí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 megszakítás gombra kattintva a confirm 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`	-
A confirm 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`	-
A confirm 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`	-
A confirm 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`	-
A confirm 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

alert

Következő fejezet

prompt