grommasdietz/kirby-blueprint-areas

Add custom Panel areas via blueprints on Kirby CMS

2.0.0 2026-07-22 19:05 UTC

Requires

• php: ^8.2
• getkirby/composer-installer: ^1.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.93
• getkirby/cms: ^5.5.2
• phpunit/phpunit: ^12.5
• vimeo/psalm: ^6.15

Conflicts

• getkirby/cms: <5.5.2

MIT

• Grommas Dietz

• panel
• Settings
• blueprints
• kirby
• kirby-plugin
• kirby-cms
• kirby5

Published on Packagist.org on 2026-07-22 19:05 UTC

README

Add custom Panel areas via blueprints on Kirby CMS.

Requirements

• Kirby 5.5.2+
• PHP 8.2+

Installation

composer require grommasdietz/kirby-blueprint-areas

Tip

For a manual install, download the Source code (zip) archive of an immutable GitHub release tag and copy it to site/plugins/kirby-blueprint-areas.

Quickstart

Create blueprints in site/blueprints/areas. Define title, icon, and your desired content:

# site/blueprints/areas/namespace.yml
title: Namespace
icon: box

tabs:
  content:
    label: Content
    columns:
      - width: 1/1
        sections:
          settings:
            type: fields
            fields:
              headline:
                label: Headline
                type: text

Each blueprint will render as an own area. Each area saves content to site model by default. Optionally change resolved model (like a page) with query or restrict users access.

Options

Configure via site/config/config.php:

return [
  'grommasdietz.blueprint-areas' => [
    'panel' => [
      // Show/hide all auto-registered menu entries
      'enabled'    => true,

      // Show a numeric badge instead of a dot on menu items
      'badgeCount' => false,

      // Optional collision-safe Panel ID prefix; empty keeps existing URLs
      'areaPrefix' => '',
    ],

    // Override the blueprint directory
    'blueprints.root' => kirby()->root('blueprints') . '/areas',

    'api' => [
      // Keep accepting legacy direct-value API payloads
      'legacyPayload' => true,
    ],
  ]
];

Documentation

Full reference for usage, contributions and maintenance lives in documentation.

Changelog

See CHANGELOG.md for version history and changes.

Security

See SECURITY.md for security policies and reporting vulnerabilities.

Contributing

See CONTRIBUTING.md for guidance and expectations.

License