Skip to content

[Doc] Fix incorrect documentation of EditInDialogButton #10943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 5, 2025
+55 −71
Merged

[Doc] Fix incorrect documentation of EditInDialogButton #10943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a94c8d
Fix incorrect documentation of EditInDialogButton.
Madeorsk Sep 17, 2025
8b5400b
Fix code snippet
fzaninotto Nov 4, 2025
feba805
Improve labels
djhi Nov 5, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 47 additions & 59 deletions docs/EditDialog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,75 +433,63 @@ const sexChoices = [
{ id: 'female', name: 'Female' },
];

const CustomerForm = (props: any) => (
<SimpleForm defaultValues={{ firstname: 'John', name: 'Doe' }} {...props}>
const CustomerForm = () => (
<SimpleForm>
<TextInput source="first_name" validate={required()} />
<TextInput source="last_name" validate={required()} />
<DateInput source="dob" label="born" validate={required()} />
<DateInput source="dob" label="Born" validate={required()} />
<SelectInput source="sex" choices={sexChoices} />
</SimpleForm>
);

const EmployerSimpleFormWithFullyControlledDialogs = () => {
const record = useRecordContext();

const [isEditDialogOpen, setIsEditDialogOpen] = useState(false);
const openEditDialog = useCallback(() => {
setIsEditDialogOpen(true);
const EmployerEdit = () => {
const [record, setRecord] = React.useState<any>(undefined);
const closeDialog = React.useCallback(() => {
setRecord(undefined);
}, []);
const closeEditDialog = useCallback(() => {
setIsEditDialogOpen(false);
}, []);

return (
<SimpleForm>
<TextInput source="name" validate={required()} />
<TextInput source="address" validate={required()} />
<TextInput source="city" validate={required()} />
<ReferenceManyField
label="Customers"
reference="customers"
target="employer_id"
>
<DataTable>
<DataTable.Col source="id" />
<DataTable.Col source="first_name" />
<DataTable.Col source="last_name" />
<DataTable.Col source="dob" label="born" field={DateField} />
<DataTable.Col source="sex">
<SelectField source="sex" choices={sexChoices} />
</DataTable.Col>
<DataTable.Col>
<Button
label="Edit customer"
onClick={() => openEditDialog()}
size="medium"
variant="contained"
sx={{ mb: 4 }}
/>
<DataTable.Col>
</DataTable>
</ReferenceManyField>
<EditDialog
fullWidth
maxWidth="md"
record={{ employer_id: record?.id }} // pre-populates the employer_id to link the new customer to the current employer
isOpen={isEditDialogOpen}
open={openEditDialog}
close={closeEditDialog}
resource="customers"
>
<CustomerForm />
</EditDialog>
</SimpleForm>
<Edit>
<SimpleForm>
<TextInput source="name" validate={required()} />
<TextInput source="address" validate={required()} />
<TextInput source="city" validate={required()} />
<ReferenceManyField
label="Customers"
reference="customers"
target="employer_id"
>
<DataTable>
<DataTable.Col source="id" />
<DataTable.Col source="first_name" />
<DataTable.Col source="last_name" />
<DataTable.Col label="born">
<DateField source="dob" label="Born" />
</DataTable.Col>
<DataTable.Col source="sex">
<SelectField source="sex" choices={sexChoices} />
</DataTable.Col>
<DataTable.Col render={record => (
<Button
label="Edit customer"
onClick={() => setRecord(record)}
/>
)} />
</DataTable>
</ReferenceManyField>
<EditDialog
record={record}
resource="customers"
isOpen={!!record}
close={closeDialog}
fullWidth
maxWidth="md"
>
<CustomerForm />
</EditDialog>
</SimpleForm>
</Edit>
);
};

const EmployerEdit = () => (
<Edit>
<EmployerSimpleFormWithFullyControlledDialogs />
</Edit>
);
```

{% endraw %}
Expand Down
20 changes: 8 additions & 12 deletions docs/ReferenceManyField.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,18 +582,14 @@ const EmployerEdit = () => (
<DataTable>
<DataTable.Col source="first_name" />
<DataTable.Col source="last_name" />
<DataTable.Col
render={record => (
<EditInDialogButton>
<SimpleForm
record={{ employer_id: record.id }}
>
<TextInput source="first_name" />
<TextInput source="last_name" />
</SimpleForm>
</EditInDialogButton>
)}
/>
<DataTable.Col>
<EditInDialogButton>
<SimpleForm>
<TextInput source="first_name" />
<TextInput source="last_name" />
</SimpleForm>
</EditInDialogButton>
</DataTable.Col>
</DataTable>
</ReferenceManyField>
</SimpleForm>
Expand Down
Loading