prompt

A prompt 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.prompt 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 szövegbeviteli párbeszédablakot.

Használat

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

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

Példa:

megnyitás

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

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

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

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

API

prompt(options: Options): Promise<string>

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, és a feloldás értéke a beviteli mező tartalma, más esetben elutasításra kerül.

Options

Attribútum név	Típus	Alapértelmezett érték
`headline`	`string`	-
a prompt-ablak címe
`description`	`string`	-
a prompt leíró szövege
`icon`	`string`	-
a prompt tetején található Material Icons ikon neve
`closeOnEsc`	`boolean`	`false`
bezáródik-e a prompt az ESC billentyű lenyomásakor
`closeOnOverlayClick`	`boolean`	`false`
bezáródik-e a prompt 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 prompt jelenik meg. Ebben a paraméterben megadhat egy várólista nevet. Az azonos várólistanéven futó prompt függvények csak az előző prompt 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`	`(value: string, dialog: Dialog) => void \| boolean \| Promise<void>`	-
A felhasználó megerősítésre kattintva meghívódó visszahívási függvény. A függvény paraméterei az inputmező értéke és 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 párbeszédablak 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`	`(value: string, 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éterei a beviteli mező értéke és a dialog példány, a `this` a dialog példányra mutat. Alapértelmezés szerint a megszakítás gombra kattintva a prompt 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 prompt 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 prompt 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 prompt 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 prompt 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.
`validator`	`(value: string) => boolean \| string \| Promise<void>`	-
A beviteli mező ellenőrző függvénye, paramétere a beviteli mező értéke. A `this` a TextField példányra mutat. A böngésző natív ellenőrző API-ján való áthaladás után ezt a függvényt használja az ellenőrzéshez. Visszaadhat `boolean` értéket, `false` esetén az ellenőrzés sikertelen, `true` esetén sikeres. Visszaadhat karakterláncot is, ha nem üres, az ellenőrzés sikertelen, és a visszaadott karakterlánc szolgál hibajelzésként. Visszaadhat Promise-t is, a feloldás sikeres ellenőrzést, az elutasítás sikertelen ellenőrzést jelez, és az elutasítás oka szolgál hibajelzésként.
`textFieldOptions`	`Partial<TextField>`	-
A promptban lévő beviteli mező a `<mdui-text-field>` komponens. Ebben a paraméterben beállíthatja a `<mdui-text-field>` komponens paramétereit.

Előző fejezet

confirm

Következő fejezet

snackbar