PHPackages                             beebmx/kirby-x-ray - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. beebmx/kirby-x-ray

ActiveKirby-plugin[Utility & Helpers](/categories/utility)

beebmx/kirby-x-ray
==================

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.

1.0.5(6mo ago)12656—10%MITPHPCI passing

Since Aug 20Pushed 6mo ago1 watchersCompare

[ Source](https://github.com/beebmx/kirby-x-ray)[ Packagist](https://packagist.org/packages/beebmx/kirby-x-ray)[ Docs](https://github.com/beebmx/kirby-x-ray)[ GitHub Sponsors](https://github.com/beebmx)[ RSS](/packages/beebmx-kirby-x-ray/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (5)Versions (7)Used By (0)

[![X-Ray Logo](/.github/assets/logo.svg?raw=true)](https://github.com/beebmx/kirby-x-ray)

[![Build Status](https://camo.githubusercontent.com/73afffe9c303c8506f3ea16020bf1475d663645f50304ec911cad1abfc10795f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f626565626d782f6b697262792d782d7261792f74657374732e796d6c3f6272616e63683d6d61696e)](https://github.com/beebmx/kirby-x-ray/actions)[![Total Downloads](https://camo.githubusercontent.com/0293fdcc928d3de77ee12c6db4939dada34429da2d99253737849f5499931e8f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f626565626d782f6b697262792d782d726179)](https://packagist.org/packages/beebmx/kirby-x-ray)[![Latest Stable Version](https://camo.githubusercontent.com/6ba3f20fff494ebd3ec6eae9490e63ad805dad9e81ce83ea4da12510b0309ea1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f626565626d782f6b697262792d782d726179)](https://packagist.org/packages/beebmx/kirby-x-ray)[![License](https://camo.githubusercontent.com/47ae6a4fc50d5d71a6199201bf94e0e0d3a48469fab8d27493d73215e30a2f03/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f626565626d782f6b697262792d782d726179)](https://packagist.org/packages/beebmx/kirby-x-ray)

X-Ray for Kirby
===============

[](#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.

[![X-Ray](/.github/assets/banner.jpg)](/.github/assets/banner.jpg)

---

Overview
--------

[](#overview)

- [1. Installation](#installation)
- [2. Usage](#usage)
- [3. Options](#options)
- [4. License](#license)
- [5. Credits](#credits)

Installation
------------

[](#installation)

### Composer

[](#composer)

```
composer require beebmx/kirby-x-ray

```

Usage
-----

[](#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

[](#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.

[![X-Ray preview](/.github/assets/preview.jpg)](/.github/assets/preview.jpg)

Note

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

### Page button

[](#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)).

### 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
-------

[](#options)

OptionTypeDefaultDescriptionbeebmx.x-ray.autoclean.files`bool`trueWhen this option is `true` and a `file` is changed, it will automatically reset the cache of the page.beebmx.x-ray.autoclean.pages`bool`trueWhen this option is `true` and a `page` is changed, it will automatically reset the cache of the page.beebmx.x-ray.cache`bool`trueWhen this option is `true`, it will cache the data of the `site` and `pages` inspected.beebmx.x-ray.icon`string`x-ray-iconWith this option, you can change the `default` icon of the area and the buttons.beebmx.x-ray.limit.overview`int`5The number of rows displayed in the `overview` section.beebmx.x-ray.limit.resource`int`10The number of rows displayed in the full table (resources) section.beebmx.x-ray.title`string`X RayThe title of the area.beebmx.x-ray.overview`enum`FilterType::PageThe `default` view in the `overview` section.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
-------

[](#license)

Licensed under the [MIT](LICENSE.md).

Credits
-------

[](#credits)

- Fernando Gutierrez [@beebmx](https://github.com/beebmx)
- Jonas Ceja [@jonatanjonas](https://github.com/jonatanjonas) `logo`
- [All Contributors](../../contributors)

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance68

Regular maintenance activity

Popularity24

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~15 days

Total

6

Last Release

186d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/434a3fd09c4701e824184e720b3d2fd97814ed8d1275417f6762c411bf146328?d=identicon)[beebmx](/maintainers/beebmx)

---

Top Contributors

[![beebmx](https://avatars.githubusercontent.com/u/2191576?v=4)](https://github.com/beebmx "beebmx (6 commits)")

---

Tags

kirby-pluginkirby5statskirbykirby-pluginkirby5X-Rayxray

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/beebmx-kirby-x-ray/health.svg)

```
[![Health](https://phpackages.com/badges/beebmx-kirby-x-ray/health.svg)](https://phpackages.com/packages/beebmx-kirby-x-ray)
```

###  Alternatives

[beebmx/kirby-env

Enable env variables to Kirby

2037.9k2](/packages/beebmx-kirby-env)[oblik/kirby-link-field

Kirby 4 field for all types of links.

7650.6k2](/packages/oblik-kirby-link-field)[belugadigital/kirby-navigation

Kirby 5 field for hierarchical menus with drag & drop level indentation.

8713.4k](/packages/belugadigital-kirby-navigation)[bnomei/kirby3-dotenv

Kirby Plugin for environment variables from .env

4144.1k1](/packages/bnomei-kirby3-dotenv)[tobimori/kirby-icon-field

A simple Icon field plugin for Kirby CMS

5117.1k1](/packages/tobimori-kirby-icon-field)[tobimori/kirby-tailwind-merge

Tailwind Merge for Kirby CMS

276.3k](/packages/tobimori-kirby-tailwind-merge)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)