mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
658cdc180f
* iScroll: zoom takes scale as first parameter iScroll's zoom() method takes scale as the first parameter. The rest parameters are optional according to the documentation: https://github.com/cubiq/iscroll#zoomscale-x-y-time * iScroll: Update tests Update tests for iScroll to reflect the changes * iScroll: iScroll instance has 'scale' public numeric property
103 lines
2.6 KiB
TypeScript
103 lines
2.6 KiB
TypeScript
// Type definitions for iScroll 5.2
|
|
// Project: http://cubiq.org/iscroll-5-ready-for-beta-test
|
|
// Definitions by: Christiaan Rakowski <https://github.com/csrakowski>, Denis Tokarev <https://github.com/devlato>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
interface IScrollOptions {
|
|
x?: number;
|
|
y?: number;
|
|
bounce?: boolean;
|
|
bounceLock?: boolean;
|
|
momentum?: boolean;
|
|
lockDirection?: boolean;
|
|
useTransform?: boolean;
|
|
useTransition?: boolean;
|
|
topOffset?: number;
|
|
checkDOMChanges?: boolean;
|
|
handleClick?: boolean;
|
|
|
|
// Scrollbar
|
|
hScrollbar?: boolean;
|
|
vScrollbar?: boolean;
|
|
fixedScrollbar?: boolean;
|
|
hideScrollbar?: boolean;
|
|
fadeScrollbar?: boolean;
|
|
scrollbarClass?: string;
|
|
|
|
// Zoom
|
|
zoom?: boolean;
|
|
zoomMin?: number;
|
|
zoomMax?: number;
|
|
doubleTapZoom?: number;
|
|
mouseWheel?: boolean;
|
|
wheelAction?: string;
|
|
snap?: string | boolean;
|
|
snapThreshold?: number;
|
|
|
|
// 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?: string|{ style: string, fn: (k: any) => any };
|
|
|
|
preventDefault?: boolean;
|
|
preventDefaultException?: Array<RegExp>|Object;
|
|
|
|
HWCompositing?: boolean;
|
|
|
|
freeScroll?: boolean;
|
|
|
|
resizePolling?: number;
|
|
tap?: boolean;
|
|
click?: boolean;
|
|
invertWheelDirection?: boolean;
|
|
eventPassthrough?: string | boolean;
|
|
|
|
// iScroll probe edition
|
|
probeType?: number;
|
|
|
|
// Pointer events
|
|
disableMouse?: boolean;
|
|
disablePointer?: boolean;
|
|
disableTouch?: boolean;
|
|
}
|
|
|
|
declare class IScroll {
|
|
constructor (element: string, options?: IScrollOptions);
|
|
constructor (element: HTMLElement, options?: IScrollOptions);
|
|
|
|
x: number;
|
|
y: number;
|
|
scale: 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;
|
|
stop(): void;
|
|
zoom(scale: number, x?: number, y?: number, time?: number): void;
|
|
isReady(): boolean;
|
|
|
|
// Events
|
|
on(type: string, fn: (evt?: any) => void): void;
|
|
off(type: string, fn?: (evt?: any) => void): void;
|
|
}
|