ra-core
Version: 
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
47 lines • 1.75 kB
TypeScript
import type { ReactEventHandler } from 'react';
import { type UseDeleteControllerParams, type UseDeleteControllerReturn } from './useDeleteController';
import type { RaRecord } from '../../types';
/**
 * Prepare callback for a Delete button with undo support
 * @deprecated prefer the useDeleteController hook instead
 * @example
 *
 * import React from 'react';
 * import ActionDelete from '@mui/icons-material/Delete';
 * import { Button, useDeleteWithUndoController } from 'react-admin';
 *
 * const DeleteButton = ({
 *     resource,
 *     record,
 *     redirect,
 *     onClick,
 *     ...rest
 * }) => {
 *     const { isPending, handleDelete } = useDeleteWithUndoController({
 *         resource,
 *         record,
 *         redirect,
 *         onClick,
 *     });
 *
 *     return (
 *         <Button
 *             onClick={handleDelete}
 *             disabled={isPending}
 *             label="ra.action.delete"
 *             {...rest}
 *         >
 *             <ActionDelete />
 *         </Button>
 *     );
 * };
 */
declare const useDeleteWithUndoController: <RecordType extends RaRecord = any, ErrorType = Error>(props: UseDeleteWithUndoControllerParams<RecordType, ErrorType>) => UseDeleteWithUndoControllerReturn;
export interface UseDeleteWithUndoControllerParams<RecordType extends RaRecord = any, MutationOptionsError = unknown> extends Omit<UseDeleteControllerParams<RecordType, MutationOptionsError>, 'mutationMode'> {
    onClick?: ReactEventHandler<any>;
}
export interface UseDeleteWithUndoControllerReturn extends Omit<UseDeleteControllerReturn, 'handleDelete'> {
    handleDelete: ReactEventHandler<any>;
}
export default useDeleteWithUndoController;
//# sourceMappingURL=useDeleteWithUndoController.d.ts.map