PSC.Blazor.Components.MarkdownEditor 2.0.1

.NET 6.0
There is a newer version of this package available.
See the version list below for details.
dotnet add package PSC.Blazor.Components.MarkdownEditor --version 2.0.1
NuGet\Install-Package PSC.Blazor.Components.MarkdownEditor -Version 2.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="PSC.Blazor.Components.MarkdownEditor" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PSC.Blazor.Components.MarkdownEditor --version 2.0.1
#r "nuget: PSC.Blazor.Components.MarkdownEditor, 2.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install PSC.Blazor.Components.MarkdownEditor as a Cake Addin
#addin nuget:?package=PSC.Blazor.Components.MarkdownEditor&version=2.0.1

// Install PSC.Blazor.Components.MarkdownEditor as a Cake Tool
#tool nuget:?package=PSC.Blazor.Components.MarkdownEditor&version=2.0.1

Blazor Markdown Editor

This is a Markdown Editor component for Blazor WebAssembly and Blazor Server. The component is based on EasyMDE to create the editor and Markdig for rendering the Markdown text in HTML.

Usage

Add the Editor to your _Imports.razor

@using PSC.Blazor.Components.MarkdownEditor 
@using PSC.Blazor.Components.MarkdownEditor.EventsArgs

Then, in your index.html or host.html add those lines:

<link href="/_content/PSC.Blazor.Components.MarkdownEditor/css/easymde.min.css" rel="stylesheet" />

<script src="/_content/PSC.Blazor.Components.MarkdownEditor/js/easymde.min.js"></script>
<script src="/_content/PSC.Blazor.Components.MarkdownEditor/js/markdownEditor.js"></script>

jQuery is also required. The component cointains the EasyMDE script version 2.15.0. Obviously, you can add this script in your project but if you use the script in the component, you are sure it works fine and all functionalities are tested.

Add MarkdownEditor in a page

In a Razor page, we can add the component with this lines

<MarkdownEditor Value="@markdownValue" ValueChanged="@OnMarkdownValueChanged" />

The result is a nice Markdown Editor like in the following screenshot.

markdown-editor-example

Limitation

In the current implementation, some Markdig extensions are not working. For example, adding a mermaid code, won't create a graph.

Documentation

Name Description Type Default
AutoSaveEnabled Gets or sets the setting for the auto save. Saves the text that's being written and will load it back in the future. It will forget the text when the form it's contained in is submitted. Recommended to choose a unique ID for the Markdown Editor. bool false
AutoSaveId Gets or sets the automatic save identifier. You must set a unique string identifier so that EasyMDE can autosave. Something that separates this from other instances of EasyMDE elsewhere on your website. string Default value
AutoSaveDelay Delay between saves, in milliseconds. Defaults to 10000 (10s). int 10000 (10s)
AutoSaveSubmitDelay Delay before assuming that submit of the form failed and saving the text, in milliseconds. int 5000 (5s)
AutoSaveText Text for autosave string Autosaved:
AutoSaveTimeFormatLocale Set the format for the datetime to display. For more info, see the JavaScript documentation DateTimeFormat instances string en-US
AutoSaveTimeFormatYear Set the format for the year string numeric
AutoSaveTimeFormatMonth Set the format for the month string long
AutoSaveTimeFormatDay Set the format for the day string 2-digit
AutoSaveTimeFormatHour Set the format for the hour string 2-digit
AutoSaveTimeFormatMinute Set the format for the minute string 2-digit
AutoDownloadFontAwesome If set to true, force downloads Font Awesome (used for icons). If set to false, prevents downloading. bool? null
CustomButtonClicked Occurs after the custom toolbar button is clicked. EventCallback<MarkdownButtonEventArgs>
Direction rtl or ltr. Changes text direction to support right-to-left languages. Defaults to ltr. string ltr
ErrorCallback A callback function used to define how to display an error message. Defaults to (errorMessage) ⇒ alert(errorMessage). Func<string, Task>
ErrorMessages Errors displayed to the user, using the errorCallback option, where #image_name#, #image_size# and #image_max_size# will replaced by their respective values, that can be used for customization or internationalization. MarkdownErrorMessages
HideIcons An array of icon names to hide. Can be used to hide specific icons shown by default without completely customizing the toolbar. string[] 'side-by-side', 'fullscreen'
ImageAccept A comma-separated list of mime-types used to check image type before upload (note: never trust client, always check file types at server-side). Defaults to image/png, image/jpeg. string image/png, image/jpeg
ImageCSRFToken CSRF token to include with AJAX call to upload image. For instance used with Django backend. string
ImageMaxSize Maximum image size in bytes, checked before upload (note: never trust client, always check image size at server-side). Defaults to 1024 * 1024 * 2 (2Mb). long 1024 * 1024 * 2 (2Mb)
ImagePathAbsolute If set to true, will treat imageUrl from imageUploadFunction and filePath returned from imageUploadEndpoint as an absolute rather than relative path, i.e. not prepend window.location.origin to it. string
ImageTexts Texts displayed to the user (mainly on the status bar) for the import image feature, where #image_name#, #image_size# and #image_max_size# will replaced by their respective values, that can be used for customization or internationalization. MarkdownImageTexts null
ImageUploadChanged Occurs every time the selected image has changed. Func<FileChangedEventArgs, Task>
ImageUploadEnded Occurs when an individual image upload has ended. Func<FileEndedEventArgs, Task>
ImageUploadEndpoint The endpoint where the images data will be sent, via an asynchronous POST request. The server is supposed to save this image, and return a json response. string
ImageUploadProgressed Notifies the progress of image being written to the destination stream. Func<FileProgressedEventArgs, Task>
ImageUploadStarted Occurs when an individual image upload has started. Func<FileStartedEventArgs, Task>
LineNumbers If set to true, enables line numbers in the editor. bool false
LineWrapping If set to false, disable line wrapping. Defaults to true. bool false
MaxHeight Sets fixed height for the composition area. minHeight option will be ignored. Should be a string containing a valid CSS value like "500px". Defaults to undefined. string
MaxUploadImageMessageSize Gets or sets the max message size when uploading the file. long 20 * 1024
MinHeight Sets the minimum height for the composition area, before it starts auto-growing. Should be a string containing a valid CSS value like "500px". Defaults to "300px". string 300px
Placeholder If set, displays a custom placeholder message. string null
SegmentFetchTimeout Gets or sets the Segment Fetch Timeout when uploading the file. TimeSpan 1 min
ShowIcons An array of icon names to show. Can be used to show specific icons hidden by default without completely customizing the toolbar. string[] 'code', 'table'
TabSize If set, customize the tab size. Defaults to 2. int 2
Theme Override the theme. Defaults to easymde. string easymde
Toolbar [Optional] Gets or sets the content of the toolbar. RenderFragment
ToolbarTips If set to false, disable toolbar button tips. Defaults to true. bool true
UploadImage If set to true, enables the image upload functionality, which can be triggered by drag-drop, copy-paste and through the browse-file window (opened when the user click on the upload-image icon). Defaults to false. bool false
Value Gets or sets the markdown value. string null
ValueHTML Gets the HTML from the markdown value. string null
ValueChanged An event that occurs after the markdown value has changed. EventCallback<string>
ValueHTMLChanged An event that occurs after the markdown value has changed and the new HTML code is available. EventCallback<string>

Other Blazor components

  • DataTable for Blazor: DataTable component for Blazor WebAssembly and Blazor Server
  • Markdown editor for Blazor: This is a Markdown Editor for use in Blazor. It contains a live preview as well as an embeded help guide for users.
  • Modal dialog for Blazor: Simple Modal Dialog for Blazor WebAssembly
  • PSC.Extensions: A lot of functions for .NET6 in a NuGet package that you can download for free. We collected in this package functions for everyday work to help you with claim, strings, enums, date and time, expressions…
  • Quill for Blazor: Quill Component is a custom reusable control that allows us to easily consume Quill and place multiple instances of it on a single page in our Blazor application
  • Segment for Blazor: This is a Segment component for Blazor Web Assembly and Blazor Server
  • Tabs for Blazor: This is a Tabs component for Blazor Web Assembly and Blazor Server

More examples and documentation

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
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
2.0.10 4,061 5/16/2022
2.0.9 580 3/3/2022
2.0.8 177 2/22/2022
2.0.7 174 2/22/2022
2.0.6 275 1/25/2022
2.0.5 191 1/25/2022
2.0.4 187 1/21/2022
2.0.3 197 1/11/2022
2.0.2 183 1/11/2022
2.0.1 190 1/11/2022
1.0.1 196 11/5/2021

Simple Markdown editor with preview