Merge pull request #1094 from Tyriar/1089_open_parent_visible

Clarify that parent needs to be visible when calling open
This commit is contained in:
Daniel Imms
2017-11-01 08:47:53 -07:00
committed by GitHub
+3 -1
View File
@@ -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;