Ivy.Widgets.Xterm
1.2.55
dotnet add package Ivy.Widgets.Xterm --version 1.2.55
NuGet\Install-Package Ivy.Widgets.Xterm -Version 1.2.55
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="Ivy.Widgets.Xterm" Version="1.2.55" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ivy.Widgets.Xterm" Version="1.2.55" />
<PackageReference Include="Ivy.Widgets.Xterm" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Ivy.Widgets.Xterm --version 1.2.55
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Ivy.Widgets.Xterm, 1.2.55"
#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.
#:package Ivy.Widgets.Xterm@1.2.55
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Ivy.Widgets.Xterm&version=1.2.55
#tool nuget:?package=Ivy.Widgets.Xterm&version=1.2.55
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Ivy.Widgets.Xterm
A terminal emulator widget for Ivy Framework powered by xterm.js.
Installation
dotnet add package Ivy.Widgets.Xterm
Widgets
Terminal
A fully-featured terminal emulator component.
External React Libraries Used:
- @xterm/xterm - Terminal emulator
- @xterm/addon-fit - Auto-fit terminal to container
- @xterm/addon-web-links - Clickable URLs
Basic Usage
using Ivy.Widgets.Xterm;
// Simple terminal with default settings
new Terminal()
// Terminal with dark theme and custom font
new Terminal()
.DarkTheme()
.FontSize(16)
.CursorBlink(true)
// Terminal with initial content
new Terminal()
.InitialContent("Welcome!\r\n$ ")
// Terminal with event handlers
new Terminal()
.HandleData(data => Console.WriteLine($"User typed: {data}"))
.HandleResize((cols, rows) => Console.WriteLine($"Resized: {cols}x{rows}"))
Props
| Prop | Type | Default | Description |
|---|---|---|---|
Cols |
int? |
null |
Fixed column count (auto-fit if not set) |
Rows |
int? |
null |
Fixed row count (auto-fit if not set) |
FontSize |
int |
14 |
Font size in pixels |
FontFamily |
string |
"Menlo, Monaco, 'Courier New', monospace" |
Font family |
LineHeight |
double |
1.0 |
Line height multiplier |
CursorBlink |
bool |
true |
Enable cursor blinking |
CursorStyle |
CursorStyle |
Block |
Cursor style (Block, Underline, Bar) |
Scrollback |
int |
1000 |
Lines to keep in scrollback buffer |
Theme |
TerminalTheme? |
Dark theme | Terminal color theme |
InitialContent |
string? |
null |
Initial content to display |
Events
| Event | Args | Description |
|---|---|---|
OnData |
string |
Fired when user types in the terminal |
OnResize |
int cols, int rows |
Fired when terminal dimensions change |
OnTitleChange |
string |
Fired when terminal title changes (via OSC sequences) |
Themes
Built-in themes are available:
// Dark theme (VS Code-like)
new Terminal().DarkTheme()
// Light theme
new Terminal().LightTheme()
// Custom theme
new Terminal().Theme(new TerminalTheme
{
Background = "#000000",
Foreground = "#00ff00",
Cursor = "#00ff00",
// ... other colors
})
TerminalTheme Properties
All color properties accept CSS color strings (hex, rgb, rgba):
Background,Foreground,Cursor,CursorAccent,SelectionBlack,Red,Green,Yellow,Blue,Magenta,Cyan,WhiteBrightBlack,BrightRed,BrightGreen,BrightYellow,BrightBlue,BrightMagenta,BrightCyan,BrightWhite
Development
Building
Install frontend dependencies:
cd frontend npm installBuild the frontend:
npm run buildBuild the project from the root folder:
dotnet build
Running Samples
cd .samples
dotnet run Terminal.cs
Creating New Widgets
See CLAUDE.md for detailed instructions on creating new external widgets.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Ivy (>= 1.2.55)
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 |
|---|---|---|
| 1.2.55 | 38 | 5/5/2026 |
| 1.2.54 | 51 | 5/1/2026 |
| 1.2.53 | 80 | 4/30/2026 |
| 1.2.51 | 73 | 4/30/2026 |
| 1.2.50 | 97 | 4/28/2026 |
| 1.2.49 | 90 | 4/27/2026 |
| 1.2.49-pre-20260427185636 | 94 | 4/27/2026 |
| 1.2.48 | 94 | 4/27/2026 |
| 1.2.46 | 111 | 4/27/2026 |
| 1.2.46-pre-20260427132241 | 95 | 4/27/2026 |
| 1.2.44 | 94 | 4/16/2026 |
| 1.2.43 | 158 | 4/16/2026 |
| 1.2.42 | 138 | 4/15/2026 |
| 1.2.42-pre-20260414163705 | 91 | 4/14/2026 |
| 1.2.40 | 133 | 4/14/2026 |
| 1.2.39-pre-20260414141311 | 85 | 4/14/2026 |
| 1.2.37-pre-20260414092333 | 86 | 4/14/2026 |
| 1.2.37-pre-20260414091731 | 82 | 4/14/2026 |
| 1.2.37-pre-20260414084831 | 93 | 4/14/2026 |
| 1.2.37-pre-20260414084740 | 85 | 4/14/2026 |
Loading failed