FileDropzoneProps interface

Signature

  1. export interface FileDropzoneProps

Import

  1. 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.
onFileRemove(file: DropzoneFile) => void
onLoad(result: string | ArrayBuffer | null) => voidUse the onLoad function to get the result from FileReader.
optionsBackwardsCompatibleDropzoneOptionsUse 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

  1. 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

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

onFileRemove property

Signature

  1. onFileRemove?: (file: DropzoneFile) => void;

onLoad property

Use the onLoad function to get the result from FileReader.

Signature

  1. 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

  1. options?: BackwardsCompatibleDropzoneOptions;

readAs property

Use this to change the FileReader’s read.

Signature

  1. readAs?: 'readAsArrayBuffer' | 'readAsText' | 'readAsBinaryString' | 'readAsDataURL';