-
Notifications
You must be signed in to change notification settings - Fork 0
/
imagesloaded.d.ts
66 lines (54 loc) · 1.79 KB
/
imagesloaded.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/// <reference types="jquery" />
declare namespace ImagesLoaded {
type ElementSelector = Element | NodeList | Element[] | string
/** interface for an image currently loading or completed */
interface LoadingImage {
img: HTMLImageElement
isLoaded: boolean
}
interface ImagesLoadedCallback {
(instance?: ImagesLoaded): void
}
interface ImagesLoadedListener {
(instance: ImagesLoaded, image?: LoadingImage): void
}
interface ImagesLoaded {
new (elem: ElementSelector, callback: ImagesLoadedCallback): ImagesLoaded
images: LoadingImage[]
// event listeners
on(event: string, listener: ImagesLoadedListener): void
off(event: string, listener: ImagesLoadedListener): void
once(event: string, listener: ImagesLoadedListener): void
progressedCount: number | undefined
}
interface ImagesLoadedOptions {
background: true | string
}
interface ImagesLoadedConstructor {
/**
* Creates a new ImagesLoaded object with the provided callback
* @param elem Element, NodeList, Element array, or selector string for images to watch
* @param options object that can tell imagesloaded to watch background images as well
* @param callback function triggered after all images have been loaded
*/
(
elem: ElementSelector,
options: ImagesLoadedOptions,
callback?: ImagesLoadedCallback
): ImagesLoaded
(elem: ElementSelector, callback?: ImagesLoadedCallback): ImagesLoaded
}
}
declare var imagesLoaded: ImagesLoaded.ImagesLoadedConstructor
declare module 'imagesloaded' {
export = imagesLoaded
}
interface JQuery {
imagesLoaded(
callback?: ImagesLoaded.ImagesLoadedCallback
): JQueryDeferred<ImagesLoaded.ImagesLoaded>
imagesLoaded(
options: ImagesLoaded.ImagesLoadedOptions,
callback?: ImagesLoaded.ImagesLoadedCallback
): JQueryDeferred<ImagesLoaded.ImagesLoaded>
}