@allxsmith/bestax-bulma 5.64.0 → 5.65.1

package/dist/types-cjs/helpers/useSwipe.d.ts

@@ -0,0 +1,66 @@
+import type React from 'react';
+/** Which way a finished swipe went, on screen: where the pointer travelled. */
+export type SwipeDirection = 'left' | 'right' | 'up' | 'down';
+/** Options for `useSwipe`. */
+export interface UseSwipeOptions {
+    /**
+     * Whether a press starts a drag. Off, the handlers leave a press alone,
+     * `preventDefault()` included. A drag already under way still finishes.
+     * @defaultValue true
+     */
+    enabled?: boolean;
+    /**
+     * Follow the vertical axis too, so a swipe up or down is reported. Off,
+     * only the horizontal distance counts and `offsetY` stays `0`.
+     * @defaultValue false
+     */
+    vertical?: boolean;
+    /**
+     * Called when a drag ends more than 50px from where it started along an
+     * axis. With `vertical`, the axis it travelled further along decides.
+     * The direction is physical, so a caller that follows the reading
+     * direction maps it itself.
+     */
+    onSwipe: (direction: SwipeDirection) => void;
+}
+/** The mouse and touch handlers `useSwipe` hands back, to spread on the surface. */
+export interface SwipeHandlers<T extends Element = Element> {
+    /** Starts a drag. Calls `preventDefault()` while enabled, so the press neither selects text nor drags an image. */
+    onMouseDown: (event: React.MouseEvent<T>) => void;
+    /** Follows a drag. */
+    onMouseMove: (event: React.MouseEvent<T>) => void;
+    /** Ends a drag. */
+    onMouseUp: () => void;
+    /** Ends a drag when the pointer leaves the surface, as a release would. */
+    onMouseLeave: () => void;
+    /** Starts a drag with the first finger. */
+    onTouchStart: (event: React.TouchEvent<T>) => void;
+    /** Follows the first finger. */
+    onTouchMove: (event: React.TouchEvent<T>) => void;
+    /** Ends a drag. */
+    onTouchEnd: () => void;
+}
+/** What `useSwipe` returns. */
+export interface UseSwipeResult<T extends Element = Element> {
+    /** Whether a drag is under way. */
+    isSwiping: boolean;
+    /** How far the drag has gone across, in CSS pixels, `0` between drags. */
+    offsetX: number;
+    /** How far the drag has gone down (up is negative), `0` without `vertical`. */
+    offsetY: number;
+    /** The handlers to put on the surface that takes the drag. */
+    handlers: SwipeHandlers<T>;
+    /** Drops the drag under way without reporting a swipe, as when a second finger lands. */
+    cancel: () => void;
+}
+/**
+ * Follows a mouse or touch drag on a surface and reports a swipe when it
+ * ends far enough from where it started. Carousel's drag, shared: it hands
+ * back the handlers to put on the surface and the live offset to draw the
+ * drag with, and leaves what a swipe does to the component.
+ *
+ * @function
+ * @param {UseSwipeOptions} options - Whether it's on, the axes, and the callback.
+ * @returns {UseSwipeResult} The drag's state, its handlers, and a way to drop it.
+ */
+export declare function useSwipe<T extends Element = Element>({ enabled, vertical, onSwipe, }: UseSwipeOptions): UseSwipeResult<T>;

package/dist/types-cjs/index.d.ts

@@ -28,6 +28,7 @@ export * from './components/Sidebar.js';
 export * from './components/Toast.js';
 export * from './components/Dialog.js';
 export * from './components/Carousel.js';
+export * from './components/Lightbox.js';
 export * from './components/Reveal.js';
 export * from './components/TreeView.js';
 export * from './components/ScrollArea.js';