Editor

A text editor component for Universal Dashboard.

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.

Creating an Editor

To create a basic editor, use the New-UDEditor cmdlet.

New-UDEditor

The editor will be available and you can add new blocks by clicking the plus button.

Working with Data

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.

New-UDEditor -OnChange {
    Show-UDToast $EventData
}

You can also use the HTML render plugin by specifying the -Format parameter.

New-UDEditor -OnChange {
    Show-UDToast $EventData
} -Format 'html'

To specify the default data for the editor, use the -Data parameter. You need to specify the JSON block format.

New-UDEditor -Data $Data

Image Support

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.

New-UDEditor -PublishedFolder 'MyImages'

API

New-UDEditor

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.