beta-parity-react
Version:
Beta Parity React Components
66 lines • 1.65 kB
TypeScript
import React from 'react';
import './index.css';
import './variables.css';
/**
* Props for the FileItem component.
*
*/
export interface FileItemProps extends React.HTMLAttributes<HTMLDivElement> {
/**
* Whether the file item is disabled.
*
* @default false
* @memberof FileItemProps
*/
disabled?: boolean;
/**
* The status of the file item.
*
* - `error`: Indicates an error occurred.
* - `success`: Indicates the file was successfully processed.
* - `completed`: Indicates the file upload or processing is completed.
*
* @default "completed"
* @memberof FileItemProps
*/
status?: 'error' | 'success' | 'completed';
/**
* The loading progress percentage (0-100).
*
* @default 0
* @memberof FileItemProps
*/
loading?: number;
/**
* The name of the file.
*
* @default "Choose file"
*/
fileName?: string;
/**
* The size of the file in bytes.
*
* @default 0
* @memberof FileItemProps
*/
fileSize?: number;
/**
* Callback function triggered when the retry action is performed.
*
* @memberof FileItemProps
*/
onRetry?: () => void;
/**
* Callback function triggered when the remove action is performed.
*
* @memberof FileItemProps
*/
onRemove?: () => void;
}
/**
* **File Item**.
*
* @see {@link https://beta-parity-react.vercel.app/file-item Parity FileItem}
*/
export declare const FileItem: React.ForwardRefExoticComponent<FileItemProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=index.d.ts.map