English | 中文 | 日本語 | Portugues

vscode-background

Bring background images to your Visual Studio Code

fullscreen、editor、sidebar、panel、carousel、custom images/styles...

GitHub | Visual Studio Marketplace

Multiple sections, editor、sidebar、panel

fullscreen

Installation

There are 2 ways to install this extension:

Install from Visual Studio Marketplace.
Search shalldie.background from vscode.

Custom

User defined requirements can be met by changing the configuration(settings.json).

what's settings.json | where is

Config

Global Config

Name	Type	Default	Description
`background.enabled`	`Boolean`	`true`	Whether to enable background extension.

Editor Section Config

Edit background.editor to config editor section.

Name	Type	Default	Description
`useFront`	`boolean`	`true`	Place the image above or below the code.
`style`	`object`	`{}`	Custom style for images.
`styles`	`object[]`	`[{},{},{}]`	Each style of editor section image.
`images`	`string[]`	`[]`	Your custom images, support `https` and `file` protocol.
`interval`	`number`	`0`	Seconds of interval for carousel, default `0` to disabled.
`random`	`boolean`	`false`	Whether to randomly display images.

style means css style, which allows you to create great-looking background.

example:

{
  "background.editor": {
    "useFront": true,
    "style": {
      "background-position": "100% 100%",
      "background-size": "auto",
      "opacity": 1
    },
    "styles": [{}, {}, {}],
    // Local images can be dragged into the browser to quickly get the file protocol address from the address bar
    "images": ["https://pathtoimage.png", "file:///path/to/local/file"],
    "interval": 0,
    "random": false
  }
}

Fullscreen、Sidebar、Panel Section Config

Edit background.fullscreen、background.sidebar、background.panel to config these sections.

Name	Type	Default	Description
`images`	`string[]`	`[]`	Your custom images, support `https` and `file` protocol.
`opacity`	`number`	`0.91`、`0.2`	Opacity of the image, `0.85 ~ 0.95` recommended if fullscreen，others `0.1 ~ 0.3`.
`size`	`string`	`cover`	Alias to `background-size`, `cover` to self-adaption (recommended)，or `contain`、`200px 200px`.
`position`	`string`	`center`	Alias to `background-position`, default `center`.
`interval`	`number`	`0`	Seconds of interval for carousel, default `0` to disabled.
`random`	`boolean`	`false`	Whether to randomly display images.

example：

{
  "background.fullscreen": {
    // Local images can be dragged into the browser to quickly get the file protocol address from the address bar
    "images": ["https://pathtoimage.png", "file:///path/to/local/file"],
    "opacity": 0.91,
    "size": "cover",
    "position": "center",
    "interval": 0,
    "random": false
  },
  // `sidebar` and `panel` have the same config as `fullscreen`
  "background.sidebar": {},
  "background.panel": {}
}