ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
27 lines (26 loc) • 1.25 kB
TypeScript
/// <reference types="react" />
import { InfiniteListControllerResult } from './useInfiniteListController';
/**
* Context to store the pagination callbacks from the useInfiniteListController() result.
*
* Use the useInfinitePaginationContext() hook to read the pagination callbacks.
*
* @typedef {Object} InfinitePaginationContextValue
* @prop {Function} fetchNextPage a callback to fetch the next page
* @prop {Function} fetchPreviousPage a callback to fetch the previous page
* @example
*
* import { useListController, ListPaginationContext } from 'ra-core';
*
* const List = props => {
* const { fetchNextPage, fetchPreviousPage } = useInfiniteListController(props);
* return (
* <InfinitePaginationContext.Provider value={{ fetchNextPage, fetchPreviousPage }}>
* ...
* </InfinitePaginationContext.Provider>
* );
* };
*/
export declare const InfinitePaginationContext: import("react").Context<InfinitePaginationContextValue>;
export type InfinitePaginationContextValue = Pick<InfiniteListControllerResult, 'fetchNextPage' | 'fetchPreviousPage' | 'isFetchingNextPage' | 'hasNextPage' | 'hasPreviousPage' | 'isFetchingPreviousPage'>;
//# sourceMappingURL=InfinitePaginationContext.d.ts.map