Merge pull request #5860 from jgabriele/master

[Doc] Add documentation for `linkToRecord`

Author: fzaninotto

docs/Fields.md

@@ -1524,6 +1524,21 @@ export const UserList = (props) => (
 
 **Tip**: In such custom fields, the `source` is optional. React-admin uses it to determine which column to use for sorting when the column header is clicked. In case you use the `source` property for additional purposes, the sorting can be overridden by the `sortBy` property on any `Field` component.
 
+### Linking to other records
+
+Your custom Field component might need to display a link to another record. React Admin provides a `linkToRecord(basePath, id[, linkType])` method for this purpose.
+
+```js
+import { linkToRecord } from 'react-admin';
+import { Link } from 'react-router-dom';
+
+const MyCustomField = ({ record: post }) => {
+    const linkToUser = linkToRecord('/users', post.user_id, 'show');
+
+    return <Link to={linkToUser}>{seller.username}</Link>;
+};
+```
+
 ## Third-Party Components
 
 You can find components for react-admin in third-party repositories.

docs/Reference.md

@@ -140,6 +140,7 @@ title: "Reference"
 * `<TopToolbar>`
 * [`<UrlField>`](./Fields.md#urlfield)
 * [`<WizardForm>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#wizardform)<img class="icon" src="./img/premium.svg" />
+* [`linkToRecord`](./Fields.md#linking-to-other-records)
 * [`useAppLocationState`](https://marmelab.com/ra-enterprise/modules/ra-navigation#useapplocationstate-retrieve-and-define-app-location)<img class="icon" src="./img/premium.svg" />
 * [`useAppLocationMatcher`](https://marmelab.com/ra-enterprise/modules/ra-navigation#useapplocationmatcher-apply-a-matching-on-the-current-app-location)<img class="icon" src="./img/premium.svg" />
 * [`useAuthenticated`](./Authentication.md#useauthenticated-hook)