Adds mouse features to neovim using nvim-orgmode.
Requires neovim 0.9.2+.
This plugin depends on nvim-orgmode/orgmode.
Code Example
{
"chipsenkbeil/org-mouse.nvim",
dependencies = { "nvim-orgmode/orgmode" },
config = function()
require("org-mouse").setup()
end
}
Code Example
use {
"chipsenkbeil/org-mouse.nvim",
requires = { "nvim-orgmode/orgmode" },
config = function()
require("org-mouse"):setup()
end
}
![](https://private-user-images.githubusercontent.com/2481802/321439690-f0e475e8-ba8c-44dc-a81e-e44321415cc6.gif?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAyODg3MzYsIm5iZiI6MTcyMDI4ODQzNiwicGF0aCI6Ii8yNDgxODAyLzMyMTQzOTY5MC1mMGU0NzVlOC1iYThjLTQ0ZGMtYTgxZS1lNDQzMjE0MTVjYzYuZ2lmP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDZUMTc1MzU2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YWExNTVhNzBiZmEyZDViZTk2NTdlOTRiN2U5ZjYzNjI4MTI3N2I0ZjU1YTUyZjgyMjkwOTQxMjRkNzNlNjBlNCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.KZuXeJobw_vW7gJHHC1dotT8pTdLkgRSd64LbKJIVJw)
![](https://private-user-images.githubusercontent.com/2481802/321439686-0644fd1b-437a-418a-937e-caf20eac945e.gif?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAyODg3MzYsIm5iZiI6MTcyMDI4ODQzNiwicGF0aCI6Ii8yNDgxODAyLzMyMTQzOTY4Ni0wNjQ0ZmQxYi00MzdhLTQxOGEtOTM3ZS1jYWYyMGVhYzk0NWUuZ2lmP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDZUMTc1MzU2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YmUxNGQ5YWVjYjMwMDZkZTEzMzgwMDU2ZmJjMDgwNGE4MDM3NjM5MzAxYzkxMjUzZWJmZmRmNDA2MWU4NmU4NCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.f-o7iRqWymc-rt6qRcJglS3BiraIbPMe8eDZ-mGSyOE)
If true, clicking on links will open them.
Takes a boolean. Defaults to true
.
require("org-mouse"):setup({
click_open_links = false,
})
If true, highlights links when mousing over them.
This will enable vim.opt.mouseoverevent
if disabled!
Takes a boolean. Defaults to true
.
require("org-mouse"):setup({
highlight_links = false,
})
Highlight group to apply when highlighting links.
Takes a string. Defaults to WarningMsg
.
require("org-mouse"):setup({
highlight_links_group = "Comment",
})
Specifies filetypes where mouse events will be bound.
This is leveraged during setup to configure a FileType
autocmd to attach
keybindings for <MouseMove>
and <LeftRelease>
to support mouse
interactions.
Takes a list of strings. Defaults to {"org", "org-*"}
.
Notice that the strings are in pattern format, meaning you can use wildcards to support multiple filetypes.
require("org-mouse"):setup({
filetypes = { "org", "org-*", "org-custom-*" },
})