PhatBrainSoftware.MarkdownEdit
1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package PhatBrainSoftware.MarkdownEdit --version 1.0.0
NuGet\Install-Package PhatBrainSoftware.MarkdownEdit -Version 1.0.0
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="PhatBrainSoftware.MarkdownEdit" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PhatBrainSoftware.MarkdownEdit --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: PhatBrainSoftware.MarkdownEdit, 1.0.0"
#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 PhatBrainSoftware.MarkdownEdit as a Cake Addin #addin nuget:?package=PhatBrainSoftware.MarkdownEdit&version=1.0.0 // Install PhatBrainSoftware.MarkdownEdit as a Cake Tool #tool nuget:?package=PhatBrainSoftware.MarkdownEdit&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Introduction
Markdown Text Editor for Blazor applications - Uses Bootstrap, Fontawesome, and Markdig
Getting Setup
You can install the package via the NuGet package manager just search for Blazored.Toast. You can also install via powershell using the following command.
Install-Package PhatBrainSoftware.MarkdownEdit
Or via the dotnet CLI.
dotnet add package PhatBrainSoftware.MarkdownEdit
If you're using Visual Studio you can also install via the built in NuGet package manager.
Add Imports
Add the following to your _Imports.razor
@using PhatBrainSoftware.MarkdownEdit
Basic Example
See code in the Index.razor page in the repo for more examples.
@page "/"
<h1>Hello, world!</h1>
<EditForm Model=@this.Model>
@*https://icons.getbootstrap.com/#usage*@
<MarkdownEdit @ref=@MarkdownEdit @bind-Value=@this.Model.Text ShowHelp=false>
<Toolbar>
<ToolbarButtonGroup>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertTextAsync("# "))><i class="bi-type-h1"></i></ToolbarButton>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertTextAsync("## "))><i class="bi-type-h2"></i></ToolbarButton>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertTextAsync("### "))><i class="bi-type-h3"></i></ToolbarButton>
</ToolbarButtonGroup>
<ToolbarButtonGroup>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.WrapTextAsync("**"))><i class="bi-type-bold"></i></ToolbarButton>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.WrapTextAsync("*"))><i class="bi-type-italic"></i></ToolbarButton>
</ToolbarButtonGroup>
<ToolbarButtonGroup>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertTextAsync("> "))><i class="bi-blockquote-left"></i></ToolbarButton>
</ToolbarButtonGroup>
<ToolbarButtonGroup>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertTextAsync("* "))><i class="bi-list-ul"></i></ToolbarButton>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertTextAsync("1. "))><i class="bi-list-ol"></i></ToolbarButton>
</ToolbarButtonGroup>
<ToolbarButtonGroup>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertImageAsync())><i class="bi-link"></i></ToolbarButton>
<ToolbarButton OnClickCallback=@(() => this.MarkdownEdit.InsertLinkAsync())><i class="bi-image"></i></ToolbarButton>
</ToolbarButtonGroup>
</Toolbar>
</MarkdownEdit>
</EditForm>
@code
{
private MarkdownEdit MarkdownEdit;
public class TestModel
{
public string Text { get; set; } = "Hello, world!";
}
public TestModel Model { get; set; }
protected override void OnInitialized()
{
this.Model = new TestModel();
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. 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.
-
net5.0
- Markdig (>= 0.25.0)
- Microsoft.AspNetCore.Components (>= 5.0.7)
- Microsoft.AspNetCore.Components.Web (>= 5.0.7)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.