Add Extensions page to Settings UI #18559

carlos-zamora · 2025-02-11T00:50:05Z

Summary of the Pull Request

Adds an Extensions page to the Settings UI. This lets you enable/disable extensions and see how they affect your settings (i.e. adding/modifying profiles and adding color schemes). This page is specifically designed for fragment extensions, but can be expanded on in the future as we develop a more advanced extensions model.

Detailed Description of the Pull Request / Additional comments

Settings Model changes:
- FragmentSettings represents a parsed json fragment extension.
- FragmentProfileEntry and FragmentColorSchemeEntry are used to track profiles and color schemes added/modified
Editor changes - view models:
- ExtensionsViewModel operates as the main view model for the page.
- FragmentProfileViewModel and FragmentColorSchemeViewModel are used to reference specific components of fragments. They also provide support for navigating to the linked profile or color scheme via the settings UI!
- ExtensionPackageViewModel is a VM for a group of extensions exposed by a single source. This is mainly needed because a single source can have multiple JSON fragments in it. This is used for the navigators on the main page. Can be extended to provide additional information (i.e. package logo, package name, etc.)
Editor changes - views:
- Extensions.xaml uses a lot of data templates. These are reused in ItemsControls to display extension components.

Follow-ups

Expose dynamic profile generators and allow management over them
Collect and display some package metadata (i.e. icon, package name, etc.) for fragment extensions added from an AppExtension
- include a deep link to the settings app so you can manage the package
Streamline a process for adding extensions from the new page

carlos-zamora · 2025-02-11T01:00:58Z

Remaining work

"TODO CARLOS" littered throughout code
Test stability (i.e. add/remove fragments, hide/remove components added by fragments, etc.)
Replace "Active Extensions" Expanders with Navigators. In sub pages, include same "Modified Profiles", "Added Profiles" and "Added Color Schemes" along with full JSON. Probably include other metadata (i.e. fragment path)
- That said, keep those sections in the initial page! It's nice to see a full overview of what was modified all on one page
~~Polish "disclaimer" at the top of extensions page~~
- ~~investigate adding more info on creating new fragments and ways to simplify that~~
- Skipped over this one. Wasn't sure exactly what we wanted, but it should be super easy to add in if desired

For any reviewers that come along, let me know what you think! 😊 What else would you like to see here?

carlos-zamora · 2025-02-19T20:30:12Z

Demo

carlos-zamora · 2025-02-19T20:32:08Z

src/cascadia/TerminalSettingsEditor/AddProfile.xaml

@@ -59,7 +59,7 @@
                                <IconSourceElement Grid.Column="0"
                                                   Width="16"
                                                   Height="16"
-                                                   IconSource="{x:Bind mtu:IconPathConverter.IconSourceWUX(Icon), Mode=OneTime}" />
+                                                   IconSource="{x:Bind mtu:IconPathConverter.IconSourceWUX(EvaluatedIcon), Mode=OneTime}" />


📝 Admittedly, a drive by. Happy to pull this out into a separate PR if desired.

carlos-zamora · 2025-02-19T20:33:43Z

src/cascadia/TerminalSettingsEditor/CommonResources.xaml

@@ -1199,7 +1199,7 @@
        <Setter Property="HorizontalAlignment" Value="Stretch" />
        <Setter Property="CornerRadius" Value="{ThemeResource ControlCornerRadius}" />
        <Setter Property="VerticalAlignment" Value="Stretch" />
-        <Setter Property="HorizontalContentAlignment" Value="Left" />
+        <Setter Property="HorizontalContentAlignment" Value="Stretch" />


📝 Had to update this style a bit to enable functionality for showing "Disabled" on the right side when an extension was disabled.

The way I made that work is that we have a 2-column grid. We need the grid to take up the entire horizontal content, so we need to set HorizontalContentAlignmen to stretch

carlos-zamora · 2025-02-19T20:38:44Z

src/cascadia/TerminalSettingsEditor/NewTabMenu.xaml

-            <!--  TODO CARLOS: Icon  -->
+            <!--  TODO GH #18281: Icon  -->


📝 This one's on me 😅

carlos-zamora · 2025-02-19T20:40:32Z

src/cascadia/TerminalSettingsEditor/SettingContainerStyle.xaml

@@ -227,6 +227,45 @@
        </Setter>
    </Style>

+    <!--  A basic setting container displaying immutable text as content  -->
+    <Style x:Key="SettingContainerWithTextContent"


📝 Used to display the Scope for an extension. Also allowed me to apply the SecondaryTextBlockStyle to the text shown on the right side (aka the value of Scope)

carlos-zamora · 2025-02-19T20:44:10Z

src/cascadia/TerminalSettingsModel/GlobalAppSettings.cpp

+    if (_DisabledProfileSources)
+    {
+        globals->_DisabledProfileSources = winrt::single_threaded_vector<hstring>();
+        for (const auto& src : *_DisabledProfileSources)
+        {
+            globals->_DisabledProfileSources->Append(src);
+        }
+    }


📝 Surprised we never copied these over! It's ok though! We didn't have a way for users to modify DisabledProfileSources via the SUI, so this never was a problem!

For cloning it you can use wil::to_vector: https://github.com/microsoft/wil/blob/1b9fd9d9482a16cd176fcdca8dd49c7fd3ee5fa0/include/wil/cppwinrt_helpers.h#L294-L311

carlos-zamora · 2025-02-19T20:52:19Z

src/cascadia/TerminalSettingsEditor/Extensions.cpp

+            for (const auto&& entry : fragExt.ModifiedProfilesView())
+            {
+                // Ensure entry successfully modifies a profile before creating and registering the object
+                if (const auto& deducedProfile = _settings.FindProfile(entry.ProfileGuid()))
+                {
+                    auto vm = winrt::make<FragmentProfileViewModel>(entry, fragExt, deducedProfile);
+                    currentProfilesModified.push_back(vm);
+                    if (extensionEnabled)
+                    {
+                        profilesModifiedTotal.push_back(vm);
+                    }
+                }
+            }
+
+            for (const auto&& entry : fragExt.NewProfilesView())
+            {
+                // Ensure entry successfully points to a profile before creating and registering the object.
+                // The profile may have been removed by the user.
+                if (const auto& deducedProfile = _settings.FindProfile(entry.ProfileGuid()))
+                {
+                    auto vm = winrt::make<FragmentProfileViewModel>(entry, fragExt, deducedProfile);
+                    currentProfilesAdded.push_back(vm);
+                    if (extensionEnabled)
+                    {
+                        profilesAddedTotal.push_back(vm);
+                    }
+                }
+            }
+
+            for (const auto&& entry : fragExt.ColorSchemesView())
+            {
+                for (const auto& schemeVM : _colorSchemesPageVM.AllColorSchemes())
+                {
+                    if (schemeVM.Name() == entry.ColorSchemeName())
+                    {
+                        auto vm = winrt::make<FragmentColorSchemeViewModel>(entry, fragExt, schemeVM);
+                        currentColorSchemesAdded.push_back(vm);
+                        if (extensionEnabled)
+                        {
+                            colorSchemesAddedTotal.push_back(vm);
+                        }
+                    }
+                }
+            }


I'm only displaying the ones that were added successfully and point to something that already exists.

Long-term, do we want to do more here? Perhaps show the ones that weren't added successfully? I'm just not sure what the next steps would be and how we would want to approach this issue.

carlos-zamora added 2 commits February 10, 2025 13:10

Add Extensions page to Settings UI

ffed695

rename some resources; remove some TODOs

4c6fabe

This comment was marked as outdated.

Sign in to view

carlos-zamora added 2 commits February 14, 2025 13:59

add nested page

b8d0f00

add nested page (part 2) + support for multiple json files

be99fdd

carlos-zamora marked this pull request as ready for review February 19, 2025 20:18

copy over DisabledProfileSources

cef8e02

carlos-zamora commented Feb 19, 2025

View reviewed changes

carlos-zamora added the zBugBash-Consider label Feb 19, 2025

carlos-zamora commented Feb 19, 2025

View reviewed changes

OmegaGateway333 approved these changes Feb 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Extensions page to Settings UI #18559

Add Extensions page to Settings UI #18559

carlos-zamora commented Feb 11, 2025 •

edited

Loading

This comment was marked as outdated.

carlos-zamora commented Feb 11, 2025 •

edited

Loading

carlos-zamora commented Feb 19, 2025

carlos-zamora Feb 19, 2025

carlos-zamora Feb 19, 2025

carlos-zamora Feb 19, 2025

carlos-zamora Feb 19, 2025

carlos-zamora Feb 19, 2025

lhecker Feb 19, 2025

carlos-zamora Feb 19, 2025

Add Extensions page to Settings UI #18559

Are you sure you want to change the base?

Add Extensions page to Settings UI #18559

Conversation

carlos-zamora commented Feb 11, 2025 • edited Loading

Summary of the Pull Request

Detailed Description of the Pull Request / Additional comments

Follow-ups

This comment was marked as outdated.

carlos-zamora commented Feb 11, 2025 • edited Loading

Remaining work

carlos-zamora commented Feb 19, 2025

Demo

carlos-zamora Feb 19, 2025

Choose a reason for hiding this comment

carlos-zamora Feb 19, 2025

Choose a reason for hiding this comment

carlos-zamora Feb 19, 2025

Choose a reason for hiding this comment

carlos-zamora Feb 19, 2025

Choose a reason for hiding this comment

carlos-zamora Feb 19, 2025

Choose a reason for hiding this comment

lhecker Feb 19, 2025

Choose a reason for hiding this comment

carlos-zamora Feb 19, 2025

Choose a reason for hiding this comment

carlos-zamora commented Feb 11, 2025 •

edited

Loading

carlos-zamora commented Feb 11, 2025 •

edited

Loading