///
import { ListControllerProps } from './useListController';
/**
* Context to store the pagination part of the useListController() result.
*
* Use the useListPaginationContext() hook to read the pagination information.
* That's what List components do in ../../app (e.g. ).
*
* @typedef {Object} ListPaginationContextValue
* @prop {boolean} loading boolean that is true on mount, and false once the data was fetched
* @prop {integer} total the total number of results for the current filters, excluding pagination. Useful to build the pagination controls. e.g. 23
* @prop {integer} page the current page. Starts at 1
* @prop {Function} setPage a callback to change the page, e.g. setPage(3)
* @prop {integer} perPage the number of results per page. Defaults to 25
* @prop {Function} setPerPage a callback to change the number of results per page, e.g. setPerPage(25)
* @prop {string} resource the resource name, deduced from the location. e.g. 'posts'
*
* @typedef Props
* @prop {ListPaginationContextValue} value
*
* @param {Props}
*
* @see useListController
* @see useListContext
*
* @example
*
* import { useListController, ListPaginationContext } from '../../core';
*
* const List = props => {
* const controllerProps = useListController(props);
* return (
*
* ...
*
* );
* };
*/
declare const ListPaginationContext: import("react").Context;
export declare type ListPaginationContextValue = Pick;
export declare const usePickPaginationContext: (context: ListControllerProps) => ListPaginationContextValue;
export default ListPaginationContext;