Added more options and functions + better types

This commit is contained in:
Bert Verhelst
2016-03-25 11:29:05 +01:00
parent a44529fcb1
commit dd095f9111
+16 -14
View File
@@ -4,8 +4,6 @@
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
interface IScrollOptions {
//hScroll?: boolean;
//vScroll?: boolean;
x?: number;
y?: number;
bounce?: boolean;
@@ -31,28 +29,30 @@ interface IScrollOptions {
zoomMin?: number;
zoomMax?: number;
doubleTapZoom?: number;
mouseWheel?: boolean;
wheelAction?: string;
///String or boolean
snap?: any;
snap?: string | boolean;
snapThreshold?: number;
//new in IScroll 5?
// New in IScroll 5?
resizeIndicator?: boolean;
mouseWheelSpeed?: number;
startX?: number;
startY?: number;
scrollX?: boolean;
scrollY?: boolean;
scrollbars?: boolean | string;
shrinkScrollbars?: string;
interactiveScrollbars?: boolean;
releaseScroll?: boolean;
fadeScrollbars?: boolean;
directionLockThreshold?: number;
bounceTime?: number;
///String or function
bounceEasing?: any;
preventDefault?: boolean;
preventDefaultException?: boolean;
@@ -64,21 +64,22 @@ interface IScrollOptions {
tap?: boolean;
click?: boolean;
invertWheelDirection?: boolean;
///Boolean or string
eventPassthrough?: any;
eventPassthrough?: string | boolean;
}
declare class IScroll {
constructor (element: string, options?: IScrollOptions);
constructor (element: HTMLElement, options?: IScrollOptions);
x: number;
y: number;
destroy(): void;
refresh(): void;
scrollTo(x: number, y: number, time?: number, relative?: boolean): void;
scrollToElement(element: string, time?: number): void;
scrollToElement(element: HTMLElement, time?: number): void;
scrollToElement(element: HTMLElement, time?: number, offsetX?: number | boolean, offsetY?: number | boolean, easing?: Function): void;
goToPage(pageX: number, pageY: number, time?: number): void;
disable(): void;
enable(): void;
@@ -87,5 +88,6 @@ declare class IScroll {
isReady(): boolean;
// Events
on: (type: string, fn: () => void) => void;
on(type: string, fn: (evt?: any) => void): void;
off(type: string, fn?: (evt?: any) => void): void;
}