LicrusUIHelper

LicrusUIHelper

Lircus IQ uygulamlarında geliştirilen View’lar temel arayüz işlemlerini yapmak için kullanılan yardımcı sınıftır.
Geliştirdiğiniz View, BaseView sınıflarından birinden türemişse:

Bir view içerisinden LicrusUIHelper instance’ına erişmek için kullanılacak temsilci;
this.ui

UI tarafında herhangi bir kod bloğunda LicrusUIHelper instance’ına erişmek için kullanılacak temsilci;
app.ui

Aşağıdaki fonksiyon örnekleri, view içerisinde erişim örneği üzerinden anlatılacaktır.

[[TOC]]

Loader

Yükleniyor simgesini gizlemek ve göstermek için aşağıdaki fonksiyon kullanılır.

public loader(visible): void

Örnek

this.ui.loader(true);  //gösterir
this.ui.loader(false); //gizler

image.png

Messages

View’larda veya uygulamada her hangi bir kod bloğunda kullanıcıya uyarı ve mesaj göstermek için kullanılır. Mevcut sürümdeki tasarımda uyarılar ekranında sağ üst köşesinde gösterilir.

Mesaj Metodu

public showMessage(args: MessageArgs): void

Mesaj gösterimi için kullanılacak arguman sınıfı ve verilebilecek değerler.

class MessageArgs {
    type: MessageType;
    title: string;
    text: string;
}
Parametre Açıklama
type Mesaj tipi. *Değerler için MessageType enum tanımına bakınız.
title Mesaj başlığı
text Mesaj metni

Kullanılabilecek mesaj tipleri;

enum MessageType {
    error = 0,
    warning = 1,
    info = 2,
    success = 4,
}

Örnek

this.ui.showMessage(
    {
        type:MessageType.info,
        title: "Licrus IQ",
        text: "Sample message",
    }
);

image.png

showMessage metodu dışında sınıflandırılmış mesajlar için aşağıdaki metodlar da kullanılabilir.

Hata Mesajı

Uygulamada bir hata mesajı göstermek için kullanılacak fonksiyondur.

public showError(msg: string): void

Örnek kullanım ve ekran görüntüsü aşağıdaki gibi olacaktır.

this.ui.showError("error message.");

image.png

Uyarı Mesajı

Uygulamada bir uyarı mesajı göstermek için kullanılacak fonksiyondur.

public showWarning(msg: string): void

Örnek kullanım ve ekran görüntüsü aşağıdaki gibi olacaktır.

this.ui.showWarning("warning message.");

image.png

Bilgi Mesajı

Uygulamada bir bilgi mesajı göstermek için kullanılacak fonksiyondur.

public showInfo(msg: string): void
this.ui.showInfo("information message.");

Örnek kullanım ve ekran görüntüsü aşağıdaki gibi olacaktır.

image.png

İşlem Başarlı Mesajı

Uygulamada bir işlemin sonucu başarılı olduğunda mesaj göstermek için kullanılacak fonksiyondur.

public showSuccess(msg: string): void

Örnek kullanım ve ekran görüntüsü aşağıdaki gibi olacaktır.

this.ui.showSuccess("success message.");

image.png

Modal Mesaj

public messageModal(args: IConfirmArs)

Web Api Mesajları

Web Api katmanından gelen response nesnesi içerisinde yer alan mesajları göstermek için kullanılır. Response nesnesinde yer alan hata veya bilgi mesajları yorumlanıp uygun formatta gösterilir.

public showResponseMessages(response: ApiResponse): void

Confirm

public confirm(args: any): void
public confirmModal(args: IConfirmArs)

Side Panel

Bir view’da yardımcı bir View’ı veya Component’ı ekranın sağında göstermek için kullanılacak yardımcı metodlardır.

Bir View’ı Side Panel’de göstermek için kullanılır. Parametre detayları için LoadViewArgs başlığına bakınız

public showViewOnSidePanel(lva: LoadViewArgs): void

Slide Panel kapatmak için kullanılır.

public closeSidePanel(): void

Misc

Çeşitli ve yardımcı metodlar

Default Button

public setDefaultButton(containerSelector, buttonSelector): void

Dark Mode

public darkMode(enable: boolean)

Help and Tips

public screenHelp(show: boolean)