ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
65 lines • 2.14 kB
TypeScript
import { UseDeleteOptions } from '../../dataProvider/useDelete';
import { RedirectionSideEffect } from '../../routing/useRedirect';
import { RaRecord, MutationMode } from '../../types';
/**
* Prepare a set of callbacks for a delete button
*
* @example
* const DeleteButton = ({
* redirect,
* ...rest
* }) => {
* const {
* isPending,
* handleDelete,
* } = useDeleteController({
* mutationMode: 'pessimistic',
* redirect,
* });
*
* const [open, setOpen] = useState(false);
*
* return (
* <Fragment>
* <Button
* onClick={() => setOpen(true)}
* label="ra.action.delete"
* {...rest}
* >
* {icon}
* </Button>
* <Confirm
* isOpen={open}
* loading={isPending}
* title="ra.message.delete_title"
* content="ra.message.delete_content"
* titleTranslateOptions={{
* name: resource,
* id: record.id,
* }}
* contentTranslateOptions={{
* name: resource,
* id: record.id,
* }}
* onConfirm={() => handleDelete()}
* onClose={() => setOpen(false)}
* />
* </Fragment>
* );
* };
*/
export declare const useDeleteController: <RecordType extends RaRecord = any, ErrorType = Error>(props: UseDeleteControllerParams<RecordType, ErrorType>) => UseDeleteControllerReturn;
export interface UseDeleteControllerParams<RecordType extends RaRecord = any, MutationOptionsError = unknown> {
mutationMode?: MutationMode;
mutationOptions?: UseDeleteOptions<RecordType, MutationOptionsError>;
record?: RecordType;
redirect?: RedirectionSideEffect;
resource?: string;
successMessage?: string;
}
export interface UseDeleteControllerReturn {
isLoading: boolean;
isPending: boolean;
handleDelete: () => void;
}
//# sourceMappingURL=useDeleteController.d.ts.map