@fountain-ui/lab 2.0.0-beta.10 → 2.0.0-beta.13

package/build/typescript/ViewabilityTrackerView/ViewabilityTrackerViewProps.d.ts

@@ -0,0 +1,22 @@
+import type { ViewProps } from 'react-native';
+import type { OverridableComponentProps } from '@fountain-ui/core';
+import type Viewability from './Viewability';
+export default interface ViewabilityTrackerViewProps extends OverridableComponentProps<ViewProps, {
+    /**
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * @default 1000
+     */
+    measurementIntervalMillis?: number;
+    /**
+     *
+     */
+    onViewabilityChange?: (viewability: Viewability) => void;
+    /**
+     * @default 50
+     */
+    visiblePercentThreshold?: number;
+}> {
+}

package/build/typescript/ViewabilityTrackerView/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './ViewabilityTrackerView';
+export type { default as ViewabilityTrackerViewProps } from './ViewabilityTrackerViewProps';

package/build/typescript/ViewabilityTrackerView/measureViewability.d.ts

@@ -0,0 +1,11 @@
+import type { View } from 'react-native';
+export interface ViewabilityDetail {
+    visiblePercent: number;
+}
+export interface MeasureViewabilityParameters {
+    view: View;
+    windowWidth: number;
+    windowHeight: number;
+    onViewabilityDetailMeasured: (detail: ViewabilityDetail) => void;
+}
+export default function measureViewability({ view, windowWidth, windowHeight, onViewabilityDetailMeasured, }: MeasureViewabilityParameters): void;

package/build/typescript/ViewabilityTrackerView/useViewabilityTracker.d.ts

@@ -0,0 +1,11 @@
+import type { RefObject } from 'react';
+import type { View } from 'react-native';
+import type Viewability from './Viewability';
+export interface ViewabilityTrackerConfig {
+    enabled: boolean;
+    measurementIntervalMillis: number;
+    onViewabilityChange?: (viewability: Viewability) => void;
+    viewRef: RefObject<View>;
+    visiblePercentThreshold: number;
+}
+export default function useViewabilityTracker(config: ViewabilityTrackerConfig): void;

package/build/typescript/hooks/index.d.ts

@@ -1,2 +1,4 @@
+export { default as useDeferredExecutor } from './useDeferredExecutor';
+export { default as useIsMounted } from './useIsMounted';
 export { default as useUnstableCollapsibleAppBar } from './useUnstableCollapsibleAppBar';
 export { default as useUnstableToggleDisplayStyle } from './useUnstableToggleDisplayStyle';

package/build/typescript/hooks/useDeferredExecutor.d.ts

@@ -0,0 +1,11 @@
+export interface Runnable {
+    (): void;
+}
+export interface DeferredExecute {
+    (runnable: Runnable, delay?: number): void;
+}
+export interface DeferredExecutor {
+    cancel: () => void;
+    execute: DeferredExecute;
+}
+export default function useDeferredExecutor(): DeferredExecutor;

package/build/typescript/hooks/useIsMounted.d.ts

@@ -0,0 +1,4 @@
+export interface UseIsMounted {
+    (): boolean;
+}
+export default function useIsMounted(): UseIsMounted;

package/build/typescript/index.d.ts

@@ -12,4 +12,6 @@ export { default as ComicViewer } from './ComicViewer';
 export * from './ComicViewer';
 export { default as StatusBarProvider, useStatusBarContext } from './StatusBarProvider';
 export * from './StatusBarProvider';
+export { default as ViewabilityTrackerView } from './ViewabilityTrackerView';
+export * from './ViewabilityTrackerView';
 export * from './hooks';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fountain-ui/lab",
-  "version": "2.0.0-beta.10",
+  "version": "2.0.0-beta.13",
   "private": false,
   "author": "Fountain-UI Team",
   "description": "Incubator for Fountain-UI React components.",
@@ -29,9 +29,7 @@
     "react-dom": "^16.8.0 || ^17.0.0",
     "react-native": "^0.63.0",
     "react-native-gesture-handler": "^2.0.0",
-    "react-native-pager-view": "^4.0.0",
-    "react-native-snap-carousel": "^3.9.0",
-    "react-slick": "^0.25.0"
+    "react-native-pager-view": "^4.0.0"
   },
   "peerDependenciesMeta": {
     "@gorhom/bottom-sheet": {
@@ -40,28 +38,15 @@
     "react-dom": {
       "optional": true
     },
-    "react-native": {
-      "optional": true
-    },
-    "react-slick": {
-      "optional": true
-    },
     "react-native-pager-view": {
       "optional": true
-    },
-    "react-native-snap-carousel": {
-      "optional": true
     }
   },
   "devDependencies": {
     "@gorhom/bottom-sheet": "4.1.3",
-    "@types/react-native-snap-carousel": "^3.8.4",
-    "@types/react-slick": "^0.23.5",
     "date-fns": "^2.23.0",
     "react-native-pager-view": "^4.2.4",
-    "react-native-safe-area-context": "^3.3.2",
-    "react-native-snap-carousel": "^3.9.1",
-    "react-slick": "^0.28.1"
+    "react-native-safe-area-context": "^3.3.2"
   },
   "react-native-builder-bob": {
     "source": "./src",
@@ -85,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0ac49f4ca5f910fc8b5edad2593300d796b2d914"
+  "gitHead": "4f247070bf942db98feafb9573e8c1dc3fc1d758"
 }

package/src/Carousel/Carousel.tsx

@@ -0,0 +1,152 @@
+import React, { forwardRef, memo, useImperativeHandle, useMemo, useRef } from 'react';
+import { Animated } from 'react-native';
+import ViewabilityTrackerView from '../ViewabilityTrackerView';
+import type CarouselProps from './CarouselProps';
+import type { CarouselInstance } from './types';
+import {
+    useAutoplayController,
+    useDimensionChangeReaction,
+    useIndexController,
+    useItemVisibilityStore,
+    useLoopedData,
+    usePagingAnimation,
+} from './hooks';
+import { createDefaultItemStyle, createDefaultScrollAnimation } from './animation';
+import { InternalContext, RootView, ScrollViewGesture } from './components';
+
+const Carousel = forwardRef<CarouselInstance, CarouselProps>(function Carousel(props, ref) {
+    const {
+        autoplay = false,
+        autoplayInterval = 3000,
+        createItemStyle = createDefaultItemStyle,
+        createScrollAnimation = createDefaultScrollAnimation,
+        data: originalData,
+        disableSmartAutoplay = false,
+        initialIndex = 0,
+        itemHeight,
+        itemWidth,
+        loop = false,
+        onIndexChange,
+        renderItem,
+        scrollEnabled = true,
+        style,
+        windowSize = 5,
+    } = props;
+
+    const data = useLoopedData(originalData, loop);
+
+    const initialTx = itemWidth * initialIndex;
+    const controlledTx = useRef(new Animated.Value(initialTx)).current;
+    const offsetTx = useRef(new Animated.Value(0)).current;
+
+    const {
+        currentIndex,
+        getCurrentIndex,
+        lastIndex,
+        monitorElement,
+    } = useIndexController({
+        controlledTx,
+        initialIndex,
+        itemWidth,
+        numberOfOriginalData: originalData.length,
+        onIndexChange,
+    });
+
+    const itemVisibilityStore = useItemVisibilityStore({
+        currentIndex,
+        numberOfData: data.length,
+        windowSize,
+    });
+
+    const {
+        finalizeAnimation,
+        globalInterpolation,
+        startPagingAnimation,
+    } = usePagingAnimation({
+        controlledTx,
+        createScrollAnimation,
+        getCurrentIndex,
+        itemWidth,
+        lastIndex,
+        loop,
+        numberOfData: data.length,
+        offsetTx,
+    });
+
+    const autoplayController = useAutoplayController({
+        enabled: autoplay,
+        intervalMillis: autoplayInterval,
+        startPagingAnimation,
+    });
+
+    useDimensionChangeReaction({
+        controlledTx,
+        currentIndex,
+        itemWidth,
+    });
+
+    useImperativeHandle(
+        ref,
+        () => ({
+            getCurrentIndex,
+            next: () => startPagingAnimation('directional', { direction: 'next' }),
+            prev: () => startPagingAnimation('directional', { direction: 'prev' }),
+            scrollTo: (option) => startPagingAnimation('index', option),
+        }),
+        [startPagingAnimation, getCurrentIndex],
+    );
+
+    const contextValue = useMemo(() => ({
+        createItemStyle,
+        data,
+        globalInterpolation,
+        itemHeight,
+        itemWidth,
+        itemVisibilityStore,
+        loop,
+    }), [
+        createItemStyle,
+        data,
+        globalInterpolation,
+        itemHeight,
+        itemWidth,
+        itemVisibilityStore,
+        loop,
+    ]);
+
+    return (
+        <InternalContext.Provider value={contextValue}>
+            {monitorElement}
+
+            <ViewabilityTrackerView
+                enabled={autoplay && !disableSmartAutoplay}
+                measurementIntervalMillis={Math.max(3000, autoplayInterval)}
+                onViewabilityChange={({ visible }) => {
+                    if (visible) {
+                        autoplayController.resume();
+                    } else {
+                        autoplayController.pause();
+                    }
+                }}
+            >
+                <ScrollViewGesture
+                    autoplayController={autoplayController}
+                    finalizeAnimation={finalizeAnimation}
+                    offsetTx={offsetTx}
+                    scrollEnabled={scrollEnabled}
+                    startPagingAnimation={startPagingAnimation}
+                >
+                    <RootView
+                        data={data}
+                        itemHeight={itemHeight}
+                        originalData={originalData}
+                        renderItem={renderItem}
+                        style={style}
+                    />
+                </ScrollViewGesture>
+            </ViewabilityTrackerView>
+        </InternalContext.Provider>
+    );
+});
+
+export default memo(Carousel);

package/src/Carousel/CarouselProps.ts

@@ -1,8 +1,10 @@
-import React, { RefObject } from 'react';
-import type { ListRenderItemInfo } from 'react-native';
+import type { RefObject } from 'react';
 import type { ComponentProps } from '@fountain-ui/core';
+import type { CarouselInstance, CreateItemStyle, CreateScrollAnimation, ItemHeight, RenderItem } from './types';
 
 export default interface CarouselProps<ItemT = any> extends ComponentProps<{
+    ref?: RefObject<CarouselInstance>;
+
     /**
      * If `true`, enable autoplay.
      * @default false
@@ -16,92 +18,72 @@ export default interface CarouselProps<ItemT = any> extends ComponentProps<{
     autoplayInterval?: number;
 
     /**
-     * Padding for center slide. If specified, `slidesToScroll` and `slidesToShow` set to 1.
+     * The item style creator function.
+     * @default createDefaultItemStyle
      */
-    centerSlidePadding?: number;
+    createItemStyle?: CreateItemStyle;
 
     /**
-     * Delay in ms until navigating to the next item.
+     * The scroll animation creator function.
+     * @default createDefaultScrollAnimation
+     */
+    createScrollAnimation?: CreateScrollAnimation;
+
+    /**
+     * Data for render items.
      */
     data: ReadonlyArray<ItemT>;
 
     /**
-     * Value of the opacity effect applied to inactive slides.
-     * @default 0.7
+     * If `true`, carousel will detect its own viewability and control autoplay automatically.
+     * @default false
      */
-    inactiveSlideOpacity?: number;
+    disableSmartAutoplay?: boolean;
 
     /**
-     * Value of the 'scale' transform applied to inactive slides.
-     * @default 0.9
+     * Index of initial item that should be selected.
+     * @default 0
      */
-    inactiveSlideScale?: number;
+    initialIndex?: number;
 
     /**
-     * Web only. Value of the 'scale' transform applied to a active slide.
-     * @default 0.990
+     * The item height.
+     * For a performance reason, always consider to provide a number value.
      */
-    activeSlideScale?: number;
+    itemHeight: ItemHeight;
 
     /**
-     * A number representing the index of the active slide.
+     * The item width.
      */
-    index: number;
+    itemWidth: number;
 
     /**
      * Enable infinite loop mode.
      * @default false
      */
-    infinite?: boolean;
+    loop?: boolean;
 
     /**
      * Callback fired when an index is changed.
      */
-    onChange?: (newIndex: number) => void;
+    onIndexChange?: (newIndex: number) => void;
 
     /**
      * Takes an item from data and renders it into the list.
      */
-    renderItem: (info: Omit<ListRenderItemInfo<ItemT>, 'separators'>) => React.ReactElement | null;
-
-    /**
-     * Web only. Number of slides to scroll at once.
-     * @default 1
-     */
-    slidesToScroll?: number;
-
-    /**
-     * Web only. Number of slides to display.
-     * @default 1
-     */
-    slidesToShow?: number;
+    renderItem: RenderItem<ItemT>;
 
     /**
-     * Web only. Enable items to display at the center.
+     * Whether to enable scroll gesture.
      * @default true
      */
-    centerMode?: boolean;
-
-    /**
-     * Web only. Enable arrows to display.
-     * @default true
-     */
-    arrows?: boolean;
-
-    /**
-     * Web only. Style of arrows
-     * @default true
-     */
-    arrowsStyle?: object;
-
-    /**
-     * Web only. Style of track
-     * @default object
-     */
-    trackStyle?: object;
+    scrollEnabled?: boolean;
 
     /**
-     * Only web. Refer slick object
+     * The maximum number of items that can respond to pan gesture events.
+     * Due to the nature of the `active` item, it accepts only odd number. (e.g. 1, 3, 5...)
+     * 0 means all items will respond to pan gesture events.
+     * @default 5
      */
-    ref?: RefObject<any>;
+    windowSize?: number;
 }> {}

package/src/Carousel/animation/animationUtils.ts

@@ -0,0 +1 @@
+export const itemInterpolationInputRange = [-1, 0, 1];

package/src/Carousel/animation/createDefaultItemStyle.ts

@@ -0,0 +1,3 @@
+import normalItemStyleFactory from './normalItemStyleFactory';
+
+export default normalItemStyleFactory();

package/src/Carousel/animation/createDefaultScrollAnimation.ts

@@ -0,0 +1,13 @@
+import { Animated, Easing } from 'react-native';
+
+export default function createDefaultScrollAnimation(
+    animatedValue: Animated.Value,
+    toValue: number,
+): Animated.CompositeAnimation {
+    return Animated.timing(animatedValue, {
+        toValue: toValue,
+        duration: 350,
+        easing: Easing.bezier(0.25, 1, 0.5, 1),
+        useNativeDriver: true,
+    });
+};

package/src/Carousel/animation/index.ts

@@ -0,0 +1,4 @@
+export { default as createDefaultItemStyle } from './createDefaultItemStyle';
+export { default as createDefaultScrollAnimation } from './createDefaultScrollAnimation';
+export { default as normalItemStyleFactory } from './normalItemStyleFactory';
+export { default as parallaxItemStyleFactory } from './parallaxItemStyleFactory';

package/src/Carousel/animation/normalItemStyleFactory.ts

@@ -0,0 +1,19 @@
+import type { CreateItemStyle } from '../types';
+import { itemInterpolationInputRange } from './animationUtils';
+
+export default function normalItemStyleFactory() {
+    const createItemStyle: CreateItemStyle = (itemInterpolation, itemWidth) => {
+        const translate = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                -itemWidth,
+                0,
+                itemWidth,
+            ],
+        });
+
+        return { transform: [{ translateX: translate }] };
+    };
+
+    return createItemStyle;
+};

package/src/Carousel/animation/parallaxItemStyleFactory.ts

@@ -0,0 +1,79 @@
+import type { CreateItemStyle } from '../types';
+import { itemInterpolationInputRange } from './animationUtils';
+
+export interface ParallaxAnimationConfig {
+    activeItemScale?: number;
+    activeItemOpacity?: number;
+    adjacentItemScale?: number;
+    adjacentItemOpacity?: number;
+    scrollingOffset?: number;
+}
+
+const defaultParallaxAnimationConfig: Required<Readonly<ParallaxAnimationConfig>> = {
+    activeItemScale: 0.9,
+    activeItemOpacity: 1,
+    adjacentItemScale: Math.pow(0.9, 2),
+    adjacentItemOpacity: 0.5,
+    scrollingOffset: 50,
+};
+
+export default function parallaxItemStyleFactory(config: ParallaxAnimationConfig = defaultParallaxAnimationConfig) {
+    const {
+        activeItemOpacity,
+        activeItemScale,
+        adjacentItemOpacity,
+        adjacentItemScale,
+        scrollingOffset,
+    }: Required<ParallaxAnimationConfig> = {
+        ...config,
+        ...defaultParallaxAnimationConfig,
+    };
+
+    const createItemStyle: CreateItemStyle = (itemInterpolation, itemWidth) => {
+        const translate = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                -itemWidth + scrollingOffset,
+                0,
+                itemWidth - scrollingOffset,
+            ],
+        });
+
+        const zIndex = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [0, itemWidth, 0],
+            extrapolate: 'clamp',
+        });
+
+        const scale = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                adjacentItemScale,
+                activeItemScale,
+                adjacentItemScale,
+            ],
+            extrapolate: 'clamp',
+        });
+
+        const opacity = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                adjacentItemOpacity,
+                activeItemOpacity,
+                adjacentItemOpacity,
+            ],
+            extrapolate: 'clamp',
+        });
+
+        return {
+            transform: [
+                { translateX: translate },
+                { scale },
+            ],
+            zIndex,
+            opacity,
+        };
+    };
+
+    return createItemStyle;
+};

package/src/Carousel/components/InternalContext.ts

@@ -0,0 +1,33 @@
+import { createContext } from 'react';
+import { Animated } from 'react-native';
+import type { CreateItemStyle, ItemHeight, ItemVisibilityStore } from '../types';
+
+export interface InternalContextValue<ItemT> {
+    createItemStyle: CreateItemStyle;
+    data: ReadonlyArray<ItemT>;
+    globalInterpolation: Animated.AnimatedInterpolation;
+    itemHeight: ItemHeight;
+    itemWidth: number;
+    itemVisibilityStore: ItemVisibilityStore;
+    loop: boolean;
+}
+
+const mockItemVisibilityStore: ItemVisibilityStore = {
+    dispatch: () => void 0,
+    subscribe: () => () => void 0,
+    removeAllListeners: () => void 0,
+};
+
+const initialValue: Readonly<InternalContextValue<any>> = {
+    createItemStyle: () => ({}),
+    data: [],
+    globalInterpolation: Animated.add(new Animated.Value(0), 0),
+    itemHeight: 0,
+    itemWidth: 0,
+    itemVisibilityStore: mockItemVisibilityStore,
+    loop: false,
+};
+
+const InternalContext = createContext<InternalContextValue<any>>(initialValue);
+
+export default InternalContext;

package/src/Carousel/components/ItemView.tsx

@@ -0,0 +1,66 @@
+import type { ReactElement } from 'react';
+import React, { useContext, useEffect, useMemo, useState } from 'react';
+import type { ViewProps } from 'react-native';
+import { Animated } from 'react-native';
+import { StyleSheet } from '@fountain-ui/core';
+import { useItemInterpolation } from '../hooks';
+import InternalContext from './InternalContext';
+
+export interface ItemViewProps {
+    children: (interpolation: Animated.AnimatedInterpolation) => ReactElement | null;
+    index: number;
+    onLayout?: ViewProps['onLayout'];
+}
+
+export default function ItemView(props: ItemViewProps) {
+    const {
+        children,
+        index,
+        onLayout,
+    } = props;
+
+    const {
+        createItemStyle,
+        itemHeight,
+        itemWidth,
+        itemVisibilityStore,
+    } = useContext(InternalContext);
+
+    const [visible, setVisible] = useState(false);
+
+    const interpolation = useItemInterpolation(index);
+
+    const itemStyle = useMemo(
+        () => createItemStyle(interpolation, itemWidth),
+        [createItemStyle, interpolation],
+    );
+
+    useEffect(() => {
+        return itemVisibilityStore.subscribe(ranges => {
+            const nextVisible = ranges.some(([from, to]) => index >= from && index <= to);
+            setVisible(nextVisible);
+        });
+    }, [itemVisibilityStore]);
+
+    return (
+        <Animated.View
+            children={visible ? children(interpolation) : null}
+            onLayout={onLayout}
+            style={[
+                {
+                    width: itemWidth,
+                    height: itemHeight !== 'auto' ? itemHeight : undefined,
+                },
+                styles.absolute,
+                // @ts-ignore
+                itemStyle,
+            ]}
+        />
+    );
+};
+
+const styles = StyleSheet.create({
+    absolute: {
+        position: 'absolute',
+    },
+});