description:"When set to false, any experimental/proposed APIs will throw errors.",
description:"When set to false, any experimental/proposed APIs will throw errors.",
path:["allowProposedApi"],
path:["xterm","allowProposedApi"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Allow Transparent Background",
name:"Allow Transparent Background",
description:"Whether the background is allowed to be a non-opaque color.",
description:"Whether the background is allowed to be a non-opaque color.",
path:["allowTransparentBackground"],
path:["xterm","allowTransparency"],
},
{
type:"boolean",
name:"Alt-Click To Move Cursor",
description:"If enabled, alt + click will move the prompt cursor to the position underneath the mouse.",
path:["altClickMovesCursor"],
},
},
{
{
type:"text",
type:"text",
name:"Bell Sound URI",
name:"Bell Sound URI",
description:"URI for a custom bell character sound.",
description:"URI for a custom bell character sound.",
path:["bellSound"],
path:["xterm","bellSound"],
nullable:true,
nullable:true,
},
},
{
{
type:"enum",
type:"enum",
name:"Bell Style",
name:"Bell Style",
description:"How the terminal will react to the bell character",
description:"How the terminal will react to the bell character",
path:["bellStyle"],
path:["xterm","bellStyle"],
enum:["none","sound"],
enum:["none","sound"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Force End-Of-Line",
name:"Force End-Of-Line",
description:"When enabled, any new-line characters (\\n) will be interpreted as carriage-return new-line. (\\r\\n) Typically this is done by the shell program.",
description:"When enabled, any new-line characters (\\n) will be interpreted as carriage-return new-line. (\\r\\n) Typically this is done by the shell program.",
path:["convertEol"],
path:["xterm","convertEol"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Disable Stdin",
name:"Disable Stdin",
description:"Whether input should be disabled",
description:"Whether input should be disabled",
path:["disableStdin"],
path:["xterm","disableStdin"],
},
},
{
{
type:"number",
type:"number",
name:"Letter Spacing",
name:"Letter Spacing",
description:"The spacing in whole pixels between characters.",
description:"The spacing in whole pixels between characters.",
path:["letterSpacing"],
path:["xterm","letterSpacing"],
},
},
{
{
type:"number",
type:"number",
name:"Line Height",
name:"Line Height",
description:"Line height, multiplied by the font size to get the height of terminal rows.",
description:"Line height, multiplied by the font size to get the height of terminal rows.",
path:["lineHeight"],
path:["xterm","lineHeight"],
},
},
{
{
type:"enum",
type:"enum",
name:"XTerm Log Level",
name:"XTerm Log Level",
description:"Log level for the XTerm library.",
description:"Log level for the XTerm library.",
path:["logLevel"],
path:["xterm","logLevel"],
enum:["debug","info","warn","error","off"],
enum:["debug","info","warn","error","off"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Macintosh Option Key as Meta Key",
name:"Macintosh Option Key as Meta Key",
description:"When enabled, the Option key on Macs will be interpreted as the Meta key.",
description:"When enabled, the Option key on Macs will be interpreted as the Meta key.",
path:["macOptionIsMeta"],
path:["xterm","macOptionIsMeta"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Macintosh Option Click Forces Selection",
name:"Macintosh Option Click Forces Selection",
description:"Whether holding a modifier key will force normal selection behavior, regardless of whether the terminal is in mouse events mode. This will also prevent mouse events from being emitted by the terminal. For example, this allows you to use xterm.js' regular selection inside tmux with mouse mode enabled.",
description:"Whether holding a modifier key will force normal selection behavior, regardless of whether the terminal is in mouse events mode. This will also prevent mouse events from being emitted by the terminal. For example, this allows you to use xterm.js' regular selection inside tmux with mouse mode enabled.",
path:["macOptionClickForcesSelection"],
path:["xterm","macOptionClickForcesSelection"],
},
},
{
{
type:"number",
type:"number",
name:"Forced Contrast Ratio",
name:"Forced Contrast Ratio",
description:"Miminum contrast ratio for terminal text. This will alter the foreground color dynamically to ensure the ratio is met. Goes from 1 (do nothing) to 21 (strict black and white).",
description:"Miminum contrast ratio for terminal text. This will alter the foreground color dynamically to ensure the ratio is met. Goes from 1 (do nothing) to 21 (strict black and white).",
path:["minimumContrastRatio"],
path:["xterm","minimumContrastRatio"],
},
},
{
{
type:"enum",
type:"enum",
name:"Renderer Type",
name:"Renderer Type",
description:"The terminal renderer to use. Canvas is preferred, but a DOM renderer is also available. Note: Letter spacing and cursor blink do not work in the DOM renderer.",
description:"The terminal renderer to use. Canvas is preferred, but a DOM renderer is also available. Note: Letter spacing and cursor blink do not work in the DOM renderer.",
path:["rendererType"],
path:["xterm","rendererType"],
enum:["canvas","dom"],
enum:["canvas","dom"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Right Click Selects Words",
name:"Right Click Selects Words",
description:"Whether to select the word under the cursor on right click.",
description:"Whether to select the word under the cursor on right click.",
path:["rightClickSelectsWord"],
path:["xterm","rightClickSelectsWord"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Screen Reader Support",
name:"Screen Reader Support",
description:"Whether screen reader support is enabled. When on this will expose supporting elements in the DOM to support NVDA on Windows and VoiceOver on macOS.",
description:"Whether screen reader support is enabled. When on this will expose supporting elements in the DOM to support NVDA on Windows and VoiceOver on macOS.",
path:["screenReaderMode"],
path:["xterm","screenReaderMode"],
},
},
{
{
type:"number",
type:"number",
name:"Tab Stop Width",
name:"Tab Stop Width",
description:"The size of tab stops in the terminal.",
description:"The size of tab stops in the terminal.",
path:["tabStopWidth"],
path:["xterm","tabStopWidth"],
},
},
{
{
type:"boolean",
type:"boolean",
name:"Windows Mode",
name:"Windows Mode",
description:"\"Whether 'Windows mode' is enabled. Because Windows backends winpty and conpty operate by doing line wrapping on their side, xterm.js does not have access to wrapped lines. When Windows mode is enabled the following changes will be in effect:\n- Reflow is disabled.\n- Lines are assumed to be wrapped if the last character of the line is not whitespace.",
description:"\"Whether 'Windows mode' is enabled. Because Windows backends winpty and conpty operate by doing line wrapping on their side, xterm.js does not have access to wrapped lines. When Windows mode is enabled the following changes will be in effect:\n- Reflow is disabled.\n- Lines are assumed to be wrapped if the last character of the line is not whitespace.",
path:["windowsMode"],
path:["xterm","windowsMode"],
},
},
{
{
type:"text",
type:"text",
name:"Word Separator",
name:"Word Separator",
description:"All characters considered word separators. Used for double-click to select word logic. Encoded as JSON in this editor for editing convienience.",
description:"All characters considered word separators. Used for double-click to select word logic. Encoded as JSON in this editor for editing convienience.",
Christian7573
4 years ago