Getting Started

Kirby Minimap is a plugin for Kirby CMS. Install it, and a structured sidebar appears next to the site view and every page view – no license activation, no setup.

Step 1: Install the Plugin

composer require johannschopplich/kirby-minimap

Step 2: Start Using the Minimap

Open the site view or any page – the minimap appears on the right side of the Panel.

Navigation States

Beside the view, the minimap has two states. Hover the minimap and click the arrow button that appears near the top of its inner edge to switch between them:

1. Collapsed State
   Displays a minimal vertical indicator with a marker for each field and an icon for each block, and otherwise stays out of the way.
2. Expanded State
   Reveals the complete navigation interface, showing field names and block details.

The minimap remembers which of the two it was in across reloads.

Below Kirby's own menu breakpoint – 960 pixels, where the Panel folds its menu away – there is no room beside the view, so the minimap becomes an overlay over it. Its handle sits at the right edge of the screen and stays visible. The overlay starts closed on every load, and closes again when you pick an entry, click the view behind it, or open Kirby's menu: the two never share the screen.

Scroll Position

Navigation runs both ways. Every field and block currently in the viewport is marked active in the minimap, so scrolling the form moves the highlight along with it – in the collapsed state too, where the markers are the only cue to where you are in a long blueprint.

Tab Awareness

The minimap is tab-aware: when your blueprint uses tabs, the minimap displays only the fields from the currently active tab.