diff --git a/doc/cinnamon.nvim.txt b/doc/cinnamon.nvim.txt index 7aeb15c..9779f5b 100644 --- a/doc/cinnamon.nvim.txt +++ b/doc/cinnamon.nvim.txt @@ -58,24 +58,24 @@ DEFAULT OPTIONS ~ return { -- Disable the plugin disabled = false, + keymaps = { -- Enable the provided 'basic' keymaps basic = false, -- Enable the provided 'extra' keymaps extra = false, }, + ---@class ScrollOptions options = { - -- Optional post-movement callback - callback = function() end, + -- The scrolling mode + -- `cursor`: animate cursor and window scrolling for any movement + -- `window`: animate window scrolling ONLY when the cursor moves out of view + mode = "cursor", + -- Delay between each movement step (in ms) delay = 5, - step_size = { - -- Number of cursor/window lines moved per step - vertical = 1, - -- Number of cursor/window columns moved per step - horizontal = 2, - }, + max_delta = { -- Maximum distance for line movements before scroll -- animation is skipped. Set to `false` to disable @@ -83,13 +83,20 @@ DEFAULT OPTIONS ~ -- Maximum distance for column movements before scroll -- animation is skipped. Set to `false` to disable column = false, - -- Maximum duration for a movement (in ms). Automatically scales the delay and step size + -- Maximum duration for a movement (in ms). Automatically scales the + -- delay and step size time = 1000, }, - -- The scrolling mode - -- `cursor`: animate cursor and window scrolling for any movement - -- `window`: animate window scrolling ONLY when the cursor moves out of view - mode = "cursor", + + step_size = { + -- Number of cursor/window lines moved per step + vertical = 1, + -- Number of cursor/window columns moved per step + horizontal = 2, + }, + + -- Optional post-movement callback. Not called if the movement is interrupted + callback = function() end, }, } <