react-spring-carousel 3.0.0-beta-1.0.0 → 3.0.0-beta-1.0.1

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+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 FreeScrollSlideTypeProps = {
+    slideType?: "freeScroll";
+    scrollAmount?: number;
+    itemsPerSlide?: never;
+    scrollAmountType?: never;
+    withLoop?: never;
+};
+
+declare type Item = {
+    id: string;
+    renderItem: ReactNode;
+    renderThumb?: ReactNode;
+};
+
+declare type OnDrag = Omit<FullGestureState<"drag">, "event"> & {
+    eventName: "onDrag";
+    slideActionType: SlideActionType;
+};
+
+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 Props = {
+    init?: boolean;
+    slideType?: SlideType;
+    items: Item[];
+    withLoop?: boolean;
+    enableGestures?: boolean;
+    carouselAxis?: "x" | "y";
+    slideWhenDragThresholdIsReached?: boolean;
+    gutter?: number;
+    startEndGutter?: number;
+    fadeIn?: boolean;
+} & (FixedSlideTypeProps | FluidSlideTypeProps | FreeScrollSlideTypeProps);
+
+declare type SlideActionType = "drag" | "click";
+
+declare type SlideDirection = "prev" | "next";
+
+declare type SlideType = "fixed" | "fluid" | "freeScroll";
+
+declare type SpringCarouselEvents = OnSlideStartChange | OnSlideChangeComplete | OnDrag;
+
+declare type SpringCarouselEventsEventHandler = (props: SpringCarouselEvents) => void;
+
+export declare function useSpringCarousel({ init, items: _items, slideType, scrollAmount: _scrollAmount, withLoop, enableGestures, carouselAxis, slideWhenDragThresholdIsReached, itemsPerSlide: _itemsPerSlide, scrollAmountType: _scrollAmountType, gutter, startEndGutter, fadeIn, }: Props): {
+    carouselFragment: JSX_2.Element;
+    useListenToCustomEvent: (eventHandler: SpringCarouselEventsEventHandler) => void;
+    slideToNextItem: () => void;
+    slideToPrevItem: () => void;
+    slideToIem: (id: string | number) => 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;
+};
+
+export { }