Clarify that parent needs to be visible when calling open

Fixes #1089
2026-08-05 13:43:48 -07:00 · 2017-10-28 17:44:15 -07:00
parent 8ece306dbe
commit 664c0f0f77
1 changed files with 3 additions and 1 deletions
@@ -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;