Editor
A text editor component for Universal Dashboard.
Last updated
A text editor component for Universal Dashboard.
Last updated
Copyright 2024 Ironman Software
The editor component is based on Editor.js. It's a block editor that accepts text, links, lists, code and images.
When working with the editor, you can receive data about the current document via the OnChange
parameter. By default, data is returned in the Editor.js JSON format.
To create a basic editor, use the New-UDEditor
cmdlet.
The editor will be available and you can add new blocks by clicking the plus button.
If you define a script block for the -OnChange
event handler. The $EventData
variable will contain the current status of the editor. By default, this returns the Editor.JS JSON block format.
You can also use the HTML render plugin by specifying the -Format
parameter.
To specify the default data for the editor, use the -Data
parameter. You need to specify the JSON block format.
In order to support images, you will need to provide a published folder in which to upload the images. Once a published folder is defined, images can be uploaded directly in the editor. They will be placed within the directory and then served through the request path.
Name | Type | Description | Required |
---|---|---|---|
Id | string | The ID of this component. | |
Data | Hashtable | The Editor.JS data for this component | |
OnChange | ScriptBlock | The script block event handler to call when the editor data changes. | |
Format | string | Whether to return either json or html in the OnChange script block. |