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

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;
+};

package/src/Carousel/hooks/useLoopedData.ts

@@ -0,0 +1,26 @@
+import { useMemo } from 'react';
+
+export default function useLoopedData<ItemT>(
+    originalData: ReadonlyArray<ItemT>,
+    loop: boolean,
+): ReadonlyArray<ItemT> {
+    return useMemo(() => {
+        if (!loop) {
+            return originalData;
+        }
+
+        const numberOfData = originalData.length;
+
+        if (numberOfData === 1) {
+            const [first] = originalData;
+            return [first, first, first];
+        }
+
+        if (numberOfData === 2) {
+            const [first, second] = originalData;
+            return [first, second, first, second];
+        }
+
+        return originalData;
+    }, [originalData, loop]);
+};

package/src/Carousel/hooks/usePagingAnimation.ts

@@ -0,0 +1,195 @@
+import { useCallback, useEffect, useMemo, useRef } from 'react';
+import { Animated, Platform } from 'react-native';
+import type {
+    CreateScrollAnimation,
+    DirectionalPagingAnimationConfig,
+    GetCurrentIndex,
+    IndexPagingAnimationConfig,
+    PagingAnimationConfig,
+    PagingAnimationType,
+    PagingDirection,
+    StartPagingAnimation,
+} from '../types';
+
+export interface PagingAnimationParameters {
+    controlledTx: Animated.Value;
+    createScrollAnimation: CreateScrollAnimation;
+    getCurrentIndex: GetCurrentIndex;
+    itemWidth: number;
+    lastIndex: number;
+    loop: boolean;
+    numberOfData: number;
+    offsetTx: Animated.Value;
+}
+
+export interface UsePagingAnimation {
+    finalizeAnimation: () => void;
+    globalInterpolation: Animated.AnimatedInterpolation;
+    startPagingAnimation: StartPagingAnimation;
+}
+
+function directionToValue(itemWidth: number) {
+    return function (direction: PagingDirection): number {
+        switch (direction) {
+            case 'next':
+                return -itemWidth;
+            case 'prev':
+                return itemWidth;
+            case 'stay':
+                return 0;
+        }
+    };
+}
+
+export default function usePagingAnimation(params: PagingAnimationParameters): UsePagingAnimation {
+    const {
+        controlledTx,
+        createScrollAnimation,
+        getCurrentIndex,
+        itemWidth,
+        lastIndex,
+        loop,
+        numberOfData,
+        offsetTx,
+    } = params;
+
+    const animationRef = useRef<Animated.CompositeAnimation | null>(null);
+    const toValueRef = useRef<number>(0);
+
+    const globalInterpolation = useMemo(
+        () => Animated.add(controlledTx, offsetTx),
+        [controlledTx, offsetTx],
+    );
+
+    useEffect(() => {
+        const subscriptionId = controlledTx.addListener((value) => {
+            const currentTx = value.value;
+
+            // Prevent infinite loop
+            if (currentTx !== 0) {
+                const maxWidth = numberOfData * itemWidth;
+
+                if (Math.abs(Math.round(currentTx)) === Math.round(maxWidth)) {
+                    // reset position
+                    controlledTx.setValue(0);
+                }
+            }
+        });
+
+        return () => {
+            controlledTx.removeListener(subscriptionId);
+        };
+    }, [numberOfData, itemWidth]);
+
+    const finalizeAnimation = useCallback(() => {
+        const stopUnfinishedSnapAnimation = () => {
+            if (animationRef.current) {
+                animationRef.current?.stop();
+                animationRef.current = null;
+            }
+        };
+
+        const resetBoundary = () => {
+            controlledTx.setOffset(toValueRef.current);
+            controlledTx.flattenOffset();
+
+            // FIXME: react-native-web bug maybe?
+            //  `AnimatedValue.flattenOffset()` does not trigger any event listener.
+            //  Accessing value directly via `_value` is dangerous but working on web (`useNativeDriver` always false).
+            //  So setting same value with `value.setValue(value._value)` will trigger event listener.
+            if (Platform.OS === 'web') {
+                // @ts-ignore
+                controlledTx.setValue(controlledTx._value);
+            }
+
+            offsetTx.setValue(0);
+            toValueRef.current = 0;
+        };
+
+        stopUnfinishedSnapAnimation();
+
+        resetBoundary();
+    }, [controlledTx]);
+
+    const startPagingAnimation = useCallback((type: PagingAnimationType, config: PagingAnimationConfig) => {
+        const configWithDefaults: PagingAnimationConfig = {
+            animated: true,
+            ...config,
+        };
+
+        const currentIndex = getCurrentIndex();
+
+        const getValueByDirectionOnAllAdjacentItemsVisible = directionToValue(itemWidth);
+
+        const getValueByDirectionalPagingOnLoopDisabled = (_config: DirectionalPagingAnimationConfig): number => {
+            const { direction, isOriginatedFromGesture } = _config;
+
+            if (currentIndex === 0 && direction === 'prev') {
+                return isOriginatedFromGesture
+                    ? getValueByDirectionOnAllAdjacentItemsVisible('stay')
+                    : -lastIndex * itemWidth; // last position
+            } else if (currentIndex === lastIndex && direction === 'next') {
+                return isOriginatedFromGesture
+                    ? getValueByDirectionOnAllAdjacentItemsVisible('stay')
+                    : lastIndex * itemWidth; // first position
+            }
+            return getValueByDirectionOnAllAdjacentItemsVisible(direction);
+        };
+
+        const getValueByDirectionalPaging = (_config: DirectionalPagingAnimationConfig): number => {
+            const _configWithDefaults: DirectionalPagingAnimationConfig = {
+                isOriginatedFromGesture: false,
+                ..._config,
+            };
+
+            return loop
+                ? getValueByDirectionOnAllAdjacentItemsVisible(_configWithDefaults.direction)
+                : getValueByDirectionalPagingOnLoopDisabled(_configWithDefaults);
+        };
+
+        const getValueByIndexPaging = ({ index }: IndexPagingAnimationConfig): number => {
+            if (index < 0 || index > lastIndex || index === currentIndex) {
+                // no animation if index is invalid or equals to current index
+                return 0;
+            }
+
+            const distance = Math.abs(currentIndex - index) * itemWidth;
+            const direction = index > currentIndex ? -1 : 1;
+
+            return distance * direction;
+        };
+
+        const toValue = type === 'directional'
+            // @ts-ignore
+            ? getValueByDirectionalPaging(configWithDefaults)
+            // @ts-ignore
+            : getValueByIndexPaging(configWithDefaults);
+
+        toValueRef.current = toValue;
+
+        if (configWithDefaults.animated) {
+            const animation = createScrollAnimation(offsetTx, toValue);
+            animationRef.current = animation;
+            animation.start(({ finished }) => {
+                if (finished) {
+                    finalizeAnimation();
+                }
+            });
+        } else {
+            finalizeAnimation();
+        }
+    }, [
+        createScrollAnimation,
+        getCurrentIndex,
+        finalizeAnimation,
+        itemWidth,
+        lastIndex,
+        loop,
+    ]);
+
+    return {
+        globalInterpolation,
+        finalizeAnimation,
+        startPagingAnimation,
+    };
+};

package/src/Carousel/index.ts

@@ -1,2 +1,4 @@
-export { default } from './CarouselWeb';
-export type { default as CarouselProps } from './CarouselProps';
+export { default } from './Carousel';
+export type { default as CarouselProps } from './CarouselProps';
+export type { CarouselInstance } from './types';
+export { normalItemStyleFactory, parallaxItemStyleFactory } from './animation';

package/src/Carousel/types.ts

@@ -0,0 +1,97 @@
+import type { ReactElement } from 'react';
+import type { Animated, ViewProps } from 'react-native';
+
+const directions = ['next', 'prev', 'stay'] as const;
+
+export type PagingDirection = (typeof directions)[number];
+
+export type ItemHeight = number | 'auto';
+
+export interface RenderItem<T> {
+    (info: { item: T, index: number, interpolation: Animated.AnimatedInterpolation }): ReactElement | null;
+}
+
+export interface CreateScrollAnimation {
+    (aValue: Animated.AnimatedValue, toValue: number): Animated.CompositeAnimation;
+}
+
+export interface CreateItemStyle {
+    (itemInterpolation: Animated.AnimatedInterpolation, itemWidth: number): Animated.AnimatedProps<ViewProps['style']>;
+}
+
+export interface GetCurrentIndex {
+    (): number;
+}
+
+export interface IndexController {
+    currentIndex: number;
+    getCurrentIndex: GetCurrentIndex;
+    lastIndex: number;
+    monitorElement: ReactElement;
+}
+
+export type PagingAnimationType = 'directional' | 'index';
+
+export interface BasePagingAnimationConfig {
+    animated?: boolean;
+}
+
+export interface DirectionalPagingAnimationConfig extends BasePagingAnimationConfig {
+    direction: PagingDirection;
+    isOriginatedFromGesture?: boolean;
+}
+
+export interface IndexPagingAnimationConfig extends BasePagingAnimationConfig {
+    index: number;
+}
+
+export type PagingAnimationConfig = DirectionalPagingAnimationConfig | IndexPagingAnimationConfig;
+
+export interface StartPagingAnimation {
+    (type: PagingAnimationType, config: PagingAnimationConfig): void;
+}
+
+export type VisibleIndexRanges = Array<[number, number]>;
+
+export interface StoreSubscription {
+    (): void;
+}
+
+export interface ItemVisibilityStore {
+    dispatch: (ranges: VisibleIndexRanges) => void;
+    subscribe: (listener: (ranges: VisibleIndexRanges) => void) => StoreSubscription;
+    removeAllListeners: () => void;
+}
+
+export interface AutoplayController {
+    pause: () => void;
+    resume: () => void;
+}
+
+export interface ScrollToOption {
+    index: number;
+    animated?: boolean;
+}
+
+export interface CarouselInstance {
+    /**
+     * Get current visible item index.
+     */
+    getCurrentIndex: GetCurrentIndex;
+
+    /**
+     * Scroll to next visible item.
+     */
+    next: () => void;
+
+    /**
+     * Scroll to previous visible item.
+     */
+    prev: () => void;
+
+    /**
+     * Scroll to desired indexed item.
+     * Invalid index is ignored.
+     */
+    scrollTo: (option: ScrollToOption) => void;
+}