ImageSettings

23 Sep 20251 minute to read

Configures the image settings of the RichTextEditor.

Properties

allowedTypes string[]

Specifies the allowed file types for selection.

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

display string

Specifies whether the image is inserted inline or with a break.

Defaults to ‘inline’

height string

Specifies the height of the image.

Defaults to ‘auto’

maxFileSize number

Specifies the maximum file size for image uploads in bytes.

Defaults to ‘30000000’

maxHeight string|number

Defines the maximum height of the image.

Defaults to null

maxWidth string|number

Defines the maximum width of the image.

Defaults to null

minHeight string|number

Defines the minimum height of the image.

Defaults to ‘0’

minWidth string|number

Defines the minimum width of the image.

Defaults to ‘0’

path string

Specifies the path for storing and displaying images.

Defaults to null

removeUrl string

Specifies the URL for the remove action that handles image removal on the server.
This URL should handle a POST request, with an argument named UploadFiles.

The event is triggered when uploading and canceling or removing an image in the insert image dialog, pasting, and removing an image in the Paste cleanup popup.

Defaults to null

resize boolean

Enables resizing for the image element.

Defaults to true

resizeByPercent boolean

Enables image resizing by percentage calculation.

Defaults to false

saveFormat SaveFormat

Specifies whether the inserted image is saved as a blob or base64.

Defaults to ‘Blob’

saveUrl string

Specifies the URL for the save action that handles uploaded images on the server.
This URL should handle a POST request, with an argument named UploadFiles.

The event is triggered when inserting an image via the Insert Image dialog, pasting an image, replacing an existing image, or dragging and dropping from the file browser.

Defaults to null

width string

Specifies the width of the image.

Defaults to ‘auto’