Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 3.38 KB

Readme.md

File metadata and controls

86 lines (58 loc) · 3.38 KB

Minimap package Build Status

A preview of the full source code.

Minimap Screenshot

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=false)
  • Display Code Highlights: If checked the code will be highlighted using the grammar tokens.
  • Display Minimap On Left: If checked the minimap appears on the left side of editors, otherwise it appears on the ride side. (default=false)
  • 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.
  • Line Overdraw: The amount of lines that are rendered past the bounds of the editor view. Smaller values may result in more updates but with less lines rendered each time while larger values will reduce the latency between a scroll and the display of the previously hidden lines at the cost of a bigger update time.
  • 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
  • Plugins *: When plugins are installed, a setting is created for each to enable/disable them directly from the minimap settings view.
  • Scale: The scale of the minimap.
  • Use Hardware Acceleration: If checked the minimap scroll is done using a translate3d transform, otherwise the translate transform is used.

Key Bindings

  • ctrl-k ctrl-m: Toggles the minimap without the logs.
  • ctrl-k ctrl-d: Toggles the minimap with the logs.
  • ctrl-k ctrl-s: Toggles the minimap plugins quick settings dropdown.

Customizing Key Bindings:

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

Customizing Style

If you want to use another font instead of the default [Redacted][] font or change any styles, edit your style.less (Open Your Stylesheet).

.minimap .lines {
  font-family: Monaco;
}

// 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, belows 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:

Minimap Screenshot

Wiki

License

MIT