@react-native-ohos/flash-list/dist/GridLayoutProviderWithProps.d.ts

FlashList is a more performant FlatList replacement

/**
 * MIT License
 *
 * Copyright (C) 2024 Huawei Device Co., Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
import { Dimension, GridLayoutProvider, Layout, LayoutManager } from "recyclerlistview";
import { FlashListProps } from "./FlashListProps";
export default class GridLayoutProviderWithProps<T> extends GridLayoutProvider {
    private props;
    private layoutObject;
    private averageWindow;
    private renderWindowInsets;
    private _hasExpired;
    defaultEstimatedItemSize: number;
    constructor(maxSpan: number, getLayoutType: (index: number, props: FlashListProps<T>, mutableLayout: {
        span?: number;
        size?: number;
    }) => string | number, getSpan: (index: number, props: FlashListProps<T>, mutableLayout: {
        span?: number;
        size?: number;
    }) => number, getHeightOrWidth: (index: number, props: FlashListProps<T>, mutableLayout: {
        span?: number;
        size?: number;
    }) => number | undefined, props: FlashListProps<T>, acceptableRelayoutDelta?: number);
    updateProps(props: FlashListProps<T>): GridLayoutProviderWithProps<T>;
    /**
     * This methods returns true if the layout provider has expired and needs to be recreated.
     * This can happen if the number of columns has changed or the render window size has changed in a way that cannot be handled by the layout provider internally.
     */
    get hasExpired(): boolean;
    /**
     * Calling this method will mark the layout provider as expired. As a result, a new one will be created by FlashList and old cached layouts will be discarded.
     */
    markExpired(): void;
    /**
     * Calling this method will help the layout provider track average item sizes on its own
     * Overriding layout manager can help achieve the same thing without relying on this method being called however, it will make implementation very complex for a simple use case
     * @param index Index of the item being reported
     */
    reportItemLayout(index: number): void;
    get averageItemSize(): number;
    newLayoutManager(renderWindowSize: Dimension, isHorizontal?: boolean, cachedLayouts?: Layout[]): LayoutManager;
    private updateCachedDimensions;
    private getCleanLayoutObj;
    private getAdjustedRenderWindowSize;
}
//# sourceMappingURL=GridLayoutProviderWithProps.d.ts.map