UNPKG

ra-core

Version:

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

44 lines 2.27 kB
import * as React from 'react'; import { ReferenceFieldContextProvider } from './ReferenceFieldContext'; import { useReferenceFieldController } from './useReferenceFieldController'; import { ResourceContextProvider } from '../../core'; import { RecordContextProvider } from '../record'; /** * 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 label="User" source="userId" reference="users" /> * * @example // using a Field component to represent the record * <ReferenceFieldBase label="User" 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 label="User" source="userId" reference="users" link="show" /> * * @example // You can also prevent `<ReferenceFieldBase>` from adding link to children * // by setting `link` to false. * <ReferenceFieldBase label="User" 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 label="User" 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 var ReferenceFieldBase = function (props) { var children = props.children; var controllerProps = useReferenceFieldController(props); return (React.createElement(ResourceContextProvider, { value: props.reference }, React.createElement(ReferenceFieldContextProvider, { value: controllerProps }, React.createElement(RecordContextProvider, { value: controllerProps.referenceRecord }, children)))); }; //# sourceMappingURL=ReferenceFieldBase.js.map