johannschopplich / kirby-minimap
Sidebar content navigation for the Kirby Panel
Package info
github.com/johannschopplich/kirby-minimap
Language:Vue
Type:kirby-plugin
pkg:composer/johannschopplich/kirby-minimap
Fund package maintenance!
Requires
- php: >=8.2
- getkirby/composer-installer: ^1
- johannschopplich/kirby-tools-utils: ^0.1
Requires (Dev)
- getkirby/cms: ^5
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Kirby Minimap
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. It lists the fields and blocks of the current Panel tab, marks the ones in view as you scroll, and scrolls to the one you click. Made for long blueprints.
Features
- 🖱️ Jump to a Field or Block: Click an entry and the Panel scrolls it into the middle of the view, with a short pulse on blocks.
- 🎬 Blocks by Icon and First Words: Blocks fields unfold into their blocks, each with the fieldset's icon and the first 50 characters of text.
- 🫴 See Where You Are: Fields and blocks in view are marked in the sidebar as you scroll, and required fields carry a star. The sidebar collapses to a strip of dashes and remembers its state.
Requirements
- Kirby 4 or Kirby 5
Installation
Composer (Recommended)
composer require johannschopplich/kirby-minimap
Manual Installation
Download and copy this repository to /site/plugins/kirby-minimap.
Documentation
For installation, configuration, and usage, see the Kirby Minimap documentation.
License
MIT License © 2025-PRESENT Johann Schopplich