From 3582f8733d341c43abd4f5935c43c97eca05cf30 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 14 Jul 2018 10:46:12 -0700 Subject: [PATCH 1/2] Deprecate emit Part of #1505 --- typings/xterm.d.ts | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index b4df9210..1db05639 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -416,6 +416,13 @@ declare module 'xterm' { */ off(type: 'blur' | 'focus' | 'linefeed' | 'selection' | 'data' | 'key' | 'keypress' | 'keydown' | 'refresh' | 'resize' | 'scroll' | 'title' | string, listener: (...args: any[]) => void): void; + /** + * Emits an event on the terminal. + * @param type The type of event + * @param data data associated with the event. + * @deprecated This is being removed from the API with no replacement, see + * issue #1505. + */ emit(type: string, data?: any): void; addDisposableListener(type: string, handler: (...args: any[]) => void): IDisposable; @@ -474,7 +481,7 @@ declare module 'xterm' { * (EXPERIMENTAL) Registers a character joiner, allowing custom sequences of * characters to be rendered as a single unit. This is useful in particular * for rendering ligatures and graphemes, among other things. - * + * * Each registered character joiner is called with a string of text * representing a portion of a line in the terminal that can be rendered as * a single unit. The joiner must return a sorted array, where each entry is @@ -483,16 +490,16 @@ declare module 'xterm' { * a single unit. When multiple joiners are provided, the results of each * are collected. If there are any overlapping substrings between them, they * are combined into one larger unit that is drawn together. - * + * * All character joiners that are registered get called every time a line is * rendered in the terminal, so it is essential for the handler function to * run as quickly as possible to avoid slowdowns when rendering. Similarly, * joiners should strive to return the smallest possible substrings to * render together, since they aren't drawn as optimally as individual * characters. - * + * * NOTE: character joiners are only used by the canvas renderer. - * + * * @param handler The function that determines character joins. It is called * with a string of text that is eligible for joining and returns an array * where each entry is an array containing the start (inclusive) and end From 05f136b3dafec35e02967f2b58f8aabc80e3cb1f Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 28 Jul 2018 12:42:11 -0700 Subject: [PATCH 2/2] Add link to GitHub dependents to real world uses --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bc1deeb7..bfb5270d 100644 --- a/README.md +++ b/README.md @@ -161,6 +161,8 @@ computational environment for Jupyter, supporting interactive data science and s - [**Nutanix**](https://github.com/nutanix): Nutanix Enterprise Cloud uses xterm in the webssh functionality within Nutanix Calm, and is also looking to move our old noserial (termjs) functionality to xterm.js - [**SSH Web Client**](https://github.com/roke22/PHP-SSH2-Web-Client): SSH Web Client with PHP. +[And much more...](https://github.com/xtermjs/xterm.js/network/dependents) + Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it in our list. Note: Please add any new contributions to the end of the list only. ## Releases