Merge pull request #5674 from xtermjs/anthonykim1/addScreenElementAPI

Add api to expose screenElement

Author: Tyriar

src/browser/public/Terminal.ts

@@ -83,6 +83,7 @@ export class Terminal extends Disposable implements ITerminalApi {
   public get onDimensionsChange(): IEvent<IRenderDimensions> { return this._core.onDimensionsChange; }
 
   public get element(): HTMLElement | undefined { return this._core.element; }
+  public get screenElement(): HTMLElement | undefined { return this._core.screenElement; }
   public get parser(): IParser {
     return this._parser ??= new ParserApi(this._core);
   }

test/playwright/TestUtils.ts

@@ -115,6 +115,7 @@ type TerminalProxyAsyncMethodOverrides = 'hasSelection' | 'getSelection' | 'getS
 type TerminalProxyCustomOverrides = 'buffer' | 'dimensions' | (
   // The below are not implemented yet
   'element' |
+  'screenElement' |
   'textarea' |
   'markers' |
   'unicode' |

typings/xterm.d.ts

@@ -911,6 +911,12 @@ declare module '@xterm/xterm' {
      */
     readonly element: HTMLElement | undefined;
 
+    /**
+     * The screen element containing the terminal's canvas rendering layers and
+     * decorations, excluding the viewport and the scrollbar.
+     */
+    readonly screenElement: HTMLElement | undefined;
+
     /**
      * The textarea that accepts input for the terminal.
      */