mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
imagesLoaded (npm, bower: imagesloaded) definitions
This commit is contained in:
Vendored
+53
@@ -0,0 +1,53 @@
|
||||
// Type definitions for imagesLoaded 3.1.8+
|
||||
// Project: https://github.com/desandro/imagesloaded
|
||||
// Definitions by: Chris Charabaruk <http://github.com/coldacid>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
///<reference path="../jquery/jquery.d.ts" />
|
||||
|
||||
declare module ImagesLoaded {
|
||||
type ElementSelector = Element | NodeList | Array<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: Array<LoadingImage>;
|
||||
|
||||
// event listeners
|
||||
on(event: string, listener: ImagesLoadedListener): void;
|
||||
off(event: string, listener: ImagesLoadedListener): void;
|
||||
}
|
||||
|
||||
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 callback function triggered after all images have been loaded
|
||||
*/
|
||||
(elem: ElementSelector, callback?: ImagesLoadedCallback): ImagesLoaded;
|
||||
}
|
||||
}
|
||||
|
||||
declare var imagesLoaded: ImagesLoaded.ImagesLoadedConstructor;
|
||||
|
||||
declare module 'imagesloaded' {
|
||||
export = imagesLoaded;
|
||||
}
|
||||
|
||||
interface JQuery {
|
||||
imagesLoaded(callback?: ImagesLoaded.ImagesLoadedCallback): JQueryDeferred<ImagesLoaded.ImagesLoaded>;
|
||||
}
|
||||
Reference in New Issue
Block a user