@msobiecki/react-marauders-path 1.16.0 → 1.18.0

package/README.md

@@ -85,8 +85,8 @@ useKey(
 import { useWheel } from '@msobiecki/react-marauders-path';
 
 function MyComponent() {
-  useWheel((event, delta) => {
-    console.log(`Scrolled - X: ${delta.x}, Y: ${delta.y}`);
+  useWheel((event, data) => {
+    console.log(`Scrolled - X: ${data.deltaX}, Y: ${data.deltaY}`);
   });
 
   return <div>Scroll to interact</div>;
@@ -99,8 +99,8 @@ function MyComponent() {
 import { useSwipe } from '@msobiecki/react-marauders-path';
 
 function MyComponent() {
-  useSwipe('left' (event, swipe) => {
-    console.log(`Swiped ${swipe.direction} with velocity ${swipe.velocity}`);
+  useSwipe('left' (event, direction, data) => {
+    console.log(`Swiped ${direction} with velocity ${data.velocity}`);
   });
 
   return <div>Swipe left</div>;
@@ -140,7 +140,7 @@ Hook for handling mouse wheel events with support for different delta modes and
 
 **Parameters:**
 
-- `callback: (event: WheelEvent, delta: WheelData) => void | boolean` - Called when wheel event occurs
+- `callback: (event: WheelEvent, data: WheelData) => void | boolean` - Called when wheel event occurs
 - `options?: UseWheelOptions` - Optional configuration
 
 **Options:**
@@ -160,9 +160,9 @@ interface UseWheelOptions {
 
 ```typescript
 interface WheelData {
-  x: number; // Delta X value
-  y: number; // Delta Y value
-  z: number; // Delta Z value
+  deltaX: number; // Delta X value
+  deltaY: number; // Delta Y value
+  deltaZ: number; // Delta Z value
   deltaMode: number; // Delta mode value
 }
 ```
@@ -174,7 +174,7 @@ Hook for handling touch swipe gestures with configurable distance and velocity t
 **Parameters:**
 
 - `swipe: left | right | up | down | horizontal | vertical | both` - Allowed directions to listen
-- `callback: (event: TouchEvent, data: SwipeData) => void | boolean` - Called when a swipe event occurs
+- `callback: (event: PointerEvent, direction: SwipeDirection, data: SwipeData) => void | boolean` - Called when a swipe event occurs
 - `options?: UseSwipeOptions` - Optional configuration
 
 **Options:**
@@ -194,7 +194,6 @@ interface UseSwipeOptions {
 
 ```typescript
 interface SwipeData {
-  direction: SwipeDirection; // Resolved direction
   deltaX: number; // Horizontal travel
   deltaY: number; // Vertical travel
   velocity: number; // Average speed (distance / duration)
@@ -300,14 +299,37 @@ npm lint
 
 ## Project Status
 
-Hooks
-
-- 🚧 `useMouse` – Mouse interaction handling
-- 🚧 `useMouse` – Unit test coverage
-- 🚧 `useTouch` – Touch interaction handling
-- 🚧 `useTouch` – Unit test coverage
-- 🚧 `useInteraction` – Unified mouse, touch, and keyboard interaction handling
-- 🚧 `useInteraction` – Unit test coverage
+### High-level Gesture Hook
+
+- 🚧 **`useGesture`** – high-level API for gesture handling  
+  Supported gestures:
+  - `tap` – single tap / click
+  - `doubleTap` – quick double tap
+  - `press` / `longPress` – press and hold
+  - `swipe` – directional swipe
+  - `drag` / `pan` – track movement of finger or mouse
+  - `pinch` / `zoom` – two-finger pinch / zoom
+
+### Low-level Gesture Hooks
+
+- 🚧 **`useTap`** – single tap / click
+- 🚧 **`useDoubleTap`** – quick double tap
+- 🚧 **`usePress`** – press and hold (longPress)
+- 🚧 **`useDrag`** – dragging elements (MouseEvent / PointerEvent / TouchEvent)
+- 🚧 **`usePinch`** – two-finger pinch / zoom
+
+### Pointer / Mouse Hooks (Unified)
+
+- 🚧 **`usePointer`** – unified hook for MouseEvent, PointerEvent, and TouchEvent  
+  Supported events:
+  - `pointerdown`, `pointermove`, `pointerup`, `pointerenter`, `pointerleave`, `pointercancel`  
+    Filter by pointer type: `mouse` | `touch` | `pen`  
+    Callback returns unified data e.g.: `x`, `y`, `button`, `type`, `isPrimary`
+
+- 🚧 **`useMouse`** – alias for `usePointer` filtered to mouse only  
+  Supported events:
+  - `mousemove`, `mousedown`, `mouseup`, `click`, `dblclick`  
+    Buttons: `left`, `right`, `middle`
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@msobiecki/react-marauders-path",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "type": "module",
   "engines": {
     "node": ">=22.17.1"
@@ -24,12 +24,12 @@
   "devDependencies": {
     "@anolilab/multi-semantic-release": "^4.1.1",
     "@commitlint/cli": "^20.4.1",
-    "@commitlint/config-conventional": "^20.4.1",
+    "@commitlint/config-conventional": "^20.4.2",
     "@msobiecki/eslint-config": "^9.12.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@testing-library/react": "^16.3.2",
-    "@types/node": "^25.2.3",
+    "@types/node": "^25.3.0",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react-swc": "^4.2.3",