Skip to content

prosekit/extensions/image

Interfaces

UploadImageOptions

Options for uploadImage.

Properties

uploader: Uploader<string>: The uploader used to upload the file. It should return a promise that resolves to the URL of the uploaded image.

file: File: The file that will be uploaded.

pos?: number: The position where the image should be inserted. If not provided, the image is inserted at the current selection.

onError?: ImageUploadErrorHandler: A handler to be called when an error occurs during the upload.

ImageUploadErrorHandlerOptions

Options for the ImageUploadErrorHandler callback.

Properties

file: File: The file that was uploaded.

error: unknown: The error that occurred during the upload.

uploadTask: UploadTask<string>: The upload task that was used to upload the file.

ImageAttrs

Properties

src?: null | string

width?: null | number

height?: null | number

ImageUploadHandlerOptions

A handler to be called when an error occurs during the upload.

Properties

uploader: Uploader<string>: The uploader used to upload the file. It should return a promise that resolves to the URL of the uploaded image.

canPaste?: ImageCanPastePredicate: A predicate to determine if the pasted file should be uploaded and inserted as an image. If not provided, it defaults to only allowing paste of files with a content type starting with image/.

canDrop?: ImageCanDropPredicate: A predicate to determine if the dropped file should be uploaded and inserted as an image. If not provided, it defaults to only allowing drop of files with a content type starting with image/.

onError?: ImageUploadErrorHandler: A handler to be called when an error occurs during the upload. If not provided, it defaults to logging the error to the console.

Type Aliases

ImageUploadErrorHandler()

type ImageUploadErrorHandler = (options: ImageUploadErrorHandlerOptions) => void: A handler to be called when an error occurs during the upload.

ImageCanPastePredicate()

type ImageCanPastePredicate = (options: FilePasteHandlerOptions) => boolean: A predicate to determine if the pasted file should be uploaded and inserted as an image.

ImageCanDropPredicate()

type ImageCanDropPredicate = (options: FileDropHandlerOptions) => boolean: A predicate to determine if the dropped file should be uploaded and inserted as an image.

Functions

insertImage()

function insertImage(attrs?: ImageAttrs): Command: Returns a command that inserts an image node with the given attributes at the current selection position.

uploadImage()

function uploadImage(options: UploadImageOptions): Command: Returns a command that uploads an image file and inserts an image node with a temporary URL which is replaced once the upload completes.

defineImageUploadHandler()

function defineImageUploadHandler(options: ImageUploadHandlerOptions): PlainExtension: Returns an extension that handles image file uploads when pasting or dropping images into the editor.

defineImage()

function defineImage(): ImageExtension