Merge pull request #8550 from marmelab/doc-index

[Doc] Improve Index page

docs/Reference.md

@@ -1,62 +1,70 @@
 ---
 layout: default
-title: "Reference"
+title: "Index"
 ---
 
-# Reference
+# Index
 
-<div style="column-count:3" markdown="1">
+## Components
 
-* [`<AccordionForm>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#accordionform)<img class="icon" src="./img/premium.svg" />
-* `<Actions>`
+<div class="pages-index" markdown="1">
+
+**- A -**
+* [`<AccordionForm>`](./AccordionForm.md)<img class="icon" src="./img/premium.svg" />
 * [`<Admin>`](./Admin.md)
-* `<AdminRoutes>`
 * [`<AppBar>`](./Theming.md#customizing-the-appbar-content)
 * [`<ArrayField>`](./ArrayField.md)
 * [`<ArrayInput>`](./ArrayInput.md)
 * [`<Authenticated>`](./Authenticated.md)
 * [`<AutocompleteArrayInput>`](./AutocompleteArrayInput.md)
 * [`<AutocompleteInput>`](./AutocompleteInput.md)
+
+**- B -**
 * [`<Breadcrumb>`](./Breadcrumb.md)<img class="icon" src="./img/premium.svg" />
 * [`<BreadcrumbItem>`](./Breadcrumb.md#breadcrumbitem)<img class="icon" src="./img/premium.svg" />
 * [`<BooleanField>`](./BooleanField.md)
 * [`<BooleanInput>`](./BooleanInput.md)
 * [`<BulkDeleteButton>`](./Buttons.md#bulkdeletebutton)
 * [`<BulkExportButton>`](./Buttons.md#bulkexportbutton)
 * [`<BulkUpdateButton>`](./Buttons.md#bulkupdatebutton)
-* [`<Calendar>`](https://marmelab.com/ra-enterprise/modules/ra-calendar#calendar)<img class="icon" src="./img/premium.svg" />
+
+**- C -**
+* [`<Calendar>`](./Calendar.md)<img class="icon" src="./img/premium.svg" />
 * [`<CheckboxGroupInput>`](./CheckboxGroupInput.md)
 * [`<ChipField>`](./ChipField.md)
 * [`<CloneButton>`](./CloneButton.md)
 * [`<CompleteCalendar>`](https://marmelab.com/ra-enterprise/modules/ra-calendar#completecalendar)<img class="icon" src="./img/premium.svg" />
 * [`<Confirm>`](./Confirm.md)
 * [`<ContainerLayout>`](./ContainerLayout.md)<img class="icon" src="./img/premium.svg" />
 * [`<Create>`](./Create.md)
-* `<CreateActions>`
 * [`<CreateButton>`](./Buttons.md#createbutton)
-* [`<CreateDialog>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog)<img class="icon" src="./img/premium.svg" />
-* [`<CreateInDialogButton>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-showindialogbutton)<img class="icon" src="./img/premium.svg" />
+* [`<CreateDialog>`](./CreateDialog.md)<img class="icon" src="./img/premium.svg" />
+* [`<CreateInDialogButton>`](./CreateInDialogButton.md)<img class="icon" src="./img/premium.svg" />
+* [`<CustomRoutes>`](./CustomRoutes.md)
+
+**- D -**
 * [`<DashboardMenuItem>`](./Theming.md#using-a-custom-menu)
 * [`<Datagrid>`](./Datagrid.md)
 * [`<DatagridBody>`](./Datagrid.md#body)
 * [`<DatagridRow>`](./Datagrid.md#body)
-* `<DatagridCell>`
-* `<DatagridHeaderCell>`
 * [`<DatagridHeader>`](./Datagrid.md#header)
 * [`<DateField>`](./DateField.md)
 * [`<DateInput>`](./DateInput.md)
 * [`<DateTimeInput>`](./DateTimeInput.md)
 * `<DeleteButton>`
-* [`<DualListInput>`](https://marmelab.com/ra-enterprise/modules/ra-relationships#duallistinput)<img class="icon" src="./img/premium.svg" />
+* [`<DualListInput>`](./DualListInput.md)<img class="icon" src="./img/premium.svg" />
+
+**- E -**
 * [`<Edit>`](./Edit.md)
-* [`<EditableDatagrid>`](https://marmelab.com/ra-enterprise/modules/ra-editable-datagrid)<img class="icon" src="./img/premium.svg" />
+* [`<EditableDatagrid>`](./EditableDatagrid.md)<img class="icon" src="./img/premium.svg" />
 * [`<EditGuesser>`](./EditGuesser.md)
-* `<EditActions>`
 * [`<EditButton>`](./Buttons.md#editbutton)
-* [`<EditDialog>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog)<img class="icon" src="./img/premium.svg" />
-* [`<EditInDialogButton>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-showindialogbutton)<img class="icon" src="./img/premium.svg" />
+* [`<EditDialog>`](./EditDialog)<img class="icon" src="./img/premium.svg" />
+* [`<EditInDialogButton>`](./EditInDialogButton.md)<img class="icon" src="./img/premium.svg" />
 * [`<EmailField>`](./EmailField.md)
-* [`<Empty>`](./List.md#empty-empty-page-component)  
+* [`<Empty>`](./List.md#empty-empty-page-component)
+
+**- F -**
 * [`<FileField>`](./FileField.md)
 * [`<FileInput>`](./FileInput.md)
 * [`<Filter>`](./List.md#filters-filter-inputs)
@@ -69,12 +77,18 @@ title: "Reference"
 * [`<FormDataConsumer>`](./Inputs.md#linking-two-inputs)
 * [`<FormTab>`](./TabbedForm.md)
 * [`<FunctionField>`](./FunctionField.md)
+
+**- H -**
 * [`<HorizontalMenu>`](./HorizontalMenu.md)<img class="icon" src="./img/premium.svg" />
+
+**- I -**
 * [`<IfCanAccess>`](./IfCanAccess.md)<img class="icon" src="./img/premium.svg" />
 * [`<ImageField>`](./ImageField.md)
 * [`<ImageInput>`](./ImageInput.md)
 * [`<ImageInputPreview>`](./ImageInput.md#imageinput)
 * [`<InspectorButton>`](./Configurable.md#inspectorbutton)
+
+**- L -**
 * [`<Labeled>`](./Labeled.md)
 * [`<Layout>`](./Theming.md#using-a-custom-layout)
 * [`<Loading>`](./Theming.md#loading)
@@ -86,17 +100,25 @@ title: "Reference"
 * [`<ListGuesser>`](./ListGuesser.md#usage)
 * [`<ListButton>`](./Buttons.md#listbutton)
 * [`<LocalesMenuButton>`](./LocalesMenuButton.md)
-* [`<MarkdownField>`](https://marmelab.com/ra-enterprise/modules/ra-markdown#markdownfield)<img class="icon" src="./img/premium.svg" />
-* [`<MarkdownInput>`](https://marmelab.com/ra-enterprise/modules/ra-markdown#markdowninput)<img class="icon" src="./img/premium.svg" />
-* [`<Menu>`](./Theming.md#using-a-custom-menu)
-* [`<MultiLevelMenu>`](https://marmelab.com/ra-enterprise/modules/ra-navigation#multilevelmenu-replacing-the-default-menu-by-a-multi-level-one)<img class="icon" src="./img/premium.svg" />
+
+**- M -**
+* [`<MarkdownField>`](./MarkdownField.md)<img class="icon" src="./img/premium.svg" />
+* [`<MarkdownInput>`](./MarkdownInput.md)<img class="icon" src="./img/premium.svg" />
+* [`<Menu>`](./Menu.md)
+* [`<MultiLevelMenu>`](./MultiLevelMenu.md)<img class="icon" src="./img/premium.svg" />
+
+**- N -**
 * [`<Notification>`](./Theming.md#notifications)
 * [`<NullableBooleanInput>`](./NullableBooleanInput.md)
 * [`<NumberField>`](./NumberField.md)
 * [`<NumberInput>`](./NumberInput.md)
+
+**- P -**
 * [`<Pagination>`](./List.md#pagination-pagination-component)
 * [`<PasswordInput>`](./PasswordInput.md)
 * [`<PreferencesSetter>`](https://marmelab.com/ra-enterprise/modules/ra-preferences#preferencessetter-setting-preferences-declaratively)<img class="icon" src="./img/premium.svg" />
+
+**- R -**
 * [`<RadioButtonGroupInput>`](./RadioButtonGroupInput.md)
 * [`<RealTimeEdit>`](https://marmelab.com/ra-enterprise/modules/ra-realtime#real-time-views-list-edit-show)<img class="icon" src="./img/premium.svg" />
 * [`<RealTimeList>`](https://marmelab.com/ra-enterprise/modules/ra-realtime#real-time-views-list-edit-show)<img class="icon" src="./img/premium.svg" />
@@ -108,17 +130,18 @@ title: "Reference"
 * [`<ReferenceInput>`](./ReferenceInput.md)
 * [`<ReferenceManyField>`](./ReferenceManyField.md)
 * [`<ReferenceManyInput>`](./ReferenceManyInput.md)<img class="icon" src="./img/premium.svg" />
-* [`<ReferenceManyToManyField>`](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyfield)<img class="icon" src="./img/premium.svg" />
-* [`<ReferenceManyToManyInput>`](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyinput)<img class="icon" src="./img/premium.svg" />
+* [`<ReferenceManyToManyField>`](./ReferenceManyToManyField.md)<img class="icon" src="./img/premium.svg" />
+* [`<ReferenceManyToManyInput>`](./ReferenceManyToManyInput.md)<img class="icon" src="./img/premium.svg" />
 * [`<ReferenceOneField>`](./ReferenceOneField.md)
-* `<RefreshButton>`
 * [`<Resource>`](./Resource.md)
 * [`<RichTextField>`](./RichTextField.md)
 * [`<RichTextInput>`](./RichTextInput.md)
 * [`<RowForm>`](https://marmelab.com/ra-enterprise/modules/ra-editable-datagrid#rowform)<img class="icon" src="./img/premium.svg" />
+
+**- S -**
 * [`<SaveButton>`](./SaveButton.md)
 * [`<SavedQueriesList>`](./SavedQueriesList.md)
-* [`<Search>`](https://marmelab.com/ra-enterprise/modules/ra-search#the-search-component)<img class="icon" src="./img/premium.svg" />
+* [`<Search>`](./Search.md)<img class="icon" src="./img/premium.svg" />
 * [`<SearchInput>`](./FilteringTutorial.md#searchinput)
 * [`<SelectArrayInput>`](./SelectArrayInput.md)
 * [`<SelectColumnsButton>`](./SelectColumnsButton.md)
@@ -128,101 +151,134 @@ title: "Reference"
 * [`<ShowGuesser`](./ShowGuesser.md#showguesser)
 * [`<ShowButton>`](./Buttons.md#showbutton)
 * [`<ShowDialog>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog)<img class="icon" src="./img/premium.svg" />
-* [`<ShowInDialogButton>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-showindialogbutton)<img class="icon" src="./img/premium.svg" />
+* [`<ShowInDialogButton>`](./ShowInDialogButton.md)<img class="icon" src="./img/premium.svg" />
 * [`<Sidebar>`](./Theming.md#sidebar-customization)
 * [`<SidebarOpenPreferenceSync>`](https://marmelab.com/ra-enterprise/modules/ra-preferences#sidebaropenpreferencesync-store-the-sidebar-openclose-state-in-preferences)<img class="icon" src="./img/premium.svg" />
 * [`<SimpleForm>`](./SimpleForm.md)
-* [`<SimpleFormIterator>`](./ArrayInput.md#usage)
+* [`<SimpleFormIterator>`](./SimpleFormIterator.md)
 * [`<SimpleList>`](./SimpleList.md)
 * [`<SimpleShowLayout>`](./SimpleShowLayout.md)
 * [`<SingleFieldList>`](./SingleFieldList.md)
 * [`<SortButton>`](./SortButton.md)
+
+**- T -**
 * `<Tab>`
 * [`<TabbedForm>`](./TabbedForm.md)
 * [`<TabbedShowLayout>`](./TabbedShowLayout.md)
 * [`<TextField>`](./TextField.md)
 * [`<TextInput>`](./TextInput.md)
-* `<Title>`
+* [`<TimeInput>`](./TimeInput.md)
 * [`<ToggleThemeButton>`](./ToggleThemeButton.md)
 * [`<TourProvider>`](https://marmelab.com/ra-enterprise/modules/ra-tour)<img class="icon" src="./img/premium.svg" />
 * [`<TranslatableFields>`](./TranslatableFields.md)
+* [`<TranslatableInputs>`](./TranslatableInputs.md)
 * [`<Tree>`](https://marmelab.com/ra-enterprise/modules/ra-tree#tree-component)<img class="icon" src="./img/premium.svg" />
-* [`<TreeWithDetails>`](https://marmelab.com/ra-enterprise/modules/ra-tree#treewithdetails-component)<img class="icon" src="./img/premium.svg" />
+* [`<TreeWithDetails>`](./TreeWithDetails.md)<img class="icon" src="./img/premium.svg" />
 * [`<Toolbar>`](./Toolbar.md)
-* `<TopToolbar>`
+
+**- U -**
 * [`<UrlField>`](./UrlField.md)
 * [`<UserMenu>`](./Theming.md#usermenu-customization)
+
+**- W -**
 * [`<WithPermissions>`](./WithPermissions.md)
 * [`<WithRecord>`](./WithRecord.md)
-* [`<WizardForm>`](https://marmelab.com/ra-enterprise/modules/ra-form-layout#wizardform)<img class="icon" src="./img/premium.svg" />
+* [`<WizardForm>`](./WizardForm.md)<img class="icon" src="./img/premium.svg" />
+* [`<WrapperField>`](./WrapperField.md)
+
+</div>
+
+## Hooks
+
+<div class="pages-index" markdown="1">
+
+**- A -**
 * [`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`](./useAuthenticated.md)
 * [`useAuthProvider`](./useAuthProvider.md)
 * [`useAuthState`](./useAuthState.md)
+
+**- C -**
 * [`useCanAccess`](./useCanAccess.md)<img class="icon" src="./img/premium.svg" />
-* `useCheckAuth`
-* `useChoices`
 * [`useChoicesContext`](./useChoicesContext.md)
 * [`useCreate`](./useCreate.md)
 * [`useCreateController`](./useCreateController.md)
+
+**- D -**
 * [`useDataProvider`](./useDataProvider.md#usedataprovider)
 * [`useDelete`](./useDelete.md)
 * [`useDeleteMany`](./useDeleteMany.md)
+
+**- E -**
 * [`useEditController`](./useEditController.md)
-* `useExpanded`
-* `useFilterState`
+
+**- G -**
 * [`useGetIdentity`](./useGetIdentity.md)
 * [`useGetList`](./useGetList.md)
 * [`useGetMany`](./useGetMany.md)
 * [`useGetManyAggregate`](./useGetOne.md#aggregating-getone-calls)
 * [`useGetManyReference`](./useGetManyReference.md)
 * [`useGetOne`](./useGetOne.md)
 * [`useGetPermissions`](./WithPermissions.md)
+* [`useGetRecordId`](./useGetRecordId.md)
+
+**- H -**
 * [`useHasLock`](https://marmelab.com/ra-enterprise/modules/ra-realtime#locks-on-content)<img class="icon" src="./img/premium.svg" />
 * [`useHasLocks`](https://marmelab.com/ra-enterprise/modules/ra-realtime#locks-on-content)<img class="icon" src="./img/premium.svg" />
+
+**- I -**
+* [`useInfiniteGetList`](./useInfiniteGetList.md)
 * [`useInput`](./useInput.md)
+
+**- L -**
 * [`useList`](./useList.md)
 * [`useListContext`](./useListContext.md)
 * [`useListController`](./useListController.md)
-* `useListParams`
-* `useLoading`
 * [`useLocaleState`](./useLocaleState.md)
 * [`useLock`](https://marmelab.com/ra-enterprise/modules/ra-realtime#locks-on-content)<img class="icon" src="./img/premium.svg" />
 * [`useLogin`](./useLogin.md)
 * [`useLogout`](./useLogout.md)
-* `useLogoutIfAccessDenied`
+
+**- M -**
 * [`useMediaQuery`](./Theming.md#usemediaquery-hook)
+
+**- N -**
 * [`useNotify`](./useNotify.md)
-* `usePaginationState`
+
+**- P -**
 * [`usePermissions`](./usePermissions.md)
 * [`usePreferences`](https://marmelab.com/ra-enterprise/modules/ra-preferences#usepreferences-reading-and-writing-user-preferences)<img class="icon" src="./img/premium.svg" />
+
+**- R -**
 * [`useRecordContext`](./useRecordContext.md)
-* `useRecordSelection`
 * [`useRedirect`](./useRedirect.md)
 * [`useReference`](./useGetOne.md#aggregating-getone-calls)
-* `useReferenceArrayFieldController`
-* `useReferenceArrayInputController`
-* `useReferenceInputController`
-* `useReferenceManyFieldController`
 * [`useRefresh`](./useRefresh.md)
 * [`useRemoveFromStore`](./useRemoveFromStore.md)
 * [`useResetStore`](./useResetStore.md)
 * [`useResourceAppLocation`](https://marmelab.com/ra-enterprise/modules/ra-navigation#useresourceapplocation-access-current-resource-app-location)<img class="icon" src="./img/premium.svg" />
+
+**- S -**
+* [`useSaveContext`](./useSaveContext.md)
 * [`useSearch`](https://marmelab.com/ra-enterprise/modules/ra-search#the-usesearch-hook)<img class="icon" src="./img/premium.svg" />
-* `useSidebarState`
+* [`useShowContext`](./useShowContext.md)
 * [`useShowController`](./useShowController.md#useshowcontroller)
-* `useSortState`
 * [`useStore`](./useStore.md)
 * [`useStoreContext`](./useStoreContext.md)
-* `useSuggestions`
+
+**- T -**
 * [`useTheme`](./Theming.md#changing-the-theme-programmatically)
 * [`useTour`](https://marmelab.com/ra-enterprise/modules/ra-tour)<img class="icon" src="./img/premium.svg" />
 * [`useTranslate`](./useTranslate.md)
+
+**- U -**
 * [`useUpdate`](./useUpdate.md)
 * [`useUpdateMany`](./useUpdateMany.md)
 * [`useUnselect`](./useUnselect.md)
 * [`useUnselectAll`](./useUnselectAll.md)
+
+**- W -**
 * [`useWarnWhenUnsavedChanges`](./EditTutorial.md#warning-about-unsaved-changes)
 
-</div>
+</div>

docs/css/style-v13.css

@@ -28,9 +28,6 @@ main > .container .markdown-section {
         font-size: 16px;
         -webkit-font-smoothing: antialiased;
     }
-    main .markdown-section {
-        padding-left: 2em;
-    }
     main > .container {
         width: 100%;
         padding-left: 1em;
@@ -585,3 +582,18 @@ body.no-sidebar .sidenav-trigger {
     color: #9a6e3a;
     background: none;
 }
+
+
+.pages-index {
+    column-count: 3;
+}
+.pages-index ul {
+    padding-left: 0;
+}
+.pages-index ul > li {
+    list-style-type: none;
+}
+
+.pages-index code {
+    font-size: 0.8em;
+}

docs/navigation.html

@@ -235,4 +235,4 @@
 <li {% if page.path == 'Ecosystem.md' %} class="active" {% endif %}><a class="nav-link" href="./Ecosystem.html">Ecosystem</a></li>
 <li {% if page.path == 'Architecture.md' %} class="active" {% endif %}><a class="nav-link" href="./Architecture.html">Architecture</a></li>
 <li {% if page.path == 'FAQ.md' %} class="active" {% endif %}><a class="nav-link" href="./FAQ.html">FAQ</a></li>
-<li {% if page.path == 'Reference.md' %} class="active" {% endif %}><a class="nav-link" href="./Reference.html">Reference</a></li>
+<li {% if page.path == 'Reference.md' %} class="active" {% endif %}><a class="nav-link" href="./Reference.html">Index</a></li>