useAutoSave.md

title	useAutoSave

A hook that automatically saves the form at a regular interval. It works for the pessimistic and optimistic mutationMode but not for the undoable.

This feature requires a valid Enterprise Edition subscription.

Usage

Note that you must add the resetOptions prop with { keepDirtyValues: true } to avoid having the user changes overridden by the latest update operation result.

Note: useAutoSave is not compatible with the default warnWhenUnsavedChanges prop of the react-admin form components. However, it implements its own similar mechanism which is enabled by default. You can disable it with the disableWarnWhenUnsavedChanges prop.

Note: This equivalent of warnWhenUnsavedChanges needs a router that supports navigation blocking. It works with the default router provided by react-admin. If you set up your own react-router router, it must be a Data Router. If not, you'll need to use the disableWarnWhenUnsavedChanges prop.

import { useAutoSave } from '@react-admin/ra-core-ee';
import { EditBase, Form } from 'ra-core';
import { TextInput } from 'my-react-admin-ui-library';

const AutoSave = () => {
    const [lastSave, setLastSave] = useState();
    const [error, setError] = useState();
    useAutoSave({
        debounce: 5000,
        onSuccess: () => setLastSave(new Date()),
        onError: error => setError(error),
    });
    return (
        <div>
            {lastSave && <p>Saved at {lastSave.toLocaleString()}</p>}
            {error && <p>Error: {error}</p>}
        </div>
    );
};

const PostEdit = () => (
    <EditBase mutationMode="optimistic">
        <Form resetOptions={{ keepDirtyValues: true }}>
            <TextInput source="title" />
            <TextInput source="teaser" />
            <button type="submit">Save</button>
            <AutoSave />
        </Form>
    </EditBase>
);

useAutoSave returns a boolean indicating whether the form is currently being saved.

const isSaving = useAutoSave({
    debounce: 5000,
    onSuccess: () => setLastSave(new Date()),
    onError: error => setError(error),
});

Parameters

It accepts the following parameters:

Parameter	Required	Type	Default	Description
debounce	-	number	3000 (3s)	The interval in milliseconds between two autosaves.
onSuccess	-	function		A callback to call when the save request succeeds.
onError	-	function		A callback to call when the save request fails.
transform	-	function		A function to transform the data before saving.
disableWarnWhenUnsavedChanges	-	boolean	false	A boolean indicating whether users should be warned when they close the browser tab or navigate away from the application if they have unsaved changes.

debounce

The interval in milliseconds between two autosaves. Defaults to 3000 (3s).

const isSaving = useAutoSave({
    debounce: 5000,
});

disableWarnWhenUnsavedChanges

A boolean indicating whether users should be warned when they close the browser tab or navigate away from the application if they have unsaved changes.

const isSaving = useAutoSave({
    disableWarnWhenUnsavedChanges: true
});

onSuccess

A callback to call when the save request succeeds.

const [lastSave, setLastSave] = useState();

const isSaving = useAutoSave({
    onSuccess: () => setLastSave(new Date()),
});

onError

A callback to call when the save request fails.

const [error, setError] = useState();

const isSaving = useAutoSave({
    onError: error => setError(error),
});

transform

A function to transform the data before saving.

const isSaving = useAutoSave({
    transform: data => ({
        ...data,
        fullName: `${data.firstName} ${data.lastName}`
    })
});