Scenario: Add support for panes #1000

zadjii-msft · 2019-05-24T19:02:15Z

This is the megathread for tracking all the work related to Panes in the Windows Terminal.

1.0 Features

1.x features / bugs

Allow the user's "open pane" bindings to open a pane with the current pane #1756 The user should be able to configure what profile is used for splitting a pane. Currently, the default profile is used, but it's possible a user might want to create a new pane with the parent pane's profile.
Panes should be resizable with the mouse #992 Panes should be resizable with the mouse. The user should be able to drag the separator for a pair of panes, and have the content between them resize as the separator moves.
Pane focus movement doesn't remember where it came from #4692 Pane focus movement doesn't remember where it came from

2.0 Features / Bugs

Panes Titlebar Follow-ups - See #4998

Add title to split window Add title to split window #4717
Allow moving panes to other tabs #7075 Allow moving panes to other tabs
Panes should have editable titles Panes should have editable titles #7290

Backlog items

Theming items

Add a setting to manually set the Pane highlight color #3061 Add a setting to manually set the Pane highlight color ~~(PR Enable changing the color of the active pane border #3752)~~
- Add configurable Pane border hover color Add configurable Pane border _hover_ color #8564
Add a setting to manually set the Pane border width #3063 Add a setting to manually set the Pane border width
Add option for more subtle pane focus border #3708 Add option for more subtle pane focus border

The text was updated successfully, but these errors were encountered:

* Start working on adding support for panes See #1000 for the panes megathread on remaining work. The functionality will be there, but the keybinding won't be there, so people have to opt-in to it.

DHowett-MSFT · 2019-06-08T00:07:58Z

We didn't commit the keybinding constants in with which people could opt. ☹️

decriptor · 2019-06-12T16:09:04Z

I noticed that @zadjii-msft added the keybindings for panes back. I'm assuming it made it into 0.1.1621.0?

If I add this block:

                "command" : "splitHorizontal",
                "keys" : 
                [
                    "ctrl+shift+-"
                ]
            },
            {
                "command" : "splitVertical",
                "keys" : 
                [
                    "ctrl+shift+|"
                ]
            },

Only Horizontal works. I noticed that if I close Windows Terminal it deletes the splitVertical keybinding from profiles.json.

zadjii-msft · 2019-06-12T16:11:21Z

@decriptor I believe that's because '|' isn't actually a key we support in the keybindings quite yet - see #1212

decriptor · 2019-06-12T16:13:48Z

@zadjii-msft I believe you are right. I used ctrl+1 as a test and it didn't remove it.

Jaykul · 2019-06-26T15:20:27Z

I know you really want it, @zadjii-msft but you have #998 on your list twice ;-)

zadjii-msft · 2019-07-01T14:11:39Z

@Jaykul good catch, those are supposed to be separate issues.

akulbe · 2019-07-03T17:15:34Z

@zadjii-msft and @Jaykul - just let me know where to send the care packages (hoppy beverages / candy / beef jerky / etc) 😆

Cannot wait for panes to be implemented!

Fumler · 2019-07-24T11:20:53Z

Any chance of getting "focus follows mouse" like in iterm2 and other terminals? So if this setting is turned on, the active pane would be the pane you have your mouse pointer over, without having to click it first.

Trolldemorted · 2020-11-11T00:55:39Z

I wrote a startup script which chains multiple split-pane commands, but it always splits one of the results of the last split:

Can I convice wt somehow to also split the left or top right pane? As you can see the resulting segmentation is neither ideal, nor what all users want.

If not, is there a feature request for that?

anthonyvdotbe · 2020-11-11T08:20:08Z

@Trolldemorted as is mentioned in the OP:

#4340 Choose Direction to Split Pane

Trolldemorted · 2020-11-11T09:07:37Z

#4340 would allow me to specify whether I want to split the right or left pane, but not to split both, right?

anthonyvdotbe · 2020-11-11T09:24:24Z

Ah yes. What about #3759?

Trolldemorted · 2020-11-11T10:32:07Z

Depending how they solve it it might partially cover that, but it won't cover the "commit a batch script in your repository which starts wt in a grid layout" use case, correct? Every user would have to create a profile manually, or we'd have to touch the users' profiles in our batch script.

zadjii-msft · 2020-11-11T12:09:57Z

So, #4340 "Choose Direction to Split Pane" might be helpful yes, but then you'll still get stuck splitting panes down just one branch of the tree.

What you really want is probably #6580, which will let you move-focus in the commandline, so you'll be able to navigate to other panes and split those.

Also maybe helpful in the future:

moveFocus to panel using number #5803 moveFocus to pane using number (See also Add support for focus-pane subcommand #5464)
- again, only useful once there's a move-focus command
  Feature Request: Add nextPane and prevPane keybindings #2871 Add nextPane and prevPane keybindings
- Same deal, you'd need nextPane & prevPane to be exposed as subcommands, not just actions

Trolldemorted · 2020-11-11T13:26:55Z

Thanks @zadjii-msft ! Let's hope #6580 will make it to the roadmap soon.

Can I specify an initial command for the shells somehow? Right now I am using -d . powershell.exe -NoExit -Command someshellcommand, but I am unable to rerun that command with arrow up + enter (it doesn't show up, only old commands from old shells are showing). Tried to do it with add-history, but without success.

@zadjii-msft

Adds a "move to previous pane" and "move to next pane" keybinding, which navigates to the last/first focused pane We assign pane IDs on creation and maintain a vector of active pane IDs in MRU order. Navigating panes by MRU then requires specifying which pane ID we want to focus. From our offline discussion (thanks @zadjii-msft for the concise description): > For the record, the full spec I'm imagining is: > > { command": { "action": "focus(Next|Prev)Pane", "order": "inOrder"|"mru", "useSwitcher": true|false } }, > > and order defaults to mru, and useSwitcher will default to true, when > there is a switcher. So > > { command": { "action": "focusNextPane" } }, > { command": { "action": "focusNextPane", "order": "mru" } }, > > these are the same action. (but right now we don't support the order > param) > > Then there'll be another PR for "focusPane(target=id)" > > Then a third PR for "focus(Next|Prev)Pane(order=inOrder)" > for the record, I prefer this approach over the "one action to rule > them all" version with both target and order/direction as params, > because I don't like the confusion of what happens if there's both > target and order/direction provided. References #1000 Closes #2871

@zadjii-msft

Adds a "move to previous pane" and "move to next pane" keybinding, which navigates to the last/first focused pane We assign pane IDs on creation and maintain a vector of active pane IDs in MRU order. Navigating panes by MRU then requires specifying which pane ID we want to focus. From our offline discussion (thanks @zadjii-msft for the concise description): > For the record, the full spec I'm imagining is: > > { command": { "action": "focus(Next|Prev)Pane", "order": "inOrder"|"mru", "useSwitcher": true|false } }, > > and order defaults to mru, and useSwitcher will default to true, when > there is a switcher. So > > { command": { "action": "focusNextPane" } }, > { command": { "action": "focusNextPane", "order": "mru" } }, > > these are the same action. (but right now we don't support the order > param) > > Then there'll be another PR for "focusPane(target=id)" > > Then a third PR for "focus(Next|Prev)Pane(order=inOrder)" > for the record, I prefer this approach over the "one action to rule > them all" version with both target and order/direction as params, > because I don't like the confusion of what happens if there's both > target and order/direction provided. References microsoft#1000 Closes microsoft#2871

JelteF · 2021-05-07T10:13:38Z

"#6459 Pane focus follows mouse" can be checked off the list, a fix for it has been merged a while back.

zadjii-msft · 2021-05-07T12:53:42Z

@JelteF Thanks! Cleaned that up a bit ☺️

diegopaludo · 2021-06-04T18:32:06Z

Hi,

There are option to move panes like tmux ?

…2) (#10638)  ## Summary of the Pull Request Add functionality to swap a pane with an adjacent (Up/Down/Left/Right) neighbor.  ## References This work potentially touches on: #1000 #2398 and #4922  ## PR Checklist * [x] Closes a component of #1000 (partially, comment), #4922 (partially, `SwapPanes` function is added but not hooked up, no detach functionality) * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [x] 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: #xxx  ## Detailed Description of the Pull Request / Additional comments Its been a while since I've written C++ code, and it is my first time working on a Windows application. I hope that I have not made too many mistakes. Work currently done: - Add boilerplate/infrastructure for argument parsing, hotkeys, event handling - Adds the `MovePane` function that finds the focused pane, and then tries to find a pane that is visually adjacent to according to direction. - First pass at the `SwapPanes` function that swaps the tree location of two panes - First working version of helpers `_FindFocusAndNeighbor` and `_FindNeighborFromFocus` that search the tree for the currently focused pane, and then climbs back up the tree to try to find a sibling pane that is adjacent to it. - An `_IsAdjacent' function that tests whether two panes, given their relative offsets, are adjacent to each other according to the direction. Next steps: - Once working these functions (`_FindFocusAndNeighbor`, etc) could be utilized to also solve #2398 by updating the `NavigateFocus` function. - Do we want default hotkeys for the new actions?  ## Validation Steps Performed At this point, compilation and manual testing of functionality (with hotkeys) by creating panes, adding distinguishers to each pane, and then swapping them around to confirm they went to the right location.

…2) (microsoft#10638)  ## Summary of the Pull Request Add functionality to swap a pane with an adjacent (Up/Down/Left/Right) neighbor.  ## References This work potentially touches on: microsoft#1000 microsoft#2398 and microsoft#4922  ## PR Checklist * [x] Closes a component of microsoft#1000 (partially, comment), microsoft#4922 (partially, `SwapPanes` function is added but not hooked up, no detach functionality) * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] Tests added/passed * [ ] Documentation updated. If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/terminal) and link it here: #xxx * [x] 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: #xxx  ## Detailed Description of the Pull Request / Additional comments Its been a while since I've written C++ code, and it is my first time working on a Windows application. I hope that I have not made too many mistakes. Work currently done: - Add boilerplate/infrastructure for argument parsing, hotkeys, event handling - Adds the `MovePane` function that finds the focused pane, and then tries to find a pane that is visually adjacent to according to direction. - First pass at the `SwapPanes` function that swaps the tree location of two panes - First working version of helpers `_FindFocusAndNeighbor` and `_FindNeighborFromFocus` that search the tree for the currently focused pane, and then climbs back up the tree to try to find a sibling pane that is adjacent to it. - An `_IsAdjacent' function that tests whether two panes, given their relative offsets, are adjacent to each other according to the direction. Next steps: - Once working these functions (`_FindFocusAndNeighbor`, etc) could be utilized to also solve microsoft#2398 by updating the `NavigateFocus` function. - Do we want default hotkeys for the new actions?  ## Validation Steps Performed At this point, compilation and manual testing of functionality (with hotkeys) by creating panes, adding distinguishers to each pane, and then swapping them around to confirm they went to the right location.

Instead of `Pane` hosting a `TermControl` directly, it now hosts an `IPaneContent`. This is an abstraction between the TermControl and the pane itself, to allow for arbitrary implementations of `IPaneContent`, with things that might not be terminals. ## References and Relevant Issues * #997 * #1000 ## Detailed Description of the Pull Request / Additional comments This PR by itself doesn't do much. It's just a refactoring. - It doesn't actually add any other types of pane content. - It overall just tries to move code whenever possible, with as little refactoring as possible. There are some patterns from before that don't super scale well to other types of pane content (think: the `xyzChanged` events on `IPaneContent`). - There's a few remaining places where Pane is explicitly checking if its content is a terminal. We probably shouldn't, but meh There are two follow-up PRs to this PR: * #16171 * #16172 In addition, there's more work to be done after these merge: * TODO! issue number for "Replace `IPaneContent::xyzChanged` with `PropertyChanged` events" * TODO! issue number for "Re-write state restoration so panes don't produce `NewTerminalArgs`" ## Validation Steps Performed * It still launches * It still works * Broadcasting still works * The weird restart connection thing from #16001 still works ## PR Checklist - [x] Closes #997 ## other PRs * #16170 <-- you are here * #16171 * #16172

zadjii-msft added the Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. label May 24, 2019

ghost added Needs-Tag-Fix Doesn't match tag requirements Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting labels May 24, 2019

zadjii-msft added Area-User Interface Issues pertaining to the user interface of the Console or Terminal Product-Terminal The new Windows Terminal. labels May 24, 2019

ghost removed the Needs-Tag-Fix Doesn't match tag requirements label May 24, 2019

zadjii-msft added this to the Terminal v1.0 milestone May 24, 2019

zadjii-msft mentioned this issue May 24, 2019

Add support for multiple panes in the same window #825

Merged

9 tasks

DHowett-MSFT removed Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting labels May 24, 2019

DHowett-MSFT added this to Spec In Review in Specification Tracker May 28, 2019

carlos-zamora mentioned this issue Jun 5, 2019

Feature Request: Add tab indicator to show number of panes in tab #1147

Open

zadjii-msft moved this from Spec In Review ⏰ to Spec Accepted! 🎉 in Specification Tracker Jun 7, 2019

zadjii-msft mentioned this issue Jun 9, 2019

Add the keybinding for panes back #1190

Merged

mdtauk mentioned this issue Jun 19, 2019

settings.json should provide tab color as part of a scheme and/or profile, with an optional way to introduce variant for multiple instances of the same profile #1337

Closed

This was referenced Jun 22, 2019

MEGA THREAD: Design still subject to change, UI is pretty okay though #1375

Closed

Feature Request: Grid system #1491

Closed

BartXZX mentioned this issue Jun 25, 2019

Feature Request: Vertical and horizontal splitting of terminal #1587

Closed

JushBJJ mentioned this issue Jun 25, 2019

Feature Request - Scripts Panel #1595

Closed

zadjii-msft mentioned this issue Jul 10, 2019

Add support for moving focus between panes with the keyboard #1910

Merged

1 task

DHowett-MSFT mentioned this issue Jul 14, 2019

Take the best from Gnome terminal and simple implement features in windows terminal. #1968

Closed

PankajBhojwani mentioned this issue Nov 6, 2020

Support for navigating panes by MRU #8183

Merged

zadjii-msft mentioned this issue Nov 18, 2020

Multiple tabs in the same view #8318

Closed

zadjii-msft mentioned this issue Dec 11, 2020

Golden Ratio mode #8562

Open

just1a-person mentioned this issue Dec 20, 2020

bug report srsly #1769

Closed

zadjii-msft mentioned this issue Feb 9, 2021

Add a percent parameter to SplitPane #3997

Closed

zadjii-msft removed this from the Terminal v2.0 milestone May 7, 2021

This was referenced Jun 4, 2021

Split Screen #10327

Closed

Add session concept to terminal like tmux #10331

Closed

Rosefield mentioned this issue Jul 12, 2021

Preliminary work to add Swap Panes functionality (GH Issues 1000, 4922) #10638

Merged

6 tasks

ghost added In-PR This issue has a related PR and removed In-PR This issue has a related PR labels Jul 12, 2021

zadjii-msft mentioned this issue Jul 15, 2021

The ability to toggle the split direction of a pane #10665

Closed

zadjii-msft added this to the Megathreads milestone Jan 4, 2022

zadjii-msft removed this from Spec Accepted! 🎉 in Specification Tracker Jun 9, 2022

zadjii-msft mentioned this issue Oct 13, 2023

Refactor Pane to be able to host non-terminal content #16170

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scenario: Add support for panes #1000

Scenario: Add support for panes #1000

zadjii-msft commented May 24, 2019 •

edited

DHowett-MSFT commented Jun 8, 2019 •

edited

decriptor commented Jun 12, 2019

zadjii-msft commented Jun 12, 2019

decriptor commented Jun 12, 2019

Jaykul commented Jun 26, 2019

zadjii-msft commented Jul 1, 2019

akulbe commented Jul 3, 2019

Fumler commented Jul 24, 2019

Trolldemorted commented Nov 11, 2020

anthonyvdotbe commented Nov 11, 2020

Trolldemorted commented Nov 11, 2020

anthonyvdotbe commented Nov 11, 2020

Trolldemorted commented Nov 11, 2020

zadjii-msft commented Nov 11, 2020

Trolldemorted commented Nov 11, 2020

JelteF commented May 7, 2021

zadjii-msft commented May 7, 2021

diegopaludo commented Jun 4, 2021

Scenario: Add support for panes #1000

Scenario: Add support for panes #1000

Comments

zadjii-msft commented May 24, 2019 • edited

1.0 Features

1.x features / bugs

2.0 Features / Bugs

Panes Titlebar Follow-ups - See #4998

Backlog items

Theming items

DHowett-MSFT commented Jun 8, 2019 • edited

decriptor commented Jun 12, 2019

zadjii-msft commented Jun 12, 2019

decriptor commented Jun 12, 2019

Jaykul commented Jun 26, 2019

zadjii-msft commented Jul 1, 2019

akulbe commented Jul 3, 2019

Fumler commented Jul 24, 2019

Trolldemorted commented Nov 11, 2020

anthonyvdotbe commented Nov 11, 2020

Trolldemorted commented Nov 11, 2020

anthonyvdotbe commented Nov 11, 2020

Trolldemorted commented Nov 11, 2020

zadjii-msft commented Nov 11, 2020

Trolldemorted commented Nov 11, 2020

JelteF commented May 7, 2021

zadjii-msft commented May 7, 2021

diegopaludo commented Jun 4, 2021

zadjii-msft commented May 24, 2019 •

edited

DHowett-MSFT commented Jun 8, 2019 •

edited