Minimap package

A preview of the full source code.

Installation

apm install minimap

Features

Mouse wheel and click-to-scroll (no animation)
Drag-to-scroll

Settings

Auto Toggle: If checked the minimap is toggled on at startup. (default=true)
Display Code Highlights: If checked the code will be highlighted using the grammar tokens. (default=true)
Display Minimap On Left: If checked the minimap appears on the left side of editors, otherwise it appears on the ride side. (default=false)
Char Height: The height of a character in the minimap in pixels. (default=2)
Char Width: The width of a character in the minimap in pixels. (default=1)
Interline: The space between lines in the minimap in pixels. (default=1)
Text Opacity: The opacity used to render the line text in the minimap. (default=0.6)
Display Plugins Controls: If checked, the minimap plugins can be activated/deactivated from the minimap settings view and a quick settings dropdown will be available on the top right corner of the minimap. You need to restart Atom for this setting to be effective. (default=true)
Minimap Scroll Indicator: Toggles the display of a side line showing which part of the buffer is currently displayed by the minimap. The side line appear only if the minimap height is bigger than the editor view height. (default=true)
Plugins *: When plugins are installed, a setting is created for each to enable/disable them directly from the minimap settings view.
Use Hardware Acceleration: If checked the minimap scroll is done using a translate3d transform, otherwise the translate transform is used. (default=true)

Key Bindings

ctrl-k ctrl-m: Toggles the minimap.
ctrl-k ctrl-s: Toggles the minimap plugins quick settings dropdown.

Customizing Key Bindings:

'.editor':
  'cmd-m': 'minimap:toggle'

Customizing Style

If you want to hide the default editor scrollbar, edit your style.less (Open Your Stylesheet).

// hide scrollbar
.with-minimap .vertical-scrollbar {
  opacity: 0;
  width: 0;
}

Contributors

https://github.com/fundon/atom-minimap/graphs/contributors

Plugins

The minimap can be augmented with plugins.

Plugins can be created with the Minimap: Generate Plugin command available in the command palette.

Below is the list of available plugins so far:

When the displayPluginsControls setting is toggled on, plugins activation can be managed directly from the minimap package settings or by using the quick settings dropdown available on the mimimap itself:

Documentation

License

MIT

germ13/atom-minimap