react-spring-carousel 3.0.0-beta078 → 3.0.0-beta079

package/dist/types/useSpringCarousel.types.d.ts

@@ -0,0 +1,102 @@
+import { ReactNode } from 'react';
+import { ItemWithThumb, ItemWithNoThumb, PrepareThumbsData } from '../types';
+import { UseListenToCustomEvent } from './useEventsModule.types';
+export type UseSpringReturnType = {
+    carouselFragment: ReactNode;
+    thumbsFragment: ReactNode;
+    useListenToCustomEvent: UseListenToCustomEvent<'use-spring'>['useListenToCustomEvent'];
+    getIsFullscreen(): boolean;
+    enterFullscreen(ref?: HTMLElement): void;
+    exitFullscreen(): void;
+    slideToNextItem(animate?: boolean): void;
+    slideToPrevItem(animate?: boolean): void;
+    slideToItem(item: string | number, animate?: boolean): void;
+    getIsActiveItem(id: string): boolean;
+    getIsNextItem(id: string | number): boolean;
+    getIsPrevItem(id: string | number): boolean;
+};
+export type UseSpringFreeScrollReturnType = {
+    carouselFragment: ReactNode;
+    thumbsFragment: ReactNode;
+    useListenToCustomEvent: UseListenToCustomEvent<'use-spring'>['useListenToCustomEvent'];
+    getIsFullscreen(): boolean;
+    enterFullscreen(ref?: HTMLElement): void;
+    exitFullscreen(): void;
+    slideToNextItem(animate?: boolean): void;
+    slideToPrevItem(animate?: boolean): void;
+};
+export type SlideType = 'fixed' | 'fluid';
+export type SpringCarouselWithThumbs<T extends 'use-spring' | 'use-transition' = 'use-spring'> = {
+    withThumbs: true;
+    thumbsSlideAxis?: 'x' | 'y';
+    items: ItemWithThumb<T>[];
+    prepareThumbsData?: PrepareThumbsData<T>;
+};
+export type SpringCarouselWithNoThumbs<T extends 'use-spring' | 'use-transition' = 'use-spring'> = {
+    withThumbs?: false | undefined;
+    thumbsSlideAxis?: never;
+    items: ItemWithNoThumb<T>[];
+    prepareThumbsData?: never;
+};
+export type SpringCarouselWithFixedItems = {
+    slideType?: SlideType[0];
+    itemsPerSlide?: number;
+    startEndGutter?: number;
+    initialActiveItem?: number;
+};
+export type SpringCarouselWithNoFixedItems = {
+    slideType?: SlideType[1];
+    itemsPerSlide?: never;
+    startEndGutter?: never;
+    initialActiveItem?: never;
+};
+export type SpringCarouselWithLoop = {
+    withLoop: true;
+    initialStartingPosition?: 'start' | 'center' | 'end';
+};
+export type SpringCarouselWithNoLoop = {
+    withLoop?: false | undefined;
+    initialStartingPosition?: never;
+};
+export type SpringCarouselFreeScroll = {
+    freeScroll: true;
+    withLoop?: never;
+    slideType?: never;
+    enableFreeScrollDrag?: true | false;
+    initialActiveItem?: never;
+    itemsPerSlide?: never;
+    animateWhenActiveItemChange?: never;
+    slideWhenThresholdIsReached?: never;
+};
+export type SpringCarouselNoFreeScroll = {
+    freeScroll?: never | false | undefined;
+    withLoop?: boolean;
+    slideType?: SlideType;
+    enableFreeScrollDrag?: never;
+    initialActiveItem?: number;
+    itemsPerSlide?: number;
+    animateWhenActiveItemChange?: boolean;
+    slideWhenThresholdIsReached?: boolean;
+};
+export type ControllerRef = {
+    slideToNextItem: UseSpringReturnType['slideToNextItem'];
+    slideToPrevItem: UseSpringReturnType['slideToPrevItem'];
+    slideToItem?: UseSpringReturnType['slideToItem'];
+};
+export type BaseProps = {
+    init?: boolean;
+    gutter?: number;
+    carouselSlideAxis?: 'x' | 'y';
+    draggingSlideTreshold?: number;
+    disableGestures?: boolean;
+    startEndGutter?: number;
+    getControllerRef?(ref: ControllerRef): void;
+};
+type ScrollType<T> = T extends true ? SpringCarouselFreeScroll : SpringCarouselNoFreeScroll;
+export type UseSpringCarouselWithThumbs<T> = BaseProps & SpringCarouselWithThumbs & ScrollType<T> & (SpringCarouselWithFixedItems | SpringCarouselWithNoFixedItems) & (SpringCarouselWithLoop | SpringCarouselWithNoLoop);
+export type UseSpringCarouselWithNoThumbs<T> = BaseProps & SpringCarouselWithNoThumbs & ScrollType<T> & (SpringCarouselWithFixedItems | SpringCarouselWithNoFixedItems) & (SpringCarouselWithLoop | SpringCarouselWithNoLoop);
+export type UseSpringCarouselWithFixedItems<T> = BaseProps & SpringCarouselWithFixedItems & ScrollType<T> & (SpringCarouselWithThumbs | SpringCarouselWithNoThumbs) & (SpringCarouselWithLoop | SpringCarouselWithNoLoop);
+export type UseSpringCarouselWithNoFixedItems<T> = BaseProps & SpringCarouselWithNoFixedItems & ScrollType<T> & (SpringCarouselWithThumbs | SpringCarouselWithNoThumbs) & (SpringCarouselWithLoop | SpringCarouselWithNoLoop);
+export type UseSpringCarouselWithFreeScroll = BaseProps & SpringCarouselFreeScroll & (SpringCarouselWithThumbs | SpringCarouselWithNoThumbs);
+export type UseSpringCarouselComplete = BaseProps & (SpringCarouselWithThumbs | SpringCarouselWithNoThumbs) & (SpringCarouselWithFixedItems | SpringCarouselWithNoFixedItems) & (SpringCarouselWithLoop | SpringCarouselWithNoLoop) & (SpringCarouselFreeScroll | SpringCarouselNoFreeScroll);
+export {};

package/dist/types/useThumbsModule.types.d.ts

@@ -0,0 +1,8 @@
+import { ItemWithThumb, PrepareThumbsData, RenderItemProps, SpringCarouselWithThumbs } from '../types';
+export type UseThumbsModule<T extends 'use-spring' | 'use-transition'> = {
+    withThumbs?: boolean;
+    thumbsSlideAxis: SpringCarouselWithThumbs['thumbsSlideAxis'];
+    prepareThumbsData?: PrepareThumbsData<T>;
+    items: ItemWithThumb<T>[];
+    renderThumbFnProps: RenderItemProps<T>;
+};

package/dist/types/useTransitionCarousel.types.d.ts

@@ -0,0 +1,33 @@
+import { SpringConfig, TransitionFrom, TransitionTo } from '@react-spring/web';
+import { ItemWithNoThumb, ItemWithThumb, SpringCarouselWithNoThumbs, SpringCarouselWithThumbs } from '../types';
+import { ReactNode } from 'react';
+import { UseListenToCustomEvent } from './useEventsModule.types';
+type Item = ItemWithThumb<'use-transition'> | ItemWithNoThumb<'use-transition'>;
+export type SpringAnimationProps = {
+    initial: TransitionFrom<Item>;
+    from: TransitionFrom<Item>;
+    enter: TransitionTo<Item>;
+    leave: TransitionTo<Item>;
+};
+type BaseProps = {
+    init?: boolean;
+    disableGestures?: boolean;
+    springConfig?: Omit<SpringConfig, 'velocity'>;
+    toPrevItemSpringProps?: SpringAnimationProps;
+    toNextItemSpringProps?: SpringAnimationProps;
+    exitBeforeEnter?: boolean;
+    trail?: number;
+    withLoop?: boolean;
+    draggingSlideTreshold?: number;
+    thumbsSlideAxis?: 'x' | 'y';
+    activeItem?: number;
+};
+export type UseTransitionCarouselProps = BaseProps & (SpringCarouselWithThumbs<'use-transition'> | SpringCarouselWithNoThumbs<'use-transition'>);
+export type UseTransitionCarouselReturnProps = {
+    useListenToCustomEvent: UseListenToCustomEvent<'use-transition'>['useListenToCustomEvent'];
+    carouselFragment: ReactNode;
+    thumbsFragment: ReactNode;
+    slideToPrevItem(): void;
+    slideToNextItem(): void;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-spring-carousel",
-  "version": "3.0.0-beta078",
+  "version": "3.0.0-beta079",
   "type": "module",
   "description": "A new <Carousel /> experience for the web",
   "homepage": "https://react-spring-carousel.emilianobucci.com",