From d02ffc19b56d40f01abccce3b32b4404f9cdb5ed Mon Sep 17 00:00:00 2001 From: fzaninotto Date: Wed, 8 Jun 2022 12:12:29 +0200 Subject: [PATCH] [Doc] Fix Enterprise Edition modues syntax following 4.0 release --- docs/AccordionForm.md | 2 +- docs/Calendar.md | 5 ++- docs/CreateDialog.md | 18 +++++++---- docs/EditDialog.md | 21 ++++++++----- docs/EditableDatagrid.md | 7 ++--- docs/ReferenceManyToManyField.md | 14 ++++----- docs/ReferenceManyToManyInput.md | 53 ++++++++++++-------------------- docs/TreeWithDetails.md | 47 +++++++++++++++------------- docs/WizardForm.md | 3 +- 9 files changed, 84 insertions(+), 86 deletions(-) diff --git a/docs/AccordionForm.md b/docs/AccordionForm.md index aabb45110a0..f545ec8379c 100644 --- a/docs/AccordionForm.md +++ b/docs/AccordionForm.md @@ -61,4 +61,4 @@ You can also use the `` component as a child of `` ![Accordion section](https://marmelab.com/ra-enterprise/modules/assets/ra-accordion-section-overview.gif) -Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout) for more details. +Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout##accordionform) for more details. diff --git a/docs/Calendar.md b/docs/Calendar.md index a2a4cfe193a..74ec2c28e55 100644 --- a/docs/Calendar.md +++ b/docs/Calendar.md @@ -26,7 +26,7 @@ The user interface offers everything you expect: ## Usage -Use `` as a child of ``: +Use `` as a child of `` to render a list of events in a calendar: ```jsx import { Calendar, getFilterValuesFromInterval } from '@react-admin/ra-calendar'; @@ -46,7 +46,6 @@ const EventList = () => ( The `ra-calendar` module also offers a full replacement for the `` component, complete with show and edit views for events, called ``: ```jsx -import React from 'react'; import { Admin, Resource, @@ -68,7 +67,7 @@ const EventList = () => ( ); -export const Basic = () => ( +export const App = () => ( diff --git a/docs/CreateDialog.md b/docs/CreateDialog.md index 5d93a9d95df..badcfe6acc7 100644 --- a/docs/CreateDialog.md +++ b/docs/CreateDialog.md @@ -10,8 +10,15 @@ This [Enterprise Edition](https://marmelab.com/ra-enterprise) ( @@ -21,17 +28,16 @@ const CustomerList = () => ( ... - + - - + ); ``` -Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout) for more details. +Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog) for more details. diff --git a/docs/EditDialog.md b/docs/EditDialog.md index 74fb858341a..3f370e25013 100644 --- a/docs/EditDialog.md +++ b/docs/EditDialog.md @@ -10,9 +10,17 @@ This [Enterprise Edition](https://marmelab.com/ra-enterprise) ( <> @@ -21,17 +29,16 @@ const CustomerList = () => ( ... - + - - + ); ``` -Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout) for more details. +Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout#createdialog-editdialog--showdialog) for more details. diff --git a/docs/EditableDatagrid.md b/docs/EditableDatagrid.md index fdbe210f236..5aaf0a81a01 100644 --- a/docs/EditableDatagrid.md +++ b/docs/EditableDatagrid.md @@ -14,7 +14,6 @@ This [Enterprise Edition](https://marmelab.com/ra-enterprise)` is a drop-in replacement for ``. It expects 2 additional props: `createForm` and `editForm`, the components to be displayed when a user creates or edits a row. The `` component allows to create such forms using react-admin Input components. ```jsx -import * as React from 'react'; import { List, TextField, @@ -36,7 +35,7 @@ const professionChoices = [ const ArtistList = () => ( } editForm={} > @@ -53,8 +52,8 @@ const ArtistList = () => ( ); -const ArtistForm = props => ( - +const ArtistForm = () => ( + diff --git a/docs/ReferenceManyToManyField.md b/docs/ReferenceManyToManyField.md index be95c62dc48..93eecf45ed7 100644 --- a/docs/ReferenceManyToManyField.md +++ b/docs/ReferenceManyToManyField.md @@ -10,24 +10,22 @@ This [Enterprise Edition](https://marmelab.com/ra-enterprise)`: ```jsx -import * as React from 'react'; -import { +import { Show, SimpleShowLayout, TextField, DateField, SingleFieldList, ChipField, - EditButton, } from 'react-admin'; -import { ReferenceManyToManyField } from '@react-admin/ra-many-to-many'; +import { ReferenceManyToManyField } from '@react-admin/ra-relationships'; -export const BookShow = props => ( - +export const BookShow = () => ( + - `: +The form displays the events name in a [``](./SelectArrayInput.md): ```jsx -import * as React from 'react'; -import { Edit, SelectArrayInput, SimpleForm, TextInput } from 'react-admin'; -import { ReferenceManyToManyInput, useReferenceManyToManyUpdate } from '@react-admin/ra-many-to-many'; - -/** - * Decorate to override the default save function. - * This is necessary to save changes in the associative table - * only on submission. - */ -const ArtistEditForm = props => { - const save = useReferenceManyToManyUpdate({ - record: props.record, - redirect: props.redirect || 'list', - reference: 'events', - resource: props.resource, - source: 'id', - through: 'performances', - undoable: props.undoable, - using: 'artist_id,event_id', - }); - - return ; -}; - -const ArtistEdit = () => ( +import { + Edit, + SelectArrayInput, + SimpleForm, + TextInput, + required, +} from 'react-admin'; +import { ReferenceManyToManyInput } from '@react-admin/ra-relationships'; + +export const ArtistEdit = () => ( - + @@ -57,16 +42,18 @@ const ArtistEdit = () => ( reference="events" through="performances" using="artist_id,event_id" - fullWidth - label="Performances" > - + - + ); - -export default ArtistEdit; ``` Check [the `ra-relationships` documentation](https://marmelab.com/ra-enterprise/modules/ra-relationships#referencemanytomanyinput) for more details. diff --git a/docs/TreeWithDetails.md b/docs/TreeWithDetails.md index 70bc81a9651..45799a2f654 100644 --- a/docs/TreeWithDetails.md +++ b/docs/TreeWithDetails.md @@ -15,13 +15,24 @@ This component allows users to browse, edit, and rearrange trees. ```jsx // in src/category.js -import * as React from 'react'; -import { Admin, Resource, TextInput } from 'react-admin'; -import { CreateNode, EditNode, SimpleForm, TreeWithDetails } from '@react-admin/ra-tree'; +import { + Admin, + Resource, + Create, + Edit, + SimpleForm, + TextInput, +} from 'react-admin'; +import { + CreateNode, + EditNode, + EditNodeToolbar, + TreeWithDetails, +} from '@react-admin/ra-tree'; // a Create view for a tree uses instead of the standard -const CategoriesCreate = props => ( - +const CategoriesCreate = () => ( + @@ -29,35 +40,27 @@ const CategoriesCreate = props => ( ); // an Edit view for a tree uses instead of the standard -const CategoriesEdit = props => ( - - +const CategoriesEdit = () => ( + + }> -) +); // a List view for a tree uses -export const CategoriesList = props => ( - +export const CategoriesList = () => ( + ); // in src/App.js import { CategoriesList } from './category'; const App = () => ( - + -) +); ``` -Check [the `ra-tree` documentation](https://marmelab.com/ra-enterprise/modules/ra-tree) for more details. +Check [the `ra-tree` documentation](https://marmelab.com/ra-enterprise/modules/ra-tree#treewithdetails-component) for more details. diff --git a/docs/WizardForm.md b/docs/WizardForm.md index 4a2e9565605..0f8a7504e5b 100644 --- a/docs/WizardForm.md +++ b/docs/WizardForm.md @@ -10,7 +10,6 @@ This [Enterprise Edition](https://marmelab.com/ra-enterprise) ( ); ``` -Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout) for more details. +Check [the `ra-form-layout` documentation](https://marmelab.com/ra-enterprise/modules/ra-form-layout#wizardform) for more details.