Release notes template

Jump to bottom

Daniel Imms edited this page Jun 26, 2022 · 12 revisions

🚀 Features

📦 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) via @meganrogge. 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.

🐞 Bug fixes

Fix triple click selection edge case where initial line was getting unselected (#3669) via @silamon
Avoid clearing marks on the current line on Terminal.clear (#3671) via @meganrogge

📝 Documentation and internal improvements

Replace internal use of getOption/setOption with options (#3667) via @childrentime
Lint code using putout (#3674) via @coderaiser
Improve the way the scroll bar is hidden when scrollback is 0 (#3678) via @silamon

🛑 Breaking changes

...
```
// before x.y.z
...

// after x.y.z
...
```

⚠️ Deprecations

...

🎉 New real-world use cases

... (#n) via @author

📥 Addons

xterm-addon-...

🤝 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@...

🌐 Website

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