Skip to content

Releases: xtermjs/xterm.js

5.5.0

05 Apr 14:02
@Tyriar Tyriar
5.5.0
9ba6c00
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
5.5.0 Latest
Latest

🚀 Features

📦 API

  • New opt-in rescaleOverlappingGlyphs option that will conservatively rescale glyphs that likely overlap with the following cell when GPU acceleration is enabled (#4997, #5001, #5012, #5013) via @Tyriar.

    Webgl with the setting off:

    image

    Webgl with the setting on:

    image

    This was primarily added to help with applications that want to achieve GB18030 compliance.

🐞 Bug fixes

📝 Documentation and internal improvements

📥 Addons

@xterm/addon-search

🤝 Compatible addon versions

Addon Version
@xterm/addon-attach 0.11.0
@xterm/addon-canvas 0.7.0
@xterm/addon-fit 0.10.0
@xterm/addon-image 0.8.0
@xterm/addon-ligatures 0.9.0
@xterm/addon-search 0.15.0
@xterm/addon-serialize 0.13.0
@xterm/addon-unicode-graphemes 0.3.0
@xterm/addon-unicode11 0.8.0
@xterm/addon-web-links 0.11.0
@xterm/addon-webgl 0.18.0

Contributors

tabarra, Tyriar, and 2 other contributors
Assets 2
Loading
0 Join discussion

5.4.0

01 Mar 17:12
@Tyriar Tyriar
5.4.0
9a512d1
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
5.4.0

📢 The package has been migrated to the @xterm scope (#4860, #4861) via @Tyriar. This means that the old xterm and xterm-* packages are now deprecated and will no longer be maintained. This was done mainly for security reasons to remove ambiguity around the package names and to prevent potential typosquatting attacks.

Please use the new scoped @xterm/* packages.

📦 API

  • input(data: string, wasUserInput?: boolean): void API to emit an input event from Terminal (#4953) via @arencoskun
  • documentOverride option to help multi-window app support (#4844) via @Tyriar
  • attachCustomWheelEventHandler API to allow embedders to intercept wheel events (#4913, #4915) via @Tyriar, @tisilent

🐞 Bug fixes

  • Selection is now synchronized between the accessibility tree and the main selection model (#4742) via @JasonXJ
  • Fix and add integration tests for inactive selection drawing (#4763, #4808) via @tisilent
  • Fix a possible exception when disposing Terminal (#4776, #4785) via @Tyriar
  • Fix handling of invisible characters in the DOM renderer (#4762) via @tisilent
  • Improve reliability of playwright tests across browsers (#4777) via @Tyriar
  • Fix inverse minimum contrast ratio edge cases (#4778) via @Tyriar
  • Fix regression in forced mouse selection handling (#4783) via @Tyriar
  • Always render cursor above selection in the DOM renderer (#4786) via @Tyriar
  • Get voice over to announce terminal output consistently (#4789) via @meganrogge
  • Use isCursorInitialized correctly in the DOM renderer (#4798) via @tisilent
  • Move WidthCache measurment container to the helper element (#4807) via @mofux
  • Fix DOM renderer showing selection overflowing its container (#4815, #4837) via @tisilent
  • Don't re-render after parse if the viewport did not change (#4820) via @Tyriar
  • Send correct code for ctrl+alt+backspace (#4839) via @JasonXJ
  • Make xterm.js multi-window aware (#4846, #4912) via @Tyriar, @jeanp413
  • Fix node process check for node v21+ (#4851) via @davidfiala
  • Improve non-browser usage of xterm package by preferring globalThis over self (#4856) via @alan-agius4
  • Fix crosshair cursor not working (#4921) via @Tyriar
  • Fix exception in render service (#4954) via @Tyriar
  • Fix spacing when measuring before element is attached to the DOM (#4973) via @Tyriar

📝 Documentation and internal improvements

⚠️ Deprecations

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

📥 Addons

@xterm/addon-canvas

  • Add underline variants to make underline patterns appear correctly (#4703) via @tisilent
  • Improve rendering of dashed underline patterns (#4874) via @tisilent
  • Support blending of selection and background/powerline characters and the selection (#4920, #4950) via @Tyriar

@xterm/addon-unicode-graphemes

This is a new experimental addon that provides support for grapheme clusters in the terminal (#4519) via @PerBothner

@xterm/addon-search

@xterm/addon-serialize

@xterm/addon-webgl

  • Add underline variants to make underline patterns appear correctly (#4703) via @tisilent
  • Improve rendering of dashed underline patterns (#4874) via @tisilent
  • Fix inactive cursor rendering (#4801) via @tisilent
  • Allow addon to work on legacy versions of Safari when webgl2 is explicitly enabled (#4836) via @xiaoxiaobt
  • Support blending of selection and background/powerline characters and the selection (#4920, #4950) via @Tyriar

@xterm/addon-web-links

🤝 Compatible addon versions

Addon Version
@xterm/addon-attach 0.10.0
@xterm/addon-canvas 0.6.0
@xterm/addon-fit 0.9.0
@xterm/addon-image 0.7.0
@xterm/addon-ligatures 0.8.0
@xterm/addon-search 0.14.0
@xterm/addon-serialize 0.12.0
@xterm/addon-unicode-graphemes 0.2.0
@xterm/addon-unicode11 0.7.0
@xterm/addon-web-links 0.10.0
@xterm/addon-webgl 0.17.0

Contributors

arcanis, szymonkaliski, and 14 other contributors
Assets 2
Loading

5.3.0

07 Sep 18:03
@Tyriar Tyriar
5.3.0
2e02c37
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
5.3.0

🚀 Features

📦 API

  • There's a new trace log level (#4687, 4709) via @Tyriar 
    const term = new Terminal({
    logLevel: 'trace'
});
  • New logger delegate option (#4563, #4564) via @Tyriar. This new API allows the embedder to define the logging behavior, instead of always using to console 
    const term = new Terminal({
    logger: {
        trace: (e, args) => console.log('trace: ', e, args),
        debug: (e, args) => console.log('debug: ', e, args),
        info: (e, args) => console.log('info: ', e, args),
        warn: (e, args) => console.log('warn: ', e, args),
        error: (e, args) => console.log('error: ', e, args)
    }
});
  • New ignoreBracketedPasteMode option that allows explicitly disabling bracketed paste mode, regardless of whether the shell enables it or not (#4636) via @Tyriar 
    const term = new Terminal({
    ignoreBracketedPasteMode: true
});
  • New cursorInactiveStyle option (#4657) via @tisilent 
    const term = new Terminal({
    cursorInactiveStyle: 'none'
});

🐞 Bug fixes

  • Fix character size being affected by CSS transformations (#4366) via @arekouzounian
  • Fix mouse tracking behavior (#4583) via @jerch
  • Improve rendering of the DOM renderer's underline cursor (#4584) via @dlech
  • Fix issues in the accessibility tree (#4637) via @meganrogge
  • Fix reset and clear leaving viewport in a bad state (#4638) via @Tyriar
  • Fix API facade memory leaks (#4655) via @Tyriar
  • Fix memory leak in cursor blink state manager (#4659) via @SvanT
  • Fix inverse rendering when a transparent foreground is used (#4667) via @Dennnnny
  • Fix disposing of decorations (#4671) via @Tyriar
  • Render selection background consistently in the DOM renderer (#4673) via @Tyriar
  • Improve rendering of powerline circle line custom glyph (#4729) via @tisilent
  • Improve texture atlas utilization and fix glyph corruption when merging (#4732) via @Tyriar

📝 Documentation and internal improvements

🎉 New real-world use cases

📥 Addons

xterm-addon-canvas

xterm-addon-image

  • The images addon has been merged into the main repository (#4577, #4727) via @jerch

xterm-addon-ligatures

xterm-addon-serialize

  • Fallback to default ANSIcolors when running xterm-headless (#4348) via @silamon

xterm-addon-webgl

  • Render the cursor in the WebGL canvas (#4568) via @xzfc

🤝 Compatible addon versions

Addon Version
xterm-addon-attach 0.9.0
xterm-addon-canvas 0.5.0
xterm-addon-fit 0.8.0
xterm-addon-image 0.5.0
xterm-addon-ligatures 0.7.0
xterm-addon-search 0.13.0
xterm-addon-serialize 0.11.0
xterm-addon-unicode11 0.6.0
xterm-addon-web-links 0.9.0
xterm-addon-webgl 0.16.0

🌐 Website

Pull from https://github.com/xtermjs/xtermjs.org/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aclosed

Contributors

dlech, Tyriar, and 15 other contributors
Assets 2
Loading

5.2.1

10 Jun 21:01
@Tyriar Tyriar
5.2.1
ac923e5
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
5.2.1

🐞 Bug fixes

  • Fix NPEs on buffer line and windowsPty option (#4551) via @Tyriar

Contributors

Tyriar
Assets 2
Loading

5.2.0

08 Jun 22:01
@Tyriar Tyriar
5.2.0
cc1089e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
5.2.0

🚀 Features

📦 API

  • Improved Windows workarounds with the new windowsPty option (#4539) via @Tyriar

    const term = new Terminal({
  windowsPty: {
    backend: 'conpty',
    buildNumber: 19000
  }
});

🐞 Bug fixes

  • Fix performance issue related to hovering links (#4341) via @Tyriar
  • Fix exception by validating rows are correct when rendering (#4346) via @Tyriar
  • Improve rendering of dotted underline (#4350) via @Tyriar
  • Invalidate links after resizing (#4358) via @Tyriar
  • Fix texture atlas exception thrown when changing options (#4390) via @Tyriar
  • Show hollow cursor when unfocused, regardless of cursor type (#4443) via @tisilent
  • Fix out of sync link underlines after resizing on Windows (#4458) via @Tyriar
  • Fix a lifecycle issue with decorations (#4465) via @Tyriar
  • Rerender in the DOM renderer after options change (#4475) via @kelvinhammond
  • Fix DECRQM reports and add DECBKM (#4478) via @jerch
  • Fix links not working when using a screen reader (#4491) via @jerch
  • Ensure decorations in the top layer render on top of decorations in the bottom layer (#4516) via @jeanp413
  • Avoid triggering a reflow while rendering search decorations (#4521) via @jeanp413
  • Don't apply dim to background color (#4525) via @Tyriar
  • Fix exception and performance issue when rendering link underlines (#4546) via @jerch

📝 Documentation and internal improvements

⚠️ Deprecations

  • windowsMode has been deprecated in favor of windowsPty 
    // Before 5.2
term = new Terminal({ windowsMode: true });
// After 5.2
term = new Terminal({
  windowsPty: {
    backend: 'conpty',
    buildNumber: 19000
  }
});

🎉 New real-world use cases

📥 Addons

xterm-addon-canvas

  • Fix rendering of underline on wide characters (#4352) via @Tyriar
  • Update selection properly after changing themes (#4353) via @Tyriar
  • Update selection properly after a resize (#4355) via @Tyriar
  • Correct cell background color after clearing formatting (#4438) via @jerch
  • Fix rendering of 0xE0BB and 0xE0BF powerline symbols (#4451) via @Starwort
  • Fix rendering of cursor leaving artifacts on Firefox (#4500) via @Tyriar
  • Disallow glyphs to exceed texture atlas size (#4508) via @Tyriar
  • Don't apply dim to background color (#4525) via @Tyriar
  • Fix blacked out content (#4533) via @Tyriar

xterm-addon-search

  • Improve search behavior when there are > 1000 results (#4504) via @jeanp413

xterm-addon-webgl

🤝 Compatible addon versions

  • xterm-addon-attach@...
  • xterm-addon-fit@...
  • xterm-addon-ligatures@...
  • xterm-addon-search@...
  • xterm-addon-serialize@...
  • xterm-addon-unicode11@...
  • xterm-addon-web-links@...
  • xterm-addon-webgl@...

Contributors

Eugeny, kelvinhammond, and 8 other contributors
Assets 2
Loading

5.1.0

19 Dec 18:34
@Tyriar Tyriar
5.1.0
19c760a
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
5.1.0

🚀 Features

Multiple texture atlas page support (#4244, #4252, #4274) via @Tyriar

Instead of there being a hard cap of 1024x1024 on the size of the texture atlas backing the canvas and webgl renderers, multiple textures are now supported. Each individual texture is now 512x512 which allows faster uploading to the GPU and will continually merge until the maximum of 4096x4096 is reached.

The benefits in simple terms of this change are:

  • Less time from drawing a glyph to rendering it
  • Less CPU is used when lots of glyphs are used
  • Essentially unlimited space for glyphs, which is good for certain use cases but will also let us explore things like "perfect" dotted and curvy underlines in the future

Here is an example of a 512x512 texture atlas page right after the terminal has loaded and printed a powerline-based prompt:

image

And here is the 1024x1024 page after a lot of glyphs have rendered:

image

Slash and triangle custom glyphs (#4313) via @Tyriar

Eight new powerline extra custom glyphs are supported:

image

New option scrollOnUserInput (#4289) via @JasonXJ

You can now specify whether to scroll to the bottom of the terminal on user input, previously this was the default and only behavior. This new setting is enabled by default.

const term = new Terminal({ scrollOnUserInput: false });

🐞 Bug fixes

  • Fix width of upper 1/8 block character (#4134) via @Tyriar
  • Allow the renderer to be set before Terminal.open is called (#4151) via @Tyriar
  • Fix trusted types in dom renderer (#4157) via @Tyriar
  • Fix several memory retention issues (#4185) via @Tyriar
  • Remove check proposed api checks (#4204) via @silamon
  • Clear the extended attribute on CSI 0 m via @JasonXJ
  • Fix clipping of italic emoji (#4237) via @Tyriar
  • Fix some edge cases in screenReaderMode (#4284) via @JasonXJ
  • Send corresponding escape code for alt+space and ctrl+alt+space (#4290) via @JasonXJ
  • Re-evaluate the link under the cursor instead dropping it completely when the terminal buffer changes (#4298) via @jerch

🏎️ Performance

📝 Documentation and internal improvements

🛑 Breaking changes

  • There is a new allowNonHttpProtocols property on ILinkHandler which forces the embedder to opt-in to non-http(s) protocols. This is a breaking change in a minor release as it could improve security of embedders. 
    // before 5.1.0
const term = new Terminal({
  linkHandler: {
    ...
  }
};

// after 5.1.0
const term = new Terminal({
  linkHandler: {
    // If you explicitly support and sanitize the links
    allowNonHttpProtocols: true,
    ...
  }
};

🎉 New real-world use cases

📥 Addons

xterm-addon-attach

  • Warn/throw on unexpected attach addon socket state (#4208) via @Tyriar

xterm-addon-canvas

  • Share texture atlases between the webgl and canvas renderers (#4170, #4168, #4182) via @Tyriar
  • Fix glyphs becoming garbled or invisible (#4189) via @Tyriar
  • Disable canvas ImageBitmap optimization on Safari (#4219) via @Tyriar
  • Correctly offset minimumContrastRatio check (#4239) via @Tyriar
  • Fix line height and letter spacing rendering (#4305) via @Tyriar
  • Fix canvas renderer selection not re-rendering sometimes (#4325) via @Tyriar

xterm-addon-serialize

  • Fallback to default ansi colors when running xterm-headless (#4196) via @silamon

xterm-addon-webgl

xterm-addon-web-links

  • Major rework of the addon (#4288) via @jerch. This adds support for more URLs, fixes underlines sometimes being incorrect and changes the regex. There will be regressions in previous behavior with this but overall it's in a much better state. If you find any problems please report them to us.
  • Add 1024 character limit (#4251) via @Tyriar

🤝 Compatible addon versions

  • xterm-addon-attach@0.7.0
  • xterm-addon-fit@0.7.0
  • xterm-addon-ligatures@0.6.0
  • xterm-addon-search@0.11.0
  • xterm-addon-serialize@0.9.0
  • xterm-addon-unicode11@0.5.0
  • xterm-addon-web-links@0.8.0
  • xterm-addon-webgl@0.14.0

Contributors

dstein64, coderaiser, and 11 other contributors
Assets 2
Loading
0 Join discussion

5.0.0

15 Sep 20:00
@Tyriar Tyriar
5.0.0
904ddff
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
5.0.0

v5 is here! This is our largest release in a long time, maybe ever 👀

Since this was a major version bump, we used the opportunity to clean up the API and make other breaking changes. Many of these changes enabled a significant reduction in the xterm module bundle size which went from 379kb to 265kb for a 30% reduction!

🚀 Features

Underline style and color support (#3921, #3976, #3980, #4053, #4068, #4074, #4077, #4109) via @Tyriar

Underline style and color sequences such as CSI 4:2m ST for double underlines are now supported:

image

Some work was also done to improve underline rendering overall, characters with long descenders don't overlap with the underline:

image

Hyperlink escape sequence support (#4005, #4087, #4088) via @Tyriar, @jerch

Building upon the improved underline rendering, hyperlink escapes outlined in this gist are now supported. They will be rendered using a dashed underline (like CSI 4:5m ST):

image

Along with this is a new linkHandler option which allows controling hover, leave and activate events, for example to show a custom tooltip. VS Code's implementation looks like this:

image

Smooth scroll support (#3940) via @Tyriar

The new smoothScrollDuration allows setting a duration in milliseconds to animate scroll between the origin and target positions. This is most useful when using a physical mouse (not a trackpad) to help not disorient the user when scrolling with the mouse wheel.

Canvas renderer addon (#3949, #3950, #3954, #3959, #3961, #3981) via @Tyriar

The canvas renderer has moved into an addon, significantly reducing the bundle size of the xterm module. This used to be the default renderer and is now recommended only as a fallback to the webgl addon if that does not work for some reason (eg. no webgl2 support).

New VT feature support (#4093, #4095, #4098)via @jerch

xterm.js handles several new VT sequences:

  • SGR-pixels mouse reports support (#4093) via @jerch
  • DECRQM support - ANSI and DEC private mode reporting (#4095) via @jerch
  • Protection flag support (#4098) via @jerch

Other features

  • Powerline semi-circle glyphs are now custom rendered (#3891) via @sbatten
  • Inactive selection background (#3965) via @Tyriar - ITheme.selectionInactiveBackground will now change the selection color when the terminal is not focused
  • Support setting extended ansi colors 16-255 (#3905, #3909) via @silamon, @Tyriar
  • The parser and buffer APIs are now stable (#3951) via @Tyriar
  • Rendering should now work when opening xterm.js in a popout window (#4069) via @mihaip

🐞 Bug fixes

  • Fix an exception when markers are deleted (#3888, #3901) via @Tyriar
  • Make corner box glyphs uniformly round (#3895) via @Tyriar
  • Fix changing allowTransparency from its initial value in the Terminal constructor (#3899) via @Tyriar
  • Throw when setting an invalid cursorStyle (#3900) via @Tyriar
  • Allow markers in the alt buffer (#3924) via @silamon
  • Retain hue when minimum contrast ratio flips luminance (#3929) via @Tyriar
  • Remove shift+backspace -> ^H binding (#3935) via @Tyriar
  • Fix disabling the webgl addon in the demo (#3988) via @Tyriar
  • Improve deletion handling on Android (#4007) via @ink404
  • Fix performance regression introduced with decoration support (#4080) via @Tyriar

📝 Documentation and internal improvements

🛑 Breaking changes

  • bellSound and bellStyle options as well as the previously builtin sound have been removed (#3941) via @Tyriar. This reduces the bundle size while still allowing the embedder to support the terminal bell via the Terminal.onBell API

    // before 5.0.0
term = new Terminal({
  bellStyle: 'sound'
});

// after 5.0.0
term = new Terminal();
term.onBell(() => {
  // Play a sound
});

  • The link matcher API registerLinkMatcher and deregisterLinkMatcher have been removed in favor of the link provider API (#3944) via @Tyriar.

  • The allowProposedApi option now defaults to false, set this to true to opt-in to proposed API usage if you understand the implications (#3945) via @Tyriar

    // before 5.0.0
term = new Terminal({});
term.someProposedApi();

// after 5.0.0
term = new Terminal({
  allowProposedApi: true
});
term.someProposedApi();

  • The deprecated addMarker API has been removed in favor of registerMarker (#3946) via @Tyriar. They are functionally equivalent.

  • The deprecated getOption and setOption APIs have been removed in favor of options (#3947) via @Tyriar

    // before 5.0.0
term.setOption('scrollback', 1000);
console.log(term.getOption('scrollback'));

// after 5.0.0
term.options.scrollback = 1000;
console.log(term.options.scrollback);

  • The deprecated writeUtf8 API has been removed in favor of write (#3947) via @Tyriar.

    const arr = new Uint8Array(10);

// before 5.0.0
term.writeUtf8(arr);

// after 5.0.0
term.write(arr);

  • ISelectionPosition have been removed from the API in favor of IBufferRange (#3952) via @Tyriar

  • cols and rows options can now only be set in the constructor (#3960, #3972, #4078) via @Tyriar, @silamon

    // before 5.0.0
term.setOption('cols', 10);

// after 5.0.0
term.resize(10, term.rows);

  • ITheme.selection has been renamed to selectionBackground for consistency (#3964) via @Tyriar

    // before 5.0.0
term.options.theme = { selection: '#000000' };

// after 5.0.0
term.options.theme = { selectionBackground: '#000000' };

  • The Terminal.options getter now returns a Required<ITerminalOptions> instead of just ITerminalOptions for better correctness. Along with this change fastScrollModifier now accepts 'none' instead of undefined

    // before 5.0.0
new Terminal({ fastScrollModifier: undefined });

// after 5.0.0
new Terminal({ fastScrollModifier: 'none' });

🎉 New real-world use cases

📥 Addons

xterm-addon-canvas

  • Redraw selection on resize (#3938) via @Tyriar
  • Fix rendering of the ▛ (U+259B) character (#3902) via @Tyriar
  • Fix blurry rendering that could happen when using a non-round devicePixelRatio (#3926, #4009, #4105) via @Tyriar, @jeanp413
  • Overdraw powerline strokes such that the top and bottom are flat against the cell boundaries (#4070) via @Tyriar
  • Show entire glyph for extra powerline symbols (#4073, #4086) via @Tyriar

xterm-addon-fit

  • Fix return type of proposeDimensions to include undefined (#3882) via @jerch

xterm-addon-ligatures

  • Warn when ligature fonts fail to download (#3933) via @Tyriar
  • Fix the addon in the latest version of Chrome (#3936) via @Tyriar
  • Fallback ligatures are now supported, allowing ligatures to work without font access (#3963) via @Tyriar
  • Remove electron renderer and node targets (#4002, #4003) via @Tyriar

xterm-addon-web-links

  • The link matcher-based implementation has been removed in favor of the link provider implementation (#3944) via @Tyriar

xterm-addon-webgl

More efficient GPU memory usage using new texture atlas packing strategy (#3979) via @Tyriar

The previous naive texture packing strategy which only allowed adding to the "active row" or below has been replaced with a new strategy that uses multiple active rows and adds glyphs to the most suitable row based on its pixel height. This leads to more effective usage of the texture xterm.js uploads to the GPU, meaning it's harder to reset the texture when it becomes filled (which is more likely to happen when screen scale is high).

Before:

image

After:

image

Other changes

  • Release webgl resources when the addon is disposed (#3890) via...
Read more

Contributors

sorenisanerd, mihaip, and 15 other contributors
Assets 2
Loading

4.19.0

29 Jun 17:19
@Tyriar Tyriar
4.19.0
4a61642
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
4.19.0

🚀 Features

  • The minimum contrast ratio feature will now change luminance in the opposite direction if the contrast ratio isn't met (#3806, #3808) via @Tyriar. For example a red foreground on a slightly darker red background will try lighten the color and if the minimumContrastRatio option isn't met when #FFFFFF is reached it will try moving it towards #000000. This can cause somewhat unexpected results by changing explicitly styled whites to blacks for example but it's really good for accessibility.
  • The library now supports parsing #rgb, #rgba, rgb(r, g, b) and rgba(r, g, b, a) color formats (#3815, #3819, #3823) via @ChaseKnowlden, @Tyriar
  • Opaque selectionBackground is now supported in the DOM renderer (#3839) via @Tyriar
  • The symbol powerline font glyphs now use custom rendering when ITerminalOptions.customGlyphs is enabled (#3856, #3862, #3866) via @Tyriar
    image
    This has multiple benefits:
    • A patched powerlines font doesn't need to be installed to render the most common characters
    • Ugly lines due to anti-aliasing that can appear no longer do
    • The glyphs always use greyscale anti-aliasing (not sub-pixel)
    • ITerminalOptions.lineHeight is taken into account when rendering the glyph

📦 API

  • The overview ruler is a companion feature to the decorations introduced in 4.18.0 which shows little indicators on the scroll bar (#3676, #3687, #3688, #3689, #3693, #3694, #3695, #3697, #3702, #3711, #3723, #3730, #3733, #3738, #3788, #3791, #3792, #3841) via @meganrogge, @Tyriar. To use it, add the overviewRulerOptions property to a decoration's IDecorationOptions and it will automatically show up in the overview ruler. 
    const marker = term.addMarker(1);
const decoration = term.registerDecoration({
  marker,
  x: 5,
  overviewRulerOptions: {
    color: '#FF0000',
    position: 'left'
  }
});
decoration.onRender(() => {
  decoration.element.style.backgroundColor = 'red';
});
    The width of the resulting overview ruler is controlled by ITerminalOptions.overviewRulerWidth.
  • Decorations can now change a cell's background and foreground colors (#3775, #3782) via @Tyriar. When this is set, the minimum contrast ratio feature will also be in effect. 
    const decoration = term.registerDecoration({
  marker,
  backgroundColor: '#ff0000',
  foregroundColor: '#ffffff'
});
  • Decorations can now specify the layer property to allow rendering above the selection (#3785, #3800) via @Tyriar 
    const decoration = term.registerDecoration({
  marker,
  layer: 'top'
});
  • There's a new selectionForeground theme color, when set this will use a static color for selections (#3813) via @Tyriar 
    const term = new Terminal({
  theme: {
    selectionBackground: '#000000',
    selectionForeground: '#FFFFFF'
  }
});

🐞 Bug fixes

  • Fix triple click selection edge case where initial line was getting unselected (#3669) via @silamon
  • Fixing edge cases when clearing decorations via Terminal.clear (#3671, #3868) via @meganrogge
  • Handle missing compositionend events for Sogou IME (#3680) via @Eugeny
  • Fix a bug when running emacs by preferring ST over BEL (#3704) via @meganrogge
  • Fix Alt-N/E/U handling in macOS, handle Alt-Shift-Letter (#3726) via @Eugeny
  • Fix caps lock while IMEs are being used preventing lowercase input (#3728) via @serkodev
  • Exclude powerline characters from the minimum contrast ratio feature (#3740, #3742) via @meganrogge
  • Send ctrl modifier for page up/down sequences (#3761) via @Tyriar
  • Send record separator on ctrl+@ (#3763) via @robinfai
  • Switching from webgl to dom renderer will now correctly reposition decorations (#3779) via @Tyriar
  • Decorations are now rendered in the same frame as the buffer, ensuring they stay in sync (#3796, #3818) via @meganrogge
  • Fire onSelectionChange when Terminal.select is called (#3805) via @Tyriar
  • Padding is now taken into account when converting mouse coordinates to cell positions (#3826) via @Tyriar
  • Exclude box drawing and block glyphs from the minimum contrast ratio as they are typically used to blend with background colors (#3844) via @meganrogge
  • Fix a minimum contrast ratio edge case with inverted text in the DOM renderer (#3846) via @meganrogge
  • Only send the wheel mouse event when scrolling a line or more (#3869) via @pfitzseb

📝 Documentation and internal improvements

🎉 New real-world use cases

📥 Addons

xterm-addon-search

xterm-addon-serialize

xterm-addon-web-links

xterm-addon-webgl

  • Simplified and sped up selection rendering by leveraging the decorations feature (#3782, #3860) via @Tyriar

🤝 Compatible addon versions

  • xterm-addon-attach@0.6.0
  • xterm-addon-fit@0.5.0
  • xterm-addon-ligatures@0.5.3
  • xterm-addon-search@0.9.0
  • xterm-addon-serialize@0.7.0
  • xterm-addon-unicode11@0.3.0
  • xterm-addon-web-links@0.6.0
  • xterm-addon-webgl@0.12.0

🌐 Website

Contributors

Eugeny, LuckyGeck, and 17 other contributors
Assets 2
Loading

4.18.0

28 Feb 17:13
@meganrogge meganrogge
4.18.0
a8fbc8d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
4.18.0

📦 API

  • Support buffer decorations (#1852) via @meganrogge

    const marker = term.addMarker(1);
const decoration = term.registerDecoration({ marker, x: 5 });
decoration.onRender(() => {
  decoration.element.style.backgroundColor = 'red';
});

    Screen Shot 2022-02-28 at 11 08 39 AM

  • Make registerMarker's cursor offset optional (#3663) via @childrentime

    // Before
const markerAtCursor = term.registerMarker(0);

// After
const markerAtCursor = term.registerMarker();

🐞 Bug fixes

📝 Documentation and internal improvements

🎉 New real-world use cases

🤝 Compatible addon versions

  • xterm-addon-attach@0.6.0
  • xterm-addon-fit@0.5.0
  • xterm-addon-ligatures@0.5.3
  • xterm-addon-search@0.8.2
  • xterm-addon-serialize@0.6.2
  • xterm-addon-unicode11@0.3.0
  • xterm-addon-web-links@0.5.1
  • xterm-addon-webgl@0.11.4

Contributors

Tyriar, meganrogge, and 2 other contributors
Assets 2
Loading

4.17.0

03 Feb 15:22
@Tyriar Tyriar
4.17.0
c3261be
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
4.17.0

🚀 Features

📦 API

  • Allow setting multiple options in the xterm-headless API too (#3599) via @silamon

🐞 Bug fixes

  • Resolve perf regression from OptionsService.options (#3559) via @silamon
  • Prevent exception that could be thrown when reducing the width of the terminal (#3604) via @Tyriar
  • Fix text baseline in legacy Edge (#3621) via @felixse

📝 Documentation and internal improvements

🎉 New real-world use cases

📥 Addons

xterm-addon-ligatures

xterm-addon-web-links

🤝 Compatible addon versions

  • xterm-addon-attach@0.6.0
  • xterm-addon-fit@0.5.0
  • xterm-addon-ligatures@0.5.2
  • xterm-addon-search@0.8.2
  • xterm-addon-serialize@0.6.1
  • xterm-addon-unicode11@0.3.0
  • xterm-addon-web-links@0.5.1
  • xterm-addon-webgl@0.11.4

🌐 Website

Contributors

wesbos, erulabs, and 7 other contributors
Assets 2
Loading