@fountain-ui/lab 2.0.0-beta.11 → 2.0.0-beta.12

package/src/Carousel/animation/parallaxItemStyleFactory.ts

@@ -0,0 +1,79 @@
+import type { CreateItemStyle } from '../types';
+import { itemInterpolationInputRange } from './animationUtils';
+
+export interface ParallaxAnimationConfig {
+    parallaxActiveItemScale?: number;
+    parallaxActiveItemOpacity?: number;
+    parallaxAdjacentItemScale?: number;
+    parallaxAdjacentItemOpacity?: number;
+    parallaxScrollingOffset?: number;
+}
+
+const defaultParallaxAnimationConfig: Required<Readonly<ParallaxAnimationConfig>> = {
+    parallaxActiveItemScale: 0.9,
+    parallaxActiveItemOpacity: 1,
+    parallaxAdjacentItemScale: Math.pow(0.9, 2),
+    parallaxAdjacentItemOpacity: 0.5,
+    parallaxScrollingOffset: 50,
+};
+
+export default function parallaxItemStyleFactory(config: ParallaxAnimationConfig = defaultParallaxAnimationConfig) {
+    const {
+        parallaxActiveItemScale,
+        parallaxActiveItemOpacity,
+        parallaxAdjacentItemOpacity,
+        parallaxAdjacentItemScale,
+        parallaxScrollingOffset,
+    }: Required<ParallaxAnimationConfig> = {
+        ...config,
+        ...defaultParallaxAnimationConfig,
+    };
+
+    const createItemStyle: CreateItemStyle = (itemInterpolation, itemWidth) => {
+        const translate = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                -itemWidth + parallaxScrollingOffset,
+                0,
+                itemWidth - parallaxScrollingOffset,
+            ],
+        });
+
+        const zIndex = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [0, itemWidth, 0],
+            extrapolate: 'clamp',
+        });
+
+        const scale = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                parallaxAdjacentItemScale,
+                parallaxActiveItemScale,
+                parallaxAdjacentItemScale,
+            ],
+            extrapolate: 'clamp',
+        });
+
+        const opacity = itemInterpolation.interpolate({
+            inputRange: itemInterpolationInputRange,
+            outputRange: [
+                parallaxAdjacentItemOpacity,
+                parallaxActiveItemOpacity,
+                parallaxAdjacentItemOpacity,
+            ],
+            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, ItemVisibilityStore } from '../types';
+
+export interface InternalContextValue<ItemT> {
+    createItemStyle: CreateItemStyle;
+    data: ReadonlyArray<ItemT>;
+    globalInterpolation: Animated.AnimatedInterpolation;
+    itemHeight: number;
+    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,56 @@
+import type { ReactElement } from 'react';
+import React, { useContext, useEffect, useMemo, useState } from 'react';
+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;
+}
+
+export default function ItemView(props: ItemViewProps) {
+    const { children, index } = 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}
+            style={[
+                { width: itemWidth, height: itemHeight },
+                styles.absolute,
+                // @ts-ignore
+                itemStyle,
+            ]}
+        />
+    );
+};
+
+const styles = StyleSheet.create({
+    absolute: {
+        position: 'absolute',
+    },
+});

package/src/Carousel/components/RootView.tsx

@@ -0,0 +1,66 @@
+import React, { memo, ReactElement, forwardRef } from 'react';
+import type { ViewProps, View } from 'react-native';
+import { Animated } from 'react-native';
+import { StyleSheet } from '@fountain-ui/core';
+import type { RenderItem } from '../types';
+import ItemView from './ItemView';
+
+const styles = StyleSheet.create({
+    root: {
+        width: '100%',
+        justifyContent: 'center',
+    },
+    horizontal: {
+        flexDirection: 'row',
+        overflow: 'hidden',
+    },
+});
+
+export type RootViewProps<ItemT> = ViewProps & {
+    data: ReadonlyArray<ItemT>;
+    itemHeight: number;
+    originalData: ReadonlyArray<ItemT>;
+    renderItem: RenderItem<ItemT>;
+};
+
+const RootView = forwardRef<View, RootViewProps<any>>(function RootView(props, ref) {
+    const {
+        data,
+        itemHeight,
+        originalData,
+        renderItem,
+        style,
+        ...otherProps
+    } = props;
+
+    const renderItemView = (item: any, index: number): ReactElement => (
+        <ItemView
+            key={index}
+            index={index}
+        >
+            {(interpolation) => renderItem({
+                item,
+                index: index % originalData.length,
+                interpolation,
+            })}
+        </ItemView>
+    );
+
+    const viewStyles = [
+        styles.root,
+        styles.horizontal,
+        { height: itemHeight },
+        style,
+    ];
+
+    return (
+        <Animated.View
+            ref={ref}
+            {...otherProps}
+            children={data.map(renderItemView)}
+            style={viewStyles}
+        />
+    );
+});
+
+export default memo(RootView);

package/src/Carousel/components/ScrollViewGesture.tsx

@@ -0,0 +1,80 @@
+import type { ReactNode } from 'react';
+import React, { useCallback } from 'react';
+import { Animated } from 'react-native';
+import type { PanGestureHandlerStateChangeEvent } from 'react-native-gesture-handler';
+import { PanGestureHandler, State as GestureHandlerState } from 'react-native-gesture-handler';
+import type { AutoplayController, PagingDirection, StartPagingAnimation } from '../types';
+
+export interface ScrollViewGestureProps {
+    autoplayController: AutoplayController;
+    children: ReactNode;
+    finalizeAnimation: () => void;
+    offsetTx: Animated.Value,
+    scrollEnabled: boolean;
+    startAnimation: StartPagingAnimation;
+}
+
+const SCROLL_TO_ADJACENT_TX_THRESHOLD = 60;
+const SCROLL_TO_ADJACENT_VX_THRESHOLD = 500;
+
+const ACTIVE_OFFSET_ABS_X = 5;
+const activeOffsetX: number[] = [-ACTIVE_OFFSET_ABS_X, ACTIVE_OFFSET_ABS_X];
+
+const endAnimationStates: Readonly<GestureHandlerState[]> = [
+    GestureHandlerState.CANCELLED,
+    GestureHandlerState.END,
+];
+
+function shouldScrollToAdjacent(translationX: number, velocityX: number): boolean {
+    return Math.abs(translationX) >= SCROLL_TO_ADJACENT_TX_THRESHOLD
+        || Math.abs(velocityX) >= SCROLL_TO_ADJACENT_VX_THRESHOLD;
+}
+
+export default function ScrollViewGesture(props: ScrollViewGestureProps) {
+    const {
+        autoplayController,
+        children,
+        finalizeAnimation,
+        offsetTx,
+        scrollEnabled,
+        startAnimation,
+    } = props;
+
+    const { pause: pauseAutoplay, resume: resumeAutoplay } = autoplayController;
+
+    const handleGestureBegin = useCallback(() => {
+        pauseAutoplay();
+
+        finalizeAnimation();
+    }, [finalizeAnimation, pauseAutoplay]);
+
+    const handleGestureEvent = useCallback(Animated.event(
+        [{ nativeEvent: { translationX: offsetTx } }],
+        { useNativeDriver: true },
+    ), []);
+
+    const handleHandlerStateChange = useCallback((event: PanGestureHandlerStateChangeEvent) => {
+        const { nativeEvent: { translationX, velocityX, state } } = event;
+
+        if (endAnimationStates.includes(state)) {
+            const userDirection: PagingDirection = shouldScrollToAdjacent(translationX, velocityX)
+                ? (translationX < 0 ? 'next' : 'prev')
+                : 'stay';
+
+            startAnimation(userDirection, true);
+
+            resumeAutoplay();
+        }
+    }, [startAnimation, resumeAutoplay]);
+
+    return (
+        <PanGestureHandler
+            activeOffsetX={activeOffsetX}
+            children={children}
+            enabled={scrollEnabled}
+            onBegan={handleGestureBegin}
+            onGestureEvent={handleGestureEvent}
+            onHandlerStateChange={handleHandlerStateChange}
+        />
+    );
+}

package/src/Carousel/components/index.ts

@@ -0,0 +1,4 @@
+export { default as InternalContext } from './InternalContext';
+export { default as ItemView } from './ItemView';
+export { default as RootView } from './RootView';
+export { default as ScrollViewGesture } from './ScrollViewGesture';

package/src/Carousel/hooks/index.ts

@@ -0,0 +1,7 @@
+export { default as useAutoplayController } from './useAutoplayController';
+export { default as useDimensionChangeReaction } from './useDimensionChangeReaction';
+export { default as useIndexController } from './useIndexController';
+export { default as useItemInterpolation } from './useItemInterpolation';
+export { default as useLoopedData } from './useLoopedData';
+export { default as usePagingAnimation } from './usePagingAnimation';
+export { default as useItemVisibilityStore } from './useItemVisibilityStore';

package/src/Carousel/hooks/useAutoplayController.ts

@@ -0,0 +1,54 @@
+import { useCallback, useEffect, useRef } from 'react';
+import type { AutoplayController, StartPagingAnimation } from '../types';
+import { useDeferredExecutor } from '../../hooks';
+
+export interface AutoplayConfig {
+    enabled: boolean;
+    intervalMillis: number;
+    startPagingAnimation: StartPagingAnimation;
+}
+
+export default function useAutoplayController(config: AutoplayConfig): AutoplayController {
+    const {
+        enabled,
+        intervalMillis,
+        startPagingAnimation,
+    } = config;
+
+    const paused = useRef<boolean>(false);
+
+    const executor = useDeferredExecutor();
+
+    const play = useCallback(() => {
+        if (paused.current) {
+            return;
+        }
+
+        executor.execute(() => {
+            startPagingAnimation('next', false);
+            play();
+        }, intervalMillis);
+    }, [intervalMillis, startPagingAnimation]);
+
+    const pause = useCallback(() => {
+        executor.cancel();
+        paused.current = true;
+    }, []);
+
+    const resume = useCallback(() => {
+        paused.current = false;
+        if (enabled) {
+            play();
+        }
+    }, [play, enabled]);
+
+    useEffect(() => {
+        if (enabled) {
+            resume();
+        } else {
+            pause();
+        }
+    }, [enabled]);
+
+    return { pause, resume };
+};

package/src/Carousel/hooks/useDimensionChangeReaction.ts

@@ -0,0 +1,25 @@
+import { useEffect } from 'react';
+import { Animated } from 'react-native';
+
+export interface Parameters {
+    controlledTx: Animated.AnimatedValue;
+    currentIndex: number;
+    itemWidth: number;
+}
+
+export default function useDimensionChangeReaction(params: Parameters) {
+    const {
+        controlledTx,
+        currentIndex,
+        itemWidth,
+    } = params;
+
+    useEffect(() => {
+        const newTx = -currentIndex * itemWidth;
+        controlledTx.setValue(newTx);
+    }, [
+        controlledTx,
+        currentIndex,
+        itemWidth,
+    ]);
+};

package/src/Carousel/hooks/useIndexController.tsx

@@ -0,0 +1,76 @@
+import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
+import { Animated } from 'react-native';
+import type { IndexController } from '../types';
+
+export interface UseIndexControllerParameters {
+    controlledTx: Animated.AnimatedValue;
+    initialIndex: number;
+    itemWidth: number;
+    numberOfOriginalData: number;
+    onIndexChange?: (newIndex: number) => void;
+}
+
+const normalizeIndex = (maybeIndex: number, numberOfData: number): number =>
+    Math.abs(Math.floor(maybeIndex)) % numberOfData;
+
+export default function useIndexController(params: UseIndexControllerParameters): IndexController {
+    const {
+        controlledTx,
+        initialIndex,
+        itemWidth,
+        numberOfOriginalData,
+        onIndexChange,
+    } = params;
+
+    const indexRef = useRef<number>(initialIndex);
+    const [index, setIndex] = useState<number>(indexRef.current);
+
+    const maybeIndex = useMemo(() => {
+        const negative = new Animated.Value(-1);
+        const reversedTx = Animated.multiply(controlledTx, negative);
+        const normalized = Animated.divide(reversedTx, itemWidth);
+        return Animated.modulo(normalized, numberOfOriginalData);
+    }, [
+        controlledTx,
+        itemWidth,
+        numberOfOriginalData,
+    ]);
+
+    useEffect(() => {
+        const subscriptionId = maybeIndex.addListener((observedValue) => {
+            const newIndex = normalizeIndex(observedValue.value, numberOfOriginalData);
+
+            if (indexRef.current !== newIndex) {
+                indexRef.current = newIndex;
+                setIndex(newIndex);
+
+                onIndexChange?.(newIndex);
+            }
+        });
+
+        return () => {
+            maybeIndex.removeListener(subscriptionId);
+        };
+    }, [
+        maybeIndex,
+        numberOfOriginalData,
+        onIndexChange,
+    ]);
+
+    const getCurrentIndex = useCallback(() => indexRef.current, []);
+
+    return {
+        currentIndex: index,
+        getCurrentIndex,
+        lastIndex: numberOfOriginalData - 1,
+        monitorElement: (
+            <Animated.View
+                collapsable={false}
+                style={[
+                    { zIndex: maybeIndex },
+                    { width: 1, height: 1, position: 'absolute' },
+                ]}
+            />
+        ),
+    };
+};

package/src/Carousel/hooks/useItemInterpolation.ts

@@ -0,0 +1,107 @@
+import { useContext, useMemo } from 'react';
+import { Animated } from 'react-native';
+import { InternalContext } from '../components';
+
+const OVERSCROLL_FRICTION_FACTOR = 4;
+
+export default function useItemInterpolation(index: number): Animated.AnimatedInterpolation {
+    const {
+        itemWidth,
+        data,
+        globalInterpolation,
+        loop,
+    } = useContext(InternalContext);
+
+    const numberOfData = data.length;
+
+    const interpolationConfigOnLoop = useMemo<Animated.InterpolationConfigType>(() => {
+        const lastIndex = numberOfData - 1;
+        const maxWidth = Math.abs(itemWidth * numberOfData);
+        const halfOfItemWidth = 0.5 * itemWidth;
+
+        const positiveCount = Math.round(lastIndex / 2);
+        const startPosition = index > positiveCount
+            ? (index - numberOfData) * itemWidth
+            : itemWidth * index;
+
+        const max = positiveCount * itemWidth;
+        const min = -((lastIndex - positiveCount) * itemWidth);
+
+        const inputRange = [
+            -maxWidth,
+            min - halfOfItemWidth - startPosition - Number.MIN_VALUE,
+            min - halfOfItemWidth - startPosition,
+            0,
+            max + halfOfItemWidth - startPosition,
+            max + halfOfItemWidth - startPosition + Number.MIN_VALUE,
+            maxWidth,
+        ];
+
+        const outputRange = [
+            startPosition,
+            max + halfOfItemWidth - Number.MIN_VALUE,
+            min - halfOfItemWidth,
+            startPosition,
+            max + halfOfItemWidth,
+            min - halfOfItemWidth + Number.MIN_VALUE,
+            startPosition,
+        ];
+
+        return {
+            inputRange,
+            outputRange,
+            extrapolate: 'clamp',
+        };
+    }, [
+        index,
+        itemWidth,
+        numberOfData,
+    ]);
+
+    const interpolationConfigOnNoLoop = useMemo<Animated.InterpolationConfigType>(() => {
+        const lastIndex = numberOfData - 1;
+        const maxWidth = itemWidth * lastIndex;
+        const startPosition = itemWidth * index;
+        const friction = itemWidth / OVERSCROLL_FRICTION_FACTOR;
+
+        const inputRange = [
+            -(maxWidth + itemWidth), // overscroll
+            -maxWidth,
+            0,
+            itemWidth, // overscroll
+        ];
+
+        const outputRange = [
+            -maxWidth + startPosition - friction,
+            -maxWidth + startPosition,
+            startPosition,
+            startPosition + friction,
+        ];
+
+        return {
+            inputRange,
+            outputRange,
+            extrapolate: 'clamp',
+        };
+    }, [
+        index,
+        itemWidth,
+        numberOfData,
+    ]);
+
+    return useMemo(() => {
+        const interpolationConfig = loop
+            ? interpolationConfigOnLoop
+            : interpolationConfigOnNoLoop;
+
+        const offsetX = globalInterpolation.interpolate(interpolationConfig);
+
+        return Animated.divide(offsetX, itemWidth);
+    }, [
+        globalInterpolation,
+        interpolationConfigOnLoop,
+        interpolationConfigOnNoLoop,
+        itemWidth,
+        loop,
+    ]);
+};

package/src/Carousel/hooks/useItemVisibilityStore.ts

@@ -0,0 +1,107 @@
+import { useEffect, useRef, useState } from 'react';
+import type { ItemVisibilityStore, VisibleIndexRanges } from '../types';
+
+export interface Parameters {
+    currentIndex: number;
+    numberOfData: number;
+    windowSize: number;
+}
+
+class SimpleItemVisibilityStore implements ItemVisibilityStore {
+
+    private store: VisibleIndexRanges;
+
+    constructor(initialValue: VisibleIndexRanges) {
+        this.store = initialValue;
+    }
+
+    private listeners: Array<(ranges: VisibleIndexRanges) => void> = [];
+
+    subscribe(listener: (ranges: VisibleIndexRanges) => void) {
+        this.listeners.push(listener);
+
+        listener(this.store);
+
+        return () => {
+            const index = this.listeners.indexOf(listener);
+            this.listeners.splice(index, 1);
+        };
+    }
+
+    dispatch(ranges: VisibleIndexRanges): void {
+        this.store = ranges;
+        for (const id in this.listeners) {
+            const listener = this.listeners[id];
+            listener?.(ranges);
+        }
+    }
+
+    removeAllListeners(): void {
+        this.listeners.splice(0, this.listeners.length);
+    }
+
+}
+
+function normalize(windowSize: number, numberOfData: number): number {
+    if (windowSize <= 0) {
+        return numberOfData;
+    }
+    if (windowSize > 0 && windowSize % 2 === 0) {
+        return windowSize + 1;
+    }
+    return windowSize;
+}
+
+function mod(value: number, modulo: number): number {
+    return ((value % modulo) + modulo) % modulo;
+}
+
+function makeVisibleIndexRanges(numberOfData: number, windowSize: number, index: number): VisibleIndexRanges {
+    const ws = normalize(windowSize, numberOfData);
+
+    const firstIndex = 0;
+    const lastIndex = numberOfData - 1;
+    const halfNumberOfAdjacent = Math.floor(ws / 2);
+
+    const leftSide = index - halfNumberOfAdjacent;
+    const rightSide = index + halfNumberOfAdjacent;
+
+    const leftRanges = leftSide >= 0
+        ? [[leftSide, index]]
+        : [[firstIndex, index], [mod(leftSide, numberOfData), lastIndex]];
+
+    const rightRanges = rightSide < numberOfData
+        ? [[index, rightSide]]
+        : [[index, lastIndex], [firstIndex, mod(rightSide, numberOfData)]];
+
+    // @ts-ignore
+    return [
+        ...leftRanges,
+        ...rightRanges,
+    ];
+}
+
+export default function useItemVisibilityStore(params: Parameters): ItemVisibilityStore {
+    const {
+        currentIndex,
+        numberOfData,
+        windowSize,
+    } = params;
+
+    const [initialRange] = useState(() => makeVisibleIndexRanges(numberOfData, windowSize, currentIndex));
+    const store = useRef(new SimpleItemVisibilityStore(initialRange)).current;
+
+    useEffect(() => {
+        const newRanges = makeVisibleIndexRanges(numberOfData, windowSize, currentIndex);
+
+        store.dispatch(newRanges);
+    }, [currentIndex, numberOfData, windowSize]);
+
+    useEffect(() => {
+        return () => {
+            store.removeAllListeners();
+        };
+    }, []);
+
+    return store;
+};