Theia API Documentation v1.65.0
    Preparing search index...

    Interface TerminalWidgetFactoryOptions

    interface TerminalWidgetFactoryOptions {
        attributes?: { [key: string]: null | string };
        created: string;
        cwd?: string | URI;
        destroyTermOnClose?: boolean;
        env?: { [key: string]: null | string };
        hideFromUser?: boolean;
        iconClass?: string | ThemeIcon;
        id?: string;
        isPseudoTerminal?: boolean;
        isTransient?: boolean;
        kind?: string;
        location?: TerminalLocationOptions;
        shellArgs?: string | string[];
        shellIntegrationNonce?: string;
        shellPath?: string;
        strictEnv?: boolean;
        title?: string;
        useServerTitle?: boolean;
    }

    Hierarchy

    Index

    Properties

    attributes? created cwd? destroyTermOnClose? env? hideFromUser? iconClass? id? isPseudoTerminal? isTransient? kind? location? shellArgs? shellIntegrationNonce? shellPath? strictEnv? title? useServerTitle?

    Properties

    attributes?: { [key: string]: null | string }

    Terminal attributes. Can be useful to apply some implementation specific information.

    created: string

    a unique string per terminal

    cwd?: string | URI

    Current working directory.

    destroyTermOnClose?: boolean

    In case destroyTermOnClose is true - terminal process will be destroyed on close terminal widget, otherwise will be kept alive.

    env?: { [key: string]: null | string }

    Environment variables for terminal.

    hideFromUser?: boolean

    When enabled the terminal will run the process as normal but not be surfaced to the user until Terminal.show is called.

    iconClass?: string | ThemeIcon

    icon class with or without color modifier

    id?: string

    Terminal id. Should be unique for all DOM.

    isPseudoTerminal?: boolean

    Whether it is a pseudo terminal where an extension controls its input and output.

    isTransient?: boolean

    When enabled, the terminal will not be persisted across window reloads.

    kind?: string

    Terminal kind that indicates whether a terminal is created by a user or by some extension for a user

    location?: TerminalLocationOptions
    shellArgs?: string | string[]

    Args for the custom shell executable. A string can be used on Windows only which allows specifying shell args in command-line format.

    shellIntegrationNonce?: string

    The nonce to use to verify shell integration sequences are coming from a trusted source. An example impact of UX of this is if the command line is reported with a nonce, it will not need to verify with the user that the command line is correct before rerunning it via the shell integration command decoration.

    This should be used if the terminal includes custom shell integration support. It should be set to a random GUID which will then set the VSCODE_NONCE environment variable. Inside the shell, this should then be removed from the environment so as to protect it from general access. Once that is done it can be passed through in the relevant sequences to make them trusted.

    shellPath?: string

    Path to the executable shell. For example: /bin/bash, bash, sh.

    strictEnv?: boolean

    Whether the terminal process environment should be exactly as provided in env.

    title?: string

    Human readable terminal representation on the UI.

    useServerTitle?: boolean

    Terminal server side can send to the client terminal title to display this value on the UI. If useServerTitle = true then display this title, otherwise display title defined by 'title' argument.

    Settings

    Member Visibility

    On This Page

    Properties