@types/swipeview
Version:
TypeScript definitions for swipeview
56 lines (44 loc) • 1.44 kB
Markdown
# Installation
> `npm install --save @types/swipeview`
# Summary
This package contains type definitions for swipeview (http://cubiq.org/swipeview).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swipeview.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swipeview/index.d.ts)
````ts
interface SwipeViewEvent {
(fn: Function): void;
}
interface SwipeViewOptions {
text?: string | undefined;
numberOfPages?: number | undefined;
snapThreshold?: number | undefined;
hastyPageFlip?: boolean | undefined;
loop?: boolean | undefined;
}
declare class SwipeView {
masterPages: HTMLElement[];
currentMasterPage: number;
wrapper: HTMLElement;
slider: HTMLElement;
constructor(element: string);
constructor(element: string, options: SwipeViewOptions);
destroy(): void;
refreshSize(): void;
updatePageCount(n: number): void;
goToPage(p: number): void;
next(): void;
prev(): void;
handleEvent(e: Event): void;
onFlip: SwipeViewEvent;
onMoveOut: SwipeViewEvent;
onMoveIn: SwipeViewEvent;
onTouchStart: SwipeViewEvent;
wrapperHeight: number;
}
````
### Additional Details
* Last updated: Tue, 30 Jan 2024 21:35:45 GMT
* Dependencies: none
# Credits
These definitions were written by [Boris Yankov](https://github.com/borisyankov).