ImageBlockSettings

9 Jul 20261 minute to read

Configures settings related to image block in the editor.

Properties

allowedTypes string[]

Specifies the allowed image file types that can be uploaded.
Common types include ‘.jpg’, ‘.jpeg’, and ‘.png’.

Defaults to [‘.jpg’, ‘.jpeg’, ‘.png’]

enableResize boolean

Specifies whether to enable resize for image.

Defaults to true

height string|number

Specifies the display height of the image.
Can be defined in pixels or percentage.

Defaults to ‘auto’

maxFileSize number

Specifies the maximum file size allowed for image uploads in bytes.
Files exceeding this size will be rejected during validation.
Default is 30000000 bytes.

Defaults to 30000000

maxHeight string|number

Specifies the maximum height of the image in pixels or as a string unit.
Prevents the image from being resized beyond this value.

Defaults to ’’

maxWidth string|number

Specifies the maximum width of the image in pixels or as a string unit.
Prevents the image from being resized beyond this value.

Defaults to ’’

minHeight string|number

Specifies the minimum height of the image in pixels or as a string unit.
Prevents the image from being resized below this value.

Defaults to ’’

minWidth string|number

Specifies the minimum width of the image in pixels or as a string unit.
Prevents the image from being resized below this value.

Defaults to ’’

path string

Specifies the base path for storing and displaying images on the server.
This path is appended to the server URL for image storage organization.

Defaults to ’’

saveFormat SaveFormat

Specifies the format to save the image.
Accepts either ‘base64’ for inline image encoding or ‘blob’ for binary object representation.

Defaults to ‘Blob’

saveUrl string

Specifies the server endpoint URL for uploading images.
If empty, server upload functionality is disabled.

Defaults to ’’

width string|number

Specifies the display width of the image.
Can be defined in pixels or percentage.

Defaults to ‘auto’