diff --git a/docs/Reference.md b/docs/Reference.md index a60f70ed1cc..9a5edf4d050 100644 --- a/docs/Reference.md +++ b/docs/Reference.md @@ -1,22 +1,25 @@ --- layout: default -title: "Reference" +title: "Index" --- -# Reference +# Index -
+## Components -* [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#accordionform) -* `` +
+ +**- A -** +* [``](./AccordionForm.md) * [``](./Admin.md) -* `` * [``](./Theming.md#customizing-the-appbar-content) * [``](./ArrayField.md) * [``](./ArrayInput.md) * [``](./Authenticated.md) * [``](./AutocompleteArrayInput.md) * [``](./AutocompleteInput.md) + +**- B -** * [``](./Breadcrumb.md) * [``](./Breadcrumb.md#breadcrumbitem) * [``](./BooleanField.md) @@ -24,7 +27,9 @@ title: "Reference" * [``](./Buttons.md#bulkdeletebutton) * [``](./Buttons.md#bulkexportbutton) * [``](./Buttons.md#bulkupdatebutton) -* [``](https://marmelab.com/ra-enterprise/modules/ra-calendar#calendar) + +**- C -** +* [``](./Calendar.md) * [``](./CheckboxGroupInput.md) * [``](./ChipField.md) * [``](./CloneButton.md) @@ -32,31 +37,34 @@ title: "Reference" * [``](./Confirm.md) * [``](./ContainerLayout.md) * [``](./Create.md) -* `` * [``](./Buttons.md#createbutton) -* [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog) -* [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-showindialogbutton) +* [``](./CreateDialog.md) +* [``](./CreateInDialogButton.md) +* [``](./CustomRoutes.md) + +**- D -** * [``](./Theming.md#using-a-custom-menu) * [``](./Datagrid.md) * [``](./Datagrid.md#body) * [``](./Datagrid.md#body) -* `` -* `` * [``](./Datagrid.md#header) * [``](./DateField.md) * [``](./DateInput.md) * [``](./DateTimeInput.md) * `` -* [``](https://marmelab.com/ra-enterprise/modules/ra-relationships#duallistinput) +* [``](./DualListInput.md) + +**- E -** * [``](./Edit.md) -* [``](https://marmelab.com/ra-enterprise/modules/ra-editable-datagrid) +* [``](./EditableDatagrid.md) * [``](./EditGuesser.md) -* `` * [``](./Buttons.md#editbutton) -* [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog) -* [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-showindialogbutton) +* [``](./EditDialog) +* [``](./EditInDialogButton.md) * [``](./EmailField.md) -* [``](./List.md#empty-empty-page-component) +* [``](./List.md#empty-empty-page-component) + +**- F -** * [``](./FileField.md) * [``](./FileInput.md) * [``](./List.md#filters-filter-inputs) @@ -69,12 +77,18 @@ title: "Reference" * [``](./Inputs.md#linking-two-inputs) * [``](./TabbedForm.md) * [``](./FunctionField.md) + +**- H -** * [``](./HorizontalMenu.md) + +**- I -** * [``](./IfCanAccess.md) * [``](./ImageField.md) * [``](./ImageInput.md) * [``](./ImageInput.md#imageinput) * [``](./Configurable.md#inspectorbutton) + +**- L -** * [``](./Labeled.md) * [``](./Theming.md#using-a-custom-layout) * [``](./Theming.md#loading) @@ -86,17 +100,25 @@ title: "Reference" * [``](./ListGuesser.md#usage) * [``](./Buttons.md#listbutton) * [``](./LocalesMenuButton.md) -* [``](https://marmelab.com/ra-enterprise/modules/ra-markdown#markdownfield) -* [``](https://marmelab.com/ra-enterprise/modules/ra-markdown#markdowninput) -* [``](./Theming.md#using-a-custom-menu) -* [``](https://marmelab.com/ra-enterprise/modules/ra-navigation#multilevelmenu-replacing-the-default-menu-by-a-multi-level-one) + +**- M -** +* [``](./MarkdownField.md) +* [``](./MarkdownInput.md) +* [``](./Menu.md) +* [``](./MultiLevelMenu.md) + +**- N -** * [``](./Theming.md#notifications) * [``](./NullableBooleanInput.md) * [``](./NumberField.md) * [``](./NumberInput.md) + +**- P -** * [``](./List.md#pagination-pagination-component) * [``](./PasswordInput.md) * [``](https://marmelab.com/ra-enterprise/modules/ra-preferences#preferencessetter-setting-preferences-declaratively) + +**- R -** * [``](./RadioButtonGroupInput.md) * [``](https://marmelab.com/ra-enterprise/modules/ra-realtime#real-time-views-list-edit-show) * [``](https://marmelab.com/ra-enterprise/modules/ra-realtime#real-time-views-list-edit-show) @@ -108,17 +130,18 @@ title: "Reference" * [``](./ReferenceInput.md) * [``](./ReferenceManyField.md) * [``](./ReferenceManyInput.md) -* [``](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyfield) -* [``](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyinput) +* [``](./ReferenceManyToManyField.md) +* [``](./ReferenceManyToManyInput.md) * [``](./ReferenceOneField.md) -* `` * [``](./Resource.md) * [``](./RichTextField.md) * [``](./RichTextInput.md) * [``](https://marmelab.com/ra-enterprise/modules/ra-editable-datagrid#rowform) + +**- S -** * [``](./SaveButton.md) * [``](./SavedQueriesList.md) -* [``](https://marmelab.com/ra-enterprise/modules/ra-search#the-search-component) +* [``](./Search.md) * [``](./FilteringTutorial.md#searchinput) * [``](./SelectArrayInput.md) * [``](./SelectColumnsButton.md) @@ -128,50 +151,69 @@ title: "Reference" * [``](./Buttons.md#showbutton) * [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog) -* [``](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createindialogbutton-editindialogbutton-and-showindialogbutton) +* [``](./ShowInDialogButton.md) * [``](./Theming.md#sidebar-customization) * [``](https://marmelab.com/ra-enterprise/modules/ra-preferences#sidebaropenpreferencesync-store-the-sidebar-openclose-state-in-preferences) * [``](./SimpleForm.md) -* [``](./ArrayInput.md#usage) +* [``](./SimpleFormIterator.md) * [``](./SimpleList.md) * [``](./SimpleShowLayout.md) * [``](./SingleFieldList.md) * [``](./SortButton.md) + +**- T -** * `` * [``](./TabbedForm.md) * [``](./TabbedShowLayout.md) * [``](./TextField.md) * [``](./TextInput.md) -* `` +* [`<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) @@ -179,50 +221,64 @@ title: "Reference" * [`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> \ No newline at end of file diff --git a/docs/css/style-v13.css b/docs/css/style-v13.css index a483ff5fa88..7fa78fa6641 100644 --- a/docs/css/style-v13.css +++ b/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; +} \ No newline at end of file diff --git a/docs/navigation.html b/docs/navigation.html index f44e34835ca..abbc49acdb9 100644 --- a/docs/navigation.html +++ b/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>