Support drawing popup frame #4313

ath3 · 2022-10-16T14:25:30Z

Usability improvement: popup-frame.

On some terminals / themes the popups are hard to differentiate from the background.
This makes (for example) LSP information hard to read, and makes the daily work using ssh sessions not as good as it could be.

With this change popups and menus can be configured have a border, and is easy to tell them apart from background with every theme and terminal.

Before:

After:

book/src/configuration.md

sudormrfbin · 2022-10-16T19:57:19Z

Drawing borders for popups feel like a good default whereas having a config option for it feels a bit overkill. I suppose some might prefer a sleeker look without the border?

the-mikedavis · 2022-10-16T20:09:11Z

I think an option for it seems ok. I prefer the borderless look but I've seen some discussions and matrix messages about wanting a border around popups

the-mikedavis · 2022-10-19T00:36:59Z

helix-term/src/ui/lsp.rs

        let margin = Margin::horizontal(1);
+        area.height -= 1;


Why the change here?

I removed it now, and added .clip_bottom(1) instead.
Before the change in this function, the text would be rendered on the bottom border line for signature help.

The clip_bottom should probably be gated on the new config option as well - there's a noticeable blank line when the option is off

I thought the lack of bottom margin was unintentional since other popups have margins around them, and here we only miss it from the bottom.
I changed this now, so without borders if should look as it originally was.

zjp-CN · 2022-10-20T12:30:16Z

I want this to be default. I use dracula theme, and in order to distinguish the popup, I have to modify the theme:

And I haven't seen any popup in nvim without borders. The same codeactionin nvim with lspsage.nvim plugin:

the-mikedavis · 2022-10-21T13:28:44Z

This change covers popups (like signature-help) but not menus (completion, code-actions). I think an option to enable/disable borders on both would be good

ath3 · 2022-10-25T02:32:24Z

This change covers popups (like signature-help) but not menus (completion, code-actions). I think an option to enable/disable borders on both would be good

It covers now both menus and popups, with settings to enable one of them, both, or none.

ath3 · 2022-11-17T13:25:56Z

Updated after the changes to popups having scrollbars.
Also fixed the unnecessary leading newlines in popups displayed for the selected menu item.

ath3 · 2022-11-26T16:03:17Z

I decided to take out the changes related to selection popup whitespace since it has nothing to do with borders.
The pr containing those changes is #4902

ath3 · 2023-01-16T22:12:23Z

I think this pr is ready for merge.
The last force-push was only to fix a merge conflict with newer changes on master.

archseer · 2023-02-02T19:55:18Z

helix-term/src/ui/menu.rs

+
+        if render_borders {
+            Widget::render(Block::default().borders(Borders::ALL), area, surface);
+            area = area.clip_top(1).clip_bottom(1);


area.inner doesn't work with Borders?

It does, i changed it to use area.inner now.

I removed the mut from area in function parameter and instead create a new variable "inner" to make it look more consistent with popup render code.
If you prefer the previous version i can revert this change.

SoraTenshi · 2023-06-22T09:49:32Z

Nice job on the PR, has been a staple in my fork for like ever.
Minor bug that i noticed tho: DAP mode (list all variables - Spc g v) does not properly draw the frame.

ath3 · 2023-08-09T09:46:35Z

I cleaned up the code, added popup-borders typable command, and fixed the issues with dap variable popup (thanks @SoraTenshi), and with menu only border setting.

ath3 · 2023-10-16T21:33:07Z

I think this PR is from my perspective in a good state and unless requested i dont plan to do any changes to it.
To celebrate this PR's birthday, can i get a review please?

ath3 · 2023-10-23T10:52:07Z

@the-mikedavis @archseer

dead10ck

Thanks for your patience on this PR! This is something I'd like to use myself; we just only have so much time to review all the PRs.

dead10ck · 2023-10-24T12:24:13Z

helix-term/src/ui/menu.rs

-        if let Some(cursor) = self.cursor {
-            let offset_from_top = cursor - scroll;
-            let left = &mut surface[(area.left(), area.y + offset_from_top as u16)];
-            left.set_style(selected);
-            let right = &mut surface[(
-                area.right().saturating_sub(1),
-                area.y + offset_from_top as u16,
-            )];
-            right.set_style(selected);
+        let render_borders = cx.editor.menu_border;
+
+        if !render_borders {
+            if let Some(cursor) = self.cursor {
+                let offset_from_top = cursor - scroll;
+                let left = &mut surface[(area.left(), area.y + offset_from_top as u16)];
+                left.set_style(selected);
+                let right = &mut surface[(
+                    area.right().saturating_sub(1),
+                    area.y + offset_from_top as u16,
+                )];
+                right.set_style(selected);
+            }


Apologies, since I'm not super familiar with the rendering code, so I could be misunderstanding something, but this looks like if we want to draw borders around popups that we are deciding not to render the cursor? Why is that?

This code colors the first and last cell of the selected line in menu.
With borders turned on, the colors would run through the borders.

dead10ck · 2023-10-24T12:28:32Z

helix-term/src/ui/popup.rs

+            let win_height = inner.height as usize - 2 * border;
+            let len = self.child_size.1 as usize - 2 * border;


Should we do a saturating_sub here?

dead10ck · 2023-10-24T12:31:26Z

helix-view/src/editor.rs

+    pub popup_border: bool,
+    pub menu_border: bool,


Could these just be helper methods instead of new fields on the Editor object?

Yes, i changed them

dead10ck · 2023-10-24T12:33:57Z

helix-term/src/commands/typed.rs

+fn set_borders(
+    cx: &mut compositor::Context,
+    args: &[Cow<str>],
+    event: PromptEvent,
+) -> anyhow::Result<()> {
+    if event != PromptEvent::Validate {
+        return Ok(());
+    }
+
+    if args.is_empty() {
+        let borders = (cx.editor.popup_border, cx.editor.menu_border);
+        cx.editor.set_status(match borders {
+            (true, true) => "all",
+            (true, false) => "popup",
+            (false, true) => "menu",
+            (false, false) => "none",
+        });
+
+        return Ok(());
+    }
+
+    let arg = args.get(0).context("argument missing")?.to_lowercase();
+
+    if let Some(borders) = match arg {
+        arg if arg.starts_with("all") => Some((true, true)),
+        arg if arg.starts_with("popup") => Some((true, false)),
+        arg if arg.starts_with("menu") => Some((false, true)),
+        arg if arg.starts_with("none") => Some((false, false)),
+        _ => None,
+    } {
+        cx.editor.popup_border = borders.0;
+        cx.editor.menu_border = borders.1;
+    } else {
+        cx.editor
+            .set_status("Valid options are: none, popup, menu, all");
+    };
+
+    Ok(())
+}
+


Does this need its own command? Wouldn't just doing :set popup-border <choice> work?

Yeah, i deleted this command now

dead10ck

Ok this looks good to me! I tried it out locally too, and it looks good. Thanks for the PR.

ath3 · 2023-11-27T17:28:16Z

Bump

the-mikedavis

This looks good to me but I'll leave it up to @archseer to merge

the-mikedavis · 2023-12-11T23:48:37Z

helix-term/src/ui/popup.rs

+        let inner = if self
+            .contents
+            .type_name()
+            .starts_with("helix_term::ui::menu::Menu")


This seems very hacky to me but I don't see a good way around it - there isn't a way to compare the type to Menu<_> without dealing with strings like this. I think I'm fine with this for now but it's something we should try to eliminate in the future (though it may take a large refactor to the compositor system to do it)

Co-authored-by: Blaž Hrastnik <[email protected]>

ath3 force-pushed the popup-frame branch from a4efdaf to 4239670 Compare October 16, 2022 14:59

the-mikedavis reviewed Oct 16, 2022

View reviewed changes

book/src/configuration.md Outdated Show resolved Hide resolved

ath3 force-pushed the popup-frame branch from 4239670 to 41724be Compare October 16, 2022 17:34

the-mikedavis added A-helix-term Area: Helix term improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Oct 16, 2022

ath3 force-pushed the popup-frame branch from 41724be to adf6d19 Compare October 16, 2022 22:03

the-mikedavis reviewed Oct 19, 2022

View reviewed changes

ath3 force-pushed the popup-frame branch 3 times, most recently from e1285fd to 00c55c5 Compare October 19, 2022 23:12

ath3 force-pushed the popup-frame branch 3 times, most recently from 56ce875 to 73e707f Compare October 25, 2022 02:26

the-mikedavis previously approved these changes Oct 27, 2022

View reviewed changes

ath3 force-pushed the popup-frame branch from 73e707f to c255b7f Compare November 17, 2022 13:09

ath3 force-pushed the popup-frame branch 2 times, most recently from be830c7 to 7e579ba Compare November 26, 2022 15:59

ath3 force-pushed the popup-frame branch from 7e579ba to c4fd256 Compare December 6, 2022 16:10

ath3 closed this Feb 2, 2023

ath3 force-pushed the popup-frame branch from c4fd256 to 62d046f Compare February 2, 2023 11:40

ath3 reopened this Feb 2, 2023

archseer reviewed Feb 2, 2023

View reviewed changes

ath3 force-pushed the popup-frame branch 2 times, most recently from badbff3 to 2577f97 Compare March 20, 2023 15:06

ath3 force-pushed the popup-frame branch from 2577f97 to 2c98f8e Compare April 4, 2023 22:16

ath3 force-pushed the popup-frame branch from 2c98f8e to 653ec31 Compare April 20, 2023 22:20

ath3 requested a review from the-mikedavis April 20, 2023 22:29

ath3 force-pushed the popup-frame branch from 653ec31 to ffe8776 Compare August 9, 2023 09:38

ath3 force-pushed the popup-frame branch from ffe8776 to 704240f Compare August 10, 2023 22:30

ath3 force-pushed the popup-frame branch from 704240f to bf72b1d Compare October 16, 2023 21:19

dead10ck reviewed Oct 24, 2023

View reviewed changes

ath3 force-pushed the popup-frame branch from bf72b1d to 84d05a0 Compare October 24, 2023 20:20

Support drawing popup frame

bd1355f

ath3 force-pushed the popup-frame branch from 84d05a0 to bd1355f Compare October 24, 2023 20:27

dead10ck previously approved these changes Oct 24, 2023

View reviewed changes

the-mikedavis previously approved these changes Dec 11, 2023

View reviewed changes

Merge branch 'master' into popup-frame

6e58c6c

archseer dismissed stale reviews from the-mikedavis and dead10ck via 6e58c6c December 19, 2023 01:10

archseer approved these changes Dec 19, 2023

View reviewed changes

archseer merged commit 9ba691c into helix-editor:master Dec 19, 2023
6 checks passed

dgkf pushed a commit to dgkf/helix that referenced this pull request Jan 30, 2024

Support drawing popup frame (helix-editor#4313)

dff7ccf

Co-authored-by: Blaž Hrastnik <[email protected]>

This was referenced Feb 2, 2024

Popup scroll track (ui.menu.scroll.bg) no longer being colored properly #9498

Closed

Fix rendering of popup scrollbar #9499

Closed

mtoohey31 pushed a commit to mtoohey31/helix that referenced this pull request Jun 2, 2024

Support drawing popup frame (helix-editor#4313)

20f1c92

Co-authored-by: Blaž Hrastnik <[email protected]>

Vulpesx pushed a commit to Vulpesx/helix that referenced this pull request Jun 7, 2024

Support drawing popup frame (helix-editor#4313)

573a968

Co-authored-by: Blaž Hrastnik <[email protected]>

smortime pushed a commit to smortime/helix that referenced this pull request Jul 10, 2024

Support drawing popup frame (helix-editor#4313)

96391bc

Co-authored-by: Blaž Hrastnik <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support drawing popup frame #4313

Support drawing popup frame #4313

ath3 commented Oct 16, 2022 •

edited

Loading

sudormrfbin commented Oct 16, 2022 •

edited

Loading

the-mikedavis commented Oct 16, 2022

the-mikedavis Oct 19, 2022

ath3 Oct 19, 2022

the-mikedavis Oct 19, 2022

ath3 Oct 19, 2022

zjp-CN commented Oct 20, 2022

the-mikedavis commented Oct 21, 2022

ath3 commented Oct 25, 2022

ath3 commented Nov 17, 2022

ath3 commented Nov 26, 2022 •

edited

Loading

ath3 commented Jan 16, 2023

archseer Feb 2, 2023

ath3 Feb 2, 2023

ath3 Feb 3, 2023

SoraTenshi commented Jun 22, 2023

ath3 commented Aug 9, 2023

ath3 commented Oct 16, 2023

ath3 commented Oct 23, 2023

dead10ck left a comment

dead10ck Oct 24, 2023

ath3 Oct 24, 2023

dead10ck Oct 24, 2023

ath3 Oct 24, 2023

dead10ck Oct 24, 2023

ath3 Oct 24, 2023

dead10ck Oct 24, 2023

ath3 Oct 24, 2023

dead10ck left a comment

ath3 commented Nov 27, 2023

the-mikedavis left a comment

the-mikedavis Dec 11, 2023

		let win_height = inner.height as usize - 2 * border;
		let len = self.child_size.1 as usize - 2 * border;

Support drawing popup frame #4313

Support drawing popup frame #4313

Conversation

ath3 commented Oct 16, 2022 • edited Loading

sudormrfbin commented Oct 16, 2022 • edited Loading

the-mikedavis commented Oct 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zjp-CN commented Oct 20, 2022

the-mikedavis commented Oct 21, 2022

ath3 commented Oct 25, 2022

ath3 commented Nov 17, 2022

ath3 commented Nov 26, 2022 • edited Loading

ath3 commented Jan 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SoraTenshi commented Jun 22, 2023

ath3 commented Aug 9, 2023

ath3 commented Oct 16, 2023

ath3 commented Oct 23, 2023

dead10ck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dead10ck left a comment

Choose a reason for hiding this comment

ath3 commented Nov 27, 2023

the-mikedavis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ath3 commented Oct 16, 2022 •

edited

Loading

sudormrfbin commented Oct 16, 2022 •

edited

Loading

ath3 commented Nov 26, 2022 •

edited

Loading