@xterm/headless 6.1.0-beta.9 → 6.1.0-beta.90

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xterm/headless",
   "description": "A headless terminal component that runs in Node.js",
-  "version": "6.1.0-beta.9",
+  "version": "6.1.0-beta.90",
   "main": "lib-headless/xterm-headless.js",
   "module": "lib/xterm.mjs",
   "types": "typings/xterm-headless.d.ts",
@@ -25,5 +25,5 @@
     "webgl",
     "xterm"
   ],
-  "commit": "269d8c20aed41b71c743690b1fe70d82dbd420d6"
+  "commit": "c97abced76fe3ca2191b86f6c03c1275b6d4e696"
 }

package/typings/xterm-headless.d.ts

@@ -49,7 +49,9 @@ declare module '@xterm/headless' {
     convertEol?: boolean;
 
     /**
-     * Whether the cursor blinks.
+     * Whether the cursor blinks. The blinking will stop after 5 minutes of idle
+     * time (refreshed by clicking, focusing or the cursor moving). The default
+     * is false.
      */
     cursorBlink?: boolean;
 
@@ -63,22 +65,6 @@ declare module '@xterm/headless' {
      */
     cursorWidth?: number;
 
-    /**
-     * Whether to draw custom glyphs instead of using the font for the following
-     * unicode ranges:
-     *
-     * - Box Drawing (U+2500-U+257F)
-     * - Box Elements (U+2580-U+259F)
-     * - Powerline Symbols (U+E0A0–U+E0BF)
-     * - Symbols for Legacy Computing (U+1FB00–U+1FBFF)
-     *
-     * This will typically result in better rendering with continuous lines,
-     * even when line height and letter spacing is used. Note that this doesn't
-     * work with the DOM renderer which renders all characters using the font.
-     * The default is true.
-     */
-    customGlyphs?: boolean;
-
     /**
      * Whether input should be disabled.
      */
@@ -146,7 +132,8 @@ declare module '@xterm/headless' {
     /**
      * Whether to reflow the line containing the cursor when the terminal is
      * resized. Defaults to false, because shells usually handle this
-     * themselves.
+     * themselves. Note that this will not move the cursor position, only the
+     * line contents.
      */
     reflowCursorLine?: boolean;
 
@@ -597,21 +584,18 @@ declare module '@xterm/headless' {
     readonly cols: number;
 
     /**
-     * (EXPERIMENTAL) The terminal's current buffer, this might be either the
-     * normal buffer or the alt buffer depending on what's running in the
-     * terminal.
+     * Access to the terminal's normal and alt buffer.
      */
     readonly buffer: IBufferNamespace;
 
     /**
-     * (EXPERIMENTAL) Get all markers registered against the buffer. If the alt
-     * buffer is active this will always return [].
+     * Get all markers registered against the buffer. If the alt buffer is
+     * active this will always return [].
      */
     readonly markers: ReadonlyArray<IMarker>;
 
     /**
-     * (EXPERIMENTAL) Get the parser interface to register
-     * custom escape sequence handlers.
+     * Get the parser interface to register custom escape sequence handlers.
      */
     readonly parser: IParser;
 
@@ -712,6 +696,17 @@ declare module '@xterm/headless' {
      */
     onLineFeed: IEvent<void>;
 
+    /**
+     * Adds an event listener for when rows are _requested_ to be rendered. The
+     * event value contains the start row and end rows of the rendered area
+     * (ranges from `0` to `Terminal.rows - 1`). This differs from the regular
+     * xterm.js in that it doesn't actually do any rendering but requests
+     * rendering from the outside. This is useful for implementing a custom
+     * renderer on top of xterm-headless.
+     * @returns an `IDisposable` to stop listening.
+     */
+    onRender: IEvent<{ start: number, end: number }>;
+
     /**
      * Adds an event listener for when data has been parsed by the terminal,
      * after {@link write} is called. This event is useful to listen for any
@@ -1247,7 +1242,7 @@ declare module '@xterm/headless' {
      * @param id Specifies the function identifier under which the callback
      * gets registered, e.g. {intermediates: '%' final: 'G'} for
      * default charset selection.
-     * @param callback The function to handle the sequence.
+     * @param handler The function to handle the sequence.
      * Return true if the sequence was handled; false if we should try
      * a previous handler (set by addEscHandler or setEscHandler).
      * The most recently added handler is tried first.
@@ -1352,6 +1347,10 @@ declare module '@xterm/headless' {
      * Send FocusIn/FocusOut events: `CSI ? 1 0 0 4 h`
      */
     readonly sendFocusMode: boolean;
+    /**
+     * Show Cursor (DECTCEM): `CSI ? 2 5 h`
+     */
+    readonly showCursor: boolean;
     /**
      * Synchronized Output Mode: `CSI ? 2 0 2 6 h`
      *