Skip to content

Improve the list view to be scrollable and auto-adjust the list view height#3583

Merged
daxian-dbw merged 7 commits intoPowerShell:masterfrom
daxian-dbw:scroll
Feb 27, 2023
Merged

Improve the list view to be scrollable and auto-adjust the list view height#3583
daxian-dbw merged 7 commits intoPowerShell:masterfrom
daxian-dbw:scroll

Conversation

@daxian-dbw
Copy link
Copy Markdown
Member

@daxian-dbw daxian-dbw commented Feb 17, 2023 •
edited
Loading

PR Summary

Fix #3563
Improve the list view to be scrollable and auto-adjust the list view height.

  • Now the list view is scrollable. It can display up to 50 items.
  • The max list view height is still 10, but the list view height can auto-adjust based on the terminal height: the max height changes to 5 when the terminal height is <=20, and then changes to 3 when the terminal height is <= 10.
  • A metadata line is added to show extra information for the list view.
  • When the terminal size is too small to show the list view, it prints a warning message to inform the user about it.
  • The key-bindings PageUp and PageDown can navigate within the list view by moving up/down a page.
  • The key-bindings Ctrl+PageUp and Ctrl+PageUp can navigate within the list view by jumping to the previous/next source.

The scrollable list view:

scrollable

The auto-adjustable list view height:

auto-adjust

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure you've added one or more new tests
  • Make sure you've tested these changes in terminals that PowerShell is commonly used in (i.e. conhost.exe, Windows Terminal, Visual Studio Code Integrated Terminal, etc.)
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed at PowerShell-Docs
      • Doc Issue filed:
Microsoft Reviewers: Open in CodeFlow

@daxian-dbw daxian-dbw marked this pull request as ready for review February 17, 2023 00:13
@daxian-dbw daxian-dbw self-assigned this Feb 17, 2023
@SteveL-MSFT SteveL-MSFT reopened this Feb 17, 2023
SteveL-MSFT
SteveL-MSFT reviewed Feb 17, 2023
View reviewed changes
SteveL-MSFT
SteveL-MSFT reviewed Feb 17, 2023
View reviewed changes
SteveL-MSFT
SteveL-MSFT reviewed Feb 17, 2023
View reviewed changes
PSReadLine/Prediction.Views.cs Outdated
private void RenderWarningLine(StringBuilder buffer)
{
// Add italic text effect to the highlight color.
string highlightColor = _singleton._options._listPredictionColor + "\x1b[3m";
Copy link
Copy Markdown
Member

@SteveL-MSFT SteveL-MSFT Feb 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of italics should just be part of the configurable prediction highlight instead of always being added. Some users may prefer bold, for example. So this should be highlightStyle and not highlightColor

Copy link
Copy Markdown
Member Author

@daxian-dbw daxian-dbw Feb 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About the new colors and styles, there are a few of them:

  • un-highlighted texts in the metadata line
  • highlighted text in the metadata line
  • warning message

Currently,

  • the un-highlighted text uses the default inline view color/style;
  • the highlighted text uses the ListPredictionColor plus italics;
  • the warning message uses the ListPredictionColor plus italics;

I'm not sure about what to expose for configuration yet. It doesn't feel needed to expose them all in my opinion. The following are my thoughts:

  1. always apply italics to the text rendered in the metadata line, and use the ListPredictionColor as the user-configurable highlighting color/style.
  2. maybe expose configuration for un-highlighted text color/style, but I'm not super sure if it's really needed.
  3. warning message in this case will be uncommon for users to see because it will usually happen when the terminal height is very small (<5). So, exposing a configuration for it seems overkill to me.

I don't have a clear idea what/how to make configurable about the new color/styles at the moment, so I prefer to wait and collect some feedback about this, which hopefully will give us a clear idea. I will open an issue about this to track it.

Copy link
Copy Markdown
Member Author

@daxian-dbw daxian-dbw Feb 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue opened: #3584

SteveL-MSFT
SteveL-MSFT reviewed Feb 17, 2023
View reviewed changes
@daxian-dbw daxian-dbw mentioned this pull request Feb 17, 2023
Open
1 task
SteveL-MSFT
SteveL-MSFT approved these changes Feb 27, 2023
View reviewed changes
@daxian-dbw daxian-dbw merged commit 372212e into PowerShell:master Feb 27, 2023
@daxian-dbw daxian-dbw deleted the scroll branch February 27, 2023 18:48
andyleejordan
andyleejordan reviewed Feb 27, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@andyleejordan andyleejordan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@daxian-dbw daxian-dbw mentioned this pull request Feb 28, 2023
Merged
7 tasks
@daxian-dbw
Copy link
Copy Markdown
Member Author

daxian-dbw commented Feb 28, 2023

@andschwa Thanks for the review! I submitted #3600 to address you feedback.

@ChristopherHaws
Copy link
Copy Markdown

ChristopherHaws commented Mar 7, 2023

Any idea when this will be released (even to a prerelease version)? I just ran powershell -noprofile -command "Update-Module PSReadLine -AllowPrerelease" and PSReadLine is still on version 2.2.6 and doesnt have these changes.

Thanks! :)

@ghost
Copy link
Copy Markdown

ghost commented Mar 8, 2023

🎉 v2.3.0-beta0 has been released which incorporates this pull request. 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andyleejordan andyleejordan andyleejordan left review comments

@SteveL-MSFT SteveL-MSFT SteveL-MSFT approved these changes

Assignees

@daxian-dbw daxian-dbw

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Auto-resize Predictor ListView when the height is too small

4 participants

@daxian-dbw @ChristopherHaws @andyleejordan @SteveL-MSFT