Fill in documentation on new option

This commit is contained in:
Daniel Imms
2018-05-04 10:02:01 -07:00
parent b14308f2c4
commit 6cadd7c4a8
2 changed files with 10 additions and 3 deletions
+10 -1
View File
@@ -102,7 +102,16 @@ declare module 'xterm' {
macOptionIsMeta?: boolean;
/**
* The type of renderer to use.
* (EXPERIMENTAL) The type of renderer to use, this allows using the
* fallback DOM renderer when canvas is too slow for the environment. The
* following features do not work when the DOM renderer is used:
*
* - Links
* - Line height
* - Letter spacing
*
* This option is marked as experiemental because it will eventually be
* moved to an addon.
*/
rendererType?: RendererType;