Interface IOptions

Options for the terminal widget.

interface IOptions {
    autoFit?: boolean;
    closeOnExit: boolean;
    cursorBlink: boolean;
    fontFamily?: string;
    fontSize: number;
    initialCommand: string;
    lineHeight?: number;
    macOptionIsMeta?: boolean;
    pasteWithCtrlV: boolean;
    screenReaderMode: boolean;
    scrollback?: number;
    shutdownOnClose: boolean;
    theme: Theme;
}

Properties

autoFit? closeOnExit cursorBlink fontFamily? fontSize initialCommand lineHeight? macOptionIsMeta? pasteWithCtrlV screenReaderMode scrollback? shutdownOnClose theme

Properties

Optional autoFit

autoFit?: boolean

Whether to auto-fit the terminal to its host element size.

closeOnExit

closeOnExit: boolean

Whether to close the widget when exiting a terminal or not.

cursorBlink

cursorBlink: boolean

Whether to blink the cursor. Can only be set at startup.

Optional fontFamily

fontFamily?: string

The font family used to render text.

fontSize

fontSize: number

The font size of the terminal in pixels.

initialCommand

initialCommand: string

An optional command to run when the session starts.

Optional lineHeight

lineHeight?: number

The line height used to render text.

Optional macOptionIsMeta

macOptionIsMeta?: boolean

Treat option as meta key on macOS.

pasteWithCtrlV

pasteWithCtrlV: boolean

Whether to enable using Ctrl+V to paste.

This setting has no effect on macOS, where Cmd+V is available.

screenReaderMode

screenReaderMode: boolean

Whether to enable screen reader support.

Optional scrollback

scrollback?: number

The amount of buffer scrollback to be used with the terminal

shutdownOnClose

shutdownOnClose: boolean

Whether to shut down the session when closing a terminal or not.

theme

theme: Theme

The theme of the terminal.

Settings

Member Visibility

Theme

On This Page

autoFitcloseOnExitcursorBlinkfontFamilyfontSizeinitialCommandlineHeightmacOptionIsMetapasteWithCtrlVscreenReaderModescrollbackshutdownOnClosetheme