Metotlar ve özellikler
Constructor
ts
new InsigneSlider(target: HTMLElement | string, options?: Options): InsigneSlider| Parametre | Tip | Açıklama |
|---|---|---|
target | HTMLElement | string | Çocukları slayt olacak eleman (veya seçici). Shadow root alabilmeli. |
options | Options | Herhangi bir ayar. İşaretleme ayarlarının (data-*, JSON) üzerine birleştirilir. |
Elemanın zaten bir slider'ı varsa mevcut örnek döner ve ayarlar ona uygulanır. Eleman bulunamazsa veya slider alamıyorsa hata fırlatır.
Statik üyeler
| Üye | İmza | Açıklama |
|---|---|---|
InsigneSlider.get | (target: Element | string | null) => InsigneSlider | undefined | Bir elemanın örneği. |
InsigneSlider.create | (target, spec: SliderSpec) => InsigneSlider | Slaytları veriden çizer ve slider'ı başlatır. Bkz. JSON. |
InsigneSlider.init | (root?: ParentNode) => InsigneSlider[] | root altındaki (varsayılan document) her [data-insigne]'ı başlatır. |
InsigneSlider.autoInit | () => void | DOM hazır olunca ve sonradan eklenen elemanlar için init(). |
InsigneSlider.define | (sliderTag?, slideTag?) => void | <insigne-slider> / <insigne-slide> kaydı (tekrar çağrılabilir). |
InsigneSlider.effects | readonly string[] | Tüm efekt adları. |
InsigneSlider.options | readonly OptMeta[] | Ayar meta verisi (ad, tip, varsayılan, değerler, aralık). |
InsigneSlider.defaults | Record<string, unknown> | Varsayılan değerler. |
InsigneSlider.version | string | Kütüphane sürümü. |
Örnek metotları
Aksi belirtilmedikçe tüm metotlar örneği döndürür; zincirlenebilir.
| Metot | İmza | Açıklama |
|---|---|---|
next | () => this | Sonraki slayt (loop'a uyar). |
prev | () => this | Önceki slayt. |
goTo | (index: number, opts?: { instant?: boolean }) => this | Bir slayta git (0'dan başlar). Loop'ta en kısa yolu seçer. |
play | () => this | Otomatik oynatmayı başlat (kapalıysa açar). |
pause | () => this | play()'e kadar otomatik oynatmayı durdur. |
update | (options: Options) => this | Ayarları çalışırken değiştir. Mevcut slayt korunur. |
refresh | () => this | Slaytları DOM'dan yeniden oku. Çocuklar değişince otomatik. |
addSlide | (content: Node | string, index?: number) => this | Slayt ekle (eleman veya HTML metni). Varsayılan: sona. |
removeSlide | (index: number) => this | Slaytı kaldır. |
on | (event, handler) => () => void | Abone ol; aboneliği bırakan bir fonksiyon döner. Bkz. olaylar. |
once | (event, handler) => () => void | Tek seferlik abonelik. |
off | (event, handler) => void | Aboneliği bırak. |
destroy | () => void | Her şeyi durdur, işaretlemenizi ve satır içi stilleri geri yükle, WebGL'i serbest bırak. |
Özellikler (salt okunur)
| Özellik | Tip | Açıklama |
|---|---|---|
el | HTMLElement | Slider elemanı. |
index | number | Mevcut slayt (0'dan başlar, her zaman gerçek indeks). |
count | number | Slayt sayısı. |
slides | HTMLElement[] | Slayt elemanları (listenin kopyası). |
options | Readonly<Record<string, any>> | Çözümlenmiş ayarlar (varsayılanlar + işaretleme + constructor + güncellemeler). |
isPlaying | boolean | Otomatik oynatma açık ve kullanıcı durdurmamış (hover veya görünürlük yüzünden yine de duraklamış olabilir). |
isMoving | boolean | Bir geçiş sürüyor. |
Eleman API'si
<insigne-slider> sık kullanılan üyeleri iletir; örneğe nadiren ihtiyaç duyarsınız:
| Üye | Açıklama |
|---|---|
el.slider | InsigneSlider örneği (eleman hazır olduktan sonra). |
el.options | Çözümlenmiş ayarları okur; nesne atarsanız günceller. |
el.next(), el.prev(), el.goTo(i), el.play(), el.pause() | Yukarıdaki gibi. |
el.index, el.count | Yukarıdaki gibi. |
el.on(event, fn) | Yukarıdaki gibi (hazır olduktan sonra). Ya da insigne:<olay> DOM olaylarını dinleyin. |