@trackunit/react-drawer 1.12.0 → 1.12.1

package/index.cjs.js

@@ -369,16 +369,15 @@ const getElementYTranslation = (element) => {
 const isPassedThreshold = (dragDistance, threshold) => {
     return dragDistance >= threshold;
 };
-/**
- * Hook for handling swipe events on the drawer.
 /**
  * Hook for handling swipe events on the drawer.
  *
- * @param closingThreshold - The fraction (0-1) of the drawer's height needed to trigger open/close.
- * @param onCloseGesture - Callback when a close gesture is detected (optional).
- * @param onOpenGesture - Callback when an open gesture is detected (optional).
- * @param onDragEnd - Callback when the drag/swipe gesture ends. Receives drag distance and velocity (optional).
- * @param constrainDrag - Function to constrain/deny drag. Receives drag distance, returns boolean (optional).
+ * @param options - The hook options.
+ * @param options.closingThreshold - The fraction (0-1) of the drawer's height needed to trigger open/close.
+ * @param options.onCloseGesture - Callback when a close gesture is detected (optional).
+ * @param options.onOpenGesture - Callback when an open gesture is detected (optional).
+ * @param options.onDragEnd - Callback when the drag/swipe gesture ends. Receives drag distance and velocity (optional).
+ * @param options.constrainDrag - Function to constrain/deny drag. Receives drag distance, returns boolean (optional).
  */
 const useSwipeHandlers = ({ closingThreshold, onCloseGesture, onOpenGesture, onDragEnd, constrainDrag, }) => {
     const [isDragging, setIsDragging] = react.useState(false);
@@ -442,9 +441,10 @@ const useSwipeHandlers = ({ closingThreshold, onCloseGesture, onOpenGesture, onD
 /**
  * DrawerPuller is a React component that renders a puller element for a swipeable drawer.
  *
- * @param {CommonProps} props - The props for the DrawerPuller component.
- * @param {string} [props.className] - Additional class names to apply to the puller element.
- * @param {Ref<HTMLDivElement>} ref - The ref to be forwarded to the root div element.
+ * @param props - The props for the DrawerPuller component.
+ * @param props.className - Additional class names to apply to the puller element.
+ * @param props.ref - The ref to be forwarded to the root div element.
+ * @returns {ReactElement} The drawer puller element.
  */
 const DrawerPuller = ({ className, ref, ...props }) => {
     return (jsxRuntime.jsx("div", { className: cvaPuller({ className }), "data-testid": "drawer-puller", ...props, ref: ref, children: jsxRuntime.jsx("div", { className: cvaPullerIcon() }) }));

package/index.esm.js

@@ -367,16 +367,15 @@ const getElementYTranslation = (element) => {
 const isPassedThreshold = (dragDistance, threshold) => {
     return dragDistance >= threshold;
 };
-/**
- * Hook for handling swipe events on the drawer.
 /**
  * Hook for handling swipe events on the drawer.
  *
- * @param closingThreshold - The fraction (0-1) of the drawer's height needed to trigger open/close.
- * @param onCloseGesture - Callback when a close gesture is detected (optional).
- * @param onOpenGesture - Callback when an open gesture is detected (optional).
- * @param onDragEnd - Callback when the drag/swipe gesture ends. Receives drag distance and velocity (optional).
- * @param constrainDrag - Function to constrain/deny drag. Receives drag distance, returns boolean (optional).
+ * @param options - The hook options.
+ * @param options.closingThreshold - The fraction (0-1) of the drawer's height needed to trigger open/close.
+ * @param options.onCloseGesture - Callback when a close gesture is detected (optional).
+ * @param options.onOpenGesture - Callback when an open gesture is detected (optional).
+ * @param options.onDragEnd - Callback when the drag/swipe gesture ends. Receives drag distance and velocity (optional).
+ * @param options.constrainDrag - Function to constrain/deny drag. Receives drag distance, returns boolean (optional).
  */
 const useSwipeHandlers = ({ closingThreshold, onCloseGesture, onOpenGesture, onDragEnd, constrainDrag, }) => {
     const [isDragging, setIsDragging] = useState(false);
@@ -440,9 +439,10 @@ const useSwipeHandlers = ({ closingThreshold, onCloseGesture, onOpenGesture, onD
 /**
  * DrawerPuller is a React component that renders a puller element for a swipeable drawer.
  *
- * @param {CommonProps} props - The props for the DrawerPuller component.
- * @param {string} [props.className] - Additional class names to apply to the puller element.
- * @param {Ref<HTMLDivElement>} ref - The ref to be forwarded to the root div element.
+ * @param props - The props for the DrawerPuller component.
+ * @param props.className - Additional class names to apply to the puller element.
+ * @param props.ref - The ref to be forwarded to the root div element.
+ * @returns {ReactElement} The drawer puller element.
  */
 const DrawerPuller = ({ className, ref, ...props }) => {
     return (jsx("div", { className: cvaPuller({ className }), "data-testid": "drawer-puller", ...props, ref: ref, children: jsx("div", { className: cvaPullerIcon() }) }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-drawer",
-  "version": "1.12.0",
+  "version": "1.12.1",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,10 +9,10 @@
   "dependencies": {
     "react": "19.0.0",
     "react-swipeable": "^7.0.1",
-    "@trackunit/react-components": "1.16.0",
-    "@trackunit/css-class-variance-utilities": "1.11.19",
-    "@trackunit/ui-icons": "1.11.18",
-    "@trackunit/i18n-library-translation": "1.12.0"
+    "@trackunit/react-components": "1.16.1",
+    "@trackunit/css-class-variance-utilities": "1.11.20",
+    "@trackunit/ui-icons": "1.11.19",
+    "@trackunit/i18n-library-translation": "1.12.1"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/components/SwipeableDrawer/DrawerPuller.d.ts

@@ -1,15 +1,16 @@
 import { CommonProps } from "@trackunit/react-components";
-import { type Ref } from "react";
+import { ReactElement, type Ref } from "react";
 /**
  * DrawerPuller is a React component that renders a puller element for a swipeable drawer.
  *
- * @param {CommonProps} props - The props for the DrawerPuller component.
- * @param {string} [props.className] - Additional class names to apply to the puller element.
- * @param {Ref<HTMLDivElement>} ref - The ref to be forwarded to the root div element.
+ * @param props - The props for the DrawerPuller component.
+ * @param props.className - Additional class names to apply to the puller element.
+ * @param props.ref - The ref to be forwarded to the root div element.
+ * @returns {ReactElement} The drawer puller element.
  */
 export declare const DrawerPuller: {
     ({ className, ref, ...props }: CommonProps & {
         ref?: Ref<HTMLDivElement>;
-    }): import("react/jsx-runtime").JSX.Element;
+    }): ReactElement;
     displayName: string;
 };

package/src/hooks/useSwipeHandlers.d.ts

@@ -12,16 +12,15 @@ interface UseSwipeHandlersProps {
  * @returns {number} - The Y translation value of the element. Returns 0 if the element is not provided or if the transform style is "none".
  */
 export declare const getElementYTranslation: (element?: HTMLElement | null) => number;
-/**
- * Hook for handling swipe events on the drawer.
 /**
  * Hook for handling swipe events on the drawer.
  *
- * @param closingThreshold - The fraction (0-1) of the drawer's height needed to trigger open/close.
- * @param onCloseGesture - Callback when a close gesture is detected (optional).
- * @param onOpenGesture - Callback when an open gesture is detected (optional).
- * @param onDragEnd - Callback when the drag/swipe gesture ends. Receives drag distance and velocity (optional).
- * @param constrainDrag - Function to constrain/deny drag. Receives drag distance, returns boolean (optional).
+ * @param options - The hook options.
+ * @param options.closingThreshold - The fraction (0-1) of the drawer's height needed to trigger open/close.
+ * @param options.onCloseGesture - Callback when a close gesture is detected (optional).
+ * @param options.onOpenGesture - Callback when an open gesture is detected (optional).
+ * @param options.onDragEnd - Callback when the drag/swipe gesture ends. Receives drag distance and velocity (optional).
+ * @param options.constrainDrag - Function to constrain/deny drag. Receives drag distance, returns boolean (optional).
  */
 export declare const useSwipeHandlers: ({ closingThreshold, onCloseGesture, onOpenGesture, onDragEnd, constrainDrag, }: UseSwipeHandlersProps) => {
     handlers: import("react-swipeable").SwipeableHandlers;