@factorialco/f0-react 8.25.0 → 8.26.0

package/dist/experimental.d.ts

@@ -5472,6 +5472,9 @@ declare const defaultTranslations: {
         readonly language: "Language";
         readonly audio: "Audio";
     };
+    readonly swipeDeck: {
+        readonly label: "Swipe deck";
+    };
     readonly meetingCard: {
         readonly today: "Today";
         readonly yesterday: "Yesterday";
@@ -12450,6 +12453,22 @@ export declare type F0SelectTagProp = string | {
 
 export declare type F0SelectVariant = (typeof selectVariants)[number];
 
+/**
+ * @experimental This is an experimental component, use it at your own risk.
+ */
+export declare const F0SwipeDeck: <T>({ deck, renderCard, label, empty, dataTestId, offsetThreshold, velocityThreshold, }: F0SwipeDeckProps<T>) => JSX_2.Element;
+
+export declare type F0SwipeDeckProps<T> = WithDataTestIdProps & {
+    deck: UseSwipeDeckResult<T>;
+    renderCard: (item: T) => ReactNode;
+    label?: string;
+    empty?: ReactNode;
+    /** Drag distance in pixels that commits a decision. */
+    offsetThreshold?: number;
+    /** Drag speed in pixels per second that commits a decision regardless of distance. */
+    velocityThreshold?: number;
+};
+
 /**
  * @experimental This is an experimental component use it at your own risk
  */
@@ -18792,6 +18811,24 @@ export declare type SummaryKey<Definition extends SummariesDefinition> = Definit
 
 export declare type SummaryType = "sum";
 
+export declare type SwipeDecision<T> = {
+    item: T;
+    direction: SwipeDirection;
+};
+
+export declare type SwipeDeckAction = {
+    type: "decide";
+    direction: SwipeDirection;
+} | {
+    type: "undo";
+} | {
+    type: "rollback";
+};
+
+export declare type SwipeDirection = (typeof swipeDirections)[number];
+
+export declare const swipeDirections: readonly ["left", "right"];
+
 /**
  * @experimental This is an experimental component use it at your own risk
  */
@@ -20058,6 +20095,43 @@ export declare const useSidebarChats: () => SidebarChatStore;
  */
 export declare function useSidePanel(): SidePanelContextValue;
 
+export declare const useSwipeDeck: <T>({ items, getItemId, onDecide, onUndo, onNeedMore, undoDepth, needMoreThreshold, }: UseSwipeDeckOptions<T>) => UseSwipeDeckResult<T>;
+
+export declare type UseSwipeDeckOptions<T> = {
+    /**
+     * Append-only: the deck reads it by position, so a page of new items must be
+     * added to the end. Replacing the array with a differently ordered or
+     * filtered one makes the deck skip items.
+     */
+    items: T[];
+    getItemId: (item: T) => string;
+    /**
+     * `rollback` returns the item to the deck, for a consumer whose mutation
+     * failed: as the current card when it was the most recent decision, after
+     * the items loaded so far otherwise.
+     */
+    onDecide?: (decision: SwipeDecision<T>, rollback: () => void) => void;
+    onUndo?: (item: T) => void;
+    /** Fires once each time the remaining items drop to `needMoreThreshold`. */
+    onNeedMore?: () => void;
+    undoDepth?: number;
+    needMoreThreshold?: number;
+};
+
+export declare type UseSwipeDeckResult<T> = {
+    current: T | undefined;
+    currentId: string | undefined;
+    index: number;
+    total: number;
+    remaining: number;
+    canUndo: boolean;
+    lastAction: SwipeDeckAction | undefined;
+    decide: (direction: SwipeDirection) => void;
+    swipeLeft: () => void;
+    swipeRight: () => void;
+    undo: () => void;
+};
+
 /**
  * Attaches a track to a media element F0 owns.
  *