Status title 릴리즈 Release 2.4.0 이상or Above
It is the plugin that checks web accessibility when you write create contents with SynapEditor.
How to Use
Loading Plugin File
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
//... 'editor.toolbar': [ //..., 'WebAccessibilityChecker', //... ], // ... |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
//...
'editor.menu.definition': {
//...,
'tools': [
//...,
'WebAccessibilityChecker',
//...
],
//...
},
//... |
API
editor.checkWebAccessibility(callback, rules)
RELEASE 2.7.0 OR ABOVE
Performs a web accessibility check and returns the results to the callback function that received the factor.
Parameters:
name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
callback | Function | The callback function to receive web accessibility check results. The test result is returned to Boolean.
| ||||||||||||||||
rules | String[] | RELEASE 2.10.3 OR ABOVE Specifies the items to be scanned. If an item is specified, the check item (webAccessibilityChecker.config) set in the editor is ignored. If not specified, the check item set in the editor is checked. Inspection items:
|
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
editor.checkWebAccessibility(function (result) {
if (!result) {
// Open the web accessibility check dialogue if the web accessibility check does not pass
editor.getUIManager().showDialog('WebAccessibilityChecker');
}
}); |
Code Block | ||||
---|---|---|---|---|
| ||||
// // Examine only image text alternatives var rules = ['image-alt', 'se-custom-image-alt']; editor.checkWebAccessibility(function (result) { ..... }, rules); // Examining only TABLE CAPTION var rules = ['se-custom-table-has-caption']; editor.checkWebAccessibility(function (result) { ..... }, rules); |
Config
RELEASE 2.10.3 OR ABOVE
You can set the items to be inspected through the editor settings.
The settings are applied equally to the web accessibility check dialog and'editor.checkWebAccessibility()' API.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
'webAccessibilityChecker.config': {
rules: ['image-alt', 'se-custom-image-alt', ...]
} |