@rific/scroll-view 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,210 @@
+import * as react from 'react';
+import { ComponentType, ReactNode, RefObject } from 'react';
+import { NativeSyntheticEvent, NativeScrollEvent, StyleProp, ViewStyle, FlatListProps as FlatListProps$1, FlatList as FlatList$1, ScrollViewProps as ScrollViewProps$1, ScrollView as ScrollView$1, SectionListProps as SectionListProps$1, SectionList as SectionList$1 } from 'react-native';
+import { GestureType } from 'react-native-gesture-handler';
+import * as redux from 'redux';
+import * as _reduxjs_toolkit from '@reduxjs/toolkit';
+import { PayloadAction } from '@reduxjs/toolkit';
+import * as react_native_reanimated from 'react-native-reanimated';
+import { SharedValue } from 'react-native-reanimated';
+
+type ScrollToOffsetRef = {
+    scrollToOffset: (params: {
+        animated?: boolean;
+        offset: number;
+    }) => void;
+};
+type CustomListProps<P extends object> = Omit<P, 'contentInset' | 'contentOffset' | 'onScroll' | 'refreshControl' | 'scrollEventThrottle'> & {
+    component: ComponentType<P>;
+    renderFilters?: ReactNode;
+    footerFixed?: boolean;
+    gesture?: GestureType;
+    headerFixed?: boolean;
+    keyboardAware?: boolean;
+    onMomentumScrollEnd?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onRefresh?: () => Promise<void> | void;
+    onScrollBeginDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollEndDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    pullSearchHeight?: number;
+    scrollRef?: RefObject<ScrollToOffsetRef | null>;
+    style?: StyleProp<ViewStyle>;
+};
+declare const CustomListInner: <P extends object>({ component: List, renderFilters, footerFixed: footerFixedProp, gesture, headerFixed: headerFixedProp, keyboardAware, onMomentumScrollEnd: externalMomentumScrollEnd, onRefresh, onScrollBeginDrag: externalScrollBeginDrag, onScrollEndDrag: externalScrollEndDrag, pullSearchHeight, scrollRef, style, ...props }: CustomListProps<P>) => react.JSX.Element;
+declare const CustomList: typeof CustomListInner;
+
+type FlatListProps<T> = Omit<FlatListProps$1<T>, 'onRefresh' | 'refreshing'> & {
+    renderFilters?: ReactNode;
+    footerFixed?: boolean;
+    gesture?: GestureType;
+    headerFixed?: boolean;
+    keyboardAware?: boolean;
+    onMomentumScrollEnd?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onRefresh?: () => Promise<void> | void;
+    onScrollBeginDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollEndDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    pullSearchHeight?: number;
+    ref?: RefObject<FlatList$1 | null>;
+};
+declare const FlatListInner: <T>({ contentContainerStyle: externalContentContainerStyle, data, initialNumToRender, maxToRenderPerBatch, renderFilters, footerFixed: footerFixedProp, gesture, headerFixed: headerFixedProp, horizontal, keyboardAware, ListHeaderComponent: externalListHeaderComponent, onMomentumScrollEnd: externalMomentumScrollEnd, onRefresh, onScrollBeginDrag: externalScrollBeginDrag, onScrollEndDrag: externalScrollEndDrag, pagingEnabled, pullSearchHeight, removeClippedSubviews, showsHorizontalScrollIndicator, showsVerticalScrollIndicator, style, onContentSizeChange, ref: externalRef, windowSize, ...props }: FlatListProps<T>) => react.JSX.Element;
+declare const FlatList: typeof FlatListInner;
+
+type PullSearchHandle = {
+    blur: () => void;
+    focus: () => void;
+};
+type PullSearchProps = {
+    debounce?: boolean;
+    onChangeText: (text: string) => void;
+    onHeightChange: (height: number) => void;
+    placeholder?: string;
+    value?: string;
+};
+declare const PullSearch: react.ForwardRefExoticComponent<PullSearchProps & react.RefAttributes<PullSearchHandle>>;
+
+type ScrollViewSettings = {
+    backActionFixed: boolean;
+    footerFixed: boolean;
+    headerFixed: boolean;
+    snapBack: boolean;
+    snapBackFooter?: boolean;
+    snapBackHeader?: boolean;
+};
+declare const defaultScrollViewSettings: ScrollViewSettings;
+type ScrollViewSettingsContextType = {
+    settings: ScrollViewSettings;
+    set: (patch: Partial<ScrollViewSettings>) => void;
+};
+declare const ScrollViewSettingsContext: react.Context<ScrollViewSettingsContextType>;
+
+declare const scrollViewActions: _reduxjs_toolkit.CaseReducerActions<{
+    initialize: (_state: {
+        backActionFixed: boolean;
+        footerFixed: boolean;
+        headerFixed: boolean;
+        snapBack: boolean;
+        snapBackFooter?: boolean | undefined;
+        snapBackHeader?: boolean | undefined;
+    }, action: PayloadAction<ScrollViewSettings>) => ScrollViewSettings;
+}, "scrollView">;
+declare const scrollViewReducer: redux.Reducer<ScrollViewSettings>;
+
+type ScrollViewProps = ScrollViewProps$1 & {
+    footerFixed?: boolean;
+    gesture?: GestureType;
+    headerFixed?: boolean;
+    keyboardAware?: boolean;
+    onRefresh?: () => void;
+    onScrollBeginDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollEndDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    pullSearchHeight?: number;
+    ref?: RefObject<ScrollView$1 | null>;
+    refreshing?: boolean;
+};
+declare const ScrollViewInner: ({ children, footerFixed: footerFixedProp, gesture, headerFixed: headerFixedProp, horizontal, keyboardAware, onMomentumScrollEnd: externalMomentumScrollEnd, onRefresh, onScrollBeginDrag: externalScrollBeginDrag, onScrollEndDrag: externalScrollEndDrag, pullSearchHeight, refreshing, style, ...props }: ScrollViewProps) => react.JSX.Element;
+declare const ScrollView: typeof ScrollViewInner;
+
+type ScrollViewContextType = {
+    blur: boolean;
+    footerHeight: number;
+    footerHeightShared: SharedValue<number>;
+    footerFixed: boolean;
+    footerOffset: SharedValue<number>;
+    headerHeight: number;
+    headerHeightShared: SharedValue<number>;
+    headerFixed: boolean;
+    headerOffset: SharedValue<number>;
+    progress: number | null;
+    pullSearchHeightShared: SharedValue<number>;
+    snapBackFooterShared: SharedValue<boolean>;
+    snapBackHeaderShared: SharedValue<boolean>;
+    progressing: boolean;
+    scrollHeight: number;
+    scrollPosition: SharedValue<number>;
+    setFooterHeight: (h: number) => void;
+    setHeaderHeight: (h: number) => void;
+    setProgress: (p: number | null) => void;
+    setProgressing: (b: boolean) => void;
+    tabBarHeight: number;
+};
+declare const ScrollViewContext: react.Context<ScrollViewContextType>;
+
+type ScrollViewFooterProps = {
+    children?: ReactNode | ReactNode[];
+    style?: ViewStyle;
+};
+declare const ScrollViewFooter: ({ children, style }: ScrollViewFooterProps) => react.JSX.Element;
+
+type ScrollViewHeaderProps = {
+    actionSize?: number;
+    actionStyle?: ViewStyle;
+    backAction?: () => void;
+    backActionFixed?: boolean;
+    caption?: string;
+    centerContent?: ReactNode;
+    children?: ReactNode | ReactNode[];
+    iconSize?: number;
+    style?: ViewStyle;
+    title?: string;
+    topInset?: boolean;
+    trailingAction?: ReactNode;
+    trailingActionFixed?: boolean;
+};
+declare const ScrollViewHeader: ({ actionSize, actionStyle, backAction, backActionFixed, caption, centerContent, children, iconSize, style, title, topInset, trailingAction, trailingActionFixed }: ScrollViewHeaderProps) => react.JSX.Element;
+
+type ScrollViewProviderProps = {
+    blur?: boolean;
+    children: ReactNode;
+    fixed?: boolean;
+    footerFixed?: boolean;
+    headerFixed?: boolean;
+    snapBack?: boolean;
+    snapBackFooter?: boolean;
+    snapBackHeader?: boolean;
+    tabBarHeight?: number;
+};
+declare const ScrollViewProvider: ({ blur, children, fixed, footerFixed, headerFixed, snapBack, snapBackFooter, snapBackHeader, tabBarHeight }: ScrollViewProviderProps) => react.JSX.Element;
+
+type ScrollViewSettingsProviderProps = {
+    children: ReactNode;
+    onChange?: (settings: ScrollViewSettings) => void;
+    value?: Partial<ScrollViewSettings>;
+};
+declare const ScrollViewSettingsProvider: ({ children, onChange, value }: ScrollViewSettingsProviderProps) => react.JSX.Element;
+
+type SectionListProps<ItemT, SectionT extends {
+    data: ReadonlyArray<ItemT>;
+} = {
+    data: ReadonlyArray<ItemT>;
+}> = Omit<SectionListProps$1<ItemT, SectionT>, 'horizontal'> & {
+    renderFilters?: ReactNode;
+    footerFixed?: boolean;
+    gesture?: GestureType;
+    headerFixed?: boolean;
+    keyboardAware?: boolean;
+    onMomentumScrollEnd?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollBeginDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    onScrollEndDrag?: (e: NativeSyntheticEvent<NativeScrollEvent>) => void;
+    pullSearchHeight?: number;
+    ref?: RefObject<SectionList$1<ItemT, SectionT> | null>;
+};
+declare const SectionListInner: <ItemT, SectionT extends {
+    data: ReadonlyArray<ItemT>;
+} = {
+    data: ReadonlyArray<ItemT>;
+}>({ contentContainerStyle: externalContentContainerStyle, initialNumToRender, maxToRenderPerBatch, renderFilters, footerFixed: footerFixedProp, gesture, headerFixed: headerFixedProp, keyboardAware, ListHeaderComponent: externalListHeaderComponent, onMomentumScrollEnd: externalMomentumScrollEnd, onRefresh, onContentSizeChange, onScrollBeginDrag: externalScrollBeginDrag, onScrollEndDrag: externalScrollEndDrag, pullSearchHeight, refreshing, removeClippedSubviews, sections, showsVerticalScrollIndicator, style, ref: externalRef, windowSize, ...props }: SectionListProps<ItemT, SectionT>) => react.JSX.Element;
+declare const SectionList: typeof SectionListInner;
+
+declare const useKeyboardInset: () => number;
+
+declare const useScrollView: () => {
+    progress: number | null;
+    progressing: boolean;
+    scrollHeight: number;
+    scrollPosition: react_native_reanimated.SharedValue<number>;
+    setProgress: (p: number | null) => void;
+    setProgressing: (b: boolean) => void;
+};
+
+declare const useScrollViewSettings: () => ScrollViewSettingsContextType;
+
+export { CustomList, type CustomListProps, FlatList, type FlatListProps, PullSearch, type PullSearchHandle, type PullSearchProps, ScrollView, ScrollViewContext, type ScrollViewContextType, ScrollViewFooter, type ScrollViewFooterProps, ScrollViewHeader, type ScrollViewHeaderProps, type ScrollViewProps, ScrollViewProvider, type ScrollViewProviderProps, type ScrollViewSettings, ScrollViewSettingsContext, type ScrollViewSettingsContextType, ScrollViewSettingsProvider, type ScrollViewSettingsProviderProps, SectionList, type SectionListProps, defaultScrollViewSettings, scrollViewActions, scrollViewReducer, useKeyboardInset, useScrollView, useScrollViewSettings };