Skip to content

Commit

Permalink
Clarify that the parent needs to be visible
Browse files Browse the repository at this point in the history
  • Loading branch information
Tyriar authored Oct 29, 2017
1 parent e0d012e commit 18abcf4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion _docs/api/Terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 18abcf4

Please sign in to comment.