useDrawerForm
The useDrawerForm
hook allows you to manage a form within a Drawer. It returns the Ant Design <Form>
and <Drawer>
components props.
TheuseDrawerForm
hook is extended from useForm
from the @refinedev/antd package. This means that you can use all the features of useForm
hook with it.
Basic Usage
We will show two examples, one for creating a post and one for editing it. Let's see how useDrwaerForm
is used in them.
- create
- edit
In this example, we will show you how to "create"
a record with useDrawerForm
:
In this example, we will show you how to "edit"
a record with useDrawerForm
:
refine doesn't automatically add a <EditButton/>
to the each record in <PostList>
which opens the edit form in <Drawer>
when clicked.
So, we have to put the <EditButton/>
on our list manually. In that way, <Edit>
form in <Drawer>
can fetch data by the record id
.
<Table.Column<IPost>
title="Actions"
dataIndex="actions"
key="actions"
render={(_value, record) => <EditButton onClick={() => show(record.id)} />}
/>
Don't forget to pass the record "id"
to show
to fetch the record data. This is necessary for both "edit"
and "clone"
forms.
Properties
syncWithLocation
When syncWithLocation
is true
, the drawers visibility state and the id
of the record will be synced with the URL. It is false
by default.
This property can also be set as an object { key: string; syncId?: boolean }
to customize the key of the URL query parameter. id
will be synced with the URL only if syncId
is true
.
const drawerForm = useDrawerForm({
syncWithLocation: { key: "my-modal", syncId: true },
});
overtimeOptions
If you want loading overtime for the request, you can pass the overtimeOptions
prop to the this hook. It is useful when you want to show a loading indicator when the request takes too long.
interval
is the time interval in milliseconds. onInterval
is the function that will be called on each interval.
Return overtime
object from this hook. elapsedTime
is the elapsed time in milliseconds. It becomes undefined
when the request is completed.
const { overtime } = useDrawerForm({
//...
overtimeOptions: {
interval: 1000,
onInterval(elapsedInterval) {
console.log(elapsedInterval);
},
},
});
console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
// You can use it like this:
{
elapsedTime >= 4000 && <div>this takes a bit longer than expected</div>;
}
autoSave
If you want to save the form automatically after some delay when user edits the form, you can pass true to autoSave.enabled
prop.
By default the autoSave
feature does not invalidate queries. However, you can use the invalidateOnUnmount
and invalidateOnClose
props to invalidate queries upon unmount or close.
It also supports onMutationSuccess
and onMutationError
callback functions. You can use isAutoSave
parameter to determine whether the mutation is triggered by autoSave
or not.
autoSave
feature operates exclusively in edit
mode. Users can take advantage of this feature while editing data, as changes are automatically saved in editing mode. However, when creating new data, manual saving is still required.
onMutationSuccess
and onMutationError
callbacks will be called after the mutation is successful or failed.
enabled
Default:
false
To enable the autoSave
feature, set the enabled
parameter to true
.
useDrawerForm({
autoSave: {
enabled: true,
},
});
debounce
Default:
1000
Set the debounce time for the autoSave
prop.
useDrawerForm({
autoSave: {
enabled: true,
debounce: 2000,
},
});
onFinish
If you want to modify the data before sending it to the server, you can use onFinish
callback function.
useDrawerForm({
autoSave: {
enabled: true,
onFinish: (values) => {
return {
foo: "bar",
...values,
};
},
},
});
invalidateOnUnmount
Default:
false
This prop is useful when you want to invalidate the list
, many
and detail
queries from the current resource when the hook is unmounted. By default, it invalidates the list
, many
and detail
queries associated with the current resource. Also, You can use the invalidates
prop to select which queries to invalidate.
useDrawerForm({
autoSave: {
enabled: true,
invalidateOnUnmount: true,
},
});
invalidateOnClose
Default:
false
This prop is useful when you want to invalidate the list
, many
and detail
queries from the current resource when the drawer is closed. By default, it invalidates the list
, many
and detail
queries associated with the current resource. Also, You can use the invalidates
prop to select which queries to invalidate.
useDrawerForm({
autoSave: {
enabled: true,
invalidateOnClose: true,
},
});
Return values
show
A function that opens the <Drawer>
. It takes an optional id
parameter. If id
is provided, it will fetch the record data and fill the <Form>
with it.
close
A function that closes the <Drawer>
. Same as [onClose][#onClose]
.
saveButtonProps
It contains the props needed by the "submit"
button within the <Drawer>
(disabled,loading etc.). When saveButtonProps.onClick
is called, it triggers form.submit()
. You can manually pass these props to your custom button.
deleteButtonProps
It contains the props needed by the "delete"
button within the <Drawer>
(disabled,loading etc.). When deleteButtonProps.onSuccess
is called, it triggers it sets id
to undefined
and open
to false
. You can manually pass these props to your custom button.
formProps
It's required to manage <Form>
state and actions. Under the hood the formProps
came from useForm
.
It contains the props to manage the Antd <Form>
component such as onValuesChange
, initialValues
, onFieldsChange
, onFinish
etc.
drawerProps
It's required to manage <Drawer>
state and actions.
width
Default:
"500px"
It's the width of the <Drawer>
.
onClose
A function that can close the <Drawer>
. It's useful when you want to close the <Drawer>
manually.
When warnWhenUnsavedChanges
is true
, it will show a confirmation modal before closing the <Drawer>
. If you override this function, you have to handle this confirmation modal manually.
open
Default:
false
Current visible state of <Drawer>
.
forceRender
Default:
true
It renders <Drawer>
instead of lazy rendering it.
overtime
overtime
object is returned from this hook. elapsedTime
is the elapsed time in milliseconds. It becomes undefined
when the request is completed.
const { overtime } = useDrawerForm();
console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
autoSaveProps
If autoSave
is enabled, this hook returns autoSaveProps
object with data
, error
, and status
properties from mutation.
FAQ
How can I change the form data before submitting it to the API?
You may need to modify the form data before it is sent to the API.
For example, Let's send the values we received from the user in two separate inputs, name
and surname
, to the API as fullName
.
import { Create, Drawer, useDrawerForm } from "@refinedev/antd";
import { Form, Input } from "antd";
import React from "react";
export const UserCreate: React.FC = () => {
const { formProps, drawerProps, saveButtonProps } = useDrawerForm({
action: "create",
});
const handleOnFinish = (values) => {
formProps.onFinish?.({
fullName: `${values.name} ${values.surname}`,
});
};
return (
<Drawer {...drawerProps}>
<Create saveButtonProps={saveButtonProps}>
<Form
{...formProps}
onFinish={handleOnFinish}
layout="vertical"
>
<Form.Item label="Name" name="name">
<Input />
</Form.Item>
<Form.Item label="Surname" name="surname">
<Input />
</Form.Item>
</Form>
</Create>
</Drawer>
);
};
API Parameters
Properties
*
: These props have default values inRefineContext
and can also be set on <Refine> component.useDrawerForm
will use what is passed to<Refine>
as default but a local value will override it.
**
: If not explicitly configured, default value ofredirect
depends whichaction
used. Ifaction
iscreate
,redirect
s default value isedit
(created resources edit page). Otherwise ifaction
isedit
,redirect
s default value islist
.
Type Parameters
Property | Desription | Type | Default |
---|---|---|---|
TQueryFnData | Result data returned by the query function. Extends BaseRecord | BaseRecord | BaseRecord |
TError | Custom error object that extends HttpError | HttpError | HttpError |
TVariables | Values for params. | {} | |
TData | Result data returned by the select function. Extends BaseRecord . If not specified, the value of TQueryFnData will be used as the default value. | BaseRecord | TQueryFnData |
TResponse | Result data returned by the mutation function. Extends BaseRecord . If not specified, the value of TData will be used as the default value. | BaseRecord | TData |
TResponseError | Custom error object that extends HttpError . If not specified, the value of TError will be used as the default value. | HttpError | TError |
Return Value
Key | Description | Type |
---|---|---|
show | A function that opens the drawer | (id?: BaseKey) => void |
form | Ant Design form instance | FormInstance<TVariables> |
formProps | Ant Design form props | FormProps |
drawerProps | Props for managed drawer | DrawerProps |
saveButtonProps | Props for a submit button | { disabled: boolean; onClick: () => void; loading: boolean; } |
deleteButtonProps | Adds props for delete button | DeleteButtonProps |
submit | Submit method, the parameter is the value of the form fields | () => void |
open | Whether the drawer is open or not | boolean |
close | Specify a function that can close the drawer | () => void |
overtime | Overtime loading props | { elapsedTime?: number } |
autoSaveProps | Auto save props | { data: UpdateResponse<TData> | undefined, error: HttpError | null, status: "loading" | "error" | "idle" | "success" } |
Example
npm create refine-app@latest -- --example form-antd-use-drawer-form
- Basic Usage
- Properties
syncWithLocation
overtimeOptions
autoSave
enabled
debounce
onFinish
invalidateOnUnmount
invalidateOnClose
- Return values
show
close
saveButtonProps
deleteButtonProps
formProps
drawerProps
width
onClose
open
forceRender
overtime
autoSaveProps
- FAQ
- How can I change the form data before submitting it to the API?
- API Parameters
- Properties
- Type Parameters
- Return Value
- Example