Interface TerminalCreationHandler

Optional Readonlypriority

onWillOpenTerminal

• onWillOpenTerminal(
      terminal: TerminalWidget,
      options?: WidgetOpenerOptions,
  ): MaybePromise<undefined | boolean>

  Called when a terminal is about to be placed in the shell. The handler may take ownership of the terminal (e.g. add it to a custom container) by returning true. In that case, the default shell placement will be skipped.

  Parameters

  • terminal: TerminalWidget

    The terminal widget to be placed.

  • Optionaloptions: WidgetOpenerOptions

    The opener options, if any.

  Returns MaybePromise<undefined | boolean>

  true if this handler claimed the terminal, false or undefined otherwise.