|
| 1 | +*nvim-activate* |
| 2 | + |
| 3 | +Authors: Tom Kuson <mail@tjkuson.me> |
| 4 | +Version: NA |
| 5 | +Homepage: <https://github.com/tjkuson/nvim-activate> |
| 6 | + |
| 7 | +============================================================================== |
| 8 | +INTRODUCTION *nvim-activate* |
| 9 | + |
| 10 | +A plugin to display reminder the bottom-right corner of the editor to |
| 11 | +activate Neovim. |
| 12 | + |
| 13 | +============================================================================== |
| 14 | +CONFIGURATION *NvimActivate.config* |
| 15 | + |
| 16 | +This plugin is intentionally minimal and has no options. |
| 17 | + |
| 18 | +Use autocommands to control visibility in contexts (see |
| 19 | +|nvim-activate-recipes| and |nvim-activate-setup| section notes about |
| 20 | +|vim.b.nvimactivate_disable|). |
| 21 | + |
| 22 | +Note: calling |setup()| is not required to initialize the plugin. |
| 23 | +You can disable globally or per-buffer: |
| 24 | +> |
| 25 | + vim.g.nvimactivate_disable = true |
| 26 | + -- or |
| 27 | + vim.b.nvimactivate_disable = true |
| 28 | +< |
| 29 | + |
| 30 | +============================================================================== |
| 31 | +COMMANDS *nvim-activate-commands* |
| 32 | + |
| 33 | +The plugin provides these user commands: |
| 34 | +> |
| 35 | + :NvimActivateShow |
| 36 | + :NvimActivateHide |
| 37 | + :NvimActivateToggle |
| 38 | +< |
| 39 | + |
| 40 | +============================================================================== |
| 41 | +RECIPES *nvim-activate-recipes* |
| 42 | + |
| 43 | +Hide after a delay on startup: |
| 44 | + |
| 45 | +Vimscript: |
| 46 | +> |
| 47 | + autocmd VimEnter * ++once lua vim.defer_fn(function() |
| 48 | + vim.g.nvimactivate_disable = true |
| 49 | + require("nvim-activate").hide() |
| 50 | + end, 1500) |
| 51 | +< |
| 52 | + |
| 53 | +Lua: |
| 54 | +> |
| 55 | + vim.api.nvim_create_autocmd("VimEnter", { |
| 56 | + once = true, |
| 57 | + callback = function() |
| 58 | + vim.defer_fn(function() |
| 59 | + vim.g.nvimactivate_disable = true |
| 60 | + require("nvim-activate").hide() |
| 61 | + end, 1500) |
| 62 | + end, |
| 63 | + }) |
| 64 | +< |
| 65 | + |
| 66 | +Hide during Insert mode, show on exit: |
| 67 | + |
| 68 | +Vimscript: |
| 69 | +> |
| 70 | + autocmd InsertEnter * NvimActivateHide |
| 71 | + autocmd InsertLeave * NvimActivateShow |
| 72 | +< |
| 73 | + |
| 74 | +Lua: |
| 75 | +> |
| 76 | + vim.api.nvim_create_autocmd("InsertEnter", { |
| 77 | + callback = function() require("nvim-activate").hide() end, |
| 78 | + }) |
| 79 | + vim.api.nvim_create_autocmd("InsertLeave", { |
| 80 | + callback = function() require("nvim-activate").show() end, |
| 81 | + }) |
| 82 | +< |
| 83 | + |
| 84 | +Enable only in specific filetypes (when globally disabled): |
| 85 | + |
| 86 | +Vimscript: |
| 87 | +> |
| 88 | + let g:nvimactivate_disable = v:true |
| 89 | + augroup NvimActivateExamples |
| 90 | + autocmd! |
| 91 | + autocmd FileType lua,python let b:nvimactivate_disable = v:false |
| 92 | + augroup END |
| 93 | +< |
| 94 | + |
| 95 | +Lua: |
| 96 | +> |
| 97 | + vim.g.nvimactivate_disable = true |
| 98 | + local grp = vim.api.nvim_create_augroup("NvimActivateExamples", { clear = true }) |
| 99 | + vim.api.nvim_create_autocmd("FileType", { |
| 100 | + group = grp, |
| 101 | + pattern = { "lua", "python" }, |
| 102 | + callback = function() |
| 103 | + vim.b.nvimactivate_disable = false |
| 104 | + end, |
| 105 | + }) |
| 106 | +< |
| 107 | +------------------------------------------------------------------------------ |
| 108 | +vim:tw=78:ts=8:ft=help:norl: |
0 commit comments