@craftercms/studio-ui/components/DeleteDialog/utils.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import StandardAction from '../../models/StandardAction';
import { DetailedItem } from '../../models/Item';
import React from 'react';
import LookupTable from '../../models/LookupTable';
import { InputProps } from '@mui/material/Input';
import { SelectionListProps } from '../DependencySelection/SelectionList';
import { EnhancedDialogProps } from '../EnhancedDialog';
import { EnhancedDialogState } from '../../hooks/useEnhancedDialogState';
import ApiResponse from '../../models/ApiResponse';
export interface DeleteDialogBaseProps {
  items: DetailedItem[];
  isFetching: boolean;
  childItems: string[];
  dependentItems: string[];
  error: ApiResponse;
}
export interface DeleteDialogProps extends DeleteDialogBaseProps, EnhancedDialogProps {
  onSuccess?(response?: any): any;
}
export interface DeleteDialogStateProps extends DeleteDialogBaseProps, EnhancedDialogState {
  onClose?: StandardAction;
  onClosed?: StandardAction;
  onSuccess?: StandardAction;
}
export interface DeleteDialogContainerProps
  extends DeleteDialogBaseProps,
    Pick<DeleteDialogProps, 'isSubmitting' | 'onClose' | 'onSuccess'> {}
export interface DeleteDialogContentUIProps {
  items: DetailedItem[];
  childItems: string[];
  dependentItems: string[];
  comment: string;
  selectedItems: LookupTable<boolean>;
  isCommentRequired: boolean;
  isDisabled: boolean;
  isConfirmDeleteChecked: boolean;
  onCommentChange: InputProps['onChange'];
  onItemClicked: SelectionListProps['onItemClicked'];
  onSelectAllClicked: SelectionListProps['onSelectAllClicked'];
  onSelectAllDependantClicked: SelectionListProps['onSelectAllClicked'];
  onConfirmDeleteChange(event: React.ChangeEvent, checked: boolean): void;
  onEditDependantClick: SelectionListProps['onEditClick'];
}
export interface DeleteDialogUIProps extends DeleteDialogContentUIProps {
  isSubmitting: boolean;
  isSubmitButtonDisabled: boolean;
  error: ApiResponse;
  submitError: ApiResponse;
  isFetching: boolean;
  onSubmit(): void;
  onCloseButtonClick?(e: React.MouseEvent<HTMLButtonElement, MouseEvent>): void;
}