@types/scrollbooster - npm Package Compare versions

Comparing version 2.2.2 to 3.0.0

scrollbooster/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for scrollbooster 2.2
+// Type definitions for scrollbooster 3.0
 // Project: https://github.com/ilyashubin/scrollbooster
@@ -15,7 +15,6 @@ // Definitions by: Chris <https://github.com/chrisneven>
     isDragging: boolean;
+    isScrolling: boolean;
     position: Required<Position>;
-    dragOffset: {
-        x: number;
-        y: number;
-    };
+    dragOffset: Required<Position>;
+    dragAngle: number;
     borderCollision: {
@@ -30,16 +29,23 @@ left: boolean;
 export interface ScrollBoosterOptions {
-    content?: HTMLElement | null | undefined;
-    viewport: HTMLElement | null;
+    viewport: Element;
+    content: Element;
+    direction?: 'all' | 'vertical' | 'horizontal';
+    pointerMode?: 'all' | 'touch' | 'mouse';
     scrollMode?: 'transform' | 'native' | undefined;
-    direction?: 'horizontal' | 'vertical' | 'all' | undefined;
-    bounce?: boolean | undefined;
-    textSelection?: boolean | undefined;
-    inputsFocus?: boolean | undefined;
-    pointerMode?: 'touch' | 'mouse' | 'all' | undefined;
-    friction?: number | undefined;
-    bounceForce?: number | undefined;
-    emulateScroll?: boolean | undefined;
-    onUpdate?: ((state: ScrollingState) => void) | undefined;
-    onClick?: ((state: ScrollingState, event: Event) => void) | undefined;
-    shouldScroll?: ((state: ScrollingState, event: Event) => boolean) | undefined;
+    bounce?: boolean;
+    bounceForce?: number;
+    friction?: number;
+    textSelection?: boolean;
+    inputsFocus?: boolean;
+    emulateScroll?: boolean;
+    preventDefaultOnEmulateScroll?: 'vertical' | 'horizontal';
+    lockScrollOnDragDirection?: 'all' |'vertical' | 'horizontal';
+    dragDirectionTolerance?: number;
+    onClick?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
+    onUpdate?: (state: ScrollingState) => void;
+    onWheel?: (state: ScrollingState, event: Event) => void;
+    shouldScroll?: (state: ScrollingState, event: Event) => boolean;
+    onPointerDown?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
+    onPointerUp?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
+    onPointerMove?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
 }
@@ -49,14 +55,8 @@
     constructor(options: ScrollBoosterOptions);
-
+    destroy(): void;
     setPosition(position: Position): void;
-
+    getState(): ScrollingState;
     scrollTo(position: Position): void;
-
     updateMetrics(): void;
-
     updateOptions(options: Partial<ScrollBoosterOptions>): void;
-
-    getState(): ScrollingState;
-
-    destroy(): void;
 }

scrollbooster/package.json

 {
     "name": "@types/scrollbooster",
-    "version": "2.2.2",
+    "version": "3.0.0",
     "description": "TypeScript definitions for scrollbooster",
@@ -28,4 +28,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/scrollbooster",
     "dependencies": {},
-    "typesPublisherContentHash": "8dcd4ce9680daac9d4ac098f5f2579ce3637f386c425f92e2d32604fbf553ec2",
-    "typeScriptVersion": "4.1"
+    "typesPublisherContentHash": "158b2cbc557db56014369d815a2d0b521e29bd43f2bcd2fc92a9f63118ba027e",
+    "typeScriptVersion": "4.3"
 }

scrollbooster/README.md

@@ -11,3 +11,3 @@ # Installation
 ````ts
-// Type definitions for scrollbooster 2.2
+// Type definitions for scrollbooster 3.0
 // Project: https://github.com/ilyashubin/scrollbooster
@@ -26,7 +26,6 @@ // Definitions by: Chris <https://github.com/chrisneven>
     isDragging: boolean;
+    isScrolling: boolean;
     position: Required<Position>;
-    dragOffset: {
-        x: number;
-        y: number;
-    };
+    dragOffset: Required<Position>;
+    dragAngle: number;
     borderCollision: {
@@ -41,16 +40,23 @@ left: boolean;
 export interface ScrollBoosterOptions {
-    content?: HTMLElement | null | undefined;
-    viewport: HTMLElement | null;
+    viewport: Element;
+    content: Element;
+    direction?: 'all' | 'vertical' | 'horizontal';
+    pointerMode?: 'all' | 'touch' | 'mouse';
     scrollMode?: 'transform' | 'native' | undefined;
-    direction?: 'horizontal' | 'vertical' | 'all' | undefined;
-    bounce?: boolean | undefined;
-    textSelection?: boolean | undefined;
-    inputsFocus?: boolean | undefined;
-    pointerMode?: 'touch' | 'mouse' | 'all' | undefined;
-    friction?: number | undefined;
-    bounceForce?: number | undefined;
-    emulateScroll?: boolean | undefined;
-    onUpdate?: ((state: ScrollingState) => void) | undefined;
-    onClick?: ((state: ScrollingState, event: Event) => void) | undefined;
-    shouldScroll?: ((state: ScrollingState, event: Event) => boolean) | undefined;
+    bounce?: boolean;
+    bounceForce?: number;
+    friction?: number;
+    textSelection?: boolean;
+    inputsFocus?: boolean;
+    emulateScroll?: boolean;
+    preventDefaultOnEmulateScroll?: 'vertical' | 'horizontal';
+    lockScrollOnDragDirection?: 'all' |'vertical' | 'horizontal';
+    dragDirectionTolerance?: number;
+    onClick?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
+    onUpdate?: (state: ScrollingState) => void;
+    onWheel?: (state: ScrollingState, event: Event) => void;
+    shouldScroll?: (state: ScrollingState, event: Event) => boolean;
+    onPointerDown?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
+    onPointerUp?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
+    onPointerMove?: (state: ScrollingState, event: MouseEvent, isTouch: boolean) => void;
 }
@@ -60,14 +66,8 @@
     constructor(options: ScrollBoosterOptions);
-
+    destroy(): void;
     setPosition(position: Position): void;
-
+    getState(): ScrollingState;
     scrollTo(position: Position): void;
-
     updateMetrics(): void;
-
     updateOptions(options: Partial<ScrollBoosterOptions>): void;
-
-    getState(): ScrollingState;
-
-    destroy(): void;
 }
@@ -78,3 +78,3 @@
 ### Additional Details
- * Last updated: Tue, 04 Oct 2022 19:33:01 GMT
+ * Last updated: Tue, 25 Jul 2023 07:02:46 GMT
  * Dependencies: none
@@ -81,0 +81,0 @@ * Global values: none

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7037

increased by11.43%

Lines of code

55

increased by12.24%

No dependency changes