unfocusedAppearance ignores backgroundImage set to null and continued to display image #16949

Open
opened 2026-01-31 05:28:11 +00:00 by claunia · 1 comment
Owner

Originally created by @doverton12 on GitHub (Mar 8, 2022).

Windows Terminal version

1.13.10395.0

Windows build number

10.0.22567.1

Other Software

No response

Steps to reproduce

It is possible to set in the UI, and via the settings XML, for there to be no background image when a terminal windows is unfocused using the example below:
"unfocusedAppearance":
{
"backgroundImage": null
}

Expected Behavior

The expected behaviour is that the background image will disappear when set to null or change image to a new image if a value is set

Actual Behavior

Actual behaviour is that the background image continues to be displayed if set to null, although a new image is displayed if a correct file location is set.

Originally created by @doverton12 on GitHub (Mar 8, 2022). ### Windows Terminal version 1.13.10395.0 ### Windows build number 10.0.22567.1 ### Other Software _No response_ ### Steps to reproduce It is possible to set in the UI, and via the settings XML, for there to be no background image when a terminal windows is unfocused using the example below: "unfocusedAppearance": { "backgroundImage": null } ### Expected Behavior The expected behaviour is that the background image will disappear when set to null or change image to a new image if a value is set ### Actual Behavior Actual behaviour is that the background image continues to be displayed if set to null, although a new image is displayed if a correct file location is set.
claunia added the Help WantedArea-SettingsIssue-BugProduct-TerminalPriority-2 labels 2026-01-31 05:28:11 +00:00
Author
Owner

@scottpickett commented on GitHub (Jan 17, 2025):

I'm also having this issue on an instance of Windows Terminal Version: 1.21.3231.0 on Windows 11.

null does not replace the current backgroundImage value when unfocusedAppearance is triggered.

Workaround Solution:

Add, or integrate, the following to settings.json:

"unfocusedAppearance": 
  {
    "backgroundImageOpacity": 0
  }

This worked for my implementation and allows my desired background and foreground values to display correctly when unfocusedAppearance is active.

Working example snippet:

            "unfocusedAppearance": 
            {
                "background": "#7F5501",
                "foreground": "#808000",
                "opacity": 100,
                "backgroundImage": null,
                "backgroundImageOpacity": 0
            }

Hope this helps!

@scottpickett commented on GitHub (Jan 17, 2025): I'm also having this issue on an instance of Windows Terminal Version: 1.21.3231.0 on Windows 11. `null` does not replace the current `backgroundImage` value when `unfocusedAppearance` is triggered. Workaround Solution: Add, or integrate, the following to `settings.json`: ``` "unfocusedAppearance": { "backgroundImageOpacity": 0 } ``` This worked for my implementation and allows my desired `background` and `foreground` values to display correctly when `unfocusedAppearance` is active. Working example snippet: ``` "unfocusedAppearance": { "background": "#7F5501", "foreground": "#808000", "opacity": 100, "backgroundImage": null, "backgroundImageOpacity": 0 } ``` Hope this helps!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#16949