Rich Text Editor

Overview

The Rich Text Editor component allows you to type and format text just like in a small online editor. You can add links, videos, or images, change colors, and adjust the layout using a toolbar. It’s useful anywhere you need more than plain text, for example, writing notes, descriptions, or messages.

Properties

Name
Type
Description

name

string

Component name

value

string

Current component value

contents

object

Quill getContents() output (Delta object)

readonly

boolean

Indicates if the component is in the read-only mode

quill

object

Quill instance. Contains all Quill prototype methods.

See more in Quill docs.

valid

boolean

Indicates if the component is valid

validating

boolean

Indicates if the component is validating

Methods

Name
Parameters
Returns
Description

setValue

value: string |

Quill.Delta

void

Set component value

setReadonly

readOnly: boolean

void

Enable or disable read-only mode

reset

void

Reset component to the initial value

focus

void

Set focus on the component

validate

void

Trigger component validation

resetValidation

void

Clear validation errors

setErrors

errors: string |

string[] | null

void

Mark the component as invalid and display errors

setRequired

required: boolean

void

Mark the component as required or optional

Triggers

Name
Description

On Change

Triggered when the component's state changes

On Quill Event

Triggered when the underlying Quill instance fires a change event

On Enter

Triggered when the Enter key is pressed

On Focus

Triggered when the component is in focus

On Blur

Triggered when the component loses focus

On Init

Triggered when the component is initialized

Last updated

Was this helpful?