Skip to content

Latest commit

 

History

History
131 lines (84 loc) · 3.45 KB

README.md

File metadata and controls

131 lines (84 loc) · 3.45 KB
Raw

ToastUI Editor Blazor NuGet

tui.editor.blazor is a Blazor component that provides a Markdown editor based on the tui.editor library.

Installation

Install the package using following command:

Install-Package ToastUIEditor

or

dotnet add package ToastUIEditor

or just use nuget package manager.

Usage

  1. Add the following import statement to your _Imports.razor file
@using ToastUI
  1. Use the Editor component in your Blazor page or component
<Editor @bind-Value="content" Options="@options" />
  • @bind-Value: Binds the editor's content to a string property in your Blazor component.
  • Options: Sets the configuration options for the editor. Refer to the EditorOptions class for available options.
  1. Use the Viewer component in your Blazor page or component
<Viewer Value="@content" />
  • Value: Sets the content to be displayed in the viewer. It will update automatically when content changes.
  1. Handle the available events by specifying event callbacks
<Editor @bind-Value="content"
        Load="HandleLoad"
        Change="HandleChange"
        CaretChange="HandleCaretChange"
        Focus="HandleFocus"
        Blur="HandleBlur"
        KeyDown="HandleKeyDown"
        KeyUp="HandleKeyUp"
        BeforePreviewRender="HandleBeforePreviewRender"
        BeforeConvertWYSIWYGToMarkdown="HandleBeforeConvertWYSIWYGToMarkdown" />

<Viewer Value="content"
        Load="HandleLoad"
        UpdatePreview="HandleUpdatePreview" />

These events are the same as the native public events, and the parameters are detailed in the code comments.

  1. Access the Editor or Viewer instance to invoke methods
<Editor @ref="editorRef" @bind-Value="markdown" Options="@options" />

<Viewer @ref="viewerRef" Value="markdown" />

<button @onclick="HandlePreview">Preview</button>

<Viewer @ref="viewerRef2"/>

@code {
    Editor editorRef = default!;
    Viewer viewerRef = default!;
    Viewer viewerRef2 = default!;
    string markdown = string.Empty;
    
    async Task HandlePreview()
    {
        var markdown = await editorRef.GetMarkdown();
        await viewerRef2.SetMarkdown(markdown);
    }
}

Most of all native methods have been implemented. Refer to the Editor class for available methods.

  1. Add custom language
  • Use Editor.SetLanguage static method to add custom language.
  • Use Editor.SetDefaultLanguage static method to set default language, it will be used when no language is set in EditorOptions.

Note: Please make sure Editor.SetLanguage and Editor.SetDefaultLanguage are called before Editor component is rendered.

  1. Widget rules

Due to BlazorServer mode not supporting JavaScript call .NET method synchronously, the widget rules only support in BlazorWebAssembly mode.

Implemented Features

  • Editor and Viewer basic usage
  • Editor and Viewer events
  • Language setting and custom language
  • Editor and Viewer instance methods
  • Toolbar with custom button
  • Add command and execute command
  • Add widget and set widget rules (only support in BlazorWebAssembly mode)
  • Link attributes
  • Custom markdown renderer
  • Custom HTML renderer
  • Custom HTML Sanitizer

License

This software is licensed under the MIT License