ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
42 lines • 1.95 kB
TypeScript
import { UseQueryOptions } from '@tanstack/react-query';
import { RaRecord, SortPayload } from '../../types';
import { UseReferenceResult } from '../useReference';
export interface UseReferenceOneFieldControllerParams<RecordType extends RaRecord = any, ReferenceRecordType extends RaRecord = any, ErrorType = Error> {
reference: string;
target: string;
filter?: any;
queryOptions?: Omit<UseQueryOptions<{
data: ReferenceRecordType[];
total: number;
}, ErrorType>, 'queryFn' | 'queryKey'> & {
meta?: any;
};
record?: RecordType;
sort?: SortPayload;
source?: string;
}
/**
* Fetch a reference record in a one-to-one relationship, and return it when available
*
* The reference prop should be the name of one of the <Resource> components
* added as <Admin> child.
*
* @example
*
* const { data, isPending, error } = useReferenceOneFieldController({
* record: { id: 7, name: 'James Joyce'}
* reference: 'bios',
* target: 'author_id',
* });
*
* @typedef {Object} UseReferenceOneFieldControllerParams
* @prop {Object} props.record The current resource record
* @prop {string} props.reference The linked resource name
* @prop {string} props.target The target resource key
* @prop {string} props.source The key current record identifier ('id' by default)
* @prop {Object} props.sort The sort to apply to the referenced records
* @prop {Object} props.filter The filter to apply to the referenced records
* @returns {UseReferenceResult} The request state. Destructure as { referenceRecord, isPending, error }.
*/
export declare const useReferenceOneFieldController: <RecordType extends RaRecord = any, ReferenceRecordType extends RaRecord = any, ErrorType = Error>(props: UseReferenceOneFieldControllerParams<RecordType, ReferenceRecordType, ErrorType>) => UseReferenceResult<ReferenceRecordType, ErrorType>;
//# sourceMappingURL=useReferenceOneFieldController.d.ts.map