fix: fix comments

dohooo · Jan 16, 2022 · 753051f · 753051f
1 parent c20d2fd
commit 753051f
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 27 deletions.
diff --git a/docs/props.md b/docs/props.md
@@ -57,5 +57,5 @@
 | prev            | ({ count = 1, animated = false, onFinished?: () => void }) => void                      | Scroll to previous item, it takes one optional argument (count), which allows you to specify how many items to cross      |
 | next            | ({ count = 1, animated = false, onFinished?: () => void }) => void                      | Scroll to next item, it takes one optional argument (count), which allows you to specify how many items to cross      |
 | scrollTo        | ({ count = 1, animated = false, onFinished?: () => void }) => void | Use count to scroll to a position where relative to the current position, scrollTo(-2) is equivalent to prev(2), scrollTo(2) is equivalent to next(2)            |
-| goToIndex       | (index: number, animated?: boolean) => void | Go to index            |
+| （deprecated）goToIndex       | (index: number, animated?: boolean) => void | Go to index            |
 | getCurrentIndex | ()=>number                                  | Get current item index |
diff --git a/src/Carousel.tsx b/src/Carousel.tsx
@@ -69,7 +69,7 @@ function Carousel<T>(
         originalLength: data.length,
         onScrollEnd: () => runOnJS(_onScrollEnd)(),
         onScrollBegin: () => !!onScrollBegin && runOnJS(onScrollBegin)(),
-        onChange: (i) => onSnapToItem && runOnJS(onSnapToItem)(i),
+        onChange: (i) => !!onSnapToItem && runOnJS(onSnapToItem)(i),
         duration: scrollAnimationDuration,
     });
 
@@ -82,9 +82,9 @@ function Carousel<T>(
         getCurrentIndex,
     } = carouselController;
 
-    const { run, pause } = useAutoPlay({
+    const { start, pause } = useAutoPlay({
         autoPlay,
-        autoPlayInterval: Math.max(autoPlayInterval, 0),
+        autoPlayInterval,
         autoPlayReverse,
         carouselController,
     });
@@ -100,9 +100,9 @@ function Carousel<T>(
     }, [sharedPreIndex, sharedIndex, computedIndex, onScrollEnd]);
 
     const scrollViewGestureOnScrollEnd = React.useCallback(() => {
-        run();
+        start();
         _onScrollEnd();
-    }, [_onScrollEnd, run]);
+    }, [_onScrollEnd, start]);
 
     const goToIndex = React.useCallback(
         (i: number, animated?: boolean) => {

diff --git a/src/hooks/useAutoPlay.ts b/src/hooks/useAutoPlay.ts
@@ -17,35 +17,39 @@ export function useAutoPlay(opts: {
     const timer = React.useRef<NodeJS.Timer>();
     const stopped = React.useRef<boolean>(!autoPlay);
 
-    const pause = React.useCallback(() => {
-        timer.current && clearInterval(timer.current);
-        stopped.current = true;
-    }, []);
-
-    const run = React.useCallback(() => {
+    const play = React.useCallback(() => {
         if (stopped.current) {
             return;
         }
 
         timer.current = setTimeout(() => {
             autoPlayReverse
-                ? carouselController.prev({ onFinished: run })
-                : carouselController.next({ onFinished: run });
+                ? carouselController.prev({ onFinished: play })
+                : carouselController.next({ onFinished: play });
         }, autoPlayInterval);
     }, [autoPlayReverse, autoPlayInterval, carouselController]);
 
+    const pause = React.useCallback(() => {
+        timer.current && clearInterval(timer.current);
+        stopped.current = true;
+    }, []);
+
+    const start = React.useCallback(() => {
+        stopped.current = false;
+        play();
+    }, [play]);
+
     React.useEffect(() => {
         if (autoPlay) {
-            stopped.current = false;
-            run();
+            start();
         } else {
             pause();
         }
         return pause;
-    }, [run, pause, autoPlay]);
+    }, [pause, start, autoPlay]);
 
     return {
-        run,
         pause,
+        start,
     };
 }
diff --git a/src/hooks/useInitProps.ts b/src/hooks/useInitProps.ts
@@ -2,14 +2,20 @@ import React from 'react';
 import { DATA_LENGTH } from '../constants';
 import type { TCarouselProps } from '../types';
 
-export type TInitializeCarouselProps<T> = TCarouselProps<T> & {
-    defaultIndex: Required<TCarouselProps>['defaultIndex'];
-    loop: Required<TCarouselProps>['loop'];
-    width: Required<TCarouselProps>['width'];
-    height: Required<TCarouselProps>['height'];
-    scrollAnimationDuration: Required<TCarouselProps>['scrollAnimationDuration'];
-    autoPlayInterval: Required<TCarouselProps>['autoPlayInterval'];
-};
+type TGetRequiredProps<P extends keyof TCarouselProps> = Record<
+    P,
+    Required<TCarouselProps>[P]
+>;
+
+export type TInitializeCarouselProps<T> = TCarouselProps<T> &
+    TGetRequiredProps<
+        | 'defaultIndex'
+        | 'loop'
+        | 'width'
+        | 'height'
+        | 'scrollAnimationDuration'
+        | 'autoPlayInterval'
+    >;
 
 export function useInitProps<T>(
     props: TCarouselProps<T>
@@ -18,7 +24,7 @@ export function useInitProps<T>(
         defaultIndex = 0,
         data: _data = [],
         loop = true,
-        autoPlayInterval = 1000,
+        autoPlayInterval: _autoPlayInterval = 1000,
         scrollAnimationDuration = 500,
         style = {},
         panGestureHandlerProps = {},
@@ -30,6 +36,7 @@ export function useInitProps<T>(
 
     const width = Math.round(_width || 0);
     const height = Math.round(_height || 0);
+    const autoPlayInterval = Math.max(_autoPlayInterval, 0);
 
     const data = React.useMemo<T[]>(() => {
         if (!loop) return _data;