aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
diff options
context:
space:
mode:
authorbfredl <bjorn.linse@gmail.com>2023-11-08 12:17:25 +0100
committerGitHub <noreply@github.com>2023-11-08 12:17:25 +0100
commit1b0fd377aba3b4d076e4dbfb5adb96866a4982d1 (patch)
tree460bbeada52d9b7bd3a1ad194224cec461f7f055 /runtime/doc/api.txt
parent4c8fdc018b428c4b5f35215a1189d2cd55cd5888 (diff)
parent4e6f559b8c5f77924fdbe2e5abd9c6aa8efad13f (diff)
downloadrneovim-1b0fd377aba3b4d076e4dbfb5adb96866a4982d1.tar.gz
rneovim-1b0fd377aba3b4d076e4dbfb5adb96866a4982d1.tar.bz2
rneovim-1b0fd377aba3b4d076e4dbfb5adb96866a4982d1.zip
Merge pull request #25767 from luukvbaal/signdel
feat(extmarks): add 'invalidate' property
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r--runtime/doc/api.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index edf683473f..b38524bd55 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -2707,6 +2707,12 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
the extmark end position (if it exists) will be shifted in
when new text is inserted (true for right, false for
left). Defaults to false.
+ • undo_restore : Restore the exact position of the mark if
+ text around the mark was deleted and then restored by
+ undo. Defaults to true.
+ • invalidate : boolean that indicates whether to hide the
+ extmark if the entirety of its range is deleted. If
+ "undo_restore" is false, the extmark is deleted instead.
• priority: a priority value for the highlight group or sign
attribute. For example treesitter highlighting uses a
value of 100.
@@ -2777,7 +2783,7 @@ nvim_set_decoration_provider({ns_id}, {*opts})
|nvim_buf_set_extmark()| can be called to add marks on a per-window or
per-lines basis. Use the `ephemeral` key to only use the mark for the
current screen redraw (the callback will be called again for the next
- redraw ).
+ redraw).
Note: this function should not be called often. Rather, the callbacks
themselves can be used to throttle unneeded callbacks. the `on_start`