docs: Describe how to escape keycodes with nvim_feedkeys (#12484)

Closes #12297
This commit is contained in:
Anmol Sethi 2020-07-01 21:57:03 -04:00 committed by GitHub
parent 267bc57d21
commit 2844cd54da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 0 deletions

View File

@ -729,6 +729,15 @@ nvim_feedkeys({keys}, {mode}, {escape_csi}) *nvim_feedkeys()*
On execution error: does not fail, but updates v:errmsg.
If you need to input sequences like <C-o> use nvim_replace_termcodes
to replace the termcodes and then pass the resulting string to
nvim_feedkeys. You'll also want to enable escape_csi.
Example: >
:let key = nvim_replace_termcodes("<C-o>", v:true, v:false, v:true)
:call nvim_feedkeys(key, 'n', v:true)
<
Parameters: ~
{keys} to be typed
{mode} behavior flags, see |feedkeys()|

View File

@ -203,6 +203,16 @@ Integer nvim_get_hl_id_by_name(String name)
/// flags. This is a blocking call, unlike |nvim_input()|.
///
/// On execution error: does not fail, but updates v:errmsg.
//
// If you need to input sequences like <C-o> use nvim_replace_termcodes
// to replace the termcodes and then pass the resulting string to
// nvim_feedkeys. You'll also want to enable escape_csi.
///
/// Example:
/// <pre>
/// :let key = nvim_replace_termcodes("<C-o>", v:true, v:false, v:true)
/// :call nvim_feedkeys(key, 'n', v:true)
/// </pre>
///
/// @param keys to be typed
/// @param mode behavior flags, see |feedkeys()|