Feat: Add border for popup menu ('pumborder' option) #18486

girishji · 2025-10-04T08:27:33Z

This PR introduces a new global option, 'pumborder' ('pb'), that allows
users to define borders and optional decorations for the completion popup
menu.

'pumborder' 'pb'	number	(default 0)
			global
	Defines a border and optional decorations for the popup menu in
	completion.  The value is a comma-separated list of keywords.

	Border styles (at most one):
	"single"	use thin box-drawing characters
	"double"	use double-line box-drawing characters
	"round"		use rounded corners
	"ascii"		use ASCII characters (-, |, +)
	"custom:X;X;X;X;X;X;X;X"
			use eight characters separated by semicolons, in the
			order: top, right, bottom, left,
			topleft, topright, botright, botleft

	Additional flags:
	"margin"	adds one-cell spacing inside the left and right border
	"shadow"	draws a shadow at the right and bottom edges

	Highlight groups:
	|hl-PmenuBorder|	used for the border characters
	|hl-PmenuShadow|	used for the shadow

	Examples: >
		:set pumborder=single
		:set pumborder=double,margin,shadow
		:set pumborder=custom:─;│;─;│;┌;┐;┘;└,shadow
<
	Border styles using box-drawing characters ("single", "double",
	"round") are only available when |'encoding'| is "utf-8" and
	|'ambiwidth'| is "single".  "margin" requires a border style.
	See also: |ins-completion-menu|.

Also, fixes #18441 (comment)

This PR introduces a new global option, `'pumborder'` (`'pb'`), that allows users to define borders and optional decorations for the completion popup menu. ``` *'pumborder'* *'pb'* 'pumborder' 'pb' number (default 0) global Defines a border and optional decorations for the popup menu in completion. The value is a comma-separated list of keywords. Border styles (at most one): "single" use thin box-drawing characters "double" use double-line box-drawing characters "round" use rounded corners "ascii" use ASCII characters (-, |, +) "custom:XXXXXXXX" use eight characters given after "custom:", in order: top, right, bottom, left, topleft, topright, botright, botleft Additional flags: "margin" adds one-cell spacing inside the left and right border "shadow" draws a shadow at the right and bottom edges Highlight groups: |hl-PmenuBorder| used for the border characters |hl-PmenuShadow| used for the shadow Examples: > :set pumborder=single :set pumborder=double,margin,shadow :set pumborder=custom:─│─│┌┐┘└,shadow < Border styles using box-drawing characters ("single", "double", "round") are only available when |'encoding'| is "utf-8" and |'ambiwidth'| is "single". "margin" requires a border style. See also: |ins-completion-menu|. ``` Also, fixes vim#18441 (comment)

src/optionstr.c

M ci/hlgroups.ignore

M src/optionstr.c

habamax · 2025-10-05T00:25:18Z

huh, looks good

chrisbra · 2025-10-05T13:20:31Z

So this is essentially the same as #17091 ?

girishji · 2025-10-05T16:12:09Z

@chrisbra This PR builds on #18441, which simplifies the positioning logic, making it easier to add borders and shadows without introducing bugs.

Copilot

Pull Request Overview

This PR introduces a new global option 'pumborder' ('pb') that allows users to define borders and optional decorations for the completion popup menu. This enhancement provides visual improvements to the popup menu by adding customizable borders, margins, and shadows.

Adds the 'pumborder' option with support for different border styles (single, double, round, ascii, custom)
Implements margin and shadow features for the popup menu
Adds new highlight groups PmenuBorder and PmenuShadow for customization

Reviewed Changes

Copilot reviewed 73 out of 73 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/vim.h	Adds new highlight group constants for popup menu border and shadow
src/popupmenu.c	Core implementation of border drawing, shadow effects, and popup positioning logic
src/optionstr.c	Handles parsing and validation of the `pumborder` option
src/optiondefs.h	Defines the new `pumborder` option in the options table
src/option.h	Declares the global variable for the `pumborder` option
src/highlight.c	Sets up default highlight groups and color schemes for border and shadow
runtime/ files	Updates documentation, syntax highlighting, and option window support
src/testdir/ files	Adds comprehensive tests and screen dumps for the new functionality

Comments suppressed due to low confidence (1)

src/popupmenu.c:211

The condition changed from width > p_pmw to width >= p_pmw. This means when width equals p_pmw, it will now be truncated and end_padding disabled. This could be a subtle behavior change that affects popup menu rendering. Verify this change is intentional and doesn't break existing functionality.

    if (p_pmw > 0 && width >= p_pmw)
    {
	width = p_pmw;
	end_padding = FALSE;
    }

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/testdir/test_options.vim

src/testdir/test_highlight.vim

src/popupmenu.c

chrisbra · 2025-10-06T19:25:12Z

Does this also apply to popups or do you plan to make use of it for popups?

girishji · 2025-10-07T06:48:55Z

Does this also apply to popups or do you plan to make use of it for popups?

popupwin.c (used by plugins and info window) already has border. Only popupmenu.c didn't have border, and now it does.

chrisbra · 2025-10-07T20:02:10Z

thanks

Problem: not possible to style popup borders globally Solution: Add the 'pumborder' option (Girish Palya) This commit introduces a new global option, 'pumborder' ('pb'), that allows users to define borders and optional decorations for the completion popup menu. ``` Defines a border and optional decorations for the popup menu in completion. The value is a comma-separated list of keywords. Border styles (at most one): "single"singleuse thin box-drawing characters "double"doubleuse double-line box-drawing characters "round"rounduse rounded corners "ascii"asciiuse ASCII characters (-, |, +) "custom:XXXXXXXX" use eight characters given after "custom:", in order: top, right, bottom, left, topleft, topright, botright, botleft Additional flags: "margin"marginadds one-cell spacing inside the left and right border "shadow"shadowdraws a shadow at the right and bottom edges Highlight groups: |hl-PmenuBorder|hl-PmenuBorderused for the border characters |hl-PmenuShadow|hl-PmenuShadowused for the shadow Examples: > :set pumborder=single :set pumborder=double,margin,shadow :set pumborder=custom:─│─│┌┐┘└,shadow Border styles using box-drawing characters ("single", "double", "round") are only available when |'encoding'| is "utf-8" and |'ambiwidth'| is "single". "margin" requires a border style. See also: |ins-completion-menu|. ``` fixes: vim#18441 (comment) closes: vim#18486 closes: vim#17091 Signed-off-by: Girish Palya <girishji@gmail.com> Signed-off-by: Christian Brabandt <cb@256bit.org>

girishji · 2025-10-08T04:12:41Z

Thanks

girishji · 2026-01-08T16:05:13Z

@zeertzjq any reason why this is not merged into Neovim?

zeertzjq · 2026-01-08T22:54:39Z

A part of it is merged (some of the 'pumborder' values works), but due to the presence of the existing 'winborder' option there are some differences, and I haven't figured out how to merged the remaining part yet.

girishji · 2026-01-09T09:13:49Z

Thanks, I guess I was using the older version of Neovim. Your shadow implementation does not look right though (on the side it is only half as wide as the bottom), and underlying text is invisible unlike Vim which has some transparency. Option values cannot be combined either. Anyway, just nitpicking.

girishji force-pushed the border2 branch from e206dec to e96c681 Compare October 4, 2025 08:29

girishji mentioned this pull request Oct 4, 2025

Feat: Add more settings to 'completepopup' #18487

Closed

github-advanced-security bot found potential problems Oct 4, 2025

View reviewed changes

src/optionstr.c Fixed Show fixed Hide fixed

girishji added 3 commits October 4, 2025 10:51

Fix test failure

6b59642

M ci/hlgroups.ignore

Fix redundant null check

3cbe43f

M src/optionstr.c

Merge branch 'vim:master' into border2

4c58b9c

This comment was marked as off-topic.

Sign in to view

chrisbra requested a review from Copilot October 6, 2025 18:56

Copilot AI reviewed Oct 6, 2025

View reviewed changes

src/testdir/test_options.vim Show resolved Hide resolved

src/testdir/test_highlight.vim Show resolved Hide resolved

src/popupmenu.c Show resolved Hide resolved

src/popupmenu.c Show resolved Hide resolved

chrisbra closed this in 474b981 Oct 7, 2025

ddad431 mentioned this pull request Oct 8, 2025

completion: pumborder shadow does not completely cover the text #18514

Closed

girishji deleted the border2 branch October 8, 2025 04:12

Uh oh!

Feat: Add border for popup menu ('pumborder' option) #18486

Feat: Add border for popup menu ('pumborder' option) #18486

Uh oh!

Conversation

girishji commented Oct 4, 2025

Uh oh!

Uh oh!

habamax commented Oct 5, 2025

Uh oh!

chrisbra commented Oct 5, 2025

Uh oh!

This comment was marked as off-topic.

girishji commented Oct 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisbra commented Oct 6, 2025

Uh oh!

girishji commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chrisbra commented Oct 7, 2025

Uh oh!

girishji commented Oct 8, 2025

Uh oh!

girishji commented Jan 8, 2026

Uh oh!

zeertzjq commented Jan 8, 2026

Uh oh!

girishji commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

girishji commented Oct 7, 2025 •

edited

Loading

girishji commented Jan 9, 2026 •

edited

Loading