From 18abcf49e6bf7a1675b59621012842d903e71b98 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Sat, 28 Oct 2017 17:42:26 -0700 Subject: [PATCH] Clarify that the parent needs to be visible Related sourcelair/xterm.js#1089 --- _docs/api/Terminal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/api/Terminal.md b/_docs/api/Terminal.md index 29a1f88..640abab 100644 --- a/_docs/api/Terminal.md +++ b/_docs/api/Terminal.md @@ -211,7 +211,7 @@ term.off('resize', logResize) - `parent` - HTMLElement - The DOM element to host the terminal - `focus` - Boolean - Focus the terminal, after it gets instantiated in the DOM -Open the terminal into the given parent element. +Open the terminal into the given parent element. The parent element should be visible (have dimensions) when `open` is called as several DOM-based measurements need to be performed when this function is called. > ⚠️ The `focus` argument currently defaults to `true` but starting with xterm.js 3.0 it will default to `false`.