Merge pull request #3768 from marmelab/reference-links

[RFR] Add hooks to Reference list
marmelab · Oct 3, 2019 · 6e7a4da · 6e7a4da
2 parents cfe1b78 + 798e2f4
commit 6e7a4da
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 15 deletions.
diff --git a/docs/Inputs.md b/docs/Inputs.md
@@ -1490,6 +1490,7 @@ import { FormDataConsumer } from 'react-admin';
 
 **Tip**: When using a `FormDataConsumer` you can define `subscription` prop to pass to the `react-final-form`
 
+{% raw %}
 ```jsx
 import { FormDataConsumer } from 'react-admin';
 
@@ -1506,3 +1507,4 @@ import { FormDataConsumer } from 'react-admin';
      </Edit>
  );
 ```
+{% endraw %}
diff --git a/docs/Reference.md b/docs/Reference.md
@@ -10,7 +10,7 @@ title: "Reference"
 * `<Actions>`
 * [`<Admin>`](./Admin.md)
 * `<AdminRoutes>`
-* `<AppBar>`
+* [`<AppBar>`](./Theming.md#customizing-the-appbar-content)
 * [`<ArrayField>`](./Fields.md#arrayfield)
 * [`<ArrayInput>`](./Inputs.md#arrayinput)
 * [`<Authenticated>`](./Authentication.md#restricting-access-to-a-custom-page)
@@ -34,6 +34,7 @@ title: "Reference"
 * [`<DateInput>`](./Inputs.md#dateinput)
 * `<DeleteButton>`
 * [`<Edit>`](./CreateEdit.md#the-create-and-edit-components)
+* [`<EditGuesser>`](./CreateEdit.md#the-editguesser-component)
 * `<EditActions>`
 * `<EditButton>`
 * [`<EmailField>`](./Fields.md#emailfield)
@@ -52,13 +53,16 @@ title: "Reference"
 * [`<Layout>`](./Theming.md#using-a-custom-layout)
 * [`<Loading>`](./Theming.md#Loading)
 * [`<List>`](./List.md#the-list-component)
+* [`<ListGuesser>`](./List.md#the-listguesser-component)
 * `<ListButton>`
 * [`<Menu>`](./Theming.md#using-a-custom-menu)
+* [`<Mutation>`](./Actions.md#legacy-components-query-mutation-and-withdataprovider)
 * `<Notification>`
 * [`<NullableBooleanInput>`](./Inputs.md#booleaninput-and-nullablebooleaninput)
 * [`<NumberField>`](./Fields.md#numberfield)
 * [`<NumberInput>`](./Inputs.md#numberinput)
 * [`<Pagination>`](./List.md#pagination)
+* [`<Query>`](./Actions.md#legacy-components-query-mutation-and-withdataprovider)
 * [`<RadioButtonGroupInput>`](./Inputs.md#radiobuttongroupinput)
 * [`<ReferenceArrayField>`](./Fields.md#referencearrayfield)
 * [`<ReferenceArrayInput>`](./Inputs.md#referencearrayinput)
@@ -73,6 +77,7 @@ title: "Reference"
 * [`<SelectField>`](./Fields.md#selectfield)
 * [`<SelectInput>`](./Inputs.md#selectinput)
 * [`<Show>`](./Show.md#the-show-component)
+* [`<ShowGuesser`](./Show.md#the-showguesser-component)
 * `<ShowButton>`
 * `<Sidebar>`
 * `<SimpleList>`
@@ -84,11 +89,67 @@ title: "Reference"
 * `<Tab>`
 * [`<TabbedForm>`](./CreateEdit.md#the-tabbedform-component)
 * [`<TabbedShowLayout>`](./Show.md#the-tabbedshowlayout-component)
+* [`<TestContext>`](./UnitTesting.md#testing-custom-views)
 * [`<TextField>`](./Fields.md#textfield)
 * [`<TextInput>`](./Inputs.md#textinput)
 * `<Title>`
+* [`translate`](./Translation.md#withtranslate-hoc)
 * `<Toolbar>`
 * [`<UrlField>`](./Fields.md#urlfield)
+* [`useAuthenticated`](./Authentication.md#useauth-hook)
+* `useAuthProvider`
+* [`useAuthState`](./Authentication.md#useauthstate-hook)
+* `useCheckAuth`
+* `useChoices`
+* [`useCreate`](./Actions.md#specialized-hooks)
+* `useCreateController`
+* [`useDataProvider`](./Actions.md#usedataprovider-hook)
+* [`useDelete`](./Actions.md#specialized-hooks)
+* [`useDeleteMany`](./Actions.md#specialized-hooks)
+* `useEditController`
+* `useFilterState`
+* [`useGetList`](./Actions.md#specialized-hooks)
+* [`useGetMany`](./Actions.md#specialized-hooks)
+* [`useGetManyReference`](./Actions.md#specialized-hooks)
+* `useGetMatching`
+* `useGetMatchingReferences`
+* [`useGetOne`](./Actions.md#specialized-hooks)
+* `useGetPermissions`
+* `useInput`
+* `useListController`
+* `useListParams`
+* `useLoading`
+* [`useLocale`](./Translation.md#uselocale-getting-the-current-locale)
+* [`useLogin`](./Authentication.md#customizing-the-login-and-logout-components)
+* [`useLogout`]((./Authentication.md#customizing-the-login-and-logout-components))
+* `useLogoutIfAccessDenied`
+* [`useMediaQuery`](./Theming.md#usemediaquery-hook)
+* [`useMutation`](./Actions.md#usemutation-hook)
+* [`useNotify`](./Actions.md#handling-side-effects-in-usedataprovider)
+* `usePaginationState`
+* [`usePermissions`](./Authorization.mdusepermissions-hook)
+* [`useQuery`](./Actions.md#usequery-hook)
+* [`useQueryWithStore`](./Actions.md#usequerywithstore-hook)
+* [`useRedirect`](./Actions.md#handling-side-effects-in-usedataprovider)
+* `useReference`
+* `useReferenceArrayFieldController`
+* `useReferenceArrayInputController`
+* `useReferenceInputController`
+* `useReferenceManyFieldController`
+* [`useRefresh`](./Actions.md#handling-side-effects-in-usedataprovider)
+* [`useSetLocale`](./Translation.md#usesetlocale-changing-locale-at-runtime)
+* `useShowController`
+* `useSortState`
+* [`useStyles`](./Theming.md#overriding-a-component-style)
+* `useSuggestions`
+* [`useTranslate`](./Translation.md#usetranslate-hook)
+* [`useUpdate`](./Actions.md#specialized-hooks)
+* `useUpdateLoading`
+* [`useUpdateMany`](./Actions.md#specialized-hooks)
+* [`useUnselectAll`](./Actions.md#handling-side-effects-in-usedataprovider)
+* `useVersion`
+* [`withDataProvider`](./Actions.md#legacy-components-query-mutation-and-withdataprovider)
+* [`withTranslate`](./Translation.md#withtranslate-hoc)
 * [`<WithPermissions>`](./Authorization.md#withpermissions)
 
 </div>
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -648,7 +648,7 @@
                                 <a href="#useauth-hook"><code>useAuthenticated()</code> Hook</a>
                             </li>
                             <li class="chapter">
-                                <a href="#useauth-hook"><code>&lt;Authenticated&gt;</code> Component</a>
+                                <a href="#authenticated-component"><code>&lt;Authenticated&gt;</code> Component</a>
                             </li>
                             <li class="chapter">
                                 <a href="#useauthstate-hook"><code>useAuthState()</code> Hook</a>
@@ -706,7 +706,7 @@
                                 <a href="#using-a-custom-layout">Using a Custom Layout</a>
                             </li>
                             <li class="chapter">
-                                <a href="#using-a-custom-appbar">Using a Custom AppBar</a>
+                                <a href="#customizing-the-appbar-content">Using a Custom AppBar</a>
                             </li>
                             <li class="chapter">
                                 <a href="#using-a-custom-menu">Using a Custom Menu</a>
@@ -736,7 +736,7 @@
                                     <a href="#specialized-hooks">Specialized Hooks</a>
                                 </li>
                             <li class="chapter">
-                                <a href="#handling-side-effects-in-useDataProvider">Handling Side Effects</a>
+                                <a href="#handling-side-effects-in-usedataprovider">Handling Side Effects</a>
                             </li>
                             <li class="chapter">
                                 <a href="#optimistic-rendering-and-undo">Optimistic Rendering and Undo</a>
@@ -875,17 +875,6 @@
                 </div>
             </div>
         </div>
-        <script>
-            (function (i, s, o, g, r, a, m) {
-                i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
-                    (i[r].q = i[r].q || []).push(arguments)
-                }, i[r].l = 1 * new Date(); a = s.createElement(o),
-                    m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
-            })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
-
-            ga('create', 'UA-46201426-1', 'auto');
-            ga('send', 'pageview');
-        </script>
         <script src="js/prism.js"></script>
         <script src="js/menu.js"></script>
         <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>