Xterm.js: How to set background color on terminal

[zwhitchcox]

I set the background terminal color with

term._core.renderer.colorManager.colors.background = {
  css: "#fdf6e3",
  rgba: "rgb(253, 246, 227)",
}

Just wanted to share my solution and immediately close this in case anyone else was having the same problem

[zwhitchcox]

Also, I don't think gitter is a viable solution, because other people can't learn from that

[mofux]

This is not really the recommended way of defining the colors 😀You can pass a theme object with colors in the Terminal constructor options, e.g.:

const term = new Terminal({
  theme: {
    background: '#fdf6e3'
  }
});

You can also update the theme colors at runtime:

term.setOption('theme', {
    background: '#fdf6e3'
});

Note 1: If you don't define a theme value, we will use the default fallback value for it.
Note 2: If you want a transparent background, you also have to specify the allowTransparency option.

For a list of available theme colors, check this out:
https://xtermjs.org/docs/api/terminal/interfaces/itheme/

[zwhitchcox]

Well, don't I feel silly

[mofux]

I would blame our docs, they are not really helpful in explaining the options available 😅