Add support for switching the scheme based on the app's theme

[bennettnicholas]

Summary of the Pull Request

This pull request solved the problem of users not being able to set color schemes specifically for dark or light mode. Now the code has been updated to accept a dark and light color scheme in the json. The old setting is still compatible. Keep in mind if you update your color scheme through the settings UI, it will set both dark and light to the color scheme selected. This is because the settings UI update for selecting both Dark and Light color schemes is not supported yet.

This also solves the problem of the UI not using the system OS theme. Now you can select system theme and your color scheme will be selected based on if the system theme is dark or light.

References

#4066

PR Checklist

• Closes Theme-controlled color scheme switch #4066
• Closes SettingsModelLocalTests failures are on the rise #14050
• CLA signed. If not, go over here and sign the CLA.
• Tests added/passed I believe so, added one test to ColorSchemeTests.cpp and I believe it passed. Also had to modify TerminalSettingsTests.cpp to accept the new ApplyAppearanceSettings function template
• Documentation updated. If checked, please file a pull request on our docs repo and link it here: #xxx
• Schema updated.
• I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: Theme-controlled color scheme switch #4066 and also teams messages with @carlos-zamora

Detailed Description of the Pull Request / Additional comments

-Removed ColorSchemeName from MTSMSettings.h in order to process the setting for both string and object.
-Added DarkColorSchemeName and LightColorSchemeName properties to the AppearanceConfig to replace ColorSchemeName.
-Hacked a few processes to play nice with all 3 properties listed above as in some cases around the UI, we need to still use the ColorSchemeName. Once we change the UI I believe we can go back to just Dark and LightColorSchemeName
-Added and Updated Test to align to the new code.

Acceptable Json values,

"colorScheme":
{
"dark": "Campbell",
"light": "Campbell"
}
or

"colorScheme": "Campbell"

Validation Steps Performed

Individual testing along with the test case added.

[carlos-zamora]

Hi @bennettnicholas,

Chatted with the team today. Here's some notes from our discussion:

• don't worry about the color scheme not changing when you update the OS theme. We can throw that in a follow-up.
  • FYI: Feature Request: Terminal should listen for the WM_SETTINGCHANGE for environment variable updates #1125 would probably work. It's WM_SETTINGCHANGE should tell us when a setting changes and which one.
• Settings UI:
  • I'm ok with this being another case (like window padding) where we don't overwrite the setting if the user didn't change it. It's not great at all, but it should suffice until we get the new one designed (others may disagree here, so we'll leave that up for discussion when they review this PR). Just make sure we track this in Epic: Settings UI v2 #10000.

[carlos-zamora]

@bennettnicholas FYI found this this (sometimes) breaks color schemes: #14174

Please take a look when you get the chance. 😊

[bennettnicholas]

@carlos-zamora The bug has been identified and fixed. Along with another bug was discovered. Thanks for catching the bug. Let me know if I need to document the bug / fix

[lhecker]

Looks pretty good to me! Just a few comments/questions...

[bennettnicholas]

Looks pretty good to me! Just a few comments/questions...

@lhecker sorry for the delay, been fairly busy. I was able to incorporate most of the comments. The biggest thing around some of the logic in the code is because we are hacking the backend together until we update the UI. Once the UI is updated, a lot of this logic can be dropped. In many cases we have to process the color scheme name differently depending on if it's coming from the JSON or the UI. Please take a look at some of the changes and let me know what you think.

[carlos-zamora]

• please update the schema
• please update the docs
• We shouldn't need ColorSchemeName in the settings model anymore. We should only need the light/dark variants. Upon loading the JSON, if we encounter "colorScheme": "<name>", we should copy that name into both variants. We'll probably need special handling in Profile.cpp::LayerJson to accomplish this.
• I think you need to modify MTSMSettings.h more. This is where we do the magic of defining a new setting "once" and it goes basically everywhere in the settings model (removes the need to implement a lot of boiler plate code)
• update TerminalSettingsEditor. Specifically, the UI shouldn't change, but the text passed in should directly set the dark/light variant. Urgh, this still puts us in the situation of us not being sure which one to display depending on the theme. I say, look at the theme for the settings model that is in use, and display the relevant color scheme name. It's a bit weird, but I think that's a good intermediate step. CC @DHowett

[carlos-zamora]

Awesome. Thanks @zadjii-msft and @bennettnicholas!

[carlos-zamora]

@zadjii-msft don't forget to document this plz

[ghost]

Hello @carlos-zamora!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

[ghost]

🎉Windows Terminal Preview v1.17.1023 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes
• Store Download

[MatejKafka]

Is there a way to use a dark theme, but still switch the color scheme of a profile based on the system-wide theme? The dark theme is more readable for me, but I like to have the color scheme follow the system, since that affects a much larger area of the UI.

[zadjii-msft]

yes and no.

You could do something like

    "theme": { "dark": "my light", "light": "dark" },
    "themes":
    [
        {
            "name": "my light",
            "tab":
            {
                "background": "terminalBackground",
                "unfocusedBackground": "#00000000"
            },
            "tabRow":
            {
                "background": "#2e2e2e",
                "unfocusedBackground": "#333333FF"
            },
            "window":
            {
                "applicationTheme": "light"
            }
        },

so that the tabs were dark, even if the rest of the UI was light. The applicationTheme being light would them let the scheme pick the light value.

---

But more completely - trying to support that scenario (dark UI, OS-following color scheme) proved a bit to confusing for the settings to support, hence the current approach. (as discussed around #4066 (comment))