Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
FileDropzoneProps interface
Signature
export interface FileDropzoneProps
Import
import { FileDropzoneProps } from '@grafana/ui';
Properties
Property | Type | Description |
---|---|---|
children | ReactNode | Use the children property to have custom dropzone view. |
fileListRenderer | (file: DropzoneFile, removeFile: (file: DropzoneFile) => void) => ReactNode | The fileListRenderer property can be used to overwrite the list of files. To not to show any list return null in the function. |
onFileRemove | (file: DropzoneFile) => void | |
onLoad | (result: string | ArrayBuffer | null) => void | Use the onLoad function to get the result from FileReader. |
options | DropzoneOptions | Use this property to override the default behaviour for the react-dropzone options. { maxSize: Infinity, minSize: 0, multiple: true, useFsAccessApi: false, maxFiles: 0, } |
readAs | ‘readAsArrayBuffer’ | ‘readAsText’ | ‘readAsBinaryString’ | ‘readAsDataURL’ | Use this to change the FileReader’s read. |
children property
Use the children property to have custom dropzone view.
Signature
children?: ReactNode;
fileListRenderer property
The fileListRenderer property can be used to overwrite the list of files. To not to show any list return null in the function.
Signature
fileListRenderer?: (file: DropzoneFile, removeFile: (file: DropzoneFile) => void) => ReactNode;
onFileRemove property
Signature
onFileRemove?: (file: DropzoneFile) => void;
onLoad property
Use the onLoad function to get the result from FileReader.
Signature
onLoad?: (result: string | ArrayBuffer | null) => void;
options property
Use this property to override the default behaviour for the react-dropzone options. { maxSize: Infinity, minSize: 0, multiple: true, useFsAccessApi: false, maxFiles: 0, }
Signature
options?: DropzoneOptions;
readAs property
Use this to change the FileReader’s read.
Signature
readAs?: 'readAsArrayBuffer' | 'readAsText' | 'readAsBinaryString' | 'readAsDataURL';