Skip to main content

Interface: AppTheme

Defined in: lib/AppTheme.ts:20

Headlamp App Theme definition

Properties​

background?​

optional background?: object;

Defined in: lib/AppTheme.ts:36

default?​

optional default?: string;

Background color of the page

muted?​

optional muted?: string;

Shaded background color

surface?​

optional surface?: string;

Background color of popups and menus

base?​

optional base?: "light" | "dark";

Defined in: lib/AppTheme.ts:23

Base theme to extend

buttonTextTransform?​

optional buttonTextTransform?: "none" | "uppercase";

Defined in: lib/AppTheme.ts:120

Text style in buttons

fontFamily?​

optional fontFamily?: string[];

Defined in: lib/AppTheme.ts:122

Font family of the app

optional link?: object;

Defined in: lib/AppTheme.ts:32

color?​

optional color?: string;

Link text color

name​

name: string;

Defined in: lib/AppTheme.ts:21

optional navbar?: object;

Defined in: lib/AppTheme.ts:56

background?​

optional background?: string;

Background color of the navbar

color?​

optional color?: string;

Text and icon color of the navbar

searchHint?​

optional searchHint?: string;

Global search shortcut hint (falls back in createMuiTheme if omitted)

primary?​

optional primary?: string;

Defined in: lib/AppTheme.ts:25

Primary theme color

radius?​

optional radius?: number;

Defined in: lib/AppTheme.ts:118

General shape radius (things like buttons, popups, etc)

secondary?​

optional secondary?: string;

Defined in: lib/AppTheme.ts:27

Secondary theme color

optional sidebar?: object;

Defined in: lib/AppTheme.ts:44

actionBackground?​

optional actionBackground?: string;

Background color of sidebar action button

background?​

optional background?: string;

Background color of the sidebar

color?​

optional color?: string;

Text and icon color of the sidebar

selectedBackground?​

optional selectedBackground?: string;

Background color for the selected item

selectedColor?​

optional selectedColor?: string;

Text color for the selected item

terminal?​

optional terminal?: object;

Defined in: lib/AppTheme.ts:85

Optional terminal (xterm.js) color overrides.

The pod log viewer, pod exec terminal and node shell all render with xterm.js. By default Headlamp picks readable colors out of the surrounding MUI palette and an auto-selected ANSI palette. Plugins that swap the rest of the palette can also set specific terminal colors here without having to call any extra function.

Anything left undefined is filled in by Headlamp:

  • background falls back to the MUI muted/default surface,
  • foreground and cursor fall back to the MUI primary text color,
  • each missing ansi.* entry is taken from a built-in 16-color palette auto-selected (and contrast-clamped) for the actual terminal background luminance, so light-on-light or dark-on-dark output is never invisible.

Tip: plugin authors should make sure foreground keeps a 4.5:1 contrast ratio against background (WCAG 2.1 AA), so that the terminal stays readable.

ansi?​

optional ansi?: object;

16-color ANSI palette used by program output. Each entry is optional; any color that's left out is filled from a built-in palette auto-selected for the terminal background's luminance, then nudged darker/lighter as needed so it stays visible against that background.

ansi.black?​
optional black?: string;
ansi.blue?​
optional blue?: string;
ansi.brightBlack?​
optional brightBlack?: string;
ansi.brightBlue?​
optional brightBlue?: string;
ansi.brightCyan?​
optional brightCyan?: string;
ansi.brightGreen?​
optional brightGreen?: string;
ansi.brightMagenta?​
optional brightMagenta?: string;
ansi.brightRed?​
optional brightRed?: string;
ansi.brightWhite?​
optional brightWhite?: string;
ansi.brightYellow?​
optional brightYellow?: string;
ansi.cyan?​
optional cyan?: string;
ansi.green?​
optional green?: string;
ansi.magenta?​
optional magenta?: string;
ansi.red?​
optional red?: string;
ansi.white?​
optional white?: string;
ansi.yellow?​
optional yellow?: string;

background?​

optional background?: string;

Background color of the terminal/log viewer area.

cursor?​

optional cursor?: string;

Cursor color.

foreground?​

optional foreground?: string;

Default foreground (text) color of the terminal.

text?​

optional text?: object;

Defined in: lib/AppTheme.ts:28

primary?​

optional primary?: string;

Primary text color