New-UDEditor

Creates an Editor.JS editor.

Synopsis

Creates an Editor.JS editor.

Syntax

New-UDEditor [[-Id] <String>] [[-Data] <Hashtable>] [[-OnChange] <Endpoint>] [[-Format] <String>] [[-PublishedFolder] <String>] [<CommonParameters>]

Description

Creates an Editor.JS editor.

Parameters

-Id

The id of the editor. This defaults to a new GUID.

Required?                    false
Position?                    1
Default value                ([Guid]::NewGuid())
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Data

The data to use for the editor.

Required?                    false
Position?                    2
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnChange

The endpoint to call when the editor changes.

Required?                    false
Position?                    3
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Format

The format of the data. This can be json or html.

Required?                    false
Position?                    4
Default value                json
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-PublishedFolder

A published folder to upload files to. This is required for the image upload plugin.

Required?                    false
Position?                    5
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

Outputs

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDEditor -Id 'editor1'

Basic Editor|A basic editor.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDEditor -Id 'editor2' -Format 'html'

HTML Editor|An editor that uses HTML.




-------------------------- EXAMPLE 3 --------------------------

PS >New-UDEditor -Id 'editor3' -OnChange {
PS >     Show-UDToast $Body
PS > }

OnChange|An editor with an OnChange script block.




-------------------------- EXAMPLE 4 --------------------------

PS >New-UDEditor -Format html -OnChange {
PS >     Set-UDElement -Id 'test' -Content {
PS >         $body
PS >     }
PS > }
PS > New-UDElement -Tag pre -Id 'test'

HTML|An editor that updates a pre tag with the HTML content.