README

X-Ray for Kirby

X-Ray provides a comprehensive overview of the content present on your site and individual pages, allowing you to inspect and evaluate them at a glance.

Overview

• 1. Installation
• 2. Usage
• 3. Options
• 4. License
• 5. Credits

Installation

Composer

composer require beebmx/kirby-x-ray

Usage

X-Ray adds a new panel area, and by default, it is already configured to be accessible from the panel navigation, but you can customize it with different options.

Overview section

The overview section provides a quick summary of the content on your site, including site or page overview, pages and files displayed, and their sizes. By default, it shows the site or page overview, but you can change the view to files or pages using the option with the proper enum.

use Beebmx\KirbyXRay\Enums\FilterType;

'beebmx.x-ray' => [
    'overview' => FilterType::Files,
],

Note

You can choose between FilterType::Page, FilterType::Files, and FilterType::Pages to change the default view of the overview section.

Note

X-Ray supports light and dark modes, so it will adapt to the current panel theme.

Page button

For your convenience, X-Ray comes with the ability to add a button to the page panel that allows you to quickly access the X-Ray details of the current page.

buttons:
  x-ray: true     # Enable the button in the page panel
  settings: true

Note

If a user doesn’t have permission to access X-Ray, the button will be disabled and the area won’t be accessible (see Permissions).

Permissions

By default, X-Ray is enabled for all users (with panel access), but you can restrict access to it by setting a custom permission in your user roles.

# site/blueprints/users/editor.yml

title: Editor
permissions:
  access:
    x-ray: false

Options

Here's an example of a full use of the options from the config.php file:

use Beebmx\KirbyXRay\Enums\FilterType;

'beebmx.x-ray' => [
    'autoclean' => [
        'files' => true,
        'pages' => true,
    ],
    'cache' => true,
    'icon' => 'x-ray-icon',
    'limit' => [
        'overview' => 5,
        'resource' => 10,
    ],
    'title' => 'X Ray',
    'overview' => FilterType::Page,
],

License

Licensed under the MIT.

Credits

• Fernando Gutierrez @beebmx
• Jonas Ceja @jonatanjonas logo
• All Contributors