Bootstrap Blazor enterprise-level UI component library

Enterprise-level component library based on Bootstrap and Blazor

Editor

Convert the entered text into `html` code snippets

The Editor component is a secondary package of Summernote component, such as If you need to use the localization function, please download the corresponding language pack from the official website and quote it by yourself. zh-CN en-US has been built in；the required css javascript dynamically loaded on demand. If you edit too much content, signalR communication interruption may be triggered. Please adjust the HubOptions configuration.

builder.Services.Configure<HubOptions>(option => option.MaximumReceiveMessageSize = null);

Precautions

This component relies on BootstrapBlazor.SummerNote, which needs to reference its component package when using this component

Nuget Install

Use nuget.org to install BootstrapBlazor.SummerNote component

.NET CLI

dotnet add package BootstrapBlazor.SummerNote

PackageReference

<PackageReference Include="BootstrapBlazor.SummerNote" Version="7.0.0" />

Package Manager

Install-Package BootstrapBlazor.SummerNote

Basic usage

The default rendering is div and it becomes a rich text edit box when clicked

Demo

Set the IsEditor attribute value to control whether the component defaults to div or editor

I am a normal div click and can’t edit

<Editor />

Custom prompt message

The prompt message when a null value is set by setting the Placeholder attribute

Demo

The default prompt is Edit after clicking

@inject IStringLocalizer<EditorPlaceholder> Localizer

<Editor PlaceHolder="@Localizer["EditorEmptyPlaceholder"]" />

Display as a rich text edit box by default

Set the component to be directly displayed as a rich text edit box by setting the IsEditor property

Demo

<Editor IsEditor="true" />

Custom height

Set the height of the component by setting the Height property

Demo

<Editor IsEditor="true" Height="400" />

Two-way binding

In actual combat, two-way binding to Value automatically obtains the editing content of the client's rich text box in the background

Demo

Use bind-Value to bind the backend properties of EditorValue in two ways. After editing in the edit box, click the Finish button, and then enter the text box below. Show edited result

Show edit content:

@inject IStringLocalizer<EditorOnValueChanged> Localizer

<Editor @bind-Value="@EditorValue" OnValueChanged="@OnValueChanged" />

<label class="form-label mt-3">@Localizer["EditorOnValueChangedLabel"]</label>
<textarea class="form-control mt-3">@EditorValue</textarea>
<div class="mt-3">
    <Button OnClick="SetValue">Reset</Button>
</div>

@code {
    private string? EditorValue { get; set; }

    private Task OnValueChanged(string val)
    {
        EditorValue = val;
        return Task.CompletedTask;
    }

    private void SetValue()
    {
        EditorValue = Localizer["EditorOnValueChangedUpdateValue"];
    }

    /// <summary>
    /// OnInitialized
    /// </summary>
    protected override void OnInitialized()
    {
        base.OnInitialized();

        EditorValue = Localizer["EditorOnValueChangedInitValue"];
    }
}

Customize the extended edit box button

Customize the extension of the edit box toolbar by setting the CustomerPluginItems property, and do the function by setting the OnClickPluginItem callback delegate

Demo

In this example, two buttons are added to the toolbar by extending the CustomerPluginItems property. Click the button to pop up the SweetAlert modal box, click the modal box confirmation button and insert the text box A piece of content

@inject SwalService SwalService
@inject IStringLocalizer<EditorCustomerToolbarButtons> Localizer

<Editor IsEditor="true" OnClickButton="@PluginClick" CustomerToolbarButtons="@EditorPluginItems" />

@code {
    private List<EditorToolbarButton>? EditorPluginItems { get; set; }

    private async Task<string?> PluginClick(string pluginItemName)
    {
        var ret = "";
        if (pluginItemName == "plugin1")
        {
            var op = new SwalOption()
            {
                Title = Localizer["SwalTitle"],
                Content = Localizer["SwalContent"]
            };
            if (await SwalService.ShowModal(op))
            {
                ret = Localizer["Ret1"];
            }
        }
        if (pluginItemName == "plugin2")
        {
            var op = new SwalOption()
            {
                Title = Localizer["Swal2Title"],
                Content = Localizer["Swal2Content"]
            };
            if (await SwalService.ShowModal(op))
            {
                ret = Localizer["Ret2"];
            }
        }
        return ret;
    }

    /// <summary>
    /// OnInitialized 方法
    /// </summary>
    protected override void OnInitialized()
    {
        base.OnInitialized();

        EditorPluginItems = new List<EditorToolbarButton>()
        {
            new EditorToolbarButton()
            {
                IconClass = "fa-solid fa-pencil",
                ButtonName = "plugin1",
                Tooltip = Localizer["ToolTip1"]
            },
            new EditorToolbarButton()
            {
                IconClass = "fa-solid fa-house",
                ButtonName = "plugin2",
                Tooltip = Localizer["ToolTip2"]
            }
        };
    }
}

Customize the rich text edit box of the toolbar

Customize the toolbar content by setting the ToolbarItems property. For the currently supported toolbar values, please refer to Summernote Official website

Demo

In this example, by setting the ToolbarItems property, the default available toolbar buttons are changed

<Editor IsEditor="true" ToolbarItems="@ToolbarItems" />

@code {
    private List<object> ToolbarItems = new List<object>
    {
        new List<object>
        {
            "style", new List<string>()
            {
                "style"
            }
        },
        new List<object>
        {
            "font", new List<string>()
            {
                "bold", "underline", "clear"
            }
        }
    };
}

Instance Method

Call the instance method, please refer summernote api

Demo

In this example, by setting the ToolbarItems property, the default available toolbar buttons are changed

@inject IStringLocalizer<EditorDoMethodAsync> Localizer

<Editor IsEditor="true" @ref="Editor" />
<div class="mt-3">
    <Button OnClick="InsertHtmlAsync">@Localizer["DoMethodAsyncButton1"]</Button>
    <Button OnClick="@(() => Editor.DoMethodAysnc("formatH2", ""))">@Localizer["DoMethodAsyncButton2"]</Button>
    <Button OnClick="@(() => Editor.DoMethodAysnc("insertImage", "https://www.blazor.zone/_content/BootstrapBlazor.Shared/images/avatars/150-1.jpg", "tree"))">@Localizer["DoMethodAsyncButton3"]</Button>
</div>

@code {
    [NotNull]
    private Editor? Editor { get; set; }

    private async Task InsertHtmlAsync()
    {
        await Editor.DoMethodAysnc("pasteHTML", $"<h1>{Localizer["DoMethodAsyncPasteHTML"]}</h1>");
    }
}

Attributes

B station related video link

[portal]

交流群

QQ Group：BootstrapAdmin & Blazor 795206915 675147445 Welcome to join the group discussion

Editor

Convert the entered text into html code snippets

Demo

Demo

Demo

Demo

Demo

Demo

Demo

Demo

Attributes

Bootstrap Blazor Component library updated to 7.4.4-beta01

Convert the entered text into `html` code snippets