import { FC, ReactElement } from 'react'; import { ListControllerProps, SortPayload, FilterPayload } from '../../features/core'; import { PublicFieldProps, InjectedFieldProps } from './types'; /** * A container component that fetches records from another resource specified * by an array of *ids* in current record. * * You must define the fields to be passed to the iterator component as children. * * @example Display all the products of the current order as datagrid * // order = { * // id: 123, * // product_ids: [456, 457, 458], * // } * * * * * * * * * * @example Display all the categories of the current product as a list of chips * // product = { * // id: 456, * // category_ids: [11, 22, 33], * // } * * * * * * * By default, restricts the displayed values to 1000. You can extend this limit * by setting the `perPage` prop. * * @example * * ... * * * By default, the field displays the results in the order in which they are referenced * (i.e. in the order of the list of ids). You can change this order * by setting the `sort` prop (an object with `field` and `order` properties). * * @example * * ... * * * Also, you can filter the results to display only a subset of values. Use the * `filter` prop for that. * * @example * * ... * */ declare const ReferenceArrayField: FC; export interface ReferenceArrayFieldProps extends PublicFieldProps, InjectedFieldProps { children: ReactElement; filter?: FilterPayload; page?: number; pagination?: ReactElement; perPage?: number; reference: string; resource?: string; sort?: SortPayload; } export interface ReferenceArrayFieldViewProps extends Omit, ListControllerProps { } export declare const ReferenceArrayFieldView: FC; export default ReferenceArrayField;