ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
53 lines • 2.47 kB
TypeScript
import * as React from 'react';
import { ReactNode } from 'react';
import { UseQueryOptions } from '@tanstack/react-query';
import { RaRecord } from '../../types';
import { UseReferenceFieldControllerResult } from './useReferenceFieldController';
/**
* Fetch reference record, and render its representation, or delegate rendering to child component.
*
* The reference prop should be the name of one of the <Resource> components
* added as <Admin> child.
*
* @example // using recordRepresentation
* <ReferenceFieldBase source="userId" reference="users" />
*
* @example // using a Field component to represent the record
* <ReferenceFieldBase source="userId" reference="users">
* <TextField source="name" />
* </ReferenceFieldBase>
*
* @example // By default, includes a link to the <Edit> page of the related record
* // (`/users/:userId` in the previous example).
* // Set the `link` prop to "show" to link to the <Show> page instead.
* <ReferenceFieldBase source="userId" reference="users" link="show" />
*
* @example // You can also prevent `<ReferenceFieldBase>` from adding link to children
* // by setting `link` to false.
* <ReferenceFieldBase source="userId" reference="users" link={false} />
*
* @example // Alternatively, you can also pass a custom function to `link`.
* // It must take reference and record as arguments and return a string
* <ReferenceFieldBase source="userId" reference="users" link={(record, reference) => "/path/to/${reference}/${record}"} />
*
* @default
* In previous versions of React-Admin, the prop `linkType` was used. It is now deprecated and replaced with `link`. However
* backward-compatibility is still kept
*/
export declare const ReferenceFieldBase: <ReferenceRecordType extends RaRecord = RaRecord>(props: ReferenceFieldBaseProps<ReferenceRecordType>) => React.JSX.Element;
export interface ReferenceFieldBaseProps<ReferenceRecordType extends RaRecord = RaRecord, RecordType extends Record<string, any> = Record<string, any>> {
children?: ReactNode;
render?: (props: UseReferenceFieldControllerResult<ReferenceRecordType>) => ReactNode;
className?: string;
empty?: ReactNode;
error?: ReactNode;
loading?: ReactNode;
offline?: ReactNode;
queryOptions?: Partial<UseQueryOptions<ReferenceRecordType[], Error> & {
meta?: any;
}>;
reference: string;
record?: RecordType;
source: string;
}
//# sourceMappingURL=ReferenceFieldBase.d.ts.map