InputTinyMCEEditor.Blazor 1.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package InputTinyMCEEditor.Blazor --version 1.0.1                

                    
                

            
NuGet\Install-Package InputTinyMCEEditor.Blazor -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="InputTinyMCEEditor.Blazor" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add InputTinyMCEEditor.Blazor --version 1.0.1                

                    
                

            
#r "nuget: InputTinyMCEEditor.Blazor, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install InputTinyMCEEditor.Blazor as a Cake Addin
#addin nuget:?package=InputTinyMCEEditor.Blazor&version=1.0.1

// Install InputTinyMCEEditor.Blazor as a Cake Tool
#tool nuget:?package=InputTinyMCEEditor.Blazor&version=1.0.1

InputTinyEditor

An Input component wrapping TinyMCE Blazor Component, to be used inside an EditForm component. It offers the same validations experience as Blazor’s build-in form components out of the box.

Changelog

  1. 1.0.0: Initial release

  2. 1.0.1: Validation is merged into the official TinyMCE Blazor component. This component offers a few configuration parameters for convenience.

Installation

Nuget Manager

Search for InputTinyMCEEditor.Blazor and install.

Powershell

Install-Package InputTinyMCEEditor.Blazor

the dotnet CLI

dotnet add package InputTinyMCEEditor.Blazor

Usage

Once the package is installed, you can use the component straight away. There is no extra JavaScript script to add.

<EditForm OnValidSubmit="@Submit" EditContext="@CurrentEditContext">
    <DataAnnotationsValidator />
    <p>
        <label>Title</label>
        <InputText @bind-Value="Model.Title"></InputText>
        <ValidationMessage For="() => Model.Title" />
    </p>
    <p>
        <label>Content</label>
        <InputTinyMCEEditor.Blazor.InputTinyEditor For="() => Model.Content"
                                                   @bind-Value="Model.Content"
                                                   Height="300" />
        <ValidationMessage For="() => Model.Content" />
    </p>
    <button class="btn btn-primary" type="submit">Submit</button>
</EditForm>

@code {
    public Model Model { get; set; } = new Model();
    private EditContext? CurrentEditContext;

    protected override void OnInitialized()
    {
        CurrentEditContext = new(Model);
        base.OnInitialized();
    }

    private void Submit()
    {
        Console.WriteLine($"Title is {Model.Title}");
        Console.WriteLine($"Content is {Model.Content}");
    }

}

Required Parameters

Parameter For of type Expression<Func<string>> is required to provide identifier for validations

TinyMCE Editor Configurations

InputTinyEditor comes with default configurations, including Non-Premium Plugins and entire menubar and toolbar

Add Configurations via Parameters

InputTinyEditor is extended from the original TinyCME.Blazor.Editor. It inherits and supports all the params from TinyMCE.Blazor.Editor. See more here.

Additional Parameters:

  1. InputTinyEditor provides the following parameters of type string for quick configuration: Plugins, Toolbar, Menubar.
<InputTinyMCEEditor.Blazor.InputTinyEditor For="() => Model.Content"
@bind-Value="Model.Content" Height="300" Menubar="file edit view insert format tools table"/>
  1. Additional configurations can be added through Conf parameter
<InputTinyMCEEditor.Blazor.InputTinyEditor For="() => Model.Content"
                @bind-Value="Model.Content" Height="300" Conf="AdditionalConf"/>
@code{
	private Dictionary<string, object> AdditionalConf = new Dictionary<string, object>
    {
        {"quickbars_selection_toolbar", "bold italic | quicklink h2 h3 blockquote quickimage quicktable"}
    };
}
  1. You can also add configurations by adding key/value pairs as attributes.
<InputTinyMCEEditor.Blazor.InputTinyEditor For="() => Model.Content"
    @bind-Value="Model.Content"
    quickbars_selection_toolbar="bold italic | quicklink h2 h3 blockquote quickimage quicktable"
                                                   />
  1. By default InputTinyEditor trigger validation when onchange event fires. You can change the trigger to oninput by specifying ValidateOnInput to true.
<InputTinyMCEEditor.Blazor.InputTinyEditor For="() => Model.Content"
    @bind-Value="Model.Content" ValidationOnInput="@true"
/>

Add Configurations via JavaScript Script

  1. For the configurations that include complex objects or functions, it is easier to add them via a script. By design, InputTinyEditor will look for window.tinyMceConf object and append to existing configurations. To add additional configurations, add a script tag in the index.html or _layout.cshtml.
<body>
…
<script>
        window.tinyMceConf = {
            file_picker_callback: function (callback, value, meta) {
                /* Provide file and text for the link dialog */
                if (meta.filetype === 'file') {
                    callback('https://www.google.com/logos/google.jpg', { text: 'My text' });
                }

                /* Provide image and alt text for the image dialog */
                if (meta.filetype === 'image') {
                    callback('https://www.google.com/logos/google.jpg', { alt: 'My alt text' });
                }

                /* Provide alternative source and posted for the media dialog */
                if (meta.filetype === 'media') {
                    callback('movie.mp4', { source2: 'alt.ogg', poster: 'https://www.google.com/logos/google.jpg' });
                }
            }
        }
    </script>
</body>
  1. To hook up to TinyMCE Editor’s events, create a window.tinyMceSetup function that takes editor as parameter and add events on the editor as below. InputTinyEditor component will append this function to existing setup script. Note, oninput and onchange events are used to trigger validations. If you need to add extra behaviours to these two events, you can copy the code from source code and add your code.
<body>
    ...
    <script>
        window.tinyMceSetup = (editor) => {
            editor.on("init", () => console.log("TinyMCE editor initialized"))
        };
    </script>
</body>
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 499 12/10/2021
1.0.0 292 12/3/2021