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

[PR #10972] Persist window layout on window close #28342

New Issue
Open
opened 2026-01-31 09:27:54 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:27:54 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/microsoft/terminal/pull/10972

State: closed
Merged: Yes

This commit adds initial support for saving window layout on application
close.

Done:

  • Add user setting for if tabs should be maintained.
  • Added events to track the number of open windows for the monarch, and
    then save if you are the last window closing.
  • Saves layout when the user explicitly hits the "Close Window" button.
  • If the user manually closed all of their tabs (through the tab x
    button or through closing all panes on the tab) then remove any saved
    state.
  • Saves in the ApplicationState file a list of actions the terminal can
    perform to restore its layout and the window size/position
    information.
  • This saves an action to focus the correct pane, but this won't
    actually work without #10978. Note that if you have a pane zoomed, it
    does still zoom the correct pane, but when you unzoom it will have a
    different pane selected.

Todo:

  • multiple windows? Right now it can only handle loading/saving one
    window.
    • PR #11083 will save multiple windows.
  • This also sometimes runs into the existing bug where multiple tabs
    appear to be focused on opening.

Next Steps:

  • The business logic of when the save is triggered can be adjusted as
    necessary.
  • Right now I am taking the pragmatic approach and just saving the state
    as an array of objects, but only ever populate it with 1, that way
    saving multiple windows in the future could be added without breaking
    schema compatibility. Selfishly I'm hoping that handling multiple
    windows could be spun off into another pr/feature for now.
  • One possible thing that can maybe be done is that the commandline can
    be augmented with a "--saved ##" attribute that would load from the
    nth saved state if it exists. e.g. if there are 3 saved windows, on
    first load it can spawn three wt --saved {0,1,2} that would reopen the
    windows? This way there also exists a way to load a copy of a previous
    window (if it is in the saved state).
  • Is the application state something that is planned to be public/user
    editable? In theory the user could since it is just json, but I don't
    know what it buys them over just modifying their settings and
    startupActions.

Validation Steps Performed:

  • The happy path: open terminal -> set setting to true -> close terminal
    -> reopen and see tabs. Tested with powershell/cmd/wsl windows.
  • That closing all panes/tabs on their own will remove the saved
    session.
  • Open multiple windows, close windows and confirm that the last window
    closed saves its state.

The generated file stores a sequence of actions that will be executed to
restore the terminal to its saved form.

References #8324
This is also one of the items on microsoft/terminal#5000
Closes #766

**Original Pull Request:** https://github.com/microsoft/terminal/pull/10972 **State:** closed **Merged:** Yes --- This commit adds initial support for saving window layout on application close. Done: - Add user setting for if tabs should be maintained. - Added events to track the number of open windows for the monarch, and then save if you are the last window closing. - Saves layout when the user explicitly hits the "Close Window" button. - If the user manually closed all of their tabs (through the tab x button or through closing all panes on the tab) then remove any saved state. - Saves in the ApplicationState file a list of actions the terminal can perform to restore its layout and the window size/position information. - This saves an action to focus the correct pane, but this won't actually work without #10978. Note that if you have a pane zoomed, it does still zoom the correct pane, but when you unzoom it will have a different pane selected. Todo: - multiple windows? Right now it can only handle loading/saving one window. - PR #11083 will save multiple windows. - This also sometimes runs into the existing bug where multiple tabs appear to be focused on opening. Next Steps: - The business logic of when the save is triggered can be adjusted as necessary. - Right now I am taking the pragmatic approach and just saving the state as an array of objects, but only ever populate it with 1, that way saving multiple windows in the future could be added without breaking schema compatibility. Selfishly I'm hoping that handling multiple windows could be spun off into another pr/feature for now. - One possible thing that can maybe be done is that the commandline can be augmented with a "--saved ##" attribute that would load from the nth saved state if it exists. e.g. if there are 3 saved windows, on first load it can spawn three wt --saved {0,1,2} that would reopen the windows? This way there also exists a way to load a copy of a previous window (if it is in the saved state). - Is the application state something that is planned to be public/user editable? In theory the user could since it is just json, but I don't know what it buys them over just modifying their settings and startupActions. Validation Steps Performed: - The happy path: open terminal -> set setting to true -> close terminal -> reopen and see tabs. Tested with powershell/cmd/wsl windows. - That closing all panes/tabs on their own will remove the saved session. - Open multiple windows, close windows and confirm that the last window closed saves its state. The generated file stores a sequence of actions that will be executed to restore the terminal to its saved form. References #8324 This is also one of the items on microsoft/terminal#5000 Closes #766
claunia added the pull-request label 2026-01-31 09:27:54 +00:00
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 pull-request
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#28342
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?