useRestoreOne
This hook allows calling dataProvider.restoreOne()
when the callback is executed and restoring a single deleted record based on its id
.
Warning: The id
here is the ID of the deleted record, and not the ID of the actual record that has been deleted.
const [restoreOne, { data, isPending, error }] = useRestoreOne(
{ id, meta },
options,
);
The restoreOne()
method can be called with the same parameters as the hook:
const [restoreOne, { data, isPending, error }] = useRestoreOne();
// ...
restoreOne(
{ id, meta },
options,
);
So, should you pass the parameters when calling the hook, or when executing the callback? Itβs up to you; but if you have the choice, we recommend passing the parameters when calling the restoreOne
callback (second example).
Usage
// set params when calling the hook
import { useRecordContext } from 'react-admin';
import { useRestoreOne } from '@react-admin/ra-soft-delete';
const RestoreButton = () => {
const deletedRecord = useRecordContext();
const [restoreOne, { isPending, error }] = useRestoreOne(
{ id: deletedRecord.id }
);
const handleClick = () => {
restoreOne();
}
if (error) { return <p>ERROR</p>; }
return <button disabled={isPending} onClick={handleClick}>Restore</button>;
};
// set params when calling the restoreOne callback
import { useRecordContext } from 'react-admin';
import { useRestoreOne } from '@react-admin/ra-soft-delete';
const HardDeleteButton = () => {
const deletedRecord = useRecordContext();
const [restoreOne, { isPending, error }] = useRestoreOne();
const handleClick = () => {
restoreOne(
{ id: deletedRecord.id }
);
}
if (error) { return <p>ERROR</p>; }
return <button disabled={isPending} onClick={handleClick}>Restore</button>;
};
TypeScript
The useRestoreOne
hook accepts a generic parameter for the record type and another for the error type:
useRestoreOne<Product, Error>(undefined, undefined, {
onError: (error) => {
// TypeScript knows that error is of type Error
},
onSettled: (data, error) => {
// TypeScript knows that data is of type DeletedRecordType<Product>
// TypeScript knows that error is of type Error
},
});