PHPackages                             femundfilou/kirby-accessibility-check - 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. femundfilou/kirby-accessibility-check

Abandoned → [moinframe/kirby-accessibility-check](/?search=moinframe%2Fkirby-accessibility-check)Kirby-plugin[Utility & Helpers](/categories/utility)

femundfilou/kirby-accessibility-check
=====================================

Kirby plugin to add accessibility checks

1.1.0(2w ago)1018MITPHP

Since Jan 2Pushed 2w ago1 watchersCompare

[ Source](https://github.com/femundfilou/kirby-accessibility-check)[ Packagist](https://packagist.org/packages/femundfilou/kirby-accessibility-check)[ Docs](https://github.com/moinframe/kirby-accessibility-check)[ RSS](/packages/femundfilou-kirby-accessibility-check/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (4)Dependencies (6)Versions (4)Used By (0)

Kirby Accessibility Check
=========================

[](#kirby-accessibility-check)

This plugin adds accessibility checking capabilities to your Kirby CMS powered website. With the panel button, editors can enable an accessibility overlay to easily spot issues in the frontend of your website. By default, the Accessibility quality assurance tool [Sa11y](https://github.com/ryersondmp/sa11y) is used and added via CDN. Additional providers such as [Editoria11y](https://github.com/itmaybejj/editoria11y) can be enabled via [configuration](#providers).

Features
--------

[](#features)

- Adds accessibility check button to panel
- Only active when editor chooses to enable it (uses session)
- Automatically includes required assets when active

[![Plugin in action](kirby-accessibility-check.gif)](kirby-accessibility-check.gif)

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

[](#installation)

There are three options to install the plugin.

### Download

[](#download)

Download and copy this repository to `/site/plugins/accessibility-check`.

### Git submodule

[](#git-submodule)

```
git submodule add https://github.com/moinframe/kirby-accessibility-check.git site/plugins/accessibility-check
```

### Composer

[](#composer)

```
composer require moinframe/kirby-accessibility-check
```

Setup
-----

[](#setup)

This plugin registers a new panel view button you can use in your page blueprints.

```
# site/blueprints/pages/default.yml

buttons:
 # new button
 - accessibility-check
 # default buttons
 - preview
 - languages
 - settings
 - status
```

Configuration
-------------

[](#configuration)

You can configure the plugin in your `site/config/config.php` file:

```
return [
    // Enable/disable the plugin entirely
    'moinframe.accessibility-check.enabled' => true, // default: true

    // Which providers to render when the check is enabled.
    // Available: 'sa11y', 'editoria11y'
    'moinframe.accessibility-check.providers' => ['sa11y'], // default: ['sa11y']

    // Which Sa11y release to load ('latest' or a pinned version like '5.0.8')
    'moinframe.accessibility-check.sa11y.version' => 'latest', // default: 'latest'

    // Load Sa11y from the jsDelivr CDN. Set to false to self-host.
    'moinframe.accessibility-check.sa11y.cdn' => true, // default: true

    // When `cdn` is false, point this at your copy of Sa11y's `dist`
    // folder (no trailing slash). Required for self-hosting.
    'moinframe.accessibility-check.sa11y.assets' => '/assets/sa11y', // default: null

    'moinframe.accessibility-check.editoria11y.version' => 'latest', // default: 'latest'
    'moinframe.accessibility-check.editoria11y.cdn' => true,         // default: true
    'moinframe.accessibility-check.editoria11y.assets' => '/assets/editoria11y', // default: null
];
```

Providers
---------

[](#providers)

The plugin can render one or more accessibility tools ("providers") when an editor enables the check. Choose them with the `providers` option:

NameToolNotes`sa11y`[Sa11y](https://github.com/ryersondmp/sa11y)Default. WCAG checker overlay.`editoria11y`[Editoria11y](https://github.com/itmaybejj/editoria11y)Alternative editor-focused checkerSelf-hosting Sa11y
------------------

[](#self-hosting-sa11y)

To avoid the CDN, set `sa11y.cdn` to `false` and copy Sa11y's `dist`folder somewhere public (e.g. `assets/sa11y/dist/...`), then point `sa11y.assets` at it. The plugin expects the standard Sa11y layout below the base URL:

```
/css/sa11y.min.css
/js/lang/.umd.js
/js/sa11y.umd.min.js

```

For full control over the markup, you can still override the whole snippet at `site/snippets/accessibility-check/providers/sa11y.php`.

Self-hosting Editoria11y
------------------------

[](#self-hosting-editoria11y)

Same idea for Editoria11y: set `editoria11y.cdn` to `false` and point `editoria11y.assets` at your copy of its `dist` folder. The expected layout is:

```
/css/editoria11y.min.css
/js/lang/.umd.js
/js/ed11y.umd.min.js

```

License
-------

[](#license)

MIT

Credits
-------

[](#credits)

- [Justus Kraft](https://moinfra.me)
- Accessibility quality assurance tool [Sa11y](https://github.com/ryersondmp/sa11y)
- Accessibility checker [Editoria11y](https://github.com/itmaybejj/editoria11y)

###  Health Score

42

—

FairBetter than 88% of packages

Maintenance96

Actively maintained with recent releases

Popularity14

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

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 ~284 days

Total

3

Last Release

18d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bf9d09693dffe919aa833f7808c30813768f221bde1d76fe55b2adbf9130bfdc?d=identicon)[moinframe](/maintainers/moinframe)

---

Top Contributors

[![JuKra00](https://avatars.githubusercontent.com/u/2682834?v=4)](https://github.com/JuKra00 "JuKra00 (14 commits)")

---

Tags

plugincheckcmsaccessibilitykirby

###  Code Quality

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/femundfilou-kirby-accessibility-check/health.svg)

```
[![Health](https://phpackages.com/badges/femundfilou-kirby-accessibility-check/health.svg)](https://phpackages.com/packages/femundfilou-kirby-accessibility-check)
```

###  Alternatives

[getkirby/cms

The Kirby core

1.5k606.6k535](/packages/getkirby-cms)[medienbaecker/kirby-modules

Easily add modules to your pages

895.6k1](/packages/medienbaecker-kirby-modules)[getkirby/starterkit

Kirby Starterkit

20413.9k](/packages/getkirby-starterkit)[getkirby/plainkit

Kirby Plainkit

11911.9k1](/packages/getkirby-plainkit)[getkirby/geo

Kirby Geo

224.0k](/packages/getkirby-geo)[belugadigital/kirby-navigation

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

8615.1k](/packages/belugadigital-kirby-navigation)

PHPackages © 2026

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