prompt
prompt fonksiyonu, <mdui-dialog> bileşeninin bir sarmalayıcısıdır. Bu fonksiyon, sistemin yerel window.prompt fonksiyonunun yerine kullanılmak üzere tasarlanmıştır. Bu fonksiyonu kullanarak, bileşenin HTML kodunu yazmanıza gerek kalmadan metin girişi yapılabilen bir diyalog penceresi açabilirsiniz.
Kullanım
Fonksiyonu ihtiyacınıza göre içe aktarın:
import { prompt } from 'mdui/functions/prompt.js';
Kullanım örneği:
<mdui-button class="example-button">aç</mdui-button>
<script type="module">
import { prompt } from "mdui/functions/prompt.js";
const button = document.querySelector(".example-button");
button.addEventListener("click", () => {
prompt({
headline: "Prompt Başlığı",
description: "Prompt açıklaması",
confirmText: "TAMAM",
cancelText: "İptal",
onConfirm: (value) => console.log("onaylandı: " + value),
onCancel: () => console.log("iptal edildi"),
});
});
</script>API
prompt(options: Options): Promise<string>
Fonksiyonun parametresi Options nesnesidir; dönüş değeri Promise'tir. Onay butonuna tıklanarak kapatılırsa Promise çözülür (resolve) ve çözülme değeri metin kutusunun değeridir. Diğer yollarla kapatılırsa Promise reddedilir (reject).
Options
| Öznitelik Adı | Tür | Varsayılan Değer |
|---|---|---|
headline |
string |
- |
| prompt'un başlığı | ||
description |
string |
- |
| prompt'un açıklama metni | ||
icon |
string |
- |
| prompt'un üst kısmındaki Material Icons simge adı | ||
closeOnEsc |
boolean |
false |
| ESC tuşuna basıldığında prompt'un kapatılıp kapatılmayacağı | ||
closeOnOverlayClick |
boolean |
false |
| Kaplama katmanına (overlay) tıklandığında prompt'un kapatılıp kapatılmayacağı | ||
confirmText |
string |
TAMAM |
| Onay butonunun metni | ||
cancelText |
string |
İptal |
| İptal butonunun metni | ||
stackedActions |
boolean |
false |
| Alt işlem butonlarının dikey olarak sıralanıp sıralanmayacağı | ||
queue |
string |
- |
|
Kuyruk adı. Varsayılan olarak kuyruk etkin değildir, fonksiyon birden çok kez çağrıldığında birden fazla prompt aynı anda gösterilir. Bu parametreye bir kuyruk adı girilebilir. Aynı kuyruk adına sahip prompt fonksiyonları, bir önceki prompt kapatıldıktan sonra bir sonraki prompt'u açar.
|
||
onConfirm |
(value: string, dialog: Dialog) => void | boolean | Promise<void> |
- |
|
Onay butonuna tıklandığındaki geri çağırma fonksiyonu. Fonksiyon parametreleri, metin kutusunun değeri ve dialog örneğidir, Varsayılan olarak onay butonuna tıklandığında prompt kapanır; eğer dönüş değeri |
||
onCancel |
(value: string, dialog: Dialog) => void | boolean | Promise<void> |
- |
|
İptal butonuna tıklandığındaki geri çağırma fonksiyonu. Fonksiyon parametreleri, metin kutusunun değeri ve dialog örneğidir, Varsayılan olarak iptal butonuna tıklandığında prompt kapanır; eğer dönüş değeri |
||
onOpen |
(dialog: Dialog) => void |
- |
|
prompt açılmaya başladığındaki geri çağırma fonksiyonu. Fonksiyon parametresi dialog örneğidir, |
||
onOpened |
(dialog: Dialog) => void |
- |
|
prompt açılma animasyonu tamamlandığındaki geri çağırma fonksiyonu. Fonksiyon parametresi dialog örneğidir, |
||
onClose |
(dialog: Dialog) => void |
- |
|
prompt kapanmaya başladığındaki geri çağırma fonksiyonu. Fonksiyon parametresi dialog örneğidir, |
||
onClosed |
(dialog: Dialog) => void |
- |
|
prompt kapanma animasyonu tamamlandığındaki geri çağırma fonksiyonu. Fonksiyon parametresi dialog örneğidir, |
||
onOverlayClick |
(dialog: Dialog) => void |
- |
|
Kaplama katmanına (overlay) tıklandığındaki geri çağırma fonksiyonu. Fonksiyon parametresi dialog örneğidir, |
||
validator |
(value: string) => boolean | string | Promise<void> |
- |
|
Metin kutusunun doğrulama fonksiyonu, parametresi metin kutusunun değeridir. Tarayıcının yerel doğrulama API'si doğrulamasını geçtikten sonra, bu fonksiyon kullanılarak doğrulama yapılır.
Ayrıca bir dize de döndürebilir, dizenin boş olmaması doğrulamanın başarısız olduğunu belirtir ve döndürülen dize hata mesajı olarak kullanılır. Promise de döndürebilir, promise'in çözülmesi (resolve) doğrulamanın başarılı olduğunu, reddedilmesi (reject) ise doğrulamanın başarısız olduğunu ve reddedilme nedeni hata mesajı olarak kullanılır. |
||
textFieldOptions |
Partial<TextField> |
- |
prompt'un içindeki metin kutusu, <mdui-text-field> bileşenidir. Bu parametrede <mdui-text-field> bileşeninin parametreleri ayarlanabilir. |
||