confirm
Funkce confirm je rozšířením komponenty <mdui-dialog>. Nahrazuje nativní window.confirm, takže kvůli otevření potvrzovacího dialogu nemusíte ručně psát HTML.
Způsob použití
Importujte funkci podle potřeby:
import { confirm } from 'mdui/functions/confirm.js';
Příklad použití:
<mdui-button class="example-button">otevřít</mdui-button>
<script type="module">
import { confirm } from "mdui/functions/confirm.js";
const button = document.querySelector(".example-button");
button.addEventListener("click", () => {
confirm({
headline: "Název potvrzení",
description: "Popis potvrzení",
confirmText: "OK",
cancelText: "Zrušit",
onConfirm: () => console.log("potvrzeno"),
onCancel: () => console.log("zrušeno"),
});
});
</script>API
confirm(options: Options): Promise<void>
Funkce přijímá jako parametr objekt Options a vrací Promise. Pokud se dialog zavře kliknutím na tlačítko OK, Promise se vyřeší (resolve); jinak se odmítne (reject).
Options
| Název vlastnosti | Typ | Výchozí hodnota |
|---|---|---|
headline |
string |
- |
| Název potvrzení | ||
description |
string |
- |
| Popis potvrzení | ||
icon |
string |
- |
| Název ikony Material Icons v záhlaví potvrzení | ||
closeOnEsc |
boolean |
false |
| Určuje, zda se potvrzení zavře po stisknutí klávesy ESC. | ||
closeOnOverlayClick |
boolean |
false |
| Zda zavřít potvrzení při kliknutí na překryvnou vrstvu | ||
confirmText |
string |
OK |
| Text potvrzovacího tlačítka | ||
cancelText |
string |
Zrušit |
| Text tlačítka zrušení | ||
stackedActions |
boolean |
false |
| Zda vertikálně uspořádat akční tlačítka ve spodní části | ||
queue |
string |
- |
|
Název fronty. Ve výchozím nastavení není fronta zapnutá. Při opakovaném volání této funkce se zobrazí více potvrzení současně. Zadáním názvu fronty zajistíte, že se potvrzení se stejným názvem otevřou až po zavření předchozího. Funkce |
||
onConfirm |
(dialog: Dialog) => void | boolean | Promise<void> |
- |
|
Funkce zpětného volání při kliknutí na potvrzovací tlačítko. Parametrem funkce je instance dialogu, Ve výchozím nastavení se po kliknutí na potvrzovací tlačítko dialog zavře; pokud je návratová hodnota |
||
onCancel |
(dialog: Dialog) => void | boolean | Promise<void> |
- |
|
Funkce zpětného volání při kliknutí na tlačítko zrušení. Parametrem funkce je instance dialogu, Ve výchozím nastavení se po kliknutí na tlačítko zrušení potvrzení zavře; pokud je návratová hodnota |
||
onOpen |
(dialog: Dialog) => void |
- |
|
Funkce zpětného volání při otevření potvrzení. Parametrem funkce je instance dialogu, |
||
onOpened |
(dialog: Dialog) => void |
- |
|
Funkce zpětného volání po dokončení animace otevření potvrzení. Parametrem funkce je instance dialogu, |
||
onClose |
(dialog: Dialog) => void |
- |
|
Funkce zpětného volání při zahájení zavírání potvrzení. Parametrem funkce je instance dialogu, |
||
onClosed |
(dialog: Dialog) => void |
- |
|
Funkce zpětného volání po dokončení animace zavření potvrzení. Parametrem funkce je instance dialogu, |
||
onOverlayClick |
(dialog: Dialog) => void |
- |
|
Funkce zpětného volání při kliknutí na překryvnou vrstvu. Parametrem funkce je instance dialogu, |
||