Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseTerminalTabComponent<P>

A class to base your custom terminal tabs on

Type Parameters

Hierarchy

Implements

  • OnInit
  • OnDestroy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected activity

activity: BehaviorSubject<boolean>

alternateScreenActive

alternateScreenActive: boolean = false

Protected app

app: AppService

Private bellPlayer

bellPlayer: HTMLAudioElement

Protected binaryOutput

binaryOutput: Subject<Buffer> = ...

config

config: ConfigService

Protected contextMenuProviders

contextMenuProviders: TabContextMenuItemProvider[]

customTitle

customTitle: string

User-defined title override

Protected decorators

decorators: TerminalDecorator[] = []

disableDynamicTitle

disableDynamicTitle: boolean = false

Disables display of dynamic window/tab title provided by the shell

element

element: ElementRef<any>

enablePassthrough

enablePassthrough: boolean = true

Enables normal passthrough from session output to terminal input

Optional frontend

frontend?: Frontend

frontendReady

frontendReady: Subject<void> = ...

Private frontendWriteLock

frontendWriteLock: Promise<void> = ...

hasActivity

hasActivity: boolean

Last tab activity state

hasFocus

hasFocus: boolean

Protected hostApp

hostApp: HostAppService

hostView

hostView: ViewRef

ViewRef to the tab DOM element

Protected hostWindow

hostWindow: HostWindowService

Protected hotkeys

hotkeys: HotkeysService

Protected injector

injector: Injector

Protected log

log: LogService

Protected logger

logger: Logger

Protected multifocus

multifocus: MultifocusService

Protected notifications

notifications: NotificationsService

Protected output

output: Subject<string> = ...

parent

parent: null | BaseTabComponent

Parent tab (usually a SplitTabComponent)

Protected platform

platform: PlatformService

profile

profile: P

Protected progress

progress: BehaviorSubject<null | number>

Protected recentInputs

recentInputs: string = ''

Protected recoveryStateChangedHint

recoveryStateChangedHint: Subject<void>

Ping this if your recovery state has been changed and you want your tab state to be saved sooner

Private rightMouseDownTime

rightMouseDownTime: number = 0

Optional savedState

savedState?: any

savedStateIsLive

savedStateIsLive: boolean = false

Optional searchPanel

searchPanel?: SearchPanelComponent

session

session: null | BaseSession = null

Protected sessionChanged

sessionChanged: Subject<null | BaseSession> = ...

Private sessionHandlers

sessionHandlers: SubscriptionContainer = ...

showSearchPanel

showSearchPanel: boolean = false

size

size: ResizeEvent

Private spinner

spinner: any = ...

Private spinnerActive

spinnerActive: boolean = false

Private spinnerPaused

spinnerPaused: boolean = false

Private termContainerSubscriptions

termContainerSubscriptions: SubscriptionContainer = ...

Protected themes

themes: ThemesService

title

title: string

Current tab title

Private toolbarRevealTimeout

toolbarRevealTimeout: ResettableTimeout = ...

Protected translate

translate: TranslateService

Protected Optional viewContainer

viewContainer?: ViewContainerRef

Optional viewContainerEmbeddedRef

viewContainerEmbeddedRef?: EmbeddedViewRef<any>

Protected visibility

visibility: BehaviorSubject<boolean>

Protected zone

zone: NgZone

zoom

zoom: number = 0

Static animations

animations: AnimationTriggerMetadata[] = ...

Static styles

styles: string[] = ...

Static template

template: string = ...

Accessors

activity$

  • get activity$(): Observable<boolean>

  • Returns Observable<boolean>

alternateScreenActive$

  • get alternateScreenActive$(): Observable<boolean>

binaryOutput$

  • get binaryOutput$(): Observable<Buffer>

blurred$

  • get blurred$(): Observable<void>

  • Returns Observable<void>

color

  • get color(): null | string
  • set color(value: null | string): void

  • CSS color override for the tab's header

    Returns null | string

  • CSS color override for the tab's header

    Parameters

    • value: null | string

    Returns void

destroyed$

  • get destroyed$(): Observable<void>

  • Returns Observable<void>

focused$

  • get focused$(): Observable<void>

  • Returns Observable<void>

frontendReady$

  • get frontendReady$(): Observable<void>

hasTitleInset

  • get hasTitleInset(): boolean

icon

  • get icon(): null | string
  • set icon(value: null | string): void

  • icon override for the tab's header

    Returns null | string

  • icon override for the tab's header

    Parameters

    • value: null | string

    Returns void

input$

  • get input$(): Observable<Buffer>

output$

  • get output$(): Observable<string>

progress$

  • get progress$(): Observable<null | number>

  • Returns Observable<null | number>

recoveryStateChangedHint$

  • get recoveryStateChangedHint$(): Observable<void>

  • Returns Observable<void>

resize$

sessionChanged$

titleChange$

  • get titleChange$(): Observable<string>

  • Returns Observable<string>

topmostParent

  • get topmostParent(): null | BaseTabComponent

  • Returns null | BaseTabComponent

visibility$

  • get visibility$(): Observable<boolean>

  • Returns Observable<boolean>

Methods

addEventListenerUntilDestroyed

  • addEventListenerUntilDestroyed(element: HTMLElement, event: string, handler: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

  • Parameters

    • element: HTMLElement
    • event: string
    • handler: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

Protected attachSessionHandler

  • attachSessionHandler<T>(observable: Observable<T>, handler: ((v: T) => void)): void

Protected attachSessionHandlers

  • attachSessionHandlers(destroyOnSessionClose?: boolean): void

Protected attachTermContainerHandlers

  • attachTermContainerHandlers(): void

buildContextMenu

  • buildContextMenu(): Promise<MenuItemOptions[]>

canClose

  • canClose(): Promise<boolean>

  • Return false to prevent the tab from being closed

    Returns Promise<boolean>

clearActivity

  • clearActivity(): void

  • Removes the activity marker from the tab header

    Returns void

configure

  • configure(): void

copyCurrentPath

  • copyCurrentPath(): Promise<void>

destroy

  • destroy(): Promise<void>

Protected detachSessionHandlers

  • detachSessionHandlers(): void

Protected detachTermContainerHandlers

  • detachTermContainerHandlers(): void

displayActivity

  • displayActivity(): void

  • Shows the activity marker on the tab header

    Returns void

emitBlurred

  • emitBlurred(): void

  • Returns void

emitFocused

  • emitFocused(): void

  • Returns void

emitVisibility

  • emitVisibility(visibility: boolean): void

  • Parameters

    • visibility: boolean

    Returns void

Protected forEachFocusedTerminalPane

getCurrentProcess

  • getCurrentProcess(): Promise<null | BaseTabProcess>

  • Override this to enable task completion notifications for the tab

    Returns Promise<null | BaseTabProcess>

getRecoveryToken

  • getRecoveryToken(options?: GetRecoveryTokenOptions): Promise<null | RecoveryToken>

  • Override this and implement a [[TabRecoveryProvider]] to enable recovery for your custom tab

    Parameters

    • Optional options: GetRecoveryTokenOptions

    Returns Promise<null | RecoveryToken>

    JSON serializable tab state representation for your [[TabRecoveryProvider]] to parse

Protected handleRightMouseDown

  • handleRightMouseDown(event: MouseEvent): Promise<void>

Protected handleRightMouseUp

  • handleRightMouseUp(event: MouseEvent): Promise<void>

hideToolbar

  • hideToolbar(): void

insertIntoContainer

  • insertIntoContainer(container: ViewContainerRef): EmbeddedViewRef<any>

  • Parameters

    • container: ViewContainerRef

    Returns EmbeddedViewRef<any>

Protected isSessionExplicitlyTerminated

  • isSessionExplicitlyTerminated(): boolean

Protected onFrontendReady

  • onFrontendReady(): void

Protected onSessionClosed

  • onSessionClosed(destroyOnSessionClose?: boolean): void

Protected onSessionDestroyed

  • onSessionDestroyed(): void

paste

  • paste(): Promise<void>

removeFromContainer

  • removeFromContainer(): void

  • Returns void

resetZoom

  • resetZoom(): void

sendInput

  • sendInput(data: string | Buffer): void

setProgress

  • setProgress(progress: null | number): void

  • Sets visual progressbar on the tab

    Parameters

    • progress: null | number

    Returns void

setSession

  • setSession(session: null | BaseSession, destroyOnSessionClose?: boolean): void

setTitle

  • setTitle(title: string): void

  • Parameters

    • title: string

    Returns void

Protected shouldTabBeDestroyedOnSessionClose

  • shouldTabBeDestroyedOnSessionClose(): boolean

showToolbar

  • showToolbar(): void

Protected startSpinner

  • startSpinner(text?: string): void

Protected stopSpinner

  • stopSpinner(): void

subscribeUntilDestroyed

  • subscribeUntilDestroyed<T>(observable: Observable<T>, handler: ((v: T) => void)): void

  • Type Parameters

    • T

    Parameters

    • observable: Observable<T>
    • handler: ((v: T) => void)
        • (v: T): void

        • Parameters

          • v: T

          Returns void

    Returns void

togglePinToolbar

  • togglePinToolbar(): void

Protected withSpinnerPaused

  • withSpinnerPaused(work: (() => any)): Promise<void>

write

  • write(data: string): Promise<void>

Protected writeRaw

  • writeRaw(data: string): Promise<void>

zoomIn

  • zoomIn(): void

zoomOut

  • zoomOut(): void

Generated using TypeDoc