Minimap package

A preview of the full source code.

Installation

apm install minimap

Features

Service-based Plugin API: Use the plugin generation command and start developing your plugin right away.
Decoration API: Use the same API to manage TextEditor and Minimap decorations.
Canvas-based Rendering: Simple, fast and flexible.

Available Plugins

Below is the list of available plugins so far:

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.
Scroll Animation: Enable animations when scrolling the editor by clicking on the Minimap.
Scroll Animation Duration: Duration of the scroll animation when clicking on the Minimap.
Use Hardware Acceleration: If checked the Minimap scroll is done using a translate3d transform, otherwise the translate transform is used. (default=true)

For instance the following result is obtained by setting a Char Height of 1px:

Key Bindings

Customizing Key Bindings:

'atom-workspace':
  'cmd-m': 'minimap:toggle'
  'ctrl-alt-cmd-m': 'minimap:generate-plugin'

Plugins

Plugin Generation Command

Use the Minimap: Generate Plugin command available in the command palette or add a binding to the minimap:generate-plugin event:

'atom-workspace':
  'ctrl-alt-cmd-m': 'minimap:generate-plugin'

Plugins Controls

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 Decorations

The Minimap package mimic the decoration API available on editors so that you can easily add your own decorations on the Minimap.

While the interface is the same, some details such as the available decorations types change relatively to the editor's decorations API.

Scope And Styling

The most important change is that decorations on the Minimap doesn't use a class, but rather a scope

minimapView.decorateMarker(marker, type: 'line', scope: '.scope .to .the.marker.style')

It's still possible to pass a class parameter to the decoration:

minimapView.decorateMarker(marker, type: 'line', class: 'the marker style')

In that case, when rendering the decoration a scope will be build that will look like .minimap .editor .the.marker.style.

The reason of using a scope rather than a class is that while editor's decorations are part of the DOM and benefit of the styles cascading, Minimap's decorations, rendered in a canvas, do not. In order to work around that, decoration's styles are defined using a scope property containing the selector allowing to retrieve the decoration style.

This allow the Minimap decorations to still be styled using css. For instance, the scope used by the minimap-selection package is:

.minimap .editor .selection .region {
  /* ... */
}

Note that the scope is prefixed with .minimap so that you can override the selection style in the Minimap without impacting the editor's one.

Also note that only the background property will be retrieved to style a decoration.

A last option is to pass a css color directly in a color option, such as:

minimapView.decorateMarker(marker, type: 'line', color: '#ff0000')

In that case neither the scope nor the class will be used.

Decorations Types

Another non-trivial change is the list of available decoration's type. At the time, the available types on the Minimap are:

line: Same as the editor one, it colors the line background with a color extracted from the decoration scope.
highlight-under: Correspond to an editor highlight decoration that is rendered before rendering the line content.
highlight-over, highlight: Correspond to an editor highlight decoration that is rendered after having rendered the line content.
highlight-outline: Correspond to an editor highlight decoration that is rendered only as an outline in the Minimap.

Tweaking The Minimap

Hiding scrollbars

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

atom-text-editor .vertical-scrollbar,
atom-text-editor::shadow .vertical-scrollbar {
  opacity: 0;
  width: 0;
}

Changing the Minimap's background

atom-text-editor::shadow atom-text-editor-minimap,
atom-text-editor atom-text-editor-minimap {
  background: rgba(255,255,255, 0.1);
}

Changing the color of the Minimap's `visible-area`

atom-text-editor::shadow atom-text-editor-minimap::shadow .minimap-visible-area,
atom-text-editor atom-text-editor-minimap::shadow .minimap-visible-area {
  background-color: green;
  opacity: .5;
}

Changing the color of the Minimap's `scroll-indicator`

atom-text-editor::shadow atom-text-editor-minimap::shadow .minimap-scroll-indicator,
atom-text-editor atom-text-editor-minimap::shadow .minimap-scroll-indicator {
  background-color: green;
}

Contributing

The Minimap package try to follow the Atom contribution guidelines.

Especially, the commits should follow the conventions defined in the Git Commit Messages section of the guideline.

The CHANGELOG content is then generated using the changelog-gen utils.

See all contributors

License

MIT

kosmika/minimap