aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorbfredl <bjorn.linse@gmail.com>2023-07-03 09:53:27 +0200
committerGitHub <noreply@github.com>2023-07-03 09:53:27 +0200
commitf771d6247147b393238fe57065a96fb5e9635358 (patch)
treefa544c99d54078d46212bd665050c73593f26a2b /runtime/doc
parent4fd852b8cb88ed035203d3f9ae2e6a8258244974 (diff)
parent981acc2922ce9a5f214ba14acbb1e444748855f2 (diff)
downloadrneovim-f771d6247147b393238fe57065a96fb5e9635358.tar.gz
rneovim-f771d6247147b393238fe57065a96fb5e9635358.tar.bz2
rneovim-f771d6247147b393238fe57065a96fb5e9635358.zip
Merge pull request #23891 from rickyz/grid_line_flags
fix(ui): propagate line flags on grid_line events
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/ui.txt22
1 files changed, 14 insertions, 8 deletions
diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt
index 1391ef2808..360189e928 100644
--- a/runtime/doc/ui.txt
+++ b/runtime/doc/ui.txt
@@ -78,14 +78,14 @@ Example of a typical "redraw" batch in a single RPC notification: >
[
['grid_resize', [2, 77, 36]],
['grid_line',
- [2, 0, 0, [[' ' , 0, 77]]],
- [2, 1, 0, [['~', 7], [' ', 7, 76]]],
- [2, 9, 0, [['~', 7], [' ', 7, 76]]],
+ [2, 0, 0, [[' ' , 0, 77]], false],
+ [2, 1, 0, [['~', 7], [' ', 7, 76]], false],
+ [2, 9, 0, [['~', 7], [' ', 7, 76]], false],
...
- [2, 35, 0, [['~', 7], [' ', 7, 76]]],
- [1, 36, 0, [['[', 9], ['N'], ['o'], [' '], ['N'], ['a'], ['m'], ['e'], [']']]],
- [1, 36, 9, [[' ', 9, 50]]],
- [1, 36, 59, [['0', 9], [','], ['0'], ['-' ], ['1'], [' ', 9, 10], ['A'], ['l', 9, 2]]]
+ [2, 35, 0, [['~', 7], [' ', 7, 76]], false],
+ [1, 36, 0, [['[', 9], ['N'], ['o'], [' '], ['N'], ['a'], ['m'], ['e'], [']']], false],
+ [1, 36, 9, [[' ', 9, 50]], false],
+ [1, 36, 59, [['0', 9], [','], ['0'], ['-' ], ['1'], [' ', 9, 10], ['A'], ['l', 9, 2]], false]
],
['msg_showmode', [[]]],
['win_pos', [2, 1000, 0, 0, 77, 36]],
@@ -360,7 +360,7 @@ numerical highlight ids to the actual attributes.
use the |hl-Pmenu| family of builtin highlights.
*ui-event-grid_line*
-["grid_line", grid, row, col_start, cells] ~
+["grid_line", grid, row, col_start, cells, wrap] ~
Redraw a continuous part of a `row` on a `grid`, starting at the column
`col_start`. `cells` is an array of arrays each with 1 to 3 items:
`[text(, hl_id, repeat)]` . `text` is the UTF-8 text that should be put in
@@ -379,6 +379,12 @@ numerical highlight ids to the actual attributes.
enough to cover the remaining line, will be sent when the rest of the
line should be cleared.
+ `wrap` is a boolean indicating that this line wraps to the next row.
+ When redrawing a line which wraps to the next row, Nvim will emit a
+ `grid_line` event covering the last column of the line with `wrap` set
+ to true, followed immediately by a `grid_line` event starting at the
+ first column of the next row.
+
["grid_clear", grid] ~
Clear a `grid`.