This plugin adds the A11yFirst Link button to the editor toolbar. It provides authors with features for ensuring that the display text of a link is accessible for people with disabilities.
It is a replacement for the standard Link plugin.
The A11yFirst Link plugin has all the features of the standard Link plugin, but adds additional validation of the link display text to check for common accessibility issues.
For example, the plugin checks for display text that does not describe the target of the link, e.g "click here", "more", etc.
It prompts the author when a URL is used as the display text, as they are typically not very descriptive of the link target. However, they are allowed through a confirm dialog box, which warns the user of the accessibility problems of using the URL.
In general, this plugin helps authors understand the importance of display text in describing the target of a link as accurately and succinctly as possible.
Display Text Validation
- Does not allow empty Display Text
- Does not default to using the URL as the Display Text
- Warns when a URL is used as the Display Text
- Detects the use of ‘click here,’ ‘more’ et al.
The help command opens the A11yFirst Help plugin option to help authors learn more about the accessibility issues related to the display text for links and the importance of descriptive display text.
NOTE: The help feature is dependent on the A11yFirst Help plugin being installed.
The recommended way to install all CKEditor add-ons is to create a custom build by using Online builder. To do that, click the Add to my editor button on the plugin page. When you are done, click the Build my editor button on the right side of the page to go to Online builder.
Note: This add-on is already selected to be a part of your current build.
Add-on installation instructions
If you want to add the plugin manually, you will need to:
- Extract the downloaded plugin
pluginsfolder of your CKEditor installation. Example:
- Enable the plugin by using the
extraPluginsconfiguration setting. Example:
config.extraPlugins = 'a11ylink';
- Download and configure all its dependencies, too.
Note: The plugin may have additional requirements. Check the add-on page and documentation for more details.