[Scenario] Progress Bar Follow-ups #6700

zadjii-msft · 2020-06-27T12:04:57Z

[Original issue: #3004] [Initial PR: #8055] [Display the progress in the tab: #8133]

This is a list of tasks, bugs, etc, related to the "taskbar progress indicator", as first implemented in #8055. While not all of them are immediately relevant for the taskbar indicator, they're all related to the showing of progress state in the Terminal.

Sequence	Description
`ESC ] 9 ; 4 ; st ; pr ST`	Set progress state on Windows taskbar and tab. When `st` is: `0`: remove progress. `1`: set progress value to `pr` (number, 0-100). `2`: set the taskbar to the "Error" state `3`: set the taskbar to the "Indeterminate" state `4`: set the taskbar to the "Warning" state

Follow-up work

Give feedback

terminal activity indicator/alert when in background #7955

Area-User Interface Help Wanted Issue-Feature Product-Terminal
Add a "tab busy indicator" to show when a tab has belled or has output #1620

Area-User Interface Issue-Feature Product-Terminal
Auto-show progress in task bar based on contents of last line of buffer #8449

Area-TerminalControl Issue-Task Product-Terminal
Show error state in progress ring of tab #9481

Area-User Interface Help Wanted Issue-Task Product-Terminal
A very long title causes only half of the progress ring to be visible #8910

Area-User Interface Issue-Bug Priority-3 Product-Terminal Resolution-Fix-Committed
Combine pane taskbar states in the taskbar #10090

Area-User Interface Issue-Bug Priority-2 Product-Terminal Resolution-Fix-Committed
Progress state doesn't update correctly between panes #9743

Area-User Interface Issue-Bug Priority-2 Product-Terminal Resolution-Fix-Committed
Use an indeterminate progress ring on the tab before a tab is "connected" #3991

Area-User Interface Help Wanted Issue-Task Product-Terminal
Options

"Auto-detect output, display in tab/taskbar" (#7955) and #1620 are very closely related

Bell notifications

These cover some of the same areas of the above, so I'm including them because I feel they deserve a mention here:

Make terminal beeps highlight Windows Terminal in the taskbar, to get user attention when backgrounded Make terminal beeps highlight Windows Terminal in the taskbar, to get user attention when backgrounded #1608 -> added in Add a setting to flash the taskbar when the terminal emits BEL #8215
show an indicator if there's a bell in the tab Feature Request: show an indicator if there's a bell in the tab #8106 -> added in #8637
The bell should "fade out", like it does for browsers
More elaborate visual belling -> added in Add a setting to flash the pane when BEL is emitted #9270
- bellStyle: flash -> flash the window. (maybe visual)
- bellStyle: taskbar -> flash the taskbar (maybe taskbar)
- bellStyle: visual -> both? (maybe visual|taskbar)

Related?

Display connection state in tab & add tab context menu entry for restarting connection #14909

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

qu1ck · 2020-11-30T08:06:43Z

Just some context on how conemu does autodetection of long running operations: if last line starts with [int]% it assumes that it's a progress indicator and sets tab name accordingly and also taskbar state:

I would love to see something like this in terminal.

This commit adds a [progress ring] to the tab header when we receive an OSC 9 sequence. Adds an event handler in `Tab.cpp` for the event we raise when we get a request to set the taskbar state/progress. This event handler updates the tab header with the active control's state/progress. When we want to show the progress ring, we hide the tab icon and place the progress ring over it. [progress ring]: https://docs.microsoft.com/en-us/uwp/api/Microsoft.UI.Xaml.Controls.ProgressRing?view=winui-2.4 References #6700

sba923 · 2021-01-29T18:21:46Z

"warning": ^[]9;4;4;100^G

"error": ^[]9;4;2;100^G

One is yellow, the other is red...

Oh... reading #8055 and experimenting, I had not guessed / understood that the pr argument must be present, even when useless. It doesn't seem needed for 0 and 3, but now I know that a dummy non-zero argument must be there for 2 and 4...

tringi · 2021-02-01T05:54:36Z

It doesn't seem like a bad idea to combine these states somehow (with a setting), but we'd want to make sure we're clear what happens in cases like:

one tab has progress=N%, another tab has no progress

one tab has progress=N%, another tab has progress=M%

one tab has progress=N%, another tab has progress=indeterminate

one tab has progress=N%, another tab has progress=M% AND is in the error state

etc.

Sure, we have to specify this exhaustively.

It is specified in Taskbar API here how progress bars are combined for multiple windows collapsed into single button. For consistency it would be good idea to duplicate the behavior.

zadjii-msft · 2021-02-01T12:23:54Z

It is specified in Taskbar API here how progress bars are combined for multiple windows collapsed into single button. For consistency it would be good idea to duplicate the behavior.

Thanks for that. We should do that.

WSLUser · 2021-02-03T14:56:50Z

FYI, this WinUI bug still exists: microsoft/microsoft-ui-xaml#3787

sba923 · 2021-02-08T09:35:57Z

On at least two of my systems ESC ] 9 ; 4 ; 3 ; 100 BEL does cause the rotating symbol on the Windows Terminal tab, but doesn't trigger the animation on the taskbar button. Shall I open a separate issue for that?

sba923 · 2021-03-04T11:41:18Z

On at least two of my systems ESC ] 9 ; 4 ; 3 ; 100 BEL does cause the rotating symbol on the Windows Terminal tab, but doesn't trigger the animation on the taskbar button. Shall I open a separate issue for that?

Opened #9374

tringi · 2021-03-05T21:17:36Z

A little off topic, but wouldn't it be trivial to add this also to Conhost? Just simply forward the command to ITaskbarList3?

Thinking about it... now that this is open, I might even try myself.

sba923 · 2021-03-16T17:20:35Z

On at least two of my systems ESC ] 9 ; 4 ; 3 ; 100 BEL does cause the rotating symbol on the Windows Terminal tab, but doesn't trigger the animation on the taskbar button. Shall I open a separate issue for that?

Opened #9374

#9374 closed with solution by @DHowett: one must enable animations under Settings / Ease of Access / Display:

Without this, only OSC9;4;x;yST with x=1,2,4 are fully functional.

## Summary of the Pull Request Adds a new bellStyle called `window`. When `window` is set and a BEL is emitted, we flash the pane that emitted it. Additionally, changes bellStyle in the SUI to a list of checkboxes instead of radio buttons, to match bellStyle being a flag-enum. Deprecates 'BellStyle::Visual' in the schema, but still allows it to be set in the json (it maps to `Window | Taskbar`)  ## References #6700  ## PR Checklist * [ ] Closes #xxx * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [ ] 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 * [ ] Schema updated. * [x] I work here  ## Validation Steps Performed GIF in Teams

@echo

## Summary of the Pull Request ![background-progress-000](https://user-images.githubusercontent.com/18356694/126653006-3ad2fdae-67ae-4cdb-aa46-25d09217e365.gif) This PR causes the Terminal to combine taskbar states at the tab and window level, according to the [MSDN docs for `SetProgressState`](https://docs.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-itaskbarlist3-setprogressstate#how-the-taskbar-button-chooses-the-progress-indicator-for-a-group). This allows the Terminal's taskbar icon to continue showing progress information, even if you're in a pane/tab that _doesn't_ have progress state. This is helpful for cases where the user may be running a build in one tab, and working on something else in another. ## References * [`SetProgressState`](https://docs.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-itaskbarlist3-setprogressstate#how-the-taskbar-button-chooses-the-progress-indicator-for-a-group) * Progress mega: #6700 ## PR Checklist * [x] Closes #10090 * [x] I work here * [ ] Tests added/passed * [n/a] Requires documentation to be updated ## Detailed Description of the Pull Request / Additional comments This also fixes a related bug where transitioning from the "error" or "warning" state directly to the "indeterminate" state would cause the taskbar icon to get stuck in a bad state. ## Validation Steps Performed <details> <summary><code>progress.cmd</code></summary> ```cmd @echo off setlocal enabledelayedexpansion set _type=3 if (%1) == () ( set _type=3 ) else ( set _type=%1 ) if (%_type%) == (0) ( <NUL set /p =�]9;4� echo Cleared progress ) if (%_type%) == (1) ( <NUL set /p =�]9;4;1;25� echo Started progress (normal, 25^) ) if (%_type%) == (2) ( <NUL set /p =�]9;4;2;50� echo Started progress (error, 50^) ) if (%_type%) == (3) ( @Rem start indeterminate progress in the taskbar @Rem this `<NUL set /p =` magic will output the text _without a newline_ <NUL set /p =�]9;4;3� echo Started progress (indeterminate, {omitted}) ) if (%_type%) == (4) ( <NUL set /p =�]9;4;4;75� echo Started progress (warning, 75^) ) ``` </details>

sba923 · 2022-09-07T09:36:01Z

On at least two of my systems ESC ] 9 ; 4 ; 3 ; 100 BEL does cause the rotating symbol on the Windows Terminal tab, but doesn't trigger the animation on the taskbar button. Shall I open a separate issue for that?

Opened #9374

#9374 closed with solution by @DHowett: one must enable animations under Settings / Ease of Access / Display:

Here's the state of affairs on this issue:

on one system, even with "Show Animations in Windows" set to "on", the animation's still missing
on the same system, the "Show Animations in Windows" setting keeps turning itself off

This has been discussed in #9374 up to the point where I created https://aka.ms/AAehwy4, and from there no progress has been made.

aetonsi · 2023-03-09T15:21:23Z

Hi, is there, anywhere, a clear documentation about all of these behaviors? If not, would it be possible to add a brief section in the Console Virtual Terminal Sequences page (if that's the correct location)?

I'm asking because i have a couple of quick questions but i can't find the answer anywhere, the information is pretty fragmented (it seems to me). I'm going to place them here in case anyone has an answer.

First question
It's possible to switch from "progress" (green taskbar) status to "error"/"warning" status (red/yellow) without altering and without even knowing the current progress percentage. This is possible by using st=2/4 (error/warning) combined with pr= (empty string).
For example, if the status bar is currently 33% in "progress" (green) status, using st=2 and pr= i can go to 33% "error" (red) status.
The question is: is it possible to do the same but in the opposite direction? meaning, for example, is it possible to go from 33% "error" status to the same percentage but in "progress" status?
I tried st=1 and pr= /-1/0 either do nothing or simply reset the taskbar (as if st was 0)

Second question
In #8055 it is said:

We've also extended this with:

st 3: set indeterminate state

st 4: set paused state

What it is meant with "paused state"? is it referring to conemu's "warning" state? or is it some additional/custom WindowsTerminal's feature?

thank you everyone

j4james · 2023-03-09T16:32:59Z

The question is: is it possible to do the same but in the opposite direction? meaning, for example, is it possible to go from 33% "error" status to the same percentage but in "progress" status?

No. The default percent value for an error state is the whatever current percent is (that's why you can change from st=1 to st=2 without setting the percent), but the default percent value for the progress state is 0. In other words, if you set st=1 with no percent, you're getting 0%, which is the same as disabling the progress.

What it is meant with "paused state"? is it referring to conemu's "warning" state?

Yes. At the time this feature was being developed, ConEmu had only documented states 0, 1, and 2. I think state 3 may already have been implemented, but not yet documented. State 4 was then proposed by Windows Terminal, but it was discussed with the Maximus5 first, who agreed to add matching functionality to ConEmu. The ConEmu documentation now includes all 5 states (see ConEmu specific OSC).

aetonsi · 2023-03-10T14:48:52Z

No. The default percent value for an error state is the whatever current percent is (that's why you can change from st=1 to st=2 without setting the percent), but the default percent value for the progress state is 0. In other words, if you set st=1 with no percent, you're getting 0%, which is the same as disabling the progress.

Is this a Windows default?

Is there a system API to read the current progress percentage? Because if there is, it would nice if WindowsTerminal's behaviour was more consistent, maintaining the current percentage whenever pr= , even when going from st=2/4 to st=1 (by first reading the current "error"/"warning" percentage, then applying the "progress" state with that percentage).

If you deem this to be too misleading, because it wouldn't match the OS' behaviour, i'd just like to know if a WT escape code/API/something to get the current percentage exists, so that i can use it in my utilities to achieve the aforementioned behaviour. Something like the ESC[6n escape code which "returns" the cursor position in the stdin stream (even though i don't know how to read the returned value...)

j4james · 2023-03-10T20:46:05Z

Is this a Windows default?

No. That's the way it was defined by ConEmu. We're just following their specification.

i'd just like to know if a WT escape code/API/something to get the current percentage exists

No. The simplest option would be for you to keep track of the last percentage value yourself, since I'm assuming you're the one that set it. But if that's not an option for you, then I don't have any other ideas.

As noted in #514 closes #514 xref microsoft/terminal#6700

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

ghost closed this as completed Jun 27, 2020

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jun 27, 2020

This comment has been minimized.

Sign in to view

zadjii-msft reopened this Jun 27, 2020

ghost added the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Jul 1, 2020

microsoft deleted a comment Jul 1, 2020

ghost removed the No-Recent-Activity This issue/PR is going stale and may be auto-closed without further activity. label Jul 1, 2020

zadjii-msft removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jul 1, 2020

DHowett removed the Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting label Jul 2, 2020

miniksa added ⛺ Reserved For future use and removed Needs-Tag-Fix Doesn't match tag requirements labels Jul 6, 2020

zadjii-msft changed the title ~~Reserved for future use~~ [Scenario] Progress Bar Follow-ups Oct 29, 2020

zadjii-msft added Area-UserInterface Issues pertaining to the user interface of the Console or Terminal Area-VT Virtual Terminal sequence support Issue-Scenario Product-Terminal The new Windows Terminal. and removed ⛺ Reserved For future use labels Oct 29, 2020

zadjii-msft added this to the Terminal v2.0 milestone Oct 29, 2020

PankajBhojwani mentioned this issue Oct 30, 2020

[DRAFT] Display progress in pane #8115

Closed

9 tasks

zadjii-msft mentioned this issue Nov 2, 2020

Feature Request: show an indicator if there's a bell in the tab #8106

Closed

This was referenced Nov 2, 2020

Add a progress ring indicator to the tab header #8133

Merged

Add a setting to auto focus an error pane #8145

Closed

zadjii-msft mentioned this issue Nov 9, 2020

Tab tooltip is empty when zooming pane #8199

Closed

PankajBhojwani self-assigned this Nov 16, 2020

zadjii-msft mentioned this issue Dec 1, 2020

Auto-show progress in task bar based on contents of last line of buffer #8449

Open

zadjii-msft mentioned this issue Jan 6, 2021

Flashing the window title (and the task bar) via FlashWindowEx has no effect #8713

Closed

PankajBhojwani mentioned this issue Feb 24, 2021

Add a setting to flash the pane when BEL is emitted #9270

Merged

6 tasks

SteveL-MSFT mentioned this issue Mar 1, 2021

Doc new $PSStyle.Progress.UseOSCIndicator setting MicrosoftDocs/PowerShell-Docs#7304

Closed

KalleOlaviNiemitalo mentioned this issue Mar 13, 2021

Show error state in progress ring of tab #9481

Open

zadjii-msft mentioned this issue May 13, 2021

Combine pane taskbar states in the taskbar #10090

Closed

j4james mentioned this issue Jul 8, 2021

Progress ring is clipped when tab title is too long #10584

Closed

zadjii-msft mentioned this issue Jul 22, 2021

Combine progress states in the tab, taskbar #10755

Merged

3 tasks

zadjii-msft modified the milestones: Terminal v2.0, Megathreads Jan 4, 2022

zadjii-msft mentioned this issue Feb 28, 2022

Add docs on how progress bar sequence works MicrosoftDocs/terminal#514

Closed

zadjii-msft mentioned this issue Mar 13, 2023

Display connection state in tab & add tab context menu entry for restarting connection #14909

Closed

StartAutomating mentioned this issue Jun 22, 2023

?<Console_Progress> StartAutomating/Irregular#187

Open

ocalvo mentioned this issue Aug 17, 2023

Set Progress ring color based on the status from the running process #15847

Closed

4 tasks

zadjii-msft mentioned this issue Aug 31, 2023

Add a tutorial for using the progress bar MicrosoftDocs/terminal#704

Merged

nguyen-dows pushed a commit to MicrosoftDocs/terminal that referenced this issue Aug 31, 2023

Add a tutorial for using the progress bar (#704)

0b5d075

As noted in #514 closes #514 xref microsoft/terminal#6700

zkat mentioned this issue Sep 30, 2023

Built-in support for OSC9;4 console-rs/indicatif#596

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Scenario] Progress Bar Follow-ups #6700

[Scenario] Progress Bar Follow-ups #6700

zadjii-msft commented Jun 27, 2020 •

edited

Loading

Follow-up work

This comment has been minimized.

qu1ck commented Nov 30, 2020 •

edited

Loading

sba923 commented Jan 29, 2021 •

edited

Loading

tringi commented Feb 1, 2021

zadjii-msft commented Feb 1, 2021

WSLUser commented Feb 3, 2021

sba923 commented Feb 8, 2021

sba923 commented Mar 4, 2021

tringi commented Mar 5, 2021

sba923 commented Mar 16, 2021

sba923 commented Sep 7, 2022

aetonsi commented Mar 9, 2023

j4james commented Mar 9, 2023

aetonsi commented Mar 10, 2023

j4james commented Mar 10, 2023

[Scenario] Progress Bar Follow-ups #6700

[Scenario] Progress Bar Follow-ups #6700

Comments

zadjii-msft commented Jun 27, 2020 • edited Loading

[Original issue: #3004] [Initial PR: #8055] [Display the progress in the tab: #8133]

Follow-up work

Bell notifications

Related?

This comment has been minimized.

qu1ck commented Nov 30, 2020 • edited Loading

sba923 commented Jan 29, 2021 • edited Loading

tringi commented Feb 1, 2021

zadjii-msft commented Feb 1, 2021

WSLUser commented Feb 3, 2021

sba923 commented Feb 8, 2021

sba923 commented Mar 4, 2021

tringi commented Mar 5, 2021

sba923 commented Mar 16, 2021

sba923 commented Sep 7, 2022

aetonsi commented Mar 9, 2023

j4james commented Mar 9, 2023

aetonsi commented Mar 10, 2023

j4james commented Mar 10, 2023

zadjii-msft commented Jun 27, 2020 •

edited

Loading

qu1ck commented Nov 30, 2020 •

edited

Loading

sba923 commented Jan 29, 2021 •

edited

Loading