ra-core/dist/cjs/controller/list/ListBase.d.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { ReactNode } from 'react';
import { ListControllerProps } from './useListController';
import { RaRecord } from '../../types';
/**
 * Call useListController and put the value in a ListContext
 *
 * Base class for <List> components, without UI.
 *
 * Accepts any props accepted by useListController:
 * - filter: permanent filter applied to the list
 * - filters: Filter element, to display the filters
 * - filterDefaultValues: object;
 * - perPage: Number of results per page
 * - sort: Default sort
 * - exporter: exported function
 *
 * @example // Custom list layout
 *
 * const PostList = () => (
 *     <ListBase perPage={10}>
 *         <div>
 *              List metrics...
 *         </div>
 *         <Grid container>
 *             <Grid item xs={8}>
 *                 <SimpleList primaryText={record => record.title} />
 *             </Grid>
 *             <Grid item xs={4}>
 *                 List instructions...
 *             </Grid>
 *         </Grid>
 *         <div>
 *             Post related links...
 *         </div>
 *     </ListBase>
 * );
 */
export declare const ListBase: <RecordType extends RaRecord<import("../../types").Identifier> = any>({ children, ...props }: ListControllerProps<RecordType> & {
    children: ReactNode;
}) => JSX.Element;
//# sourceMappingURL=ListBase.d.ts.map