react-native-speedy-list/lib/components/RecyclableList/types.d.ts

A performance focused list component for React Native.

import React from "react";
import { ScrollViewProps, StyleProp, ViewStyle } from "react-native";
/**
 * Default value for the initial render batch count.
 * */
export declare const INITIAL_BATCH_SIZE = 8;
/**
 * Default amount of recyclable items.
 * */
export declare const RECYCLABLE_ITEMS_COUNT = 32;
/**
 * Delay in milliseconds between list updates.
 * */
export declare const RECYCLING_DELAY = 32;
/**
 * Function responsible for list items rendering.
 * */
export declare type RecyclableListItemRenderer<T> = (props: RecyclableListItemProps<T>) => React.ReactElement;
/**
 * Defines a list item layout.
 * */
export interface RecyclableListItemLayout {
    top: number;
    height: number;
}
/**
 * Defines a list item props.
 * */
export interface RecyclableListItemProps<T> {
    item: T;
    index: number;
    height: number;
}
/**
 * Used as a param type for the main methods.
 * */
export declare type RecyclableListItemMeta<T> = Omit<RecyclableListItemProps<T>, "height">;
/**
 * Internally stores metadata about each item.
 * */
export interface RecyclableListItemInternalMeta<T> {
    key: string;
    item: T;
    index: number;
    layout: RecyclableListItemLayout;
    recyclableViewIndex: number | null;
}
/**
 * Defines the list props.
 * */
export interface RecyclableListProps<T> {
    /**
     * List entries.
     * */
    items: Array<T>;
    /**
     * Function to render a list item.
     * */
    itemRenderer: RecyclableListItemRenderer<T>;
    /**
     * Value or function to define each list item height.
     * */
    itemHeight: number | ((meta: RecyclableListItemMeta<T>) => number);
    /**
     * Prop name or function to provide a unique key for the given item.
     * */
    itemKey: keyof T | ((meta: RecyclableListItemMeta<T>) => number | string);
    /**
     * Function to compare two entries.
     * */
    itemEquals: (a: T, b: T) => boolean;
    /**
     * Called when the ScrollView reaches the bottom.
     * */
    onEndReached?: () => void;
    onEndReachedOffset?: number;
    /**
     * List header and footer elements.
     * */
    header?: React.ReactNode;
    footer?: React.ReactNode;
    /**
     * Initial render batch size.
     * */
    initialBatchSize: number;
    /**
     * How many recyclable items to render.
     * */
    recyclableItemsCount: number;
    /**
     * Delay between list updates.
     * */
    recyclingDelay: number;
    /**
     * Props for the ScrollView component.
     * */
    scrollViewProps?: ScrollViewProps;
    /**
     * Style overrides.
     * */
    headerStyle?: StyleProp<ViewStyle>;
    contentStyle?: StyleProp<ViewStyle>;
    footerStyle?: StyleProp<ViewStyle>;
    /**
     * Enables debug logs.
     * */
    debug?: boolean;
}