<Edit> provides us a layout for displaying the page. It does not contain any logic but adds extra functionalities like a <RefreshButton>.
We will show what <Edit> does using properties with examples.
Live previews only work with the latest documentation.
import React from "react";
import {
Edit,
useAutocomplete,
TextField,
Autocomplete,
Box,
} from "@pankod/refine-mui";
import { useForm, Controller } from "@pankod/refine-react-hook-form";
const SampleEdit = () => {
const {
saveButtonProps,
refineCore: { queryResult },
register,
control,
formState: { errors },
} = useForm();
const samplesData = queryResult?.data?.data;
const { autocompleteProps: categoryAutocompleteProps } = useAutocomplete({
resource: "categories",
defaultValue: samplesData?.category?.id,
});
return (
<Edit saveButtonProps={saveButtonProps}>
<Box
component="form"
sx={{ display: "flex", flexDirection: "column" }}
autoComplete="off"
>
<TextField
{...register("id", {
required: "This field is required",
})}
error={!!(errors as any)?.id}
helperText={(errors as any)?.id?.message}
margin="normal"
fullWidth
InputLabelProps={{ shrink: true }}
type="number"
label="Id"
name="id"
disabled
/>
<TextField
{...register("title", {
required: "This field is required",
})}
error={!!(errors as any)?.title}
helperText={(errors as any)?.title?.message}
margin="normal"
fullWidth
InputLabelProps={{ shrink: true }}
type="text"
label="Title"
name="title"
/>
<Controller
control={control}
name="category"
rules={{ required: "This field is required" }}
defaultValue={null as any}
render={({ field }) => (
<Autocomplete
{...categoryAutocompleteProps}
{...field}
onChange={(_, value) => {
field.onChange(value);
}}
getOptionLabel={(item) => {
return (
categoryAutocompleteProps?.options?.find(
(p) =>
p?.id?.toString() ===
item?.id?.toString(),
)?.title ?? ""
);
}}
isOptionEqualToValue={(option, value) =>
value === undefined ||
option?.id?.toString() === value?.id?.toString()
}
renderInput={(params) => (
<TextField
{...params}
label="Category"
margin="normal"
variant="outlined"
error={!!(errors as any)?.category?.id}
helperText={
(errors as any)?.category?.id?.message
}
required
/>
)}
/>
)}
/>
</Box>
</Edit>
);
};
You can swizzle this component to customize it with the refine CLI
Properties
title
It allows adding title inside the <Edit> component. if you don't pass title props it uses "Edit" prefix and singular resource name by default. For example, for the /posts/edit resource, it will be "Edit post".
Live previews only work with the latest documentation.
import { Edit, Typography } from "@pankod/refine-mui";
const EditPage: React.FC = () => {
return (
<Edit
title={<Typography variant="h5">Custom Title</Typography>}
>
<span>Rest of your page here</span>
</Edit>
);
};
resource
The <Edit> component reads the resource information from the route by default. This default behavior will not work on custom pages. If you want to use the <Edit> component in a custom page, you can use the resource prop.
Refer to the custom pages documentation for detailed usage. →
Live previews only work with the latest documentation.
import { Refine } from "@pankod/refine-core";
import { Edit, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
const CustomPage: React.FC = () => {
return (
<Edit resource="posts" recordItemId={123}>
<span>Rest of your page here</span>
</Edit>
);
};
const App: React.FC = () => {
return (
<Refine
routerProvider={{
...routerProvider,
routes: [
{
element: <CustomPage />,
path: "/custom",
},
],
}}
Layout={Layout}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
resources={[{ name: "posts" }]}
/>
);
};
The <Edit> component has a save button by default. If you want to customize this button you can use the saveButtonProps property like the code below.
Clicking on the save button will submit your form.
Refer to the <SaveButton> documentation for detailed usage. →
Live previews only work with the latest documentation.
import { Edit } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
return (
<Edit saveButtonProps={{ size: "small" }}>
<span>Rest of your page here</span>
</Edit>
);
};
canDelete allows us to add the delete button inside the <Edit> component. If the resource has the canDelete property, refine adds the delete button by default. If you want to customize this button you can use the deleteButtonProps property like the code below.
When clicked on, the delete button executes the useDelete method provided by the dataProvider.
Refer to the <DeleteButton> documentation for detailed usage. →
Live previews only work with the latest documentation.
import { Edit } from "@pankod/refine-mui";
import { usePermissions } from "@pankod/refine-core";
const PostEdit: React.FC = () => {
const { data: permissionsData } = usePermissions();
return (
<Edit
canDelete={permissionsData?.includes("admin")}
deleteButtonProps={{ size: "small" }}
saveButtonProps={{ size: "small" }}
>
<p>Rest of your page here</p>
</Edit>
);
};
Refer to the usePermission documentation for detailed usage. →
recordItemId
The <Edit> component reads the id information from the route by default. recordItemId is used when it cannot read from the URL(when used on a custom page, modal or drawer).
Live previews only work with the latest documentation.
import { Refine } from "@pankod/refine-core";
import { Edit, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
const CustomPage: React.FC = () => {
return (
<Edit resource="posts" recordItemId={123}>
<span>Rest of your page here</span>
</Edit>
);
};
const App: React.FC = () => {
return (
<Refine
routerProvider={{
...routerProvider,
routes: [
{
element: <CustomPage />,
path: "/custom",
},
],
}}
Layout={Layout}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
resources={[{ name: "posts" }]}
/>
);
};
The <Edit> component needs the id information for the <RefreshButton> to work properly.
mutationMode
Determines which mode mutation will have while executing <DeleteButton>.
Refer to the mutation mode docs for further information. →
Live previews only work with the latest documentation.
import React from "react";
import {
Edit,
useAutocomplete,
TextField,
Autocomplete,
Box,
} from "@pankod/refine-mui";
import { useForm, Controller } from "@pankod/refine-react-hook-form";
const SampleEdit = () => {
const {
saveButtonProps,
refineCore: { queryResult },
register,
control,
formState: { errors },
} = useForm();
const samplesData = queryResult?.data?.data;
const { autocompleteProps: categoryAutocompleteProps } = useAutocomplete({
resource: "categories",
defaultValue: samplesData?.category?.id,
});
return (
<Edit
saveButtonProps={saveButtonProps}
canDelete
mutationMode="undoable"
>
<Box
component="form"
sx={{ display: "flex", flexDirection: "column" }}
autoComplete="off"
>
<TextField
{...register("id", {
required: "This field is required",
})}
error={!!(errors as any)?.id}
helperText={(errors as any)?.id?.message}
margin="normal"
fullWidth
InputLabelProps={{ shrink: true }}
type="number"
label="Id"
name="id"
disabled
/>
<TextField
{...register("title", {
required: "This field is required",
})}
error={!!(errors as any)?.title}
helperText={(errors as any)?.title?.message}
margin="normal"
fullWidth
InputLabelProps={{ shrink: true }}
type="text"
label="Title"
name="title"
/>
<Controller
control={control}
name="category"
rules={{ required: "This field is required" }}
defaultValue={null as any}
render={({ field }) => (
<Autocomplete
{...categoryAutocompleteProps}
{...field}
onChange={(_, value) => {
field.onChange(value);
}}
getOptionLabel={(item) => {
return (
categoryAutocompleteProps?.options?.find(
(p) =>
p?.id?.toString() ===
item?.id?.toString(),
)?.title ?? ""
);
}}
isOptionEqualToValue={(option, value) =>
value === undefined ||
option?.id?.toString() === value?.id?.toString()
}
renderInput={(params) => (
<TextField
{...params}
label="Category"
margin="normal"
variant="outlined"
error={!!(errors as any)?.category?.id}
helperText={
(errors as any)?.category?.id?.message
}
required
/>
)}
/>
)}
/>
</Box>
</Edit>
);
};
dataProviderName
If not specified, Refine will use the default data provider. If you have multiple data providers and want to use a different one, you can use the dataProviderName property.
import { Refine } from "@pankod/refine-core";
import { Edit } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
const PostEdit = () => {
return <Edit dataProviderName="other">...</Edit>;
};
export const App: React.FC = () => {
return (
<Refine
routerProvider={routerProvider}
dataProvider={{
default: dataProvider("https://api.fake-rest.refine.dev/"),
other: dataProvider("https://other-api.fake-rest.refine.dev/"),
}}
resources={[{ name: "posts", edit: PostEdit }]}
/>
);
};
goBack
To customize the back button or to disable it, you can use the goBack property.
Live previews only work with the latest documentation.
import { Edit, Button } from "@pankod/refine-mui";
import { useNavigation } from "@pankod/refine-core";
const BackButton = () => {
const { goBack } = useNavigation();
return <Button onClick={() => goBack()}>BACK!</Button>
}
const PostEdit: React.FC = () => {
return (
<Edit
goBack={<BackButton />}
>
<span>Rest of your page here</span>
</Edit>
);
};
isLoading
To toggle the loading state of the <Edit/> component, you can use the isLoading property.
Live previews only work with the latest documentation.
import { Edit } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
isLoading={loading}
>
<span>Rest of your page here</span>
</Edit>
);
};
breadcrumb
To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @pankod/refine-mui package.
Refer to the Breadcrumb documentation for detailed usage. →
This feature can be managed globally via the <Refine> component's options
Live previews only work with the latest documentation.
import { Edit, Breadcrumb } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
return (
<Edit
breadcrumb={
<div
style={{
padding: "3px 6px",
border: "2px dashed cornflowerblue",
}}
>
<Breadcrumb />
</div>
}
>
<span>Rest of your page here</span>
</Edit>
);
};
wrapperProps
If you want to customize the wrapper of the <Edit/> component, you can use the wrapperProps property.
Refer to the Card documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { Edit } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
wrapperProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
>
<span>Rest of your page here</span>
</Edit>
);
};
If you want to customize the header of the <Edit/> component, you can use the headerProps property.
Refer to the CardHeader documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { Edit } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
headerProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
>
<span>Rest of your page here</span>
</Edit>
);
};
contentProps
If you want to customize the content of the <Edit/> component, you can use the contentProps property.
Refer to the CardContent documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { Edit } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
contentProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
>
<span>Rest of your page here</span>
</Edit>
);
};
You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.
Live previews only work with the latest documentation.
import { Edit, Button } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<span>Rest of your page here</span>
</Edit>
);
};
You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.
Refer to the Box documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { Edit, Button } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
headerButtonProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<span>Rest of your page here</span>
</Edit>
);
};
You can customize the buttons at the footer by using the footerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.
Live previews only work with the latest documentation.
import { Edit, Button } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
footerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<span>Rest of your page here</span>
</Edit>
);
};
You can customize the wrapper element of the buttons at the footer by using the footerButtonProps property.
Refer to the CardActions documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { Edit, Button } from "@pankod/refine-mui";
const PostEdit: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<Edit
footerButtonProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
footerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<span>Rest of your page here</span>
</Edit>
);
};
Use headerButtons or footerButtons instead.
<Edit> uses the Material UI <CardActions> component. The children of the <CardActions> component shows <SaveButton> and <DeleteButton> based on your resource definition in theresourcesproperty you pass to <Refine>. If you want to use other things instead of these buttons, you can use the actionButton property like the code below.
src/pages/posts/edit.tsx
import { Edit, Button } from "@pankod/refine-mui";
export const EditPage: React.FC = () => {
return (
<Edit
actionButtons={
<>
<Button>Custom Button 1</Button>
<Button>Custom Button 2</Button>
</>
}
>
...
</Edit>
);
};
cardProps
Use wrapperProps instead.
<Edit> uses the Material UI <Card> components so you can customize with the props of cardProps.
<Edit> uses the Material UI <CardHeader> components so you can customize with the props of cardHeaderProps.
src/pages/posts/edit.tsx
import { Edit, Typography } from "@pankod/refine-mui";
export const EditPage: React.FC = () => {
return (
<Edit
cardHeaderProps={{
title: <Typography variant="h5">Custom Title</Typography>,
}}
>
...
</Edit>
);
};
cardContentProps
Use contentProps instead.
<Edit> uses the Material UI <CardContent> components so you can customize with the props of cardContentProps.
cardActionsProps
Use headerButtonProps and footerButtonProps instead.
<Edit> uses the Material UI <CardActions> components so you can customize with the props of cardActionsProps.
API Reference
Properties
http://localhost:3000/posts/edit/123