<Edit>
provides us a layout for displaying the page. It does not contain any logic and just adds extra functionalities like a <RefreshButton>
.
We will show what <Edit>
does using properties with examples.
localhost:3000/posts/edit/123
Show Code Hide Code import React from "react" ; import { Edit , useAutocomplete } from "@refinedev/mui" ; import { TextField , Autocomplete , Box } from "@mui/material" ; import { useForm } from "@refinedev/react-hook-form" ; import { Controller } from "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 ?? value ) ?. 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 with the refine CLI to customize it.
Properties title
title
allows the addition of titles 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".
localhost:3000/posts/create
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { Typography } from "@mui/material" ; 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. If you want to use a custom resource for the <Edit>
component, you can use the resource
prop.
Show Code Hide Code import { Edit } from "@refinedev/mui" ; const CustomPage : React . FC = ( ) => { return ( < Edit resource = " posts " recordItemId = { 123 } > < span > Rest of your page here </ span > </ Edit > ) ; } ;
If you have multiple resources with the same name, you can pass the identifier
instead of the name
of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name
of the resource defined in the <Refine/>
component.
For more information, refer to the identifier
section of the <Refine/>
component documentation →
The <Edit>
component has a save button that submits the form by default. If you want to customize this button you can use the saveButtonProps
property like the code below:
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; const PostEdit : React . FC = ( ) => { return ( < Edit saveButtonProps = { { size : "small" } } > < span > Rest of your page here </ span > </ Edit > ) ; } ;
For more information, refer to the <SaveButton>
documentation →
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
.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { usePermissions } from "@refinedev/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 > ) ; } ;
For more information, refer to the <DeleteButton>
→ and usePermission
→ documentations
recordItemId
The <Edit>
component reads the id
information from the route by default. recordItemId
is used when it cannot read from the URL, like when its used on a custom page, modal or drawer.
Show Code Hide Code import { Edit } from "@refinedev/mui" ; const CustomPage : React . FC = ( ) => { return ( < Edit resource = " posts " recordItemId = { 123 } > < span > Rest of your page here </ span > </ Edit > ) ; } ;
The <Edit>
component needs the id
information for the <RefreshButton>
to work properly.
mutationMode
Determines which mode mutation will have while executing <DeleteButton>
.
localhost:3000/posts/edit/123
Show Code Hide Code import React from "react" ; import { Edit , useAutocomplete } from "@refinedev/mui" ; import { TextField , Autocomplete , Box } from "@mui/material" ; import { useForm } from "@refinedev/react-hook-form" ; import { Controller } from "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 ?? value ) ?. 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 > ) ; } ;
For more information, refer to the mutation mode documentation →
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 "@refinedev/core" ; import dataProvider from "@refinedev/simple-rest" ; import { Edit } from "@refinedev/mui" ; const PostEdit = ( ) => { return < Edit dataProviderName = " other " > ... </ Edit > ; } ; export const App : React . FC = ( ) => { return ( < Refine dataProvider = { { default : dataProvider ( "https://api.fake-rest.refine.dev/" ) , other : dataProvider ( "https://other-api.fake-rest.refine.dev/" ) , } } > { } </ Refine > ) ; } ;
goBack
To customize the back button or to disable it, you can use the goBack
property.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { Button } from "@mui/material" ; import { useBack } from "@refinedev/core" ; const BackButton = ( ) => { const goBack = useBack ( ) ; 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.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/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 @refinedev/mui
package.
This feature can be managed globally via the <Refine>
component's options
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit , Breadcrumb } from "@refinedev/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 > ) ; } ;
For more information, refer to the Breadcrumb
documentation →
wrapperProps
If you want to customize the wrapper of the <Edit/>
component, you can use the wrapperProps
property.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/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 > ) ; } ;
For more information, refer to the Card
documentation from Material UI →
If you want to customize the header of the <Edit/>
component, you can use the headerProps
property.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/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 > ) ; } ;
For more information, refer to the CardHeader
documentation from Material UI →
contentProps
If you want to customize the content of the <Edit/>
component, you can use the contentProps
property.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/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 > ) ; } ;
For more information, refer to the CardContent
documentation from Material UI →
By default, the <Edit/>
component has a <ListButton>
and a <RefreshButton>
at the header.
You can customize the buttons at the header by using the headerButtons
property. It accepts React.ReactNode
or a render function ({ defaultButtons, refreshButtonProps, listButtonProps }) => React.ReactNode
which you can use to keep the existing buttons and add your own.
If "list" resource is not defined, the <ListButton>
will not render and listButtonProps
will be undefined
.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { Button } from "@mui/material" ; 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 > ) ; } ;
Or, instead of using the defaultButtons
, you can create your own buttons. If you want, you can use refreshButtonProps
and listButtonProps
to utilize the default values of the <ListButton>
and <RefreshButton>
components.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit , ListButton , RefreshButton } from "@refinedev/mui" ; import { Button } from "@mui/material" ; const PostEdit : React . FC = ( ) => { const [ loading , setLoading ] = React . useState ( true ) ; return ( < Edit headerButtons = { ( { refreshButtonProps , listButtonProps } ) => ( < > < RefreshButton { ... refreshButtonProps } meta = { { foo : "bar" } } /> { listButtonProps && ( < ListButton { ... listButtonProps } meta = { { foo : "bar" } } /> ) } < 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.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { Button } from "@mui/material" ; 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 > ) ; } ;
For more information, refer to the Box
documentation from Material UI →
By default, the <Edit/>
component has a <SaveButton>
and a <DeleteButton>
at the footer.
You can customize the buttons at the footer by using the footerButtons
property. It accepts React.ReactNode
or a render function ({ defaultButtons, saveButtonProps, deleteButtonProps }) => React.ReactNode
which you can use to keep the existing buttons and add your own.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { Button } from "@mui/material" ; 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 > ) ; } ;
Or, instead of using the defaultButtons
, you can create your own buttons. If you want, you can use saveButtonProps
and deleteButtonProps
to utilize the default values of the <SaveButton>
and <DeleteButton>
components.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit , SaveButton , DeleteButton } from "@refinedev/mui" ; import { Button } from "@mui/material" ; const PostEdit : React . FC = ( ) => { const [ loading , setLoading ] = React . useState ( true ) ; return ( < Edit footerButtons = { ( { saveButtonProps , deleteButtonProps } ) => ( < > < Button type = " primary " > Custom Button </ Button > < SaveButton { ... saveButtonProps } hideText /> { deleteButtonProps && ( < DeleteButton { ... deleteButtonProps } hideText /> ) } </ > ) } > < 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.
localhost:3000/posts/edit/123
Show Code Hide Code import { Edit } from "@refinedev/mui" ; import { Button } from "@mui/material" ; 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 > ) ; } ;
For more information, refer to the CardActions
documentation from Material UI →
autoSaveProps
You can use the auto save feature of the <Edit/>
component by using the autoSaveProps
property.
localhost:3000/posts/edit/123
Show Code Hide Code const SampleEdit = ( ) => { const { saveButtonProps , refineCore : { queryResult , autoSaveProps } , register , control , formState : { errors } , } = useForm ( { refineCoreProps : { autoSave : { enabled : true , } , } , } ) ; const samplesData = queryResult ?. data ?. data ; const { autocompleteProps : categoryAutocompleteProps } = useAutocomplete ( { resource : "categories" , defaultValue : samplesData ?. category ?. id , } ) ; return ( < Edit saveButtonProps = { saveButtonProps } autoSaveProps = { autoSaveProps } > < 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 ?? value ) ?. 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 > ) ; } ;
API Reference Properties