@craftercms/studio-ui/components/DependenciesDialog/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 { DetailedItem, SandboxItem } from '../../models/Item';
import React, { ReactNode } from 'react';
import StandardAction from '../../models/StandardAction';
import { EnhancedDialogProps } from '../EnhancedDialog';
import { EnhancedDialogState } from '../../hooks/useEnhancedDialogState';
import ApiResponse from '../../models/ApiResponse';
export interface DependenciesDialogBaseProps {
  item?: DetailedItem;
  rootPath: string;
  dependenciesShown?: 'depends-on' | 'depends-on-me';
}
export interface DependenciesDialogProps extends DependenciesDialogBaseProps, EnhancedDialogProps {}
export interface DependenciesDialogStateProps extends DependenciesDialogBaseProps, EnhancedDialogState {
  onClose?: StandardAction;
  onClosed?: StandardAction;
}
export interface DependenciesDialogContainerProps extends DependenciesDialogBaseProps {}
export interface DependenciesListProps {
  dependencies: DetailedItem[];
  compactView: boolean;
  showTypes: string;
  renderAction?(dependency: DetailedItem): ReactNode;
}
export interface DependenciesDialogUIProps {
  dependencies: DetailedItem[];
  item: DetailedItem;
  rootPath: string;
  setItem: Function;
  compactView: boolean;
  setCompactView: Function;
  showTypes: string;
  setShowTypes: Function;
  dependenciesShown: string;
  setDependenciesShown: Function;
  isEditableItem: Function;
  handleEditorDisplay(item: DetailedItem): void;
  handleHistoryDisplay(item: DetailedItem): void;
  contextMenu: any;
  error: ApiResponse;
  handleContextMenuClick(event: React.MouseEvent<HTMLButtonElement>, dependency: DetailedItem): void;
  handleContextMenuClose(): void;
}
export declare const dialogInitialState: {
  dependantItems: any;
  dependencies: any;
  compactView: boolean;
  showTypes: string;
};
export declare const assetsTypes: {
  'all-deps': {
    label: React.JSX.Element;
    filter: () => boolean;
  };
  'content-items': {
    label: React.JSX.Element;
    filter: (dependency: SandboxItem) => boolean;
  };
  assets: {
    label: React.JSX.Element;
    filter: (dependency: SandboxItem) => boolean;
  };
  code: {
    label: React.JSX.Element;
    filter: (dependency: SandboxItem) => boolean;
  };
};