Richtexteditor Ui - ImageSettings

30 Sep 20261 minute to read

Configures the image settings of the RichTextEditor.

Properties

allowedTypes string[]

Specifies the image file extensions that can be selected, dropped,
pasted, or uploaded.
API names use TypeScript camel casing.

Defaults to [‘.jpg’, ‘.jpeg’, ‘.png’, ‘.gif’, ‘.bmp’, ‘.webp’]

dimension ImageDimensionOptions

Specifies the default and permitted dimensions of an image.

Defaults to { width: ‘auto’, height: ‘auto’, minWidth: 0, maxWidth: null, minHeight: 0, maxHeight: null}

display ImageDisplayMode

Specifies how an image is positioned in the editor content.
Possible values are:

  • inline: Places the image within the current text flow.
  • break: Places the image on a separate line.

Defaults to ‘inline’

imageUrl string|null

Specifies the public base URL used to resolve uploaded image names
returned by the server.
For example, when imageUrl is /uploads/images/ and the server
returns sample.png, the resulting source is
/uploads/images/sample.png.

Defaults to null

maxFileSize number

Specifies the maximum permitted image file size, in bytes.

Defaults to 30000000

removeUrl string|null

Specifies the server endpoint used to remove an uploaded image.

Defaults to null

resize boolean

Specifies whether users can resize images in the editor.

Defaults to true

saveFormat ImageSaveFormat

Specifies how local images are represented when an upload endpoint
is not configured.
Possible values are:

  • Blob: Creates a temporary object URL for the image.
  • Base64: Embeds the image as a Base64 data URL.

Defaults to ‘Blob’

uploadUrl string|null

Specifies the server endpoint used to upload image files.
When this property is not configured, the editor uses saveFormat to
create a local image source.

Defaults to null