BaseTabComponent | tabby-core

Abstract base class for custom tab components

Hierarchy

BaseComponent
- BaseTabComponent
  - SplitTabComponent

Constructors

Protected constructor

new BaseTabComponent(injector: Injector): BaseTabComponent

Overrides BaseComponent.constructor
- Defined in tabby-core/src/components/baseTab.component.ts:97
Parameters
- injector: Injector
Returns BaseTabComponent

Properties

Private _color

_color: null | string = null

Private _destroyCalled

_destroyCalled: boolean = false

Private _icon

_icon: null | string = null

Protected activity

activity: BehaviorSubject<boolean> = ...

Private blurred

blurred: Subject<void> = ...

Protected config

config: ConfigService

customTitle

customTitle: string

User-defined title override

Private destroyed

destroyed: Subject<void> = ...

Private focused

focused: Subject<void> = ...

hasActivity

hasActivity: boolean = false

Last tab activity state

hasFocus

hasFocus: boolean = false

hostView

hostView: ViewRef

ViewRef to the tab DOM element

parent

parent: null | BaseTabComponent = null

Parent tab (usually a SplitTabComponent)

Protected progress

progress: BehaviorSubject<null | number> = ...

Protected recoveryStateChangedHint

recoveryStateChangedHint: Subject<void> = ...

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

title

title: string

Current tab title

Private titleChange

titleChange: Subject<string> = ...

Protected Optional viewContainer

viewContainer?: ViewContainerRef

Optional viewContainerEmbeddedRef

viewContainerEmbeddedRef?: EmbeddedViewRef<any>

Protected visibility

visibility: BehaviorSubject<boolean> = ...

Accessors

activity$

get activity$(): Observable<boolean>

- Defined in tabby-core/src/components/baseTab.component.ts:91
Returns Observable<boolean>

blurred$

get blurred$(): Observable<void>

- Defined in tabby-core/src/components/baseTab.component.ts:86
Returns Observable<void>

color

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

- Defined in tabby-core/src/components/baseTab.component.ts:52
CSS color override for the tab's header

Returns null | string
- Defined in tabby-core/src/components/baseTab.component.ts:53
CSS color override for the tab's header

Parameters
- value: null | string
Returns void

destroyed$

get destroyed$(): Observable<void>

Overrides BaseComponent.destroyed$
- Defined in tabby-core/src/components/baseTab.component.ts:92
Returns Observable<void>

focused$

get focused$(): Observable<void>

- Defined in tabby-core/src/components/baseTab.component.ts:85
Returns Observable<void>

icon

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

- Defined in tabby-core/src/components/baseTab.component.ts:59
icon override for the tab's header

Returns null | string
- Defined in tabby-core/src/components/baseTab.component.ts:60
icon override for the tab's header

Parameters
- value: null | string
Returns void

progress$

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

- Defined in tabby-core/src/components/baseTab.component.ts:90
Returns Observable<null | number>

recoveryStateChangedHint$

get recoveryStateChangedHint$(): Observable<void>

- Defined in tabby-core/src/components/baseTab.component.ts:93
Returns Observable<void>

titleChange$

get titleChange$(): Observable<string>

- Defined in tabby-core/src/components/baseTab.component.ts:89
Returns Observable<string>

topmostParent

get topmostParent(): null | BaseTabComponent

- Defined in tabby-core/src/components/baseTab.component.ts:206
Returns null | BaseTabComponent

visibility$

get visibility$(): Observable<boolean>

- Defined in tabby-core/src/components/baseTab.component.ts:88
Returns Observable<boolean>

Methods

addEventListenerUntilDestroyed

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

Inherited from BaseComponent.addEventListenerUntilDestroyed
- Defined in tabby-core/src/components/base.component.ts:49
Parameters
- element: HTMLElement
- event: string
- handler: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

canClose

canClose(): Promise<boolean>

- Defined in tabby-core/src/components/baseTab.component.ts:171
Return false to prevent the tab from being closed

Returns Promise<boolean>

clearActivity

clearActivity(): void

- Defined in tabby-core/src/components/baseTab.component.ts:143
Removes the activity marker from the tab header

Returns void

destroy

destroy(skipDestroyedEvent?: boolean): void

- Defined in tabby-core/src/components/baseTab.component.ts:217
Called before the tab is closed

Parameters
- skipDestroyedEvent: boolean = false
Returns void

displayActivity

displayActivity(): void

- Defined in tabby-core/src/components/baseTab.component.ts:133
Shows the activity marker on the tab header

Returns void

emitBlurred

emitBlurred(): void

- Defined in tabby-core/src/components/baseTab.component.ts:179
Returns void

emitFocused

emitFocused(): void

- Defined in tabby-core/src/components/baseTab.component.ts:175
Returns void

emitVisibility

emitVisibility(visibility: boolean): void

- Defined in tabby-core/src/components/baseTab.component.ts:184
Parameters
- visibility: boolean
Returns void

getCurrentProcess

getCurrentProcess(): Promise<null | BaseTabProcess>

- Defined in tabby-core/src/components/baseTab.component.ts:164
Override this to enable task completion notifications for the tab

Returns Promise<null | BaseTabProcess>

getRecoveryToken

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

- Defined in tabby-core/src/components/baseTab.component.ts:157
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

insertIntoContainer

insertIntoContainer(container: ViewContainerRef): EmbeddedViewRef<any>

- Defined in tabby-core/src/components/baseTab.component.ts:188
Parameters
- container: ViewContainerRef
Returns EmbeddedViewRef<any>

removeFromContainer

removeFromContainer(): void

- Defined in tabby-core/src/components/baseTab.component.ts:194
Returns void

setProgress

setProgress(progress: null | number): void

- Defined in tabby-core/src/components/baseTab.component.ts:126
Sets visual progressbar on the tab

Parameters
- progress: null | number
Returns void

setTitle

setTitle(title: string): void

- Defined in tabby-core/src/components/baseTab.component.ts:114
Parameters
- title: string
Returns void

subscribeUntilDestroyed

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

Inherited from BaseComponent.subscribeUntilDestroyed
- Defined in tabby-core/src/components/base.component.ts:53
Type Parameters
- T
Parameters
- observable: Observable<T>
- handler: ((v: T) => void)
  - - (v: T): void
    - Parameters
      - v: T
      Returns void
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

injector: Injector

Returns BaseTabComponent

Properties

Private _color

Private _destroyCalled

Private _icon

Protected activity

Private blurred

Protected config

customTitle

Private destroyed

Private focused

hasActivity

hasFocus

hostView

parent

Protected progress

Protected recoveryStateChangedHint

title

Private titleChange

Protected Optional viewContainer

Optional viewContainerEmbeddedRef

Protected visibility

Accessors

activity$

Returns Observable<boolean>

blurred$

Returns Observable<void>

color

Returns null | string

Parameters

value: null | string

Returns void

destroyed$

Returns Observable<void>

focused$

Returns Observable<void>

icon

Returns null | string

Parameters

value: null | string

Returns void

progress$

Returns Observable<null | number>

recoveryStateChangedHint$

Returns Observable<void>

titleChange$

Returns Observable<string>

topmostParent

Returns null | BaseTabComponent

visibility$

Returns Observable<boolean>

Methods

addEventListenerUntilDestroyed

Parameters

element: HTMLElement

event: string

handler: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

canClose

Returns Promise<boolean>

clearActivity

Returns void

destroy

Parameters

skipDestroyedEvent: boolean = false

Returns void

displayActivity

Returns void

emitBlurred