XtermBlazor 1.10.0
See the version list below for details.
dotnet add package XtermBlazor --version 1.10.0
NuGet\Install-Package XtermBlazor -Version 1.10.0
<PackageReference Include="XtermBlazor" Version="1.10.0" />
paket add XtermBlazor --version 1.10.0
#r "nuget: XtermBlazor, 1.10.0"
// Install XtermBlazor as a Cake Addin #addin nuget:?package=XtermBlazor&version=1.10.0 // Install XtermBlazor as a Cake Tool #tool nuget:?package=XtermBlazor&version=1.10.0
XtermBlazor
<img align="right" width="100" height="100" src="https://github.com/BattlefieldDuck/XtermBlazor/assets/29337428/244eb056-4bb1-43a2-85b4-1909034c3ddf">
Brings xterm.js to Blazor
Live Demo: https://xtermblazor.pages.dev
Demo Projects
- XtermBlazor.Demo.Server (Blazor Server)
- XtermBlazor.Demo.Wasm (Blazor WebAssembly)
Prerequisites
Installation
1. Install the package
Find the package through NuGet Package Manager or install it with following command.
dotnet add package XtermBlazor
2. Add Imports
After the package is added, you need to add the following in your _Imports.razor
@using XtermBlazor
3. Add CSS & Font references
Add the following to your HTML head section, it's either index.html
or _Host.cshtml
depending on whether you're running WebAssembly or Server.
<link href="_content/XtermBlazor/XtermBlazor.css" rel="stylesheet" />
In the HTML body section of either index.html
or _Host.cshtml
add this:
<script src="_content/XtermBlazor/XtermBlazor.min.js"></script>
Basic Usage
<Xterm @ref="_terminal" Options="_options" OnFirstRender="@OnFirstRender" />
@code {
private Xterm _terminal;
private TerminalOptions _options = new TerminalOptions
{
CursorBlink = true,
CursorStyle = CursorStyle.Bar,
Theme =
{
Background = "#17615e",
},
};
private async Task OnFirstRender()
{
await _terminal.WriteLine("Hello World");
}
}
Addons
Xterm supports Addons
To use xterm-addon-fit
addon, you need to add the following to your HTML body section either index.html
or _Host.cshtml
.
<script src="https://cdn.jsdelivr.net/npm/xterm-addon-fit@0.7.0/lib/xterm-addon-fit.min.js"></script>
<script>XtermBlazor.registerAddons({"xterm-addon-fit": new FitAddon.FitAddon()});</script>
Usage with addons
<Xterm @ref="_terminal" Options="_options" AddonIds="_addonIds" OnFirstRender="@OnFirstRender" />
@code {
private Xterm _terminal;
private TerminalOptions _options = new TerminalOptions
{
CursorBlink = true,
CursorStyle = CursorStyle.Bar,
};
private string[] _addonIds = new string[]
{
"xterm-addon-fit",
};
private async Task OnFirstRender()
{
// Invoke fit() function
await _terminal.InvokeAddonFunctionVoidAsync("xterm-addon-fit", "fit");
await _terminal.WriteLine("Hello World");
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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. |
-
net6.0
- Macross.Json.Extensions (>= 3.0.0)
- Microsoft.AspNetCore.Components.Web (>= 6.0.15)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on XtermBlazor:
Package | Downloads |
---|---|
Quick.Blazor.Bootstrap.Terminal
Quick.Blazor.Bootstrap.Terminal is a component library for Terminal built on top of Blazor and CSS frameworks Bootstrap. |
|
MoonlightPluginBase
Use this package to install all dependencies a moonlight plugins needs |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on XtermBlazor:
Repository | Stars |
---|---|
LANCommander/LANCommander
|
|
weibaohui/blazork8s
manage k8s using c# blazor enhance by chatgpt ,try something new !使用blazor技术开发的内置OpenAI GPT的k8s 管理界面
|
Version | Downloads | Last updated |
---|---|---|
2.1.2 | 730 | 9/18/2024 |
2.1.1 | 2,749 | 7/10/2024 |
2.1.0 | 2,490 | 4/16/2024 |
2.0.0 | 617 | 3/8/2024 |
1.10.2 | 5,575 | 2/5/2024 |
1.10.1 | 150 | 1/29/2024 |
1.10.0 | 2,349 | 9/27/2023 |
1.9.0 | 3,864 | 6/28/2023 |
1.8.1 | 1,914 | 3/22/2023 |
1.8.0 | 260 | 3/22/2023 |
1.7.0 | 498 | 2/19/2023 |
1.6.1 | 6,411 | 9/20/2022 |
1.6.0 | 532 | 9/18/2022 |
1.5.2 | 562 | 9/7/2022 |
1.5.1 | 445 | 9/2/2022 |
1.5.0 | 1,006 | 4/13/2022 |
1.4.0 | 504 | 2/22/2022 |
1.3.2 | 425 | 2/21/2022 |
1.3.1 | 456 | 2/16/2022 |
1.3.0 | 490 | 1/19/2022 |
1.2.0 | 502 | 1/14/2022 |
1.1.0 | 433 | 11/1/2021 |
1.0.2 | 359 | 6/14/2021 |
1.0.1 | 333 | 6/13/2021 |
1.0.0 | 455 | 6/13/2021 |