RichTextBox.AspNetCore 1.0.0-preview.5

RichTextBox for ASP.NET Core

RichTextBox is an ASP.NET Core wrapper around the RichTextEditor client runtime.

It provides:

• a richtextbox Tag Helper for Razor Pages and MVC
• bundled static web assets for the editor runtime
• builder.Services.AddRichTextBox() for package setup
• app.MapRichTextBoxUploads() for compatible upload and folder-aware image gallery endpoints
• RichTextBox.lic validation for packaged and deployed apps
• opt-in autosave via auto-save, auto-save-key, and auto-save-delay
• context menu control via enable-context-menu and context-menu-mode
• dialog library configuration via image-items-json, gallery-images-json, and html-templates-json

Typical usage:

@addTagHelper *, RichTextBox

<form method="post">
    <richtextbox asp-for="Body" toolbar="full" skin="gray" height="420px" />
</form>

Autosave example:

<richtextbox
    asp-for="Body"
    toolbar="full"
    enable-context-menu="true"
    context-menu-mode="Simple"
    auto-save="true"
    auto-save-key="draft:body"
    auto-save-delay="600" />

Dialog library example:

@{
    var imageItemsJson = System.Text.Json.JsonSerializer.Serialize(new[]
    {
        "/images/microsoft.svg",
        "/images/Intel.svg"
    });
    var galleryImagesJson = System.Text.Json.JsonSerializer.Serialize(new object[]
    {
        new { url = "/images/microsoft.svg", text = "Microsoft logo" },
        new { url = "/images/Intel.svg", text = "Intel logo" }
    });
    var htmlTemplatesJson = System.Text.Json.JsonSerializer.Serialize(new object[]
    {
        new object[] { "Newsletter", "<section><h2>Newsletter</h2><p>Start here.</p></section>" }
    });
}

<richtextbox
    asp-for="Body"
    toolbar="full"
    image-items-json="@imageItemsJson"
    gallery-images-json="@galleryImagesJson"
    html-templates-json="@htmlTemplatesJson" />

The three dialog configuration attributes expect JSON arrays.

app.MapRichTextBoxUploads() now exposes both:

• the upload endpoint used by the runtime uploader
• a gallery endpoint used by the insert image gallery dialog for folder browsing and folder creation

Context menu presets:

• Default
• Simple
• Minimal

Bundled skins currently include:

• gray
• blue
• dark
• office2007blue

License file placement for ASP.NET Core:

• place RichTextBox.lic in the app content root, beside Program.cs and your .csproj
• the default lookup path is RichTextBox.lic
• the website demo project already copies that file to build and publish output

You can also override the default content-root-relative path:

builder.Services.AddRichTextBox(options =>
{
    options.LicenseContentRootRelativePath = "licenses/RichTextBox.lic";
});