Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/katsutedev/background

The most advanced background image extension for VSCode
https://github.com/katsutedev/background

background background-image backgrounds extension ide-theme nodejs theme ts typescript visual-studio-code visual-studio-code-extension visual-studio-code-theme vscode vscode-background vscode-extension vscode-theme

Last synced: 3 months ago
JSON representation

The most advanced background image extension for VSCode

Host: GitHub
URL: https://github.com/katsutedev/background
Owner: KatsuteDev
License: gpl-2.0
Created: 2022-06-22T17:40:10.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-04-22T10:41:53.000Z (10 months ago)
Last Synced: 2024-04-22T11:49:00.923Z (10 months ago)
Topics: background, background-image, backgrounds, extension, ide-theme, nodejs, theme, ts, typescript, visual-studio-code, visual-studio-code-extension, visual-studio-code-theme, vscode, vscode-background, vscode-extension, vscode-theme
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=katsute.code-background
Size: 87.9 MB
Stars: 54
Watchers: 1
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        


    


    

        

    

    Background

    The most advanced background image extension for VSCode

    

    

    






Add multiple background images for the window, editors, sidebars, or the panel. Load backgrounds from file, [glob](https://github.com/isaacs/node-glob#glob-primer), or URL. Transition between multiple background images.



    



## Installation

 - Install from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=katsute.code-background).

 - Install directly from VSCode using the id [`katsute.code-background`](https://marketplace.visualstudio.com/items?itemName=katsute.code-background).

#### Usage

 1. Type `Background: Configuration` in the command pallette or press the **Background** tab in the statusbar.

 2. Select where you want to add a background (Window, Editor, Sidebar, Panel).

 3. Add backgrounds and change how it should be displayed.

 4. Use `Background: Install` or press the install button.

## Features

#### Multiple Backgrounds

Add background images for the whole window, editors, sidebars, or the panel. Transition between multiple background images.



    Full Window

    

    


    Editor, Sidebar, and Terminal

    

    


    Slideshow

    



#### Configuration Menu

Type `Background: Configuration` in the command pallette or press the **Background** tab in the statusbar to access the configuration menu.



    



#### Glob, URL, and Environment Variable Support

Add background images by file, folder, [glob](https://github.com/isaacs/node-glob#glob-primer), or URL.

> ⚠️ **Use only `/` for directories**

>

> [node-glob](https://github.com/isaacs/node-glob#windows) only accepts `/` as path separators, `\` is reserved for escape characters.



    



▲


## Commands

| Command | Description |

|---|---|

|`Background: Install`|Installs and enables the background.|

|`Background: Uninstall`|Uninstalls and disables the background.|

|`Background: Reload`|Randomizes the backgrounds. Background must already be installed.|

|`Background: Configuration`|Opens the configuration menu.|

|`Background: Changelog`|Opens changelog.|

▲


## Configuration

Use the `Background: Configuration` command to access the configuration menu.

Background properties are saved as arrays so you can have different options for different UI elements.

The order settings are saved in is:

 0. Window

 1. Editor

 2. Sidebar

 3. Panel

| Background | Type | Description |

|---|:-:|---|

|`background.windowBackgrounds`|`string[]`|The list of files or globs to use for the window background image.|

|`background.editorBackgrounds`|`string[]`|The list of files or globs to use for editor background images.|

|`background.sidebarBackgrounds`|`string[]`|The list of files or globs to use for the sidebar background images.|

|`background.panelBackgrounds`|`string[]`|The list of files or globs to use for the panel background image.|




| Property | Type | Description |

|---|:-:|---|

|`background.backgroundAlignment`|`enum[4]`|The alignment of the background image.|

|`background.backgroundAlignmentValue`|`string[4]`|If the background image alignment is set to `Manual`, this is the literal value for the `background-position` css property. Only accepts a [css \](https://developer.mozilla.org/en-US/docs/Web/CSS/position_value).|

|`background.backgroundBlur`|`string[4]`|Background image blur. Only accepts a [css \](https://developer.mozilla.org/en-US/docs/Web/CSS/length).|

|`background.backgroundOpacity`|`number[4]`|The UI opacity. 1 is fully visible and 0 is invisible.|

|`background.backgroundRepeat`|`enum[4]`|The background image repeat.|

|`background.backgroundSize`|`enum[4]`|The background image size.|

|`background.backgroundSizeValue`|`string[4]`|If the background image size is set to `Manual`, this is the literal value for the `background-size` css property. Only accepts a [css \](https://developer.mozilla.org/en-US/docs/Web/CSS/position_value).|

|`background.backgroundChangeTime`|`number[4]`|How long in seconds before the background should automatically change. Set to 0 to always use the same image.|




| Advanced | Type | Description |

|---|:-:|---|

|`background.autoInstall`|`boolean`|Automatically installs backgrounds and reloads the window on startup if changes are detected or VSCode updates.
This option is disabled when you run the uninstall command.|

|`background.renderContentAboveBackground`|`boolean`|Render content like images, PDFs, and markdown previews above the background.|

|`background.useInvertedOpacity`|`boolean`|Use an inverted opacity, so 0 is fully visible and 1 is invisible.|

|`background.smoothImageRendering`|`boolean`|Use smooth image rendering rather than pixelated rendering when resizing images.|

|`background.settingScope`|`Global` \| `Workspace`|Where to save background settings. This does not automatically update the background on workspace change, you need to also turn on `autoInstall`.|

|`background.CSS`|`string`|Apply raw CSS to VSCode.|

▲


## Environment Variables

| Variable | Description |

|---|---|

|`${vscode:workspace}`|Current VSCode project folder|

|`${user:home}`|Current user's home directory|

|`${...}`|System environment variable|

▲


## API

Add this extension to your `package.json`.

```json

{

    ...

    "extensionDependencies": [

        "katsute.code-background"

    ]

    ...

}

```

Access the api by using:

```js

const background = vscode.extensions.getExtension("katsute.code-background").exports;

```

 * `install(): void`

   Runs the `Background: Install` command.

 * `uninstall(): void`

   Runs the `Background: Uninstall` command.

 * `reload(): void`

   Runs the `Background: Reload` command.

 * `get(ui): string[]?`

   * `ui` : Background to get from; either `window`, `editor`, `sidebar`, `panel`.

   Returns an array of globs for the specified background.

 * `add(ui, glob): Promise`

   * `ui` : Background to add to; either `window`, `editor`, `sidebar`, `panel`.

   * `glob`: Glob to add.

   Returns true if successful.

 * `replace(ui, old, glob): Promise`

   * `ui` : Background to replace from; either `window`, `editor`, `sidebar`, `panel`.

   * `old`: Glob to replace.

   * `glob`: Updated glob.

   Returns true if successful.

 * `remove(ui, glob): Promise`

   * `ui` : Background to remove from; either `window`, `editor`, `sidebar`, `panel`.

   * `glob`: Glob to remove.

   Returns true if successful.

▲


##  

This extension is released under the [GNU General Public License (GPL) v2.0](https://github.com/KatsuteDev/Background/blob/main/LICENSE).