Blazorise RichTextEdit: API Reference

Explore the API reference for the Blazorise RichTextEdit component, detailing available attributes and methods.

The RichTextEdit component in Blazorise is a rich text editor that provides a user-friendly interface for creating and editing formatted text content. It supports a variety of text formatting options such as bold, italic, underline, lists, links, and more. Additionally, the editor is extensible, allowing developers to enable and use advanced features like inserting tables, images, and even embedding custom HTML content.

API

Parameters

RichTextEdit

Parameter Description TypeDefault
AriaDescribedBy

Specifies the aria-describedby attribute value.

Remarks

When set, this value is rendered as-is and overrides help and validation message ids generated by Field and Validation.

 string
AriaInvalid

Specifies the aria-invalid attribute value.

Remarks

When set, this value is rendered as-is and overrides the validation-derived aria-invalid state.

 string
AriaLabelledBy

Specifies the aria-labelledby attribute value.

Remarks

When set, this value is rendered as-is. Some non-labelable controls can otherwise derive it automatically from a parent FieldLabel or FieldsLabel.

 string
AriaRequired

Specifies the aria-required attribute value.

Remarks

When set, this value overrides the required-field state resolved from the parent Validation.

 boolfalse
Autofocus

Set's the focus to the component after the rendering is done.

 boolfalse
ChildContent

Specifies the content to be rendered inside this RichTextEdit.

 RenderFragmentnull
ConfigureQuillJsMethod

[Optional] The javascript method to call to configure additional QuillJs modules and or add custom bindings.

 string
Disabled

Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter.

 boolfalse
Editor

[Optional] Gets or sets the content visible in the editor.

 RenderFragmentnull
Feedback

Placeholder for validation messages.

 RenderFragmentnull
OnScreenKeyboard

Enables the on-screen keyboard for this input component. When not explicitly set, the global accessibility option is used.

 boolfalse
OnScreenKeyboardEnterKeyBehavior

Specifies how the on-screen keyboard enter key should behave for this input component.

Possible values:Default, NewLine, Submit, Hide, KeyDown

 OnScreenKeyboardEnterKeyBehaviorOnScreenKeyboardEnterKeyBehavior.Default
OnScreenKeyboardLayout

Specifies the on-screen keyboard layout for this input component. When not explicitly set, the global accessibility option is used.

Possible values:Text, Numeric, Decimal, Email, Url, Telephone

 OnScreenKeyboardLayoutOnScreenKeyboardLayout.Text
OnScreenKeyboardShowMode

Gets or sets how the on-screen keyboard is shown for this input.

Possible values:Default, Focus, Manual

 OnScreenKeyboardShowModeOnScreenKeyboardShowMode.Default
PlaceHolder

Place holder text visible in empty editor.

 string
ReadOnly

Add the readonly boolean attribute on an input to prevent modification of the input’s value.

 boolfalse
SanitizedPasteOptions

Options used to configure sanitized paste functionality.

Remarks

When this parameter is explicitly defined, it has priority over globally configured SanitizedPasteOptions.

 RichTextEditSanitizedPasteOptionsnull
Size

Sets the size of the input control.

 Size?null
SubmitOnEnter

Call EnterPressed event when user presses the ENTER key.

 boolfalse
TabIndex

If defined, indicates that its element can be focused and can participates in sequential keyboard navigation.

 int?null
Theme

The theme (Snow or Bubble) of the editor.

Possible values:Snow, Bubble

 RichTextEditThemeRichTextEditTheme.Snow
Toolbar

[Optional] Gets or sets the content of the toolbar.

 RenderFragmentnull
ToolbarPosition

Toolbar placed on the top or bottom of the editor.

Possible values:Top, Bottom, Start, End

 PlacementTop
UseResize

Indicates whether resizing functionality should be enabled.

Remarks

When this parameter is explicitly defined, it has priority over globally configured UseResize.

 boolfalse
UseSanitizedPaste

Indicates whether sanitized paste functionality should be enabled.

Remarks

When this parameter is explicitly defined, it has priority over globally configured UseSanitizedPaste.

 boolfalse
UseTables

Indicates whether table functionality should be enabled.

Remarks

When this parameter is explicitly defined, it has priority over globally configured UseTables.

 boolfalse
Value

Specifies the value inside the input field.

 TValuenull
ValueExpression

Specifies an expression that identifies the input value.

 Expression<Func<TValue>>null

RichTextEditToolbarGroup

Parameter Description TypeDefault
ChildContent

Defines the child content.

 RenderFragmentnull

RichTextEditToolbarButton

Parameter Description TypeDefault
Action

Specifies the toolbar action.

 RichTextEditAction?null
Value

Specifies the value corresponding to the action.

 string

RichTextEditToolbarSelect

Parameter Description TypeDefault
Action

Specifies the select action.

 RichTextEditAction?null
ChildContent

Defines the child content.

 RenderFragmentnull

Events

RichTextEdit

Event Description Type
Blur

The blur event fires when an element has lost focus.

 EventCallback<FocusEventArgs>
ContentChanged

Notifies when the content within the editor changes.

 EventCallback
CustomValidationValue

Used to provide custom validation value on which the validation will be processed with the Validator handler.

Remarks

Should be used carefully as it's only meant for some special cases when input is used in a wrapper component, like Autocomplete or SelectList.

 Func<TValue>
EditorBlur

Notifies when the editor loses focus.

 EventCallback
EditorFocus

Notifies when the editor gains focus.

 EventCallback
EnterPressed

Notifies when the enter key is pressed within the editor.

Remarks

This event is triggered only when SubmitOnEnter is enabled.

 EventCallback
FocusIn

Notifies when the input box gains focus.

 EventCallback<FocusEventArgs>
FocusOut

Notifies when the input box loses focus.

 EventCallback<FocusEventArgs>
KeyDown

Notifies when a key is pressed down while the control has focus.

 EventCallback<KeyboardEventArgs>
KeyPress

Notifies when a key is pressed while the control has focus.

 EventCallback<KeyboardEventArgs>
KeyUp

Notifies when a key is released while the control has focus.

 EventCallback<KeyboardEventArgs>
OnFocus

Notifies when the input box gains or loses focus.

 EventCallback<FocusEventArgs>
ValueChanged

Occurs after value has changed.

 EventCallback<TValue>

Methods

RichTextEdit

Method DescriptionReturnParameters
ClearAsync Clears the editor content asynchronously. ValueTask
GetDeltaAsync Gets the editor content as a Quill Delta JSON asynchronously. ValueTask<string>
GetHtmlAsync Gets the editor content as HTML asynchronously. ValueTask<string>RichTextEditHtmlOptions htmlOptions
GetTextAsync Gets the editor content as plain text asynchronously. ValueTask<string>
OnContentChanged Javascript callback for when content changes. Taskstring html, string text
OnEditorBlur Javascript callback for when editor lost focus. Task
OnEditorFocus Javascript callback for when editor get focus. Task
OnEnter Javascript callback for when enter is pressed. Task
SetDeltaAsync Sets the editor content as a Quill Delta JSON asynchronously.
Remarks

The Quill Delta format is a rich text format used by the Quill editor. See the official Quill.js documentation for more details.

ValueTaskstring deltaJson
SetHtmlAsync Sets the editor content as HTML asynchronously.
Remarks

Improper handling of HTML can lead to cross-site scripting (XSS). Ensure that the HTML content is properly sanitized before setting it in the editor.

ValueTaskstring html
SetTextAsync Sets the editor content as plain text asynchronously. ValueTaskstring text
ShowOnScreenKeyboard Shows the on-screen keyboard for this input. Taskbool focus
Focus Sets the focus on the underline element. Taskbool scrollToElement
Revalidate Forces the Validation (if any is used) to re-validate with the new custom or internal value. Task
On this page