ClassTelerikEditor
The class for the Telerik Editor component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Syntax:
public class TelerikEditor : TelerikInputBase<string>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentTelerikInputBase<string>TelerikEditor
Implements:
Inherited Members
Constructors
TelerikEditor()
Declaration
public TelerikEditor()
Properties
Adaptive
Specify if the toolbar should adapt and automatically hide and show the overflowing items a popup. Default value is false.
DebounceDelay
Defines the debounce delay after which ValueChanged fires. Default value 100ms.
EditMode
Defines whether the editor should render iframe, or div for the content area.
Declaration
[Parameter]
public EditorEditMode EditMode { get; set; }
Property Value
EditorCustomTools
Defines the container of custom tool renderings. EditorCustomTool.
Declaration
[Parameter]
public RenderFragment EditorCustomTools { get; set; }
Property Value
EditorSettings
Defines the container of editor settings. EditorPasteSettings.
Declaration
[Parameter]
public RenderFragment EditorSettings { get; set; }
Property Value
Height
Defines the height of the Editor. Default value 250px.
Plugins
The name of the JS function declared in the global scope (window object) that will be used to provide custom ProseMirror plugins. The function accepts an arguments object with the following properties:
- getSchema - a function that returns the current schema object. Before the editor is initialized, the schema is the default schema. After the editor is initialized, the schema is the current schema.
- getView - a function that returns the currently used instance of EditorView object. Before the editor is initialized, the view (the result of the function) is null.
- ProseMirror - object that contains various ProseMirror classes and functions.
- getPlugins - function that accepts schema as an argument and returns the default Telerik Editor plugins.
The function should return an array of ProseMirror plugins. Note: To ensure all the built-in functionalities of the Telerik Editor are working correctly, the result array should contain the default plugins which can be recieved by calling the getPlugins function.
ReadOnly
The parameter is used to specify if the input field should be read-only.
When set to true
, the input becomes non-editable.
Schema
The name of the JS function declared in the global scope (window object) that will be used to provide custom ProseMirror schema. The function accepts an arguments object with the following properties:
- getSchema - a function that returns the current schema object. Before the editor is initialized, the schema is the default schema. After the editor is initialized, the schema is the current schema.
- getView - a function that returns the currently used instance of EditorView object. Before the editor is initialized, the view (the result of the function) is null.
- ProseMirror - object that contains various ProseMirror classes and functions.
The function should return an instance of the ProseMirror Schema class.
SpellCheck
Defines the spellcheck HTML attribute of the editable container in the component. Support and behavior depends on the user environment.
Declaration
[Parameter]
public string SpellCheck { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
ExecuteAsync(ToolCommandArgsBase)
Declaration
public Task ExecuteAsync(ToolCommandArgsBase args)
Parameters
args
Returns