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

    Interface TaskTerminalWidget

    Terminal UI widget.

    interface TaskTerminalWidget {
        buffer: TerminalBuffer;
        busy?: boolean;
        dedicated?: boolean;
        dimensions: TerminalDimensions;
        envVarCollectionDescriptionsByExtension: Promise<
            Map<string, (undefined | string | MarkdownString)[]>,
        >;
        exitStatus: undefined | TerminalExitStatus;
        hiddenFromUser: boolean;
        kind: "task";
        lastCwd: URI;
        location: TerminalLocationOptions;
        node: HTMLElement;
        onData: Event<string>;
        onDidChangeVisibility: Event<boolean>;
        onDidChangeVisibilityEmitter: Emitter<boolean>;
        onDidDispose: Event<void>;
        onDidDisposeEmitter: Emitter<void>;
        onDidOpen: Event<void>;
        onDidOpenFailure: Event<void>;
        onKey: Event<{ domEvent: KeyboardEvent; key: string }>;
        onOutput: Event<string>;
        onScrollUp: Event<void>;
        onScrollUpEmitter: Emitter<void>;
        onScrollYReachEnd: Event<void>;
        onScrollYReachEndEmitter: Emitter<void>;
        onShellTypeChanged: Event<string>;
        onSizeChanged: Event<{ cols: number; rows: number }>;
        onTerminalDidClose: Event<TerminalWidget>;
        processId: Promise<number>;
        processInfo: Promise<TerminalProcessInfo>;
        scrollBar?: PerfectScrollbar;
        scrollOptions?: Options;
        taskConfig?: TaskConfiguration;
        taskId?: number;
        terminalId: number;
        toDispose: DisposableCollection;
        toDisposeOnDetach: DisposableCollection;
        get dataset(): DOMStringMap;
        get disposed(): ISignal<this, void>;
        get hiddenMode(): HiddenMode;
        set hiddenMode(value: HiddenMode): void;
        get id(): string;
        set id(value: string): void;
        get isAttached(): boolean;
        get isDisposed(): boolean;
        get isHidden(): boolean;
        get isVisible(): boolean;
        get layout(): null | Layout;
        set layout(value: null | Layout): void;
        get parent(): null | Widget;
        set parent(value: null | Widget): void;
        get title(): Title<Widget>;
        activate(): void;
        addClass(name: string): void;
        addClipboardListener<K extends "copy" | "cut" | "paste">(
            element: HTMLElement,
            type: K,
            listener: EventListenerOrEventListenerObject<K>,
        ): void;
        addEventListener<K extends keyof HTMLElementEventMap>(
            element: HTMLElement,
            type: K,
            listener: EventListenerOrEventListenerObject<K>,
            useCapture?: boolean,
        ): void;
        addKeyListener<K extends keyof HTMLElementEventMap = never>(
            element: HTMLElement,
            keysOrKeyCodes: KeyCode.Predicate | KeysOrKeyCodes,
            action: EventHandler<"keydown" | K>,
            ...additionalEventTypes: K[],
        ): void;
        addUpdateListener<K extends keyof HTMLElementEventMap>(
            element: HTMLElement,
            type: K,
            useCapture?: boolean,
        ): void;
        children(): IterableIterator<Widget>;
        clearFlag(flag: Flag): void;
        clearOutput(): void;
        close(): void;
        contains(widget: Widget): boolean;
        disableScrollBarFocus(scrollContainer: HTMLElement): void;
        dispose(): void;
        executeCommand(commandOptions: CommandLineOptions): Promise<void>;
        fit(): void;
        getPreviewNode(): undefined | Node;
        getScrollContainer(): MaybePromise<HTMLElement>;
        getSearchBox(): TerminalSearchWidget;
        handleVisiblityChanged(isNowVisible: boolean): void;
        hasChildProcesses(): Promise<boolean>;
        hasClass(name: string): boolean;
        hide(): void;
        notifyLayout(msg: Message): void;
        onActivateRequest(msg: Message): void;
        onAfterAttach(msg: Message): void;
        onAfterDetach(msg: Message): void;
        onAfterHide(msg: Message): void;
        onAfterShow(msg: Message): void;
        onBeforeAttach(msg: Message): void;
        onBeforeDetach(msg: Message): void;
        onBeforeHide(msg: Message): void;
        onBeforeShow(msg: Message): void;
        onChildAdded(msg: ChildMessage): void;
        onChildRemoved(msg: ChildMessage): void;
        onCloseRequest(msg: Message): void;
        onFitRequest(msg: Message): void;
        onResize(msg: Widget.ResizeMessage): void;
        onUpdateRequest(msg: Message): void;
        processMessage(msg: Message): void;
        removeClass(name: string): void;
        resetTerminal(): void;
        resize(cols: number, rows: number): void;
        scrollLineDown(): void;
        scrollLineUp(): void;
        scrollPageDown(): void;
        scrollPageUp(): void;
        scrollToBottom(): void;
        scrollToTop(): void;
        selectAll(): void;
        sendText(text: string): void;
        setFlag(flag: Flag): void;
        setHidden(hidden: boolean): void;
        setTitle(title: string): void;
        show(): void;
        start(id?: number): Promise<number>;
        testFlag(flag: Flag): boolean;
        toggleClass(name: string, force?: boolean): boolean;
        update(): void;
        waitOnExit(waitOnExit?: string | boolean): void;
        write(data: string): void;
        writeLine(line: string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    buffer busy? dedicated? dimensions envVarCollectionDescriptionsByExtension exitStatus hiddenFromUser kind lastCwd location node onData onDidChangeVisibility onDidChangeVisibilityEmitter onDidDispose onDidDisposeEmitter onDidOpen onDidOpenFailure onKey onOutput onScrollUp onScrollUpEmitter onScrollYReachEnd onScrollYReachEndEmitter onShellTypeChanged onSizeChanged onTerminalDidClose processId processInfo scrollBar? scrollOptions? taskConfig? taskId? terminalId toDispose toDisposeOnDetach

    Accessors

    dataset disposed hiddenMode id isAttached isDisposed isHidden isVisible layout parent title

    Methods

    activate addClass addClipboardListener addEventListener addKeyListener addUpdateListener children clearFlag clearOutput close contains disableScrollBarFocus dispose executeCommand fit getPreviewNode getScrollContainer getSearchBox handleVisiblityChanged hasChildProcesses hasClass hide notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onFitRequest onResize onUpdateRequest processMessage removeClass resetTerminal resize scrollLineDown scrollLineUp scrollPageDown scrollPageUp scrollToBottom scrollToTop selectAll sendText setFlag setHidden setTitle show start testFlag toggleClass update waitOnExit write writeLine

    Properties

    buffer: TerminalBuffer
    busy?: boolean
    dedicated?: boolean
    dimensions: TerminalDimensions
    envVarCollectionDescriptionsByExtension: Promise<
        Map<string, (undefined | string | MarkdownString)[]>,
    >

    The ids of extensions contributing to the environment of this terminal mapped to the provided description for their changes.

    exitStatus: undefined | TerminalExitStatus
    hiddenFromUser: boolean

    Terminal widget can be hidden from users until explicitly shown once.

    kind: "task"

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

    lastCwd: URI

    The last CWD assigned to the terminal, useful when attempting getCwdURI on a task terminal fails

    location: TerminalLocationOptions

    The position of the terminal widget.

    node: HTMLElement

    Get the DOM node owned by the widget.

    onData: Event<string>

    Event that fires when the terminal input data

    onDidChangeVisibility: Event<boolean>
    onDidChangeVisibilityEmitter: Emitter<boolean>
    onDidDispose: Event<void>
    onDidDisposeEmitter: Emitter<void>
    onDidOpen: Event<void>

    Event that fires when the terminal is connected or reconnected

    onDidOpenFailure: Event<void>

    Event that fires when the terminal fails to connect or reconnect

    onKey: Event<{ domEvent: KeyboardEvent; key: string }>

    Event that fires when the terminal receives a key event.

    onOutput: Event<string>
    onScrollUp: Event<void>
    onScrollUpEmitter: Emitter<void>
    onScrollYReachEnd: Event<void>
    onScrollYReachEndEmitter: Emitter<void>
    onShellTypeChanged: Event<string>

    Event that fires when the terminal shell type is changed

    onSizeChanged: Event<{ cols: number; rows: number }>

    Event that fires when the terminal size changed

    onTerminalDidClose: Event<TerminalWidget>

    Event which fires when terminal did closed. Event value contains closed terminal widget definition.

    processId: Promise<number>
    processInfo: Promise<TerminalProcessInfo>

    Get the current executable and arguments.

    scrollBar?: PerfectScrollbar
    scrollOptions?: Options
    taskConfig?: TaskConfiguration
    taskId?: number
    terminalId: number
    toDispose: DisposableCollection
    toDisposeOnDetach: DisposableCollection

    Accessors

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

    • get disposed(): ISignal<this, void>

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get hiddenMode(): HiddenMode

      Get the method for hiding the widget.

      Returns HiddenMode

    • set hiddenMode(value: HiddenMode): void

      Set the method for hiding the widget.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): void

      Set the id of the widget's DOM node.

      Parameters

      • value: string

      Returns void

    • get isAttached(): boolean

      Test whether the widget's node is attached to the DOM.

      Returns boolean

    • get isDisposed(): boolean

      Test whether the widget has been disposed.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      Returns boolean

    • get isVisible(): boolean

      Test whether the widget is visible.

      A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

    • set layout(value: null | Layout): void

      Set the layout for the widget.

      The layout is single-use only. It cannot be changed after the first assignment.

      The layout is disposed automatically when the widget is disposed.

      Parameters

      Returns void

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

    • set parent(value: null | Widget): void

      Set the parent of the widget.

      Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

      The widget will be automatically removed from its old parent.

      This is a no-op if there is no effective parent change.

      Parameters

      Returns void

    • get title(): Title<Widget>

      The title object for the widget.

      The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

      Since not all widgets will use the title, it is created on demand.

      The owner property of the title is set to this widget.

      Returns Title<Widget>

    Methods

    • Post an 'activate-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Add a class name to the widget's DOM node.

      Parameters

      • name: string

        The class name to add to the node.

        If the class name is already added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • element: HTMLElement
      • type: K
      • OptionaluseCapture: boolean

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      A new iterator over the children of the widget.

      The widget must have a populated layout in order to have children.

      If a layout is not installed, the returned iterator will be empty.

    • Clear the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Cleat terminal output.

      Returns void

    • Send a 'close-request' message to the widget.

      This is a simple convenience method for sending the message.

      Returns void

    • Test whether a widget is a descendant of this widget.

      Parameters

      • widget: Widget

        The descendant widget of interest.

      Returns boolean

      true if the widget is a descendant, false otherwise.

    • Parameters

      • scrollContainer: HTMLElement

      Returns void

    • Dispose of the widget and its descendant widgets.

      It is unsafe to use the widget after it has been disposed.

      All calls made to this method after the first are a no-op.

      Returns void

    • Resolves when the command is successfully sent, this doesn't mean that it was evaluated. Might reject if terminal wasn't properly started yet.

      Note that this method will try to escape your arguments as if it was someone inputting everything in a shell.

      Supported shells: bash, cmd.exe, wsl.exe, pwsh/powershell.exe

      Parameters

      Returns Promise<void>

    • Post a 'fit-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Returns undefined | Node

    • Parameters

      • isNowVisible: boolean

      Returns void

    • Whether the terminal process has child processes.

      Returns Promise<boolean>

    • Test whether the widget's DOM node has the given class name.

      Parameters

      • name: string

        The class name of interest.

      Returns boolean

      true if the node has the class, false otherwise.

    • Hide the widget and make it hidden to its parent widget.

      This causes the isHidden property to be true.

      If the widget is explicitly hidden, this is a no-op.

      Returns void

    • Invoke the message processing routine of the widget's layout.

      Parameters

      • msg: Message

        The message to dispatch to the layout.

        This is a no-op if the widget does not have a layout.

        This will not typically be called directly by user code.

      Returns void

    • A message handler invoked on an 'activate-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-attach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-detach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-hide' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-show' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-attach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-detach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-hide' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-show' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'child-added' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'child-removed' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'close-request' message.

      The default implementation unparents or detaches the widget.

      Parameters

      Returns void

    • A message handler invoked on a 'fit-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'update-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • Process a message sent to the widget.

      Parameters

      • msg: Message

        The message sent to the widget.

        Subclasses may reimplement this method as needed.

      Returns void

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        The class name to remove from the node.

        If the class name is not yet added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Returns void

    • Parameters

      • cols: number
      • rows: number

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Select entire content in the terminal.

      Returns void

    • Send text to the terminal server.

      Parameters

      • text: string

        text content.

      Returns void

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Parameters

      Returns void

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

        true to hide the widget, or false to show it.

        This is a convenience method for hide() and show().

      Returns void

    • Parameters

      • title: string

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

      If the widget is not explicitly hidden, this is a no-op.

      Returns void

    • Start terminal and return terminal id.

      Parameters

      • Optionalid: number

        terminal id.

      Returns Promise<number>

    • Test whether the given widget flag is set.

      This will not typically be called directly by user code.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

      • Optionalforce: boolean

        Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

      Returns boolean

      true if the class is now present, false otherwise.

      The class name must not contain whitespace.

    • Post an 'update-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Parameters

      • OptionalwaitOnExit: string | boolean

      Returns void

    • Parameters

      • data: string

      Returns void

    • Parameters

      • line: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods
    activateaddClassaddClipboardListeneraddEventListeneraddKeyListeneraddUpdateListenerchildrenclearFlagclearOutputclosecontainsdisableScrollBarFocusdisposeexecuteCommandfitgetPreviewNodegetScrollContainergetSearchBoxhandleVisiblityChangedhasChildProcesseshasClasshidenotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonFitRequestonResizeonUpdateRequestprocessMessageremoveClassresetTerminalresizescrollLineDownscrollLineUpscrollPageDownscrollPageUpscrollToBottomscrollToTopselectAllsendTextsetFlagsetHiddensetTitleshowstarttestFlagtoggleClassupdatewaitOnExitwritewriteLine