archive-gh-me/viewerjs
1
0
Fork 0
mirror of https://github.com/fengyuanchen/viewerjs.git synced 2026-02-01 16:32:50 +00:00
Code Issues Projects Releases Wiki Activity

feat: add type definitions file

Browse Source
This commit is contained in:
Chen Fengyuan 2018-02-05 21:47:41 +08:00
parent 1c7ac8ce6e
commit 2639f8a160
2 changed files with 103 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
package.json
View File

@ -6,6 +6,7 @@
"module": "dist/viewer.esm.js",
"browser": "dist/viewer.js",
"style": "dist/viewer.css",
"types": "types/index.d.ts",
"repository": "fengyuanchen/viewerjs",
"homepage": "https://fengyuanchen.github.io/viewerjs",
"license": "MIT",

102
types/index.d.ts vendored Normal file
View File

@ -0,0 +1,102 @@
declare namespace Viewer {
export enum Visibility {
Hidden = 0,
Visible = 1,
VisibleOnMediumOrWiderScreen = 2,
VisibleOnLargeOrWiderScreen = 3,
VisibleOnExtraLargeOrWiderScreen = 4,
}
export enum ToolbarButtonSize {
Small = 'small',
Medium = 'medium',
Large = 'large',
}
export interface ToolbarButtonOptions {
click?: Function,
show?: boolean | Visibility;
size?: ToolbarButtonSize,
}
export interface ToolbarOptions {
flipHorizontal?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
flipVertical?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
next?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
oneToOne?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
play?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
prev?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
reset?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
rotateLeft?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
rotateRight?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
zoomIn?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
zoomOut?: boolean | Visibility | ToolbarButtonSize | Function | ToolbarButtonOptions;
}
export interface Options {
backdrop?: boolean | string;
button?: boolean;
container?: string | Element;
filter?: Function;
fullscreen?: boolean;
hidden?(event: CustomEvent): void;
hide?(event: CustomEvent): void;
inline?: boolean;
interval?: number;
keyboard?: boolean;
loop?: boolean;
maxZoomRatio?: number;
minHeight?: number;
minWidth?: number;
minZoomRatio?: number;
movable?: boolean;
navbar?: boolean | Visibility;
ready?(event: CustomEvent): void;
rotatable?: boolean;
scalable?: boolean;
show?(event: CustomEvent): void;
shown?(event: CustomEvent): void;
title?: boolean | Visibility;
toolbar?: boolean | Visibility | ToolbarOptions;
tooltip?: boolean;
transition?: boolean;
url?: string | Function;
view?(event: CustomEvent): void;
viewed?(event: CustomEvent): void;
zIndex?: number;
zIndexInline?: number;
zoomRatio?: number;
zoomable?: boolean;
}
}
declare class Viewer {
constructor(element: Element, options?: Viewer.Options);
destroy(): Viewer;
exit(): Viewer;
full(): Viewer;
hide(): Viewer;
move(offsetX: number, offsetY?: number): Viewer;
moveTo(x: number, y?: number): Viewer;
next(loop?: boolean): Viewer;
play(): Viewer;
prev(loop?: boolean): Viewer;
reset(): Viewer;
rotate(degree: number): Viewer;
rotateTo(degree: number): Viewer;
scale(scaleX: number, scaleY?: number): Viewer;
scaleX(scaleX: number): Viewer;
scaleY(scaleY: number): Viewer;
show(): Viewer;
stop(): Viewer;
toggle(): Viewer;
tooltip(): Viewer;
update(): Viewer;
view(index?: number): Viewer;
zoom(ratio: number, hasTooltip?: boolean): Viewer;
zoomTo(ratio: number, hasTooltip?: boolean): Viewer;
}
declare module 'viewerjs' {
export default Viewer;
}