Skip to content

Vizel API / core/src / VizelFileHandlerOptions

Interface: VizelFileHandlerOptions ​

Defined in: packages/core/src/extensions/file-handler.ts:13

Options for file handler extension

Properties ​

allowedMimeTypes? ​

ts
optional allowedMimeTypes?: string[];

Defined in: packages/core/src/extensions/file-handler.ts:18

Allowed MIME types for files

Default ​

ts
["image/jpeg", "image/png", "image/gif", "image/webp", "image/svg+xml"]

onDrop? ​

ts
optional onDrop?: (editor, files, pos) => void;

Defined in: packages/core/src/extensions/file-handler.ts:34

Handler called when files are dropped

Parameters ​

ParameterTypeDescription
editorEditorThe editor instance
filesFile[]Array of dropped files
posnumberDrop position in the document

Returns ​

void


onError? ​

ts
optional onError?: (error) => void;

Defined in: packages/core/src/extensions/file-handler.ts:39

Handler for validation errors (file type not allowed, etc.)

Parameters ​

ParameterType
errorVizelFileHandlerError

Returns ​

void


onPaste? ​

ts
optional onPaste?: (editor, files, htmlContent) => void;

Defined in: packages/core/src/extensions/file-handler.ts:26

Handler called when files are pasted

Parameters ​

ParameterTypeDescription
editorEditorThe editor instance
filesFile[]Array of pasted files
htmlContentstring | undefinedHTML content from clipboard (useful for external images)

Returns ​

void

Released under the MIT License.