@signosoft/signpad-js 0.4.5 → 0.4.6

package/README.md

@@ -18,13 +18,12 @@
 `signosoft-signpad` is a powerful and flexible web component built with LitElement, designed for seamless digital signature capture integration into modern web applications. It provides a **unified interface** for working with various signature devices like **Wacom or Ugee**, supporting both stylus and mouse-based signing.
 
 This component **works effortlessly** with any modern stack:
+| **JavaScript** | **React** | **Angular** | **Vue** |
+|:-:|:-:|:-:|:-:|
+| <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/javascript/javascript-original.svg" alt="JS" width="35" height="35"> | <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/react/react-original.svg" alt="React" width="35" height="35"> | <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/angularjs/angularjs-original.svg" alt="Angular" width="35" height="35"> | <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/vuejs/vuejs-original.svg" alt="Vue" width="35" height="35"> ||
+
+
 
-<p align="center">
-  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/javascript/javascript-original.svg" alt="JS" width="35" height="35">
-  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/react/react-original.svg" alt="React" width="35" height="35">
-  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/angularjs/angularjs-original.svg" alt="Angular" width="35" height="35">
-  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/vuejs/vuejs-original.svg" alt="Vue" width="35" height="35">
-</p>
 
 It expertly handles the complexities of **WebHID device connections**, signature session lifecycles, and high-fidelity stroke rendering.
 <br/>

package/dist/index.d.ts

@@ -482,11 +482,12 @@ declare class LocalizationManager {
 }
 
 /**
- * `MouseManager` handles mouse interactions on a canvas element and converts them
+ * `PointerManager` handles pointer interactions on a canvas element and converts them
  * into standardized `IPenData`. This serves as a fallback mechanism for
  * signature capture when a physical signature tablet is not available.
+ * Uses the Pointer Events API to support mouse, touch, and Apple Pencil uniformly.
  */
-declare class MouseManager {
+declare class PointerManager {
     /** @private */
     private canvas;
     /** @private */
@@ -501,13 +502,14 @@ declare class MouseManager {
     private debugListenerRegistrationCount;
     /** @private */
     private listenersAttached;
-    private boundHandleMouseDown;
-    private boundHandleMouseMove;
-    private boundHandleMouseUp;
-    private boundHandleMouseLeave;
-    /**
-     * Creates an instance of MouseManager.
-     * @param canvas - The HTMLCanvasElement to attach mouse listeners to.
+    private boundHandlePointerDown;
+    private boundHandlePointerMove;
+    private boundHandlePointerUp;
+    private boundHandlePointerLeave;
+    private boundHandlePointerCancel;
+    /**
+     * Creates an instance of PointerManager.
+     * @param canvas - The HTMLCanvasElement to attach pointer listeners to.
      * @param onPenDataCallback - The callback function that receives generated IPenData.
      */
     constructor(canvas: HTMLCanvasElement, onPenDataCallback: IPenDataCallback);
@@ -516,15 +518,15 @@ declare class MouseManager {
      */
     get isCurrentlyDrawing(): boolean;
     /**
-     * Attaches mouse event listeners to the canvas to enable signature capture.
+     * Attaches pointer event listeners to the canvas to enable signature capture.
      */
     addListeners(): void;
     /**
-     * Removes mouse event listeners from the canvas and stops active drawing.
+     * Removes pointer event listeners from the canvas and stops active drawing.
      */
     removeListeners(): void;
     /**
-     * Returns true if mouse listeners are currently attached.
+     * Returns true if pointer listeners are currently attached.
      */
     areListenersAttached(): boolean;
     /**
@@ -532,34 +534,47 @@ declare class MouseManager {
      */
     resetSession(): void;
     /**
-     * Handles the 'mousedown' event: starts a stroke and initializes the session time.
+     * Handles the 'pointerdown' event: starts a stroke and initializes the session time.
+     * @private
+     */
+    private handlePointerDown;
+    /**
+     * Handles the 'pointermove' event: continues the stroke if pointer is down.
+     * @private
+     */
+    private handlePointerMove;
+    /**
+     * Handles the 'pointerup' event: ends the stroke.
      * @private
      */
-    private handleMouseDown;
+    private handlePointerUp;
     /**
-     * Handles the 'mousemove' event: continues the stroke if mouse is down.
+     * Handles the 'pointerleave' event: ends the stroke if the pointer leaves the canvas area.
      * @private
      */
-    private handleMouseMove;
+    private handlePointerLeave;
     /**
-     * Handles the 'mouseup' event: ends the stroke.
+     * Handles the 'pointercancel' event: terminates a stroke interrupted by the browser
+     * (e.g. iOS scroll taking over, incoming call, screen lock).
      * @private
      */
-    private handleMouseUp;
+    private handlePointerCancel;
     /**
-     * Handles the 'mouseleave' event: ends the stroke if the mouse leaves the canvas area.
+     * Core logic to transform a PointerEvent into IPenData.
+     * @param event - The raw browser PointerEvent.
+     * @param inContact - Whether the pointer is actively drawing on the surface.
      * @private
      */
-    private handleMouseLeave;
+    private processPointerEvent;
     /**
-     * Core logic to transform a MouseEvent into IPenData.
-     * @param event - The raw browser MouseEvent.
-     * @param inContact - Whether the "pen" (mouse button) is touching the surface.
+     * Returns the pressure value for a pointer event.
+     * Pen devices (Apple Pencil, stylus) report real pressure in the 0–1 range.
+     * Mouse and touch devices fall back to 0.5 (in contact) / 0 (not in contact).
      * @private
      */
-    private processMouseEvent;
+    private getPressure;
     /**
-     * Converts absolute mouse coordinates into a normalized 0-1 range relative to canvas size.
+     * Converts absolute pointer coordinates into a normalized 0-1 range relative to canvas size.
      * @private
      */
     private getNormalizedCoordinates;
@@ -599,7 +614,7 @@ export declare class SignosoftSignpad extends LitElement {
     setHasStartedDrawing(value: boolean): void;
     setDeviceStatusText(value: string): void;
     canvasManager: CanvasManager | null;
-    mouseManager: MouseManager | null;
+    pointerManager: PointerManager | null;
     connectionManager: ConnectionManager;
     stateManager: StateManager;
     buttonManager: ButtonManager;
@@ -723,11 +738,11 @@ export declare class SignosoftSignpad extends LitElement {
      */
     private initializeCanvasManager;
     /**
-     * Initializes the MouseManager for mouse and touch fallback.
+     * Initializes the PointerManager for pointer/touch fallback.
      * @private
      * @returns void
      */
-    private initializeMouseManager;
+    private initializePointerManager;
     /**
      * Throttles pen event dispatch to avoid excessive callback pressure.
      * Drawing is still processed for every sample; only event emission is throttled.