Class WebcatUI

Manages the UI for WEBCAT.

Hierarchy (View Summary)

BrowserChromeController
- WebcatUI

Index

Constructors

Methods

clearWarning getColorScheme getPageURL hideIcon loadPage setWarning showErrorIcon showErrorPage showIcon showOKIcon showWarningIcon

Constructors

constructor

new WebcatUI(
    db: Database,
    store: NamespacedKVStore,
    config: { iconPaths: PathTemplate; pagePaths: PathTemplate },
): WebcatUI
Parameters
- db: Database
  The database to load enrollments from.
- store: NamespacedKVStore
  The store to use for persistence.
- config: { iconPaths: PathTemplate; pagePaths: PathTemplate }
  - iconPaths: PathTemplate
    
    Template for icon paths.
  - pagePaths: PathTemplate
    
    Template for page paths.
Returns WebcatUI
Overrides BrowserChromeController.constructor
- Defined in webcat/ui.ts:30

Methods

clearWarning

clearWarning(id: string): Promise<void>
Clears a specific warning from the UI.
Parameters
- id: string
  The ID of the warning to clear.
Returns Promise<void>
- Defined in webcat/ui.ts:244

getColorScheme

getColorScheme(): "dark" | "light"
Determines the browser color scheme currently in use.

Returns "dark" | "light"
The current color scheme.
Inherited from BrowserChromeController.getColorScheme
- Defined in browser/chrome.ts:62

getPageURL

getPageURL(
    name: string,
    options?: {
        fragment?: string | URLSearchParams;
        query?: string | URLSearchParams;
    },
): string
Computes the URL of a named page.
Parameters
- name: string
  The name of the page.
- Optionaloptions: { fragment?: string | URLSearchParams; query?: string | URLSearchParams }
Returns string
The absolute URL of the page.
Inherited from BrowserChromeController.getPageURL
- Defined in browser/chrome.ts:76

hideIcon

hideIcon(tabId: number): Promise<void>
Hides the icon shown on a specific tab.
Parameters
- tabId: number
  The ID of the tab to hide the icon from.
Returns Promise<void>
Inherited from BrowserChromeController.hideIcon
- Defined in browser/chrome.ts:127

loadPage

loadPage(
    tabId: number,
    name: string,
    options?: {
        fragment?: string | URLSearchParams;
        query?: string | URLSearchParams;
        replace?: boolean;
    },
): Promise<void>
Loads a named page in the specified tab.
Parameters
- tabId: number
  The ID of the tab to load the page in.
- name: string
  The name of the page.
- Optionaloptions: {
      fragment?: string | URLSearchParams;
      query?: string | URLSearchParams;
      replace?: boolean;
  }
Returns Promise<void>
Inherited from BrowserChromeController.loadPage
- Defined in browser/chrome.ts:138

setWarning

setWarning(id: string, ...args: unknown[]): Promise<void>
Sets the message for the specified warning.
Parameters
- id: string
  The ID of the warning.
- ...args: unknown[]
  The arguments of the warning. Must be serializable as JSON.
Returns Promise<void>
- Defined in webcat/ui.ts:216

showErrorIcon

showErrorIcon(tabId: number): Promise<void>
Displays the error icon in the browser's URL bar.
Parameters
- tabId: number
  The ID of the tab to display the icon in.
Returns Promise<void>
- Defined in webcat/ui.ts:130

showErrorPage

showErrorPage(
    details: Stateful<RequestDetails>,
    error: WebcatError,
    replace?: boolean,
): Promise<void>
Loads the error page in the tab(s) indicated by details.
Parameters
- details: Stateful<RequestDetails>
  Details for the request that triggered the error.
- error: WebcatError
  The error information.
- replace: boolean = !details.state.isFrame
  true to replace the current history entry, false to add a new one.
Returns Promise<void>
- Defined in webcat/ui.ts:145

showIcon

showIcon(
    tabId: number,
    options?: {
        name?: string;
        popup?: {
            fragment?: string | URLSearchParams;
            name: string;
            query?: string | URLSearchParams;
        };
        title?: string;
    },
): Promise<void>
Displays the default WEBCAT icon in the browser's URL bar. If the UI has warnings, shows the warning icon instead.
Parameters
- tabId: number
  The ID of the tab to display the icon in.
- Optionaloptions: {
      name?: string;
      popup?: {
          fragment?: string | URLSearchParams;
          name: string;
          query?: string | URLSearchParams;
      };
      title?: string;
  }
  Icon options.
  - Optionalname?: string
    
    The name of the icon.
  - Optionalpopup?: {
        fragment?: string | URLSearchParams;
        name: string;
        query?: string | URLSearchParams;
    }
    
    The popup page to display on click.
  - Optionaltitle?: string
    
    The title displayed in the icon's tooltip.
Returns Promise<void>
Overrides BrowserChromeController.showIcon
- Defined in webcat/ui.ts:59

showOKIcon

showOKIcon(tabId: number, delegation?: string): Promise<void>
Displays the OK icon in the browser's URL bar. If the UI has warnings, shows the warning icon instead.
Parameters
- tabId: number
  The ID of the tab to display the icon in.
- Optionaldelegation: string
  Optional delegation information to include in the title text.
Returns Promise<void>
- Defined in webcat/ui.ts:102

showWarningIcon

showWarningIcon(tabId: number): Promise<void>
Displays the warning icon in the browser's URL bar. Clicking on the icon opens the popup with full warning info.
Parameters
- tabId: number
  The ID of the tab to display the icon in.
Returns Promise<void>
- Defined in webcat/ui.ts:78

Class WebcatUI

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

iconPaths: PathTemplate

pagePaths: PathTemplate

Returns WebcatUI

Methods

clearWarning

Parameters

Returns Promise<void>

getColorScheme

Returns "dark" | "light"

getPageURL

Parameters

Returns string

hideIcon

Parameters

Returns Promise<void>

loadPage

Parameters

Returns Promise<void>

setWarning

Parameters

Returns Promise<void>

showErrorIcon

Parameters

Returns Promise<void>

showErrorPage

Parameters

Returns Promise<void>

showIcon

Parameters

Optionalname?: string

Optionalpopup?: { fragment?: string | URLSearchParams; name: string; query?: string | URLSearchParams;}

Optionaltitle?: string

Returns Promise<void>

showOKIcon

Parameters

Returns Promise<void>

showWarningIcon

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`name?: string

`Optional`popup?: {
fragment?: string | URLSearchParams;
name: string;
query?: string | URLSearchParams;
}

`Optional`title?: string