react-ui-animate 2.0.0 → 3.0.0-rc.0

package/src/animation/{useAnimatedValue.ts → lib/useAnimatedValue.ts}

@@ -1,71 +1,60 @@
-import { useTransition, TransitionValueConfig } from '@raidipesh78/re-motion';
-import { AnimationConfigUtils } from './animationType';
-
-// useAnimatedValue value type
-type Length = number | string;
-
-export interface UseAnimatedValueConfig extends TransitionValueConfig {}
-
-type AssignValue = {
-  toValue: Length;
-  config?: UseAnimatedValueConfig;
-};
-export type ValueType =
-  | Length
-  | AssignValue
-  | ((update: (next: AssignValue) => Promise<any>) => void);
-
-/**
- * `useAnimatedValue` returns an animation value with `.value` and `.currentValue` property which is
- * initialized when passed to argument (`initialValue`). The retured value persist until the lifetime of
- * a component. It doesnot cast any re-renders which can is very good for performance optimization.
- *
- * @param { string | number } initialValue - Initial value
- * @param { UseAnimatedValueConfig } config - Animation configuration object.
- */
-export function useAnimatedValue(
-  initialValue: Length,
-  config?: UseAnimatedValueConfig
-) {
-  const [animation, setAnimation] = useTransition(initialValue, {
-    ...AnimationConfigUtils.EASE,
-    ...config,
-  });
-
-  const targetObject: {
-    value: ValueType;
-    currentValue: number | string;
-  } = {
-    value: animation as any,
-    currentValue: animation.get(),
-  };
-
-  return new Proxy(targetObject, {
-    set: function (_, key, value: ValueType) {
-      if (key === 'value') {
-        if (typeof value === 'number' || typeof value === 'string') {
-          setAnimation({ toValue: value });
-        } else if (typeof value === 'object' || typeof value === 'function') {
-          setAnimation(value);
-        }
-
-        return true;
-      }
-
-      throw new Error('You cannot set any other property to animation node.');
-    },
-    get: function (_, key) {
-      if (key === 'value') {
-        return animation;
-      }
-
-      if (key === 'currentValue') {
-        return animation.get();
-      }
-
-      throw new Error(
-        'You cannot access any other property from animation node.'
-      );
-    },
-  });
-}
+import { useFluidValue, FluidValueConfig, FluidValue } from '../core';
+import { AnimationConfigUtils } from './animationType';
+
+// useAnimatedValue value type
+type Length = number | string;
+
+export interface UseAnimatedValueConfig extends FluidValueConfig {}
+
+/**
+ * `useAnimatedValue` returns an animation value with `.value` and `.currentValue` property which is
+ * initialized when passed to argument (`initialValue`). The retured value persist until the lifetime of
+ * a component. It doesnot cast any re-renders which can is very good for performance optimization.
+ *
+ * @param { string | number } initialValue - Initial value
+ * @param { UseAnimatedValueConfig } config - Animation configuration object.
+ */
+export function useAnimatedValue(
+  initialValue: Length,
+  config?: UseAnimatedValueConfig
+) {
+  const [animation, setAnimation] = useFluidValue(initialValue, {
+    ...AnimationConfigUtils.EASE,
+    ...config,
+  });
+
+  const targetObject: {
+    value: FluidValue | string | number | undefined;
+    currentValue: number | string;
+  } = {
+    value: animation,
+    currentValue: animation.get(),
+  };
+
+  return new Proxy(targetObject, {
+    set: function (_, key, value: any) {
+      if (key === 'value') {
+        if (typeof value === 'number' || typeof value === 'string') {
+          setAnimation(value);
+        }
+
+        return true;
+      }
+
+      throw new Error('You cannot set any other property to animation node.');
+    },
+    get: function (_, key) {
+      if (key === 'value') {
+        return animation;
+      }
+
+      if (key === 'currentValue') {
+        return animation.get();
+      }
+
+      throw new Error(
+        'You cannot access any other property from animation node.'
+      );
+    },
+  });
+}

package/src/animation/{useMountedValue.ts → lib/useMountedValue.ts}

@@ -1,19 +1,18 @@
-import * as React from 'react';
-import { useMount, UseMountConfig, FluidValue } from '@raidipesh78/re-motion';
-
-export interface UseMountedValueConfig extends UseMountConfig {}
-
-/**
- * `useMountedValue` handles mounting and unmounting of a component which captures current state
- * passed as an arugment (`state`) and exposes the shadow state which handles the mount and unmount
- * of a component.
- *
- * @param { boolean } state - Boolean indicating the component should mount or unmount.
- * @param { UseMountedValueConfig } config - Animation configuration.
- */
-export function useMountedValue(state: boolean, config: UseMountedValueConfig) {
-  const mv = useMount(state, config);
-  return (
-    cb: (value: { value: FluidValue }, mounted: boolean) => React.ReactNode
-  ) => mv((a, m) => cb({ value: a }, m));
-}
+import { useMount, UseMountConfig, FluidValue } from '../core';
+
+export interface UseMountedValueConfig extends UseMountConfig {}
+
+/**
+ * `useMountedValue` handles mounting and unmounting of a component which captures current state
+ * passed as an arugment (`state`) and exposes the shadow state which handles the mount and unmount
+ * of a component.
+ *
+ * @param { boolean } state - Boolean indicating the component should mount or unmount.
+ * @param { UseMountedValueConfig } config - Animation configuration.
+ */
+export function useMountedValue(state: boolean, config: UseMountedValueConfig) {
+  const mv = useMount(state, config);
+  return (
+    cb: (value: { value: FluidValue }, mounted: boolean) => React.ReactNode
+  ) => mv((a, m) => cb({ value: a }, m));
+}

package/src/gestures/controllers/DragGesture.ts

@@ -1,177 +1,178 @@
-import { attachEvents } from '../eventAttacher';
-import { Vector2 } from '../types';
-import { clamp } from '../math';
-import { withDefault } from '../withDefault';
-import { Gesture } from './Gesture';
-
-export class DragGesture extends Gesture {
-  movementStart: Vector2 = withDefault(0, 0);
-  initialMovement: Vector2 = withDefault(0, 0);
-  movement: Vector2 = withDefault(0, 0);
-  previousMovement: Vector2 = withDefault(0, 0);
-  translation: Vector2 = withDefault(0, 0);
-  offset: Vector2 = withDefault(0, 0);
-  velocity: Vector2 = withDefault(0, 0);
-
-  // @override
-  // initialize the events
-  _initEvents() {
-    if (this.targetElement || this.targetElements.length > 0) {
-      this._subscribe = attachEvents(
-        [window],
-        [
-          ['mousedown', this.pointerDown.bind(this)],
-          ['mousemove', this.pointerMove.bind(this)],
-          ['mouseup', this.pointerUp.bind(this)],
-          ['touchstart', this.pointerDown.bind(this), { passive: false }],
-          ['touchmove', this.pointerMove.bind(this), { passive: false }],
-          ['touchend', this.pointerUp.bind(this)],
-        ]
-      );
-    }
-  }
-
-  // @override - cancel events
-  // we only canceled down and move events because mouse up
-  // will not be triggered
-  _cancelEvents() {
-    if (this._subscribe) {
-      this._subscribe(['mousedown', 'mousemove', 'touchstart', 'touchmove']);
-    }
-  }
-
-  _handleCallback() {
-    if (this.callback) {
-      this.callback({
-        args: [this.currentIndex],
-        down: this.isActive,
-        movementX: this.movement.x,
-        movementY: this.movement.y,
-        offsetX: this.translation.x,
-        offsetY: this.translation.y,
-        velocityX: this.velocity.x,
-        velocityY: this.velocity.y,
-        distanceX: Math.abs(this.movement.x),
-        distanceY: Math.abs(this.movement.y),
-        directionX: Math.sign(this.movement.x),
-        directionY: Math.sign(this.movement.y),
-        cancel: () => {
-          this._cancelEvents();
-        },
-      });
-    }
-  }
-
-  pointerDown(e: any) {
-    if (e.type === 'touchstart') {
-      this.movementStart = {
-        x: e.touches[0].clientX,
-        y: e.touches[0].clientY,
-      };
-    } else {
-      this.movementStart = { x: e.clientX, y: e.clientY };
-    }
-
-    this.movement = { x: 0, y: 0 };
-    this.offset = { x: this.translation.x, y: this.translation.y };
-    this.previousMovement = { x: 0, y: 0 };
-    this.velocity = { x: 0, y: 0 };
-
-    // find current selected element
-    const currElem = this.targetElements.find((elem: any) => elem === e.target);
-
-    if (e.target === this.targetElement || currElem) {
-      this.isActive = true;
-      e.preventDefault();
-
-      // set args
-      if (currElem) {
-        this.currentIndex = this.targetElements.indexOf(currElem);
-      }
-
-      // if initial function is defined then call it to get initial movementX and movementY
-      // if only select to bounded draggable element
-      const initial = this.config?.initial && this.config.initial();
-      const initialMovementX = initial?.movementX;
-      const initialMovementY = initial?.movementY;
-
-      this.initialMovement = {
-        x: initialMovementX ?? 0,
-        y: initialMovementY ?? 0,
-      };
-
-      this.movement = {
-        x: this.initialMovement.x,
-        y: this.initialMovement.y,
-      };
-
-      this.previousMovement = {
-        x: this.initialMovement.x,
-        y: this.initialMovement.y,
-      };
-
-      this._handleCallback();
-    }
-  }
-
-  pointerMove(e: any) {
-    if (this.isActive) {
-      e.preventDefault();
-      const now = Date.now();
-      const deltaTime = clamp(now - this.lastTimeStamp, 0.1, 64);
-      this.lastTimeStamp = now;
-
-      const t = deltaTime / 1000;
-
-      if (e.type === 'touchmove') {
-        this.movement = {
-          x:
-            this.initialMovement.x +
-            (e.touches[0].clientX - this.movementStart.x),
-          y:
-            this.initialMovement.y +
-            (e.touches[0].clientY - this.movementStart.y),
-        };
-      } else {
-        this.movement = {
-          x: this.initialMovement.x + (e.clientX - this.movementStart.x),
-          y: this.initialMovement.y + (e.clientY - this.movementStart.y),
-        };
-      }
-
-      this.translation = {
-        x: this.offset.x + this.movement.x,
-        y: this.offset.y + this.movement.y,
-      };
-
-      this.velocity = {
-        x: clamp(
-          (this.movement.x - this.previousMovement.x) / t / 1000,
-          -1 * Gesture._VELOCITY_LIMIT,
-          Gesture._VELOCITY_LIMIT
-        ),
-        y: clamp(
-          (this.movement.y - this.previousMovement.y) / t / 1000,
-          -1 * Gesture._VELOCITY_LIMIT,
-          Gesture._VELOCITY_LIMIT
-        ),
-      };
-
-      this.previousMovement = {
-        x: this.movement.x,
-        y: this.movement.y,
-      };
-
-      this._handleCallback();
-    }
-  }
-
-  pointerUp() {
-    if (this.isActive) {
-      this.isActive = false;
-      this._handleCallback();
-      this._cancelEvents();
-      this._initEvents();
-    }
-  }
-}
+import { attachEvents } from '../helpers/eventAttacher';
+import { clamp } from '../helpers/math';
+import { withDefault } from '../helpers/withDefault';
+import { Gesture } from './Gesture';
+
+import type { Vector2 } from '../types';
+
+export class DragGesture extends Gesture {
+  movementStart: Vector2 = withDefault(0, 0);
+  initialMovement: Vector2 = withDefault(0, 0);
+  movement: Vector2 = withDefault(0, 0);
+  previousMovement: Vector2 = withDefault(0, 0);
+  translation: Vector2 = withDefault(0, 0);
+  offset: Vector2 = withDefault(0, 0);
+  velocity: Vector2 = withDefault(0, 0);
+
+  // @override
+  // initialize the events
+  _initEvents() {
+    if (this.targetElement || this.targetElements.length > 0) {
+      this._subscribe = attachEvents(
+        [window],
+        [
+          ['mousedown', this.pointerDown.bind(this)],
+          ['mousemove', this.pointerMove.bind(this)],
+          ['mouseup', this.pointerUp.bind(this)],
+          ['touchstart', this.pointerDown.bind(this), { passive: false }],
+          ['touchmove', this.pointerMove.bind(this), { passive: false }],
+          ['touchend', this.pointerUp.bind(this)],
+        ]
+      );
+    }
+  }
+
+  // @override - cancel events
+  // we only canceled down and move events because mouse up
+  // will not be triggered
+  _cancelEvents() {
+    if (this._subscribe) {
+      this._subscribe(['mousedown', 'mousemove', 'touchstart', 'touchmove']);
+    }
+  }
+
+  _handleCallback() {
+    if (this.callback) {
+      this.callback({
+        args: [this.currentIndex],
+        down: this.isActive,
+        movementX: this.movement.x,
+        movementY: this.movement.y,
+        offsetX: this.translation.x,
+        offsetY: this.translation.y,
+        velocityX: this.velocity.x,
+        velocityY: this.velocity.y,
+        distanceX: Math.abs(this.movement.x),
+        distanceY: Math.abs(this.movement.y),
+        directionX: Math.sign(this.movement.x),
+        directionY: Math.sign(this.movement.y),
+        cancel: () => {
+          this._cancelEvents();
+        },
+      });
+    }
+  }
+
+  pointerDown(e: any) {
+    if (e.type === 'touchstart') {
+      this.movementStart = {
+        x: e.touches[0].clientX,
+        y: e.touches[0].clientY,
+      };
+    } else {
+      this.movementStart = { x: e.clientX, y: e.clientY };
+    }
+
+    this.movement = { x: 0, y: 0 };
+    this.offset = { x: this.translation.x, y: this.translation.y };
+    this.previousMovement = { x: 0, y: 0 };
+    this.velocity = { x: 0, y: 0 };
+
+    // find current selected element
+    const currElem = this.targetElements.find((elem: any) => elem === e.target);
+
+    if (e.target === this.targetElement || currElem) {
+      this.isActive = true;
+      e.preventDefault();
+
+      // set args
+      if (currElem) {
+        this.currentIndex = this.targetElements.indexOf(currElem);
+      }
+
+      // if initial function is defined then call it to get initial movementX and movementY
+      // if only select to bounded draggable element
+      const initial = this.config?.initial && this.config.initial();
+      const initialMovementX = initial?.movementX;
+      const initialMovementY = initial?.movementY;
+
+      this.initialMovement = {
+        x: initialMovementX ?? 0,
+        y: initialMovementY ?? 0,
+      };
+
+      this.movement = {
+        x: this.initialMovement.x,
+        y: this.initialMovement.y,
+      };
+
+      this.previousMovement = {
+        x: this.initialMovement.x,
+        y: this.initialMovement.y,
+      };
+
+      this._handleCallback();
+    }
+  }
+
+  pointerMove(e: any) {
+    if (this.isActive) {
+      e.preventDefault();
+      const now = Date.now();
+      const deltaTime = clamp(now - this.lastTimeStamp, 0.1, 64);
+      this.lastTimeStamp = now;
+
+      const t = deltaTime / 1000;
+
+      if (e.type === 'touchmove') {
+        this.movement = {
+          x:
+            this.initialMovement.x +
+            (e.touches[0].clientX - this.movementStart.x),
+          y:
+            this.initialMovement.y +
+            (e.touches[0].clientY - this.movementStart.y),
+        };
+      } else {
+        this.movement = {
+          x: this.initialMovement.x + (e.clientX - this.movementStart.x),
+          y: this.initialMovement.y + (e.clientY - this.movementStart.y),
+        };
+      }
+
+      this.translation = {
+        x: this.offset.x + this.movement.x,
+        y: this.offset.y + this.movement.y,
+      };
+
+      this.velocity = {
+        x: clamp(
+          (this.movement.x - this.previousMovement.x) / t / 1000,
+          -1 * Gesture._VELOCITY_LIMIT,
+          Gesture._VELOCITY_LIMIT
+        ),
+        y: clamp(
+          (this.movement.y - this.previousMovement.y) / t / 1000,
+          -1 * Gesture._VELOCITY_LIMIT,
+          Gesture._VELOCITY_LIMIT
+        ),
+      };
+
+      this.previousMovement = {
+        x: this.movement.x,
+        y: this.movement.y,
+      };
+
+      this._handleCallback();
+    }
+  }
+
+  pointerUp() {
+    if (this.isActive) {
+      this.isActive = false;
+      this._handleCallback();
+      this._cancelEvents();
+      this._initEvents();
+    }
+  }
+}

package/src/gestures/controllers/Gesture.ts

@@ -1,54 +1,54 @@
-export class Gesture {
-  currentIndex?: number;
-  lastTimeStamp: number = Date.now();
-  isActive: boolean = false;
-  targetElement?: HTMLElement; // represents the bounded element
-  targetElements: Array<HTMLElement> = []; // represents the bounded elements
-  config?: any;
-  callback?: <T>(event: T) => void;
-  _subscribe?: (eventKeys?: Array<string>) => void;
-  static _VELOCITY_LIMIT: number = 20;
-
-  // it must be overridden by other child classes
-  _initEvents() {}
-
-  // cancel events
-  // we only canceled down and move events because mouse up
-  // will not be triggered
-  _cancelEvents() {
-    if (this._subscribe) {
-      this._subscribe();
-    }
-  }
-
-  // re-apply new callback
-  applyCallback(callback: <T>(event: T) => void) {
-    this.callback = callback;
-  }
-
-  // apply gesture
-  applyGesture({
-    targetElement,
-    targetElements,
-    callback,
-    config,
-  }: {
-    targetElement?: any;
-    targetElements?: any;
-    callback: <T>(event: T) => void;
-    config?: any;
-  }) {
-    this.targetElement = targetElement;
-    this.targetElements = targetElements.map(
-      (element: { current: any }) => element.current
-    );
-    this.callback = callback;
-    this.config = config;
-
-    // initialize events
-    this._initEvents();
-
-    // unbind
-    return () => this._subscribe && this._subscribe();
-  }
-}
+export class Gesture {
+  currentIndex?: number;
+  lastTimeStamp: number = Date.now();
+  isActive: boolean = false;
+  targetElement?: HTMLElement; // represents the bounded element
+  targetElements: Array<HTMLElement> = []; // represents the bounded elements
+  config?: any;
+  callback?: <T>(event: T) => void;
+  _subscribe?: (eventKeys?: Array<string>) => void;
+  static _VELOCITY_LIMIT: number = 20;
+
+  // it must be overridden by other child classes
+  _initEvents() {}
+
+  // cancel events
+  // we only canceled down and move events because mouse up
+  // will not be triggered
+  _cancelEvents() {
+    if (this._subscribe) {
+      this._subscribe();
+    }
+  }
+
+  // re-apply new callback
+  applyCallback(callback: <T>(event: T) => void) {
+    this.callback = callback;
+  }
+
+  // apply gesture
+  applyGesture({
+    targetElement,
+    targetElements,
+    callback,
+    config,
+  }: {
+    targetElement?: any;
+    targetElements?: any;
+    callback: <T>(event: T) => void;
+    config?: any;
+  }) {
+    this.targetElement = targetElement;
+    this.targetElements = targetElements.map(
+      (element: { current: any }) => element.current
+    );
+    this.callback = callback;
+    this.config = config;
+
+    // initialize events
+    this._initEvents();
+
+    // unbind
+    return () => this._subscribe && this._subscribe();
+  }
+}