domain/tabs/tab-service

Classes

TabService

Defined in: app/src/domain/tabs/tab-service.ts:96

Owns the tabs of one window: their order, the active tab and recently closed tabs. A window always keeps at least one tab.

Implements

Disposable

Constructors

Constructor

new TabService(views, blankUrl, onLastClosed?): TabService

Defined in: app/src/domain/tabs/tab-service.ts:117

Parameters

views

TabViewPort

Creates and controls the web views.

blankUrl

string

URL of a new, empty tab.

onLastClosed?

() => void

Called instead of opening a new tab when the last tab closes.

Returns

TabService

Properties

onDidChange

readonly onDidChange: Event<void>

Defined in: app/src/domain/tabs/tab-service.ts:110

Fires after any tab or the active tab changed.

Accessors

active

Get Signature

get active(): Tab | undefined

Defined in: app/src/domain/tabs/tab-service.ts:129

The active tab, if any.

Returns

Tab | undefined

all

Get Signature

get all(): readonly Tab[]

Defined in: app/src/domain/tabs/tab-service.ts:124

All tabs in display order.

Returns

readonly Tab[]

Methods

activate()

activate(id): void

Defined in: app/src/domain/tabs/tab-service.ts:170

Makes a tab the active tab.

Parameters

id

string

The tab.

Returns

void

close()

close(id): void

Defined in: app/src/domain/tabs/tab-service.ts:185

Closes a tab. Closing the active tab activates its right neighbour, or the left one at the end. Closing the last tab opens a blank tab.

Parameters

id

string

The tab.

Returns

void

dispose()

dispose(): void

Defined in: app/src/domain/tabs/tab-service.ts:263

Destroys every view and removes listeners.

Returns

void

Implementation of

Disposable.dispose

navigate()

navigate(id, url): void

Defined in: app/src/domain/tabs/tab-service.ts:227

Loads a URL in a tab.

Parameters

id

string

The tab.

url

string

The URL.

Returns

void

open()

open(url?, options?): string

Defined in: app/src/domain/tabs/tab-service.ts:140

Opens a tab after the active one, or in the background after the tabs opened there before it, as Chromium does.

Parameters

url?

string = ...

URL to load; defaults to the blank page.

options?

OpenTabOptions = {}

Whether to activate the tab.

Returns

string

The new tab’s id.

reopenClosed()

reopenClosed(): string | undefined

Defined in: app/src/domain/tabs/tab-service.ts:217

Reopens the most recently closed tab.

Returns

string | undefined

The reopened tab’s id, or undefined if nothing was closed.

run()

run(id, action): void

Defined in: app/src/domain/tabs/tab-service.ts:237

Runs a history or loading action in a tab.

Parameters

id

string

The tab.

action

"back" | "forward" | "reload" | "stop"

What to do.

Returns

void

update()

update(id, update): void

Defined in: app/src/domain/tabs/tab-service.ts:247

Applies state reported by the web view, such as a new title.

Parameters

id

string

The tab.

update

TabUpdate

Changed fields.

Returns

void

Interfaces

OpenTabOptions

Defined in: app/src/domain/tabs/tab-service.ts:61

Options for TabService.open.

Properties

activate?

readonly optional activate?: boolean

Defined in: app/src/domain/tabs/tab-service.ts:67

Whether the new tab becomes the active tab. Defaults to true. Tabs opened in the background line up after the active tab in the order they open, until another tab becomes active, so links opened one after another keep their order.

lazy?

readonly optional lazy?: boolean

Defined in: app/src/domain/tabs/tab-service.ts:69

Creates the tab’s view only when the tab is shown.

title?

readonly optional title?: string

Defined in: app/src/domain/tabs/tab-service.ts:71

Title to show until the page reports its own, such as the title of a restored tab.

Tab

Defined in: app/src/domain/tabs/tab-service.ts:22

The state of one tab.

Properties

blocked

readonly blocked: number

Defined in: app/src/domain/tabs/tab-service.ts:30

Requests that the content blocker blocked on the current page.

canGoBack

readonly canGoBack: boolean

Defined in: app/src/domain/tabs/tab-service.ts:27

canGoForward

readonly canGoForward: boolean

Defined in: app/src/domain/tabs/tab-service.ts:28

id

readonly id: string

Defined in: app/src/domain/tabs/tab-service.ts:23

loading

readonly loading: boolean

Defined in: app/src/domain/tabs/tab-service.ts:26

problem

readonly problem: TabProblem | null

Defined in: app/src/domain/tabs/tab-service.ts:32

Why the tab shows no page, or null when it shows one.

title

readonly title: string

Defined in: app/src/domain/tabs/tab-service.ts:25

url

readonly url: string

Defined in: app/src/domain/tabs/tab-service.ts:24

zoom

readonly zoom: number

Defined in: app/src/domain/tabs/tab-service.ts:34

The zoom factor of the page, 1 for 100 %.

TabProblem

Defined in: app/src/domain/tabs/tab-service.ts:14

Why a tab shows no page: the page could not be loaded (error), the certificate of its site is not trusted (certificate), or the process that showed it is gone (crashed). code is Chromium’s name for the cause, such as ERR_CONNECTION_REFUSED, url the address of the page, and proceed whether the user may continue to it after a warning.