See more details in Features and Documentation.
Note
This was previously hosted at a personal echasnovski GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details here.
⦿ This is a part of mini.nvim library. Please use this link if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See whole library documentation to learn about general design principles, disable/configuration recipes, and more.
⦿ See MiniMax for a full config example that uses this module.
If you want to help this project grow but don't know where to start, check out contributing guides of 'mini.nvim' or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
demo-map.mp4
Show and manage special floating window displaying automatically updated overview of current buffer text. Window takes up whole height of Neovim instance and is fixed to a left/right side. Map content is computed by taking all current lines, converting it to binary whitespace/non-whitespace mask, rescaling to appropriate dimensions, and converting back to strings consisting from special encoding symbols. All this is done very fast and asynchronously.
See
:h MiniMap.open(),:h MiniMap.refresh(),:h MiniMap.close(),:h MiniMap.toggle(),:h MiniMap.toggle_side().For a general overview and tips, see
:h mini.map-usage.Show scrollbar next to map content. It represents current line and view (top and bottom visible lines). Can be the only thing shown, making map window a "pure scrollbar".
Highlight map lines representing certain data in current buffer. This is done via extensible set of callables, called integrations. There are pre-built generators for common integrations:
- Builtin search.
- Builtin diagnostic.
- General diff hunks provided by 'mini.diff'.
- Hunks provided by 'lewis6991/gitsigns.nvim'.
For more details see
:h MiniMap.gen_integration.
Focus on map window to quickly browse current (source) buffer. Moving inside map window updates cursor position in source window enabling fast and targeted buffer exploration. To focus back, hit
<CR>to accept current explored position or<Esc>to go back to original position. See:h MiniMap.toggle_focus().Customizable:
- Encoding symbols used to display binary information of different resolution (default is 3x2). There are pre-built generators for different basic character families and resolutions. See
:h MiniMap.gen_encode_symbols. - Scrollbar symbols, separate for line and view. Can have any width (even zero, which virtually disables scrollbar).
- Integrations producing map line highlights.
- Window options: side (left/right), width, 'winblend', and more.
- Encoding symbols used to display binary information of different resolution (default is 3x2). There are pre-built generators for different basic character families and resolutions. See
This plugin can be installed as part of 'mini.nvim' library (recommended) or as a standalone Git repository.
There are two branches to install from:
main(default, recommended) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).stablewill be updated only upon releases with code tested during public beta-testing phase inmainbranch.
Here are code snippets for some common installation methods (use only one):
(Recommended) With vim.pack (on Neovim 0.12 and newer)
Full library
Follow 'mini.nvim' installation.
Standalone plugin
Main branch:
vim.pack.add({ 'https://github.com/nvim-mini/mini.map' })Stable branch:
vim.pack.add({
{ src='https://github.com/nvim-mini/mini.map', version='stable' },
})With mini.deps (before Neovim 0.12)
Full library
Follow recommended 'mini.deps' installation.
Standalone plugin:
Main branch:
add('nvim-mini/mini.map')Stable branch:
add({ source='nvim-mini/mini.map', checkout='stable' })With folke/lazy.nvim
Full library
Follow 'mini.nvim' installation.
Standalone plugin
Main branch:
{ 'nvim-mini/mini.map', version=false },Stable branch:
{ 'nvim-mini/mini.map', version='*' },Important: don't forget to call require('mini.map').setup() to enable its functionality.
Note: if you are on Windows, there might be problems with too long file paths (like error: unable to create file <some file name>: Filename too long). Try doing one of the following:
- Enable corresponding git global config value:
git config --system core.longpaths true. Then try to reinstall. - Install plugin in other place with shorter path.
-- No need to copy this inside `setup()`. Will be used automatically.
{
-- Highlight integrations (none by default)integrations=nil,
-- Symbols used to display datasymbols= {
-- Encode symbols. See `:h MiniMap.config` for specification and-- `:h MiniMap.gen_encode_symbols` for pre-built ones.-- Default: solid blocks with 3x2 resolution.encode=nil,
-- Scrollbar parts for view and line. Use empty string to disable any.scroll_line='█',
scroll_view='┃',
},
-- Window optionswindow= {
-- Whether window is focusable in normal way (with `wincmd` or mouse)focusable=false,
-- Side to stick ('left' or 'right')side='right',
-- Whether to show count of multiple integration highlightsshow_integration_count=true,
-- Total widthwidth=10,
-- Value of 'winblend' optionwinblend=25,
-- Z-indexzindex=10,
},
}