@craftercms/studio-ui/components/UppyDashboard/UppyDashboardProps.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 { Uppy } from '@uppy/core';
import React from 'react';
import { UppyFile } from '@uppy/utils';
import { DashboardOptions } from '@uppy/dashboard';
export interface UppyDashboardProps {
  uppy: Uppy;
  site: string;
  path: string;
  title: string;
  maxActiveUploads: number;
  onMinimized?(): void;
  onPendingChanges?(pending: boolean): void;
  onClose?(): void;
  options?: DashboardOptions & {
    successfulUploadButton?: {
      /** One of the "known" icon ids (e.g. more, edit, download), or a `d` attribute for a `path` tag with a "0 0 24 24" view box */
      icon: 'more' | 'edit' | 'download' | 'MoreVertRounded' | 'EditRounded' | 'DownloadRounded' | string;
      label: string;
      onClick(
        event: React.MouseEvent,
        file: UppyFile,
        api: {
          remove(): void;
        }
      ): void;
    };
    autoProceed: boolean;
  };
}
export default UppyDashboardProps;