v2.3.0

Important

When upgrading to v2.3.0, please ensure all xterm.js addons are updated to the latest versions.
Example: 5d97eaa#diff-7eaa1862ff69c6d7f4f268c9c2b8b422e7aabdcbb023002f1fbdab2eddca08cb

Upgraded @xterm/xterm and related addons to version 6.0.0 and updated CDN references. Added OverviewRulerOptions and WindowOptions classes, integrated overview ruler and window options into TerminalOptions, and extended Theme with new scrollbar and overview ruler properties. Updated target frameworks and dependencies in the project file, and incremented the package version to 2.3.0.

What's Changed

• Update xterm.js to 6.0, add overview ruler and window options
• Bump typescript from 5.9.2 to 5.9.3 in /XtermBlazor/src by @dependabot[bot] in #103
• Bump webpack from 5.101.3 to 5.102.0 in /XtermBlazor/src by @dependabot[bot] in #102
• Bump actions/setup-node from 5 to 6 in the actions-majors group by @dependabot[bot] in #107
• Bump the npm-minor-and-patch group across 1 directory with 2 updates by @dependabot[bot] in #106
• Bump actions/checkout from 5 to 6 in the actions-majors group by @dependabot[bot] in #111
• Bump webpack from 5.102.1 to 5.103.0 in /XtermBlazor/src in the npm-minor-and-patch group by @dependabot[bot] in #110
• Bump the nuget-minor-and-patch group with 3 updates by @dependabot[bot] in #113
• Bump css-minimizer-webpack-plugin from 7.0.2 to 7.0.3 in /XtermBlazor/src in the npm-minor-and-patch group by @dependabot[bot] in #112
• Bump the npm-minor-and-patch group in /XtermBlazor/src with 3 updates by @dependabot[bot] in #114

Full Changelog: v2.2.0...v2.3.0

v2.2.0

What's Changed

• Bump webpack-cli from 5.1.4 to 6.0.1 in /XtermBlazor/src by @dependabot[bot] in #69
• Bump typescript from 5.6.2 to 5.7.2 in /XtermBlazor/src by @dependabot[bot] in #65
• Bump mini-css-extract-plugin from 2.9.1 to 2.9.2 in /XtermBlazor/src by @dependabot[bot] in #64
• Bump webpack from 5.94.0 to 5.99.9 in /XtermBlazor/src by @dependabot[bot] in #82
• Bump typescript from 5.7.2 to 5.8.3 in /XtermBlazor/src by @dependabot[bot] in #76
• Bump ts-loader from 9.5.1 to 9.5.2 in /XtermBlazor/src by @dependabot[bot] in #74
• Bump esbuild-loader from 4.2.2 to 4.3.0 in /XtermBlazor/src by @dependabot[bot] in #72
• Bump the npm_and_yarn group in /XtermBlazor/src with 2 updates by @dependabot[bot] in #71
• Potential fix for code scanning alert no. 7: Workflow does not contain permissions by @BattlefieldDuck in #83
• Potential fix for code scanning alert no. 6: Workflow does not contain permissions by @BattlefieldDuck in #84
• Potential fix for code scanning alert no. 5: Workflow does not contain permissions by @BattlefieldDuck in #85

New Contributors

• @BattlefieldDuck made their first contribution in #83

Full Changelog: v2.1.2...v2.2.0

v2.1.2

What's Changed

• Change customKeyEventHandler.call to pass the terminal as thisArgs by @Hastaroth1 in #59
• Bump esbuild-loader from 4.2.0 to 4.2.2 in /XtermBlazor/src by @dependabot in #52
• Bump Microsoft.AspNetCore.Components.WebAssembly.DevServer from 8.0.3 to 8.0.7 in /XtermBlazor by @dependabot in #53
• Bump typescript from 5.5.3 to 5.6.2 in /XtermBlazor/src by @dependabot in #60
• Bump mini-css-extract-plugin from 2.9.0 to 2.9.1 in /XtermBlazor/src by @dependabot in #56

New Contributors

• @Hastaroth1 made their first contribution in #59

Full Changelog: v2.1.1...v2.1.2

v2.1.1

What's Changed

• Bump mini-css-extract-plugin from 2.8.1 to 2.9.0 in /XtermBlazor/src by @dependabot in #38
• Bump css-minimizer-webpack-plugin from 6.0.0 to 7.0.0 in /XtermBlazor/src by @dependabot in #39
• Bump css-loader from 7.1.1 to 7.1.2 in /XtermBlazor/src by @dependabot in #40
• Bump webpack from 5.91.0 to 5.92.1 in /XtermBlazor/src by @dependabot in #43
• Bump esbuild-loader from 4.1.0 to 4.2.0 in /XtermBlazor/src by @dependabot in #42
• Fix AttachCustomWheelEventHandler error in frontend. by @aaasoft in #48
• Bump webpack-merge from 5.10.0 to 6.0.1 in /XtermBlazor/src by @dependabot in #46
• Bump typescript from 5.4.5 to 5.5.3 in /XtermBlazor/src by @dependabot in #45
• Bump braces from 3.0.2 to 3.0.3 in /XtermBlazor/src in the npm_and_yarn group by @dependabot in #49

New Contributors

• @aaasoft made their first contribution in #48

Full Changelog: v2.1.0...v2.1.1

v2.1.0

Overview

• Update xterm.js to 5.5.0
• Add new opt-in RescaleOverlappingGlyphs option
• Update dependencies

What's Changed

• Bump Microsoft.AspNetCore.Components.WebAssembly.DevServer from 8.0.2 to 8.0.3 in /XtermBlazor by @dependabot in #28
• Bump Microsoft.AspNetCore.Components.WebAssembly and Microsoft.AspNetCore.Components.Web in /XtermBlazor by @dependabot in #27
• Bump webpack from 5.90.3 to 5.91.0 in /XtermBlazor/src by @dependabot in #30
• Bump typescript from 5.4.2 to 5.4.4 in /XtermBlazor/src by @dependabot in #32
• Bump typescript from 5.4.4 to 5.4.5 in /XtermBlazor/src by @dependabot in #37
• Bump css-loader from 6.10.0 to 7.1.1 in /XtermBlazor/src by @dependabot in #36
• Bump @xterm/xterm from 5.4.0 to 5.5.0 in /XtermBlazor/src by @dependabot in #34

Full Changelog: v2.0.0...v2.1.0

v2.0.0

Overview

• Update @xterm/xterm to v5.4.0
• Support Input, AttachCustomWheelEventHandler and SetCustomWheelEventHandler
• Rename AttachCustomKeyEventHandlerEvaluate to SetCustomKeyEventHandler

Improvements

• Optimized XtermBlazor.min.css and XtermBlazor.min.js, significantly reducing their file sizes.
• Enhanced the way addons are invoked, making it more efficient and user-friendly.

Upgrade to v2.0.0

This document provides instructions on how to upgrade your code to version 2.0.0.

Changes in HTML

Replace the stylesheet link in your HTML file as follows:

<!-- Before v2.0.0 -->
<link href="_content/XtermBlazor/XtermBlazor.css" rel="stylesheet" />

<!-- After v2.0.0 -->
<link href="_content/XtermBlazor/XtermBlazor.min.css" rel="stylesheet" />

The old xterm and xterm-* packages are now deprecated and will no longer be maintained.
Please use the new scoped @xterm/* packages instead.

<!-- Before v2.0.0 -->
<script src="https://cdn.jsdelivr.net/npm/xterm-addon-fit@0.7.0/lib/xterm-addon-fit.min.js"></script>

<!-- After v2.0.0 (Blazor Server) -->
<script src="https://cdn.jsdelivr.net/npm/@@xterm/addon-fit@0.9.0/lib/addon-fit.min.js"></script>

<!-- After v2.0.0 (Blazor WebAssembly) -->
<script src="https://cdn.jsdelivr.net/npm/@xterm/addon-fit@0.9.0/lib/addon-fit.min.js"></script>

<!-- Before v2.0.0 -->
<script>XtermBlazor.registerAddons({"xterm-addon-fit": new FitAddon.FitAddon()});</script>

<!-- After v2.0.0 -->
<script>XtermBlazor.registerAddons({"addon-fit": new FitAddon.FitAddon()});</script>

Changes in Razor

Update your Razor file to reflect the following changes:

  <!-- Before v2.0.0 -->
- <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");
      }
  }

  <!-- After v2.0.0 -->
+ <Xterm @ref="_terminal" Options="_options" Addons="_addons" OnFirstRender="@OnFirstRender" />

  @code {
      private Xterm _terminal;
  
      private TerminalOptions _options = new TerminalOptions
      {
          CursorBlink = true,
          CursorStyle = CursorStyle.Bar,
      };

+     private HashSet<string> _addons = new HashSet<string>()
      {
+         "addon-fit",
      };

      private async Task OnFirstRender()
      {
          // Invoke fit() function
+         await _terminal.Addon("addon-fit").InvokeVoidAsync("fit");
      }
  }

Changes in C#

Update your C# code to reflect the following changes: (#22)

// Before v2.0.0
private async Task OnKey(KeyboardEventArgs args)
{
    
}

// After v2.0.0
private async Task OnKey(KeyEventArgs args)
{
    
}

What's Changed

• Bump Microsoft.AspNetCore.Components.WebAssembly and Microsoft.AspNetCore.Components.Web in /XtermBlazor by @dependabot in #18
• Add EventCallback with Key from Xterm by @PetterRein in #22
• Bump Microsoft.AspNetCore.Components.WebAssembly.DevServer from 8.0.1 to 8.0.2 in /XtermBlazor by @dependabot in #19
• Bump typescript from 5.3.3 to 5.4.2 in /XtermBlazor/src by @dependabot in #24
• Bump webpack from 5.90.1 to 5.90.3 in /XtermBlazor/src by @dependabot in #23
• Bump Microsoft.AspNetCore.Components.WebAssembly and Microsoft.AspNetCore.Components.Web in /XtermBlazor by @dependabot in #25
• Bump esbuild-loader from 4.0.3 to 4.1.0 in /XtermBlazor/src by @dependabot in #26

New Contributors

• @PetterRein made their first contribution in #22

Full Changelog: v1.10.2...v2.0.0

v1.10.2

The main updates in the new version include adding Source Link, ContinuousIntegrationBuild, and webpack, as well as fixing some bugs and improving the performance of the terminal object and the addon function.

What's Changed

• Bump webpack from 5.90.0 to 5.90.1 in /XtermBlazor by @dependabot in #17

Full Changelog: v1.10.1...v1.10.2

v1.10.1

Overview

In this release, we have expanded the compatibility of our project. Previously, our project was targeted for .NET 6.0. Now, we have updated our project to support multiple target frameworks.

The project now supports .NET 6.0, .NET 7.0, and .NET 8.0. This means that our project can now be run on any of these .NET versions, enhancing its versatility and reach.

What's Changed

• Bump ts-loader from 9.4.4 to 9.5.1 in /XtermBlazor by @dependabot in #8
• Bump webpack from 5.88.2 to 5.90.0 in /XtermBlazor by @dependabot in #10
• Bump copy-webpack-plugin from 11.0.0 to 12.0.2 in /XtermBlazor by @dependabot in #13
• Bump System.Net.Http.Json from 6.0.0 to 8.0.0 in /XtermBlazor by @dependabot in #9
• Bump Microsoft.AspNetCore.Components.WebAssembly.DevServer from 6.0.9 to 8.0.1 in /XtermBlazor by @dependabot in #11
• Bump typescript from 5.1.5 to 5.3.3 in /XtermBlazor by @dependabot in #12
• Bump ts-node from 10.9.1 to 10.9.2 in /XtermBlazor by @dependabot in #14
• Bump Microsoft.AspNetCore.Components.WebAssembly from 6.0.9 to 6.0.26 in /XtermBlazor by @dependabot in #16

New Contributors

• @dependabot made their first contribution in #8

Full Changelog: v1.10.0...v1.10.1

v1.10.0

• Update dependencies

Full Changelog: v1.9.0...v1.10.0

v1.9.0

• Update dependencies

Full Changelog: v1.8.1...v1.9.0