- Installation Guides
- Browser Support
- Languages Support
- Shortcuts
- Activation
- Examples
- Customize the Editor
- Use-cases
- Plugins
- APIs
- Development Frameworks
- Server Integrations
- Server SDKs
- Migration Guides
- Changelog
- Tutorials
- Froala Docs
- /
- Plugins
- /
- Accessibility Checker Plugin
Accessibility Checker Plugin
Plugins are fully functional during your trial once you've added your trial key to the setup.
Scan your content against WCAG while people write, review each finding in a small popup, and fix the common ones with a single click.
What the plugin does
The Accessibility Checker looks for common WCAG problems in the editor content, such as missing image alt text, skipped heading levels, low text contrast and tables missing header cells. It shows the problems one at a time, outlines the element in the content, and offers a one-click Fix where a repair exists.
The plugin is on by default. Adding the editor is enough to get the Accessibility Checker button in the default toolbar.
The review flow
- Click the Accessibility Checker button (the person icon, in the More Misc group of the default toolbar). The content is scanned.
- A popup shows the first finding with what is wrong, why it matters and a link to the technique. The element it describes is outlined in the content, in the color of its severity.
- Use Previous and Next to step through the findings. Ignore dismisses one for the session, Rescan checks again, and Fix applies the repair when the rule has one.
- Watch the badge on the button. It shows the number of findings, goes hollow when the content changed since the last scan, and shows a tick when the scan found nothing.
Where the popup opens
The popup opens at the top right of the editor content area, just below the toolbar, whichever toolbar group holds the button. It follows the editor when the page scrolls and stays in place when the content scrolls.
In a tall editor, the popup sits at the top of the visible part of the content, below a toolbar that sticks to the top of the screen (or above one at the bottom). It is never taller than the room available and scrolls inside itself when it needs more space. On a screen 480px wide or narrower, it docks to the bottom as a sheet. Change that breakpoint with accessibilityCheckerDockWidth.
Order of findings
Findings are listed in the order of the content, top to bottom, whichever rule found them. Next and Previous walk down and up the page. Each finding scrolls fully into view, with room for its tag and outline, before it is highlighted.
Needs review results
Some results cannot be settled from the page. Examples are text over a background image, or a color the checker cannot read, such as oklch(), lab() and color(display-p3 ...), which browsers return as written. These appear as Needs review instead of an error or warning. They show guidance on what to check by eye, and the repair step is yours to do by hand.
Terms in plain words
| Term | Meaning |
|---|---|
| WCAG | The Web Content Accessibility Guidelines, the standard the rules are based on. |
| Rule | One check, such as “an image needs alt text”. Each rule has an id like I2. |
| Finding | One place in your content where a rule reports a problem. |
| Level | A, AA or AAA. A rule runs when its level is at or below accessibilityCheckerLevel. The default is 'AA'. |
| Repair | The built-in fix for a finding. The Fix button applies it. |
Plugin API:
| Plugin options | Plugin methods | Plugin events |
Toolbar button and keyboard use
Button name:'accessibilityChecker'. In the default toolbar it sits in the More Misc group.
The popup opens with focus on the counter. These keys work inside it:
| Key | Action |
|---|---|
| Tab / Shift+Tab | Move through the popup controls. Focus stays inside the popup. |
| Arrow keys | Move across Previous, Next and Close. |
| Enter | Apply a repair from its text field. |
| Esc | Close the popup and return focus to the toolbar button. |
Built-in rules
Each finding is worded for the person editing: a short title, then one or two plain sentences that say what to do. When a finding has a repair, the sentence names the control that fixes it, using the control’s own label. The wording is translated with the rest of the editor strings.| Id | What it checks | Severity | Level | Repair |
|---|---|---|---|---|
| D1 | A short line that is large or bold but is not a heading | WARNING | A | Turn into Heading 1 to 6 |
| D2 | A heading level that is skipped, such as an h4 straight after an h2 | ERROR | A | Choose the heading level that fits |
| D3 | Two links next to each other that go to the same address | ERROR | A | Manual |
| D4 | A list typed by hand with numbers, letters or dashes instead of a real list | ERROR | A | Manual |
| D5 | Text whose contrast with the background is too low (4.5:1, or 3:1 for large text, at AA; 7:1 and 4.5:1 at AAA) | ERROR | AA | Manual |
| H93 | An id used more than once | ERROR | A | Make the id unique. Choose to remove this one (the starting choice, so the first copy keeps its id), keep this one and remove the others, or remove all |
| I1 | An image that says two things: alt text and marked decorative, or an empty alt with a label or title | ERROR | A | Keep the description, use its label as the description, or mark it as decoration |
| I2 | An image with no alt attribute | ERROR | A | Write an image description, or mark it as decorative |
| I3 | Alt text that is a file name or a camera default such as IMG_0042.jpg or Screenshot 2026-10-09 | ERROR | A | Write what the image shows |
| I4 | Alt text over 125 characters | WARNING | AA | Shorten it |
| T1 | A table with no caption | ERROR | A | Write a table title |
| T4A | A table with no rows or no data cells | ERROR | A | Manual |
| T4B | A table with no header cells | ERROR | A | Make header row (the first row) |
| T4C | A header cell that does not say whether it applies to its row or its column | ERROR | A | Choose what the header labels: the cells below it (column) or beside it (row) |
role="presentation" or role="none" is a layout table, and the table rules skip it. When a rule throws an error, the checker reports it through accessibilityChecker.ruleError and every other rule keeps running.
What a repair does
A repair changes the content and then scans again, so the list shows what is left. One Undo reverts a repair. If you enter a value the repair cannot use, such as an empty alt text, another file name, or alt text that is still too long, the content stays as it was. The finding stays selected, the reason appears under the field and focus returns to it.Mark images as decorative
In an editor with the checker enabled, the image alt text dialog also shows a Mark as decorative checkbox. It clears the text and savesalt="" with role="presentation".
Marking an image decorative, in the dialog or through a repair, also removes its aria-label and title, because an image is either described or decorative. Calling image.setAlt('text') with a text still sets that text.
Set accessibilityCheckerAllowDecorativeImages to false to remove the checkbox from the dialog and from the I2 repair.
new FroalaEditor('.selector', { accessibilityCheckerAllowDecorativeImages: false });
Keeping role and aria attributes
Therole and aria-* attributes survive saving because an editor with the checker enabled adds role and aria-.* to its own htmlAllowedAttrs list when it starts. This covers the starting content and anything pasted or set later. The shared default, FroalaEditor.DEFAULTS.htmlAllowedAttrs, stays as it was.
htmlAllowedAttrs yourself, the editor uses your list exactly as written. Add 'role' and 'aria-.*' to it so the decorative-image marker (role="presentation") is kept when content is saved. An editor with pluginsDisabled: ['accessibilityChecker'] keeps the core list and removes role and aria-* from pasted content. A pasted Word table still has role and aria-* removed.Add Plugin to your code:
Plugin name: accessibilityChecker
Plugin JS Script: ../js/plugins/image.min.js
Or from CDN https://cdn.jsdelivr.net/npm/froala-editor@latest/js/plugins/accessibility_checker.min.js
Plugin CSS link: ../css/plugins/accessibility_checker.min.css
Or from CDN https://cdn.jsdelivr.net/npm/froala-editor@latest/css/plugins/accessibility_checker.min.css