|
1 | | -*map.txt* For Vim version 9.2. Last change: 2026 Feb 14 |
| 1 | +*map.txt* For Vim version 9.2. Last change: 2026 May 02 |
2 | 2 |
|
3 | 3 |
|
4 | 4 | VIM REFERENCE MANUAL by Bram Moolenaar |
@@ -1693,7 +1693,21 @@ For the "custom" argument, the function should return the completion |
1693 | 1693 | candidates one per line in a newline separated string. |
1694 | 1694 | *E1303* |
1695 | 1695 | For the "customlist" argument, the function should return the completion |
1696 | | -candidates as a Vim List. Non-string items in the list are ignored. |
| 1696 | +candidates as a Vim List. Each item may be either a string or a |Dictionary|. |
| 1697 | +A Dictionary item may have the following keys: |
| 1698 | + word (required) the text inserted into the command line when the |
| 1699 | + item is selected |
| 1700 | + abbr alternative text shown in the popup menu in place of "word", |
| 1701 | + when 'wildoptions' contains "pum"; useful when the inserted |
| 1702 | + text and the displayed text should differ |
| 1703 | + kind short kind text (one or two characters), shown in the popup |
| 1704 | + menu when 'wildoptions' contains "pum" |
| 1705 | + menu extra text shown after the match in the popup menu |
| 1706 | + info long description shown in the info popup; the |+popupwin| |
| 1707 | + feature is required to display it |
| 1708 | +Items that are neither a string nor a Dictionary, and Dictionary items without |
| 1709 | +a "word" key, are ignored. When 'wildoptions' does not contain "pum", only |
| 1710 | +"word" is shown. |
1697 | 1711 |
|
1698 | 1712 | The function arguments are: |
1699 | 1713 | ArgLead the leading portion of the argument currently being |
|
0 commit comments