Download the PHP package moinframe/kirby-accessibility-check without Composer
On this page you can find all versions of the php package moinframe/kirby-accessibility-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download moinframe/kirby-accessibility-check
More information about moinframe/kirby-accessibility-check
Files in moinframe/kirby-accessibility-check
Package kirby-accessibility-check
Short Description Kirby plugin to add accessibility checks
License MIT
Homepage https://github.com/moinframe/kirby-accessibility-check
Informations about the package 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 is used and added via CDN. Additional providers such as Editoria11y can be enabled via configuration.
Features
- Adds accessibility check button to panel
- Only active when editor chooses to enable it (uses session)
- Automatically includes required assets when active
Installation
There are three options to install the plugin.
Download
Download and copy this repository to /site/plugins/accessibility-check.
Git submodule
Composer
Setup
This plugin registers a new panel view button you can use in your page blueprints.
Configuration
You can configure the plugin in your site/config/config.php file:
Providers
The plugin can render one or more accessibility tools ("providers") when an editor
enables the check. Choose them with the providers option:
| Name | Tool | Notes |
|---|---|---|
sa11y |
Sa11y | Default. WCAG checker overlay. |
editoria11y |
Editoria11y | Alternative editor-focused checker |
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:
For full control over the markup, you can still override the whole snippet
at site/snippets/accessibility-check/providers/sa11y.php.
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:
License
MIT
Credits
- Justus Kraft
- Accessibility quality assurance tool Sa11y
- Accessibility checker Editoria11y