Editor
A text editor component for Universal Dashboard.
Last updated
A text editor component for Universal Dashboard.
Last updated
Copyright 2024 Ironman Software
Available in PowerShell Universal 2.5 or later.
The editor component is available in the UniversalDashboard.Editor
component library. You will have to add it to your dashboard to be able to use the editor component.
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.
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.