Announce version 2.0 #2
Conversation
_posts/2016-10-03-xtermjs-2.0.md
Outdated
|
|
||
| - New APIs to [get](http://xtermjs.org/docs/api/Terminal/#getoptionkey) and [set](http://xtermjs.org/docs/api/Terminal/#setoptionkey-value) terminal options | ||
| - Better mouse and mouse wheel support | ||
| - Improved scrolling in curses-based applications (e.g. Vim) |
There was a problem hiding this comment.
The biggest wins from my perspective is scrolling in oh-my-zsh and powershell for Linux. Not sure vim scrolling changed did it?
| We are excited to announce a new major update for xterm.js; **<a href="https://github.com/sourcelair/xterm.js" target="_blank">xterm.js 2.0</a>**! This new release includes the following great updates: | ||
|
|
||
| 1. Launch of official project website with [public API docs](/docs/) and [blog](/blog/) | ||
| 2. Migration of code base to ES2015 modules to make development much easier |
There was a problem hiding this comment.
This is not so important for an update announcement imo and should we mention it if we're moving to TypeScript?
There was a problem hiding this comment.
I think it's a good idea to have this here to encourage developers to contribute.
Considering TypeScript, since we are not settled on this yet let's leave it out of this "announcement".
_posts/2016-10-03-xtermjs-2.0.md
Outdated
| Let's take a quick look on each one of this updates | ||
|
|
||
| ## Project website | ||
| Xterm.js definitely deserved it's own place in the web, so we gifted [xtermjs.org](http://xtermjs.org) to it! Here you can find the official [docs](/docs/) for the public API of the project, including some more high-level guides and a [blog](/blog/), where we will post articles about xterm.js, like releases, presentations, engineering etc. |
There was a problem hiding this comment.
including some more high-level guides -> include some high-level guides
_posts/2016-10-03-xtermjs-2.0.md
Outdated
| Xterm.js definitely deserved it's own place in the web, so we gifted [xtermjs.org](http://xtermjs.org) to it! Here you can find the official [docs](/docs/) for the public API of the project, including some more high-level guides and a [blog](/blog/), where we will post articles about xterm.js, like releases, presentations, engineering etc. | ||
|
|
||
| ## Migration to ES2015 | ||
| Xterm.js used to be a huge monolith and it was a real pain to develop it, especially when dealing with core parts like rendering. We decided to take a big step forward, break the code base into multiple native ES2015 modules and ship xterm.js as a UMD monolith which can be imported using either native modules, CommonJS, RequireJS or no module system at all! |
There was a problem hiding this comment.
"develop it" -> "maintain" or "work on" sounds better imo
| ### ⚠️ Migrating from xterm.js 1.0 to 2.0 | ||
| Since this is a major xterm.js release, we had to break our public API because of this update, so take a look here before migrating! | ||
|
|
||
| The only thing that you have to take into account when migrating from xterm.js 1.0 to 2.0 is importing the appropriate files. The xterm.js core is not stored as two built files (one JavaScript and one CSS) into the `dist` directory of the code base (instead of `src`, where they used to be). |
There was a problem hiding this comment.
A mention on the fact that the API is not strict would be good, meaning that people may have been relying on what we now consider to be private and could change at any time without notice.
There was a problem hiding this comment.
|
|
||
| **Note**: If you are importing xterm.js using CommonJS, there should be nothing to change there, since we updated the package.json file of the project accordingly. | ||
|
|
||
| ## Features and improvements |
There was a problem hiding this comment.
Not sure the level of detail we want here but:
- New API
Terminal.clearxtermjs/xterm.js@7671941 - Swallow ctrl+shift+page up/down xtermjs/xterm.js@446c395
- Mouseup focus bug xtermjs/xterm.js@4e1bbee
- More key sequence support xtermjs/xterm.js@62ce64f xtermjs/xterm.js@7f7156b
- Right click paste Allow right-click paste (again) xterm.js#293
There was a problem hiding this comment.
👍 Added Terminal.clear reference. The rest are mentioned in the GitHub Release.
No description provided.