react-spring-carousel 3.0.0-beta-1.0.422 → 3.0.0-beta-2.0.0

package/dist/index.d.ts

@@ -1,108 +1,41 @@
-import { FullGestureState } from '@use-gesture/react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ReactNode } from 'react';
 
-declare type FixedSlideTypeProps = {
-    slideType?: "fixed";
-    scrollAmount?: never;
-    itemsPerSlide?: number;
-    scrollAmountType?: "group" | "slide";
-};
-
-declare type FluidSlideTypeProps = {
-    slideType?: "fluid";
-    scrollAmount?: number;
-    itemsPerSlide?: never;
-    scrollAmountType?: never;
+declare type BaseProps = {
+    init?: boolean;
+    withLoop?: boolean;
+    items: Item[];
+    id: string;
+    slideType?: SlideType;
+    enableGestures?: boolean;
+    slideWhenDragThresholdIsReached?: boolean;
+    onInit?(): void;
 };
 
-declare type FreeScrollSlideTypeProps = {
-    slideType?: "freeScroll";
-    scrollAmount?: number;
-    itemsPerSlide?: never;
-    scrollAmountType?: never;
-    withLoop?: never;
-};
+declare type CarouselAxis = "x" | "y";
 
 declare type Item = {
     id: string;
-    renderThumb?: ReactNode;
-    renderItem: ReactNode | ((props: {
-        index: number;
-        useListenToCustomEvent(eventHandler: SpringCarouselEventsEventHandler): void;
-    }) => ReactNode);
-};
-
-export declare type OnDrag = Omit<FullGestureState<"drag">, "event"> & {
-    eventName: "onDrag";
-    slideActionType: SlideActionType;
+    renderItem: ReactNode;
 };
 
-declare type OnSlideChangeComplete = {
-    eventName: "onSlideChangeComplete";
-    slideDirection: SlideDirection;
-    sliceActionType: SlideActionType;
-    currentItem: {
-        index: number;
-        id: string;
-        startReached: boolean | undefined;
-        endReached: boolean | undefined;
-    };
-};
-
-declare type OnSlideStartChange = {
-    eventName: "onSlideStartChange";
-    slideDirection: SlideDirection;
-    sliceActionType: SlideActionType;
-    nextItem: {
-        index: number;
-        id: string;
-        startReached: boolean | undefined;
-        endReached: boolean | undefined;
-    };
+declare type LayoutProps = {
+    itemsPerSlide?: number;
+    gutter?: number;
+    startEndGutter?: number;
+    carouselAxis?: CarouselAxis;
+    startingPosition?: "start" | "middle-start" | "center" | "middle-end" | "end";
 };
 
-export declare type Props = {
-    init?: boolean | (() => Promise<boolean>);
-    slideType?: SlideType;
-    items: Item[];
-    withLoop?: boolean;
-    carouselAxis?: "x" | "y";
-    enableGestures?: boolean;
-    slideWhenDragThresholdIsReached?: boolean;
-    initialActiveItem?: number;
-    fadeIn?: boolean;
-} & (FixedSlideTypeProps | FluidSlideTypeProps | FreeScrollSlideTypeProps);
-
-export declare type SlideActionType = "drag" | "click";
-
-export declare type SlideDirection = "prev" | "next";
+declare type Props = BaseProps & LayoutProps;
 
 declare type SlideType = "fixed" | "fluid" | "freeScroll";
 
-export declare type SpringCarouselEvents = OnSlideStartChange | OnSlideChangeComplete | OnDrag;
-
-export declare type SpringCarouselEventsEventHandler = (props: SpringCarouselEvents) => void;
-
-export declare function useSpringCarousel({ init, items: _items, slideType, scrollAmount: _scrollAmount, withLoop, enableGestures, carouselAxis, slideWhenDragThresholdIsReached, scrollAmountType: _scrollAmountType, fadeIn, initialActiveItem, }: Props): {
+export declare function useSpringCarousel({ init, items, withLoop, id, itemsPerSlide, gutter, startEndGutter, carouselAxis, slideType, startingPosition, enableGestures, slideWhenDragThresholdIsReached, onInit, }: Props): {
     carouselFragment: JSX_2.Element;
-    useListenToCustomEvent: (eventHandler: SpringCarouselEventsEventHandler) => void;
     slideToNextItem: () => void;
     slideToPrevItem: () => void;
-    slideToIem: (id: string | number, shouldAnimate?: boolean) => void;
-    handleThumbsContainerScroll: ({ getContainer, activeItem, updateTotalValue, }: {
-        activeItem: number;
-        getContainer(): HTMLElement | null;
-        updateTotalValue?(props: {
-            from: number;
-            to: number;
-            itemOutOfViewport: {
-                isOut: boolean;
-                direction: "start" | "end" | null;
-            };
-        }): number;
-    }) => void;
-    carouselId: string;
+    slideToItem: (id: string | number) => void;
 };
 
 export { }