From 664c0f0f777265e6d8893eb118a2e0581fb9b908 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 28 Oct 2017 17:44:15 -0700 Subject: [PATCH] Clarify that parent needs to be visible when calling open Fixes #1089 --- typings/xterm.d.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index f0ab9daf..2cba5deb 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -290,7 +290,9 @@ declare module 'xterm' { /** * Opens the terminal within an element. - * @param parent The element to create the terminal within. + * @param parent The element to create the terminal within. This element + * must be visible (have dimensions) when `open` is called as several DOM- + * based measurements need to be performed when this function is called. */ open(parent: HTMLElement): void;