docs(help): prompt.enter {supressExit} parameter

pull/14/head release/0.9.5
Iron-E 3 years ago
parent a389bc6d4e
commit 3b85822b91
No known key found for this signature in database
GPG Key ID: 19B71B7B7B021D22

@ -1140,7 +1140,7 @@ FUNCTIONS *libmodal-lua-Prompt-functions*
<
*libmodal-lua-Prompt.new()*
`Prompt`.new({name}, {instruction} [, {completions}])
`Prompt`.new({name}, {instruction} [, {completions}, {supressExit}])
User input is taken using |input()|. It is passed through a |g:var|
determined by the {name} of the mode. For example, if {name} is "FOO"

@ -236,8 +236,8 @@ FUNCTIONS *libmodal-usage-function
|nvim_set_keymap()| For more information about {keymap}.
*libmodal-prompt* *libmodal#Prompt()* *libmodal.prompt.enter()*
`libmodal.prompt`.enter({name}, {instruction} [, {completions}])
`libmodal`#Prompt({name}, {instruction} [, {completions}])
`libmodal.prompt`.enter({name}, {instruction} [, {completions}, {supressExit}])
`libmodal`#Prompt({name}, {instruction} [, {completions}, {supressExit}])
Besides accepting user input like keys in |Normal-mode|, |libmodal| is
also capable of prompting the user for |input| like |Cmdline-mode|. To
@ -301,6 +301,17 @@ FUNCTIONS *libmodal-usage-function
Note: If no `help` command is defined, one will be created
automatically.
{supressExit} Whether or not to automatically exit the mode upon an
<Esc> press.
- If |v:false|/`false`, then <Esc> is automatically mapped to
exiting.
- If |v:true|/`true`, then <Esc> is ignored unless specified by
the user. In such cases, the user should set the
`g:`{name}`ModeExit` variable to `true` when exiting is
desired. See |libmodal-examples-supress-exit|.
See also: ~
|lua-eval| For type conversions between Vimscript to |Lua|.
|libmodal-examples-prompt| For examples of this function.

Loading…
Cancel
Save