starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Apply MVVM Pattern to Settings UI #12640

New Issue
Closed
opened 2026-01-31 03:20:54 +00:00 by claunia · 2 comments
claunia commented 2026-01-31 03:20:54 +00:00
Owner
Copy Link

Originally created by @carlos-zamora on GitHub (Feb 18, 2021).

The Settings UI is currently directly bound to the settings model. Unfortunately, this forces us to run into a few issues every now and then:

  • polluting the settings model with more XAML dependencies
  • inability to check if a value truly changed

The Model-View-ViewModel Design Pattern was designed to keep the settings model and the settings UI pure simultaneously.

We've already started some of this work by introducing the ProfileViewModel. It serves as a middle-man between the UI controls and the settings model, and can be used to track extra information like "is this the base layer" and special values for settings (i.e. background image's use desktop wallpaper, etc.).

We need to apply this design pattern to...

  • ColorSchemes
  • Global settings
  • CascadiaSettings

This allows for the following scenarios:

  • detect unsaved changes and display an appropriate warning label
  • only load font lists once, and share them across all ProfileViewModels and AppearanceViewModels
  • load the color schemes and be able to display a mini-grid of colors to display throughout the code (i.e. profile page)
  • load the key bindings upon initial SUI load asynchronously, then just pass that into the actions page for a huge performance boost
Originally created by @carlos-zamora on GitHub (Feb 18, 2021). The Settings UI is currently directly bound to the settings model. Unfortunately, this forces us to run into a few issues every now and then: - polluting the settings model with more XAML dependencies - inability to check if a value truly changed [The Model-View-ViewModel Design Pattern](https://docs.microsoft.com/en-us/archive/msdn-magazine/2009/february/patterns-wpf-apps-with-the-model-view-viewmodel-design-pattern#the-demo-application) was designed to keep the settings model and the settings UI pure simultaneously. We've already started some of this work by introducing the `ProfileViewModel`. It serves as a middle-man between the UI controls and the settings model, and can be used to track extra information like "is this the base layer" and special values for settings (i.e. background image's use desktop wallpaper, etc.). We need to apply this design pattern to... - ColorSchemes - Global settings - CascadiaSettings This allows for the following scenarios: - detect unsaved changes and display an appropriate warning label - only load font lists _once_, and share them across all `ProfileViewModel`s and `AppearanceViewModel`s - load the color schemes and be able to display a mini-grid of colors to display throughout the code (i.e. profile page) - load the key bindings upon initial SUI load asynchronously, then just pass that into the actions page for a huge performance boost
claunia added the Issue-FeatureNeeds-Tag-FixProduct-TerminalArea-SettingsUI labels 2026-01-31 03:20:55 +00:00
claunia commented 2026-01-31 03:20:56 +00:00
Author
Owner
Copy Link

@carlos-zamora commented on GitHub (Dec 15, 2021):

I should do this: https://github.com/microsoft/terminal/pull/11877#discussion_r765133799

(or really, anybody should haha. Doesn't have to be me :P)

@carlos-zamora commented on GitHub (Dec 15, 2021): I should do this: https://github.com/microsoft/terminal/pull/11877#discussion_r765133799 (or really, anybody should haha. Doesn't have to be me :P)
claunia commented 2026-01-31 03:20:56 +00:00
Author
Owner
Copy Link

@zadjii-msft commented on GitHub (Aug 25, 2022):

There was a long series of PRs for all the global settings pages, with which we can finally close this out. I think that landed broadly in 1.15 ish.

@zadjii-msft commented on GitHub (Aug 25, 2022): There was a long series of PRs for all the global settings pages, with which we can finally close this out. I think that landed broadly in 1.15 ish.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-SettingsUI Issue-Feature Needs-Tag-Fix Product-Terminal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#12640
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?