UNPKG

3.29 kBTypeScriptView Raw
1import { Quadrant } from '@better-scroll/shared-utils';
2export declare type Tap = 'tap' | '';
3export declare type BounceOptions = Partial<BounceConfig> | boolean;
4export declare type DblclickOptions = Partial<DblclickConfig> | boolean;
5export interface BounceConfig {
6 top: boolean;
7 bottom: boolean;
8 left: boolean;
9 right: boolean;
10}
11export interface DblclickConfig {
12 delay: number;
13}
14export interface CustomOptions {
15}
16export interface DefOptions {
17 [key: string]: any;
18 startX?: number;
19 startY?: number;
20 scrollX?: boolean;
21 scrollY?: boolean;
22 freeScroll?: boolean;
23 directionLockThreshold?: number;
24 eventPassthrough?: string;
25 click?: boolean;
26 tap?: Tap;
27 bounce?: BounceOptions;
28 bounceTime?: number;
29 momentum?: boolean;
30 momentumLimitTime?: number;
31 momentumLimitDistance?: number;
32 swipeTime?: number;
33 swipeBounceTime?: number;
34 deceleration?: number;
35 flickLimitTime?: number;
36 flickLimitDistance?: number;
37 resizePolling?: number;
38 probeType?: number;
39 stopPropagation?: boolean;
40 preventDefault?: boolean;
41 preventDefaultException?: {
42 tagName?: RegExp;
43 className?: RegExp;
44 };
45 tagException?: {
46 tagName?: RegExp;
47 className?: RegExp;
48 };
49 HWCompositing?: boolean;
50 useTransition?: boolean;
51 bindToWrapper?: boolean;
52 bindToTarget?: boolean;
53 disableMouse?: boolean;
54 disableTouch?: boolean;
55 autoBlur?: boolean;
56 translateZ?: string;
57 dblclick?: DblclickOptions;
58 autoEndDistance?: number;
59 outOfBoundaryDampingFactor?: number;
60 specifiedIndexAsContent?: number;
61 quadrant?: Quadrant;
62}
63export interface Options extends DefOptions, CustomOptions {
64}
65export declare class CustomOptions {
66}
67export declare class OptionsConstructor extends CustomOptions implements DefOptions {
68 [key: string]: any;
69 startX: number;
70 startY: number;
71 scrollX: boolean;
72 scrollY: boolean;
73 freeScroll: boolean;
74 directionLockThreshold: number;
75 eventPassthrough: string;
76 click: boolean;
77 tap: Tap;
78 bounce: BounceConfig;
79 bounceTime: number;
80 momentum: boolean;
81 momentumLimitTime: number;
82 momentumLimitDistance: number;
83 swipeTime: number;
84 swipeBounceTime: number;
85 deceleration: number;
86 flickLimitTime: number;
87 flickLimitDistance: number;
88 resizePolling: number;
89 probeType: number;
90 stopPropagation: boolean;
91 preventDefault: boolean;
92 preventDefaultException: {
93 tagName?: RegExp;
94 className?: RegExp;
95 };
96 tagException: {
97 tagName?: RegExp;
98 className?: RegExp;
99 };
100 HWCompositing: boolean;
101 useTransition: boolean;
102 bindToWrapper: boolean;
103 bindToTarget: boolean;
104 disableMouse: boolean;
105 disableTouch: boolean;
106 autoBlur: boolean;
107 translateZ: string;
108 dblclick: DblclickOptions;
109 autoEndDistance: number;
110 outOfBoundaryDampingFactor: number;
111 specifiedIndexAsContent: number;
112 quadrant: Quadrant;
113 constructor();
114 merge(options?: Options): this;
115 process(): this;
116 resolveBounce(bounceOptions: BounceOptions): BounceConfig;
117}