diff --git a/versions/comp-display-and-aliases/docs/completions/index.html b/versions/comp-display-and-aliases/docs/completions/index.html index ed16f0a..d810082 100644 --- a/versions/comp-display-and-aliases/docs/completions/index.html +++ b/versions/comp-display-and-aliases/docs/completions/index.html @@ -28,7 +28,36 @@ Example:
13return {cg, cg2}, prefix
Which looks like this:
Grid is the simplest completion group type. All items are strings and when +completion is done is displayed in a grid based on size.
Example:
1{
+2 items = {'just', 'a bunch', 'of items', 'here', 'hehe'},
+3 type = 'grid'
+4}
+
The list completion group type displays in a list. It displays more info than grid.
+A list item can either be a string, or a table for additional display options.
+If a completion has an alias, it can be specified either as the 2nd
entry in the options table
+or te alias
key. A description can optionally be displayed for a list item, which is either the 1st
+entry or the description
key.
Lastly, list entries can be styled. This is done with the display
key. If this is present, this
+overrides what the completion item looks like.
Example:
1{
+ 2 items = {
+ 3 ['--flag'] = {
+ 4 description = 'this flag nukes the bri ish',
+ 5 alias = '--bye-bri-ish',
+ 6 display = lunacolors.format('--{blue}fl{red}ag')
+ 7 },
+ 8 ['--flag2'] = {
+ 9 'make pizza', -- description
+10 '--pizzuh', -- alias
+11 display = lunacolors.yellow '--pizzuh'
+12 },
+13 '--flag3'
+14 },
+15 type = 'list'
+16}
+
Like most parts of Hilbish, it’s made to be extensible and customizable. The default handler for completions in general can be overwritten to provide more advanced completions if needed.