synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
26 lines • 1.16 kB
TypeScript
export type FileUploadProgressProps = {
/** The status of the upload. */
status: 'PREPARING' | 'UPLOADING' | 'PAUSED' | 'CANCELED_BY_USER' | 'FAILED' | 'COMPLETE';
/** The name of the file */
fileName: string;
/** The size of the file, in bytes */
totalSizeInBytes: number;
/** The number of this file's bytes uploaded so far. */
uploadedSizeInBytes?: number;
/** Invoked when the upload is cancelled. */
onCancel: () => void;
/** Invoked when the upload is paused. */
onPause: () => void;
/** Invoked when the resumed. */
onResume: () => void;
/** Invoked when the upload is removed from the list. */
onRemove: () => void;
/** An optional error message to display if the upload has been cancelled due to error. */
errorMessage?: string;
};
export declare const FILE_UPLOAD_PROGRESS_COMPONENT_HEIGHT_PX = 92;
/**
* Component that displays the upload progress of a file, with controls to pause or cancel the upload.
*/
export declare function FileUploadProgress(props: FileUploadProgressProps): import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=FileUploadProgress.d.ts.map