Menu

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.

DocumentationGrafana documentationAPI Reference@grafana/uiFileDropzoneProps
Enterprise Open source

FileDropzoneProps interface

Signature

typescript 
export interface FileDropzoneProps

Import

typescript 
import { FileDropzoneProps } from '@grafana/ui';

Properties

PropertyTypeDescription
childrenReactNodeUse the children property to have custom dropzone view.
fileListRenderer(file: DropzoneFile, removeFile: (file: DropzoneFile) => void) => ReactNodeThe fileListRenderer property can be used to overwrite the list of files. To not to show any list return null in the function.
onLoad(result: string | ArrayBuffer | null) => voidUse the onLoad function to get the result from FileReader.
optionsDropzoneOptionsUse 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

typescript 
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

typescript 
fileListRenderer?: (file: DropzoneFile, removeFile: (file: DropzoneFile) => void) => ReactNode;

onLoad property

Use the onLoad function to get the result from FileReader.

Signature

typescript 
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

typescript 
options?: DropzoneOptions;

readAs property

Use this to change the FileReader’s read.

Signature

typescript 
readAs?: 'readAsArrayBuffer' | 'readAsText' | 'readAsBinaryString' | 'readAsDataURL';