Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
themeEmacs
titleEditor Configuration
//...
'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:

nameTypeDescription
callbackFunction

The callback function to receive web accessibility check results. The test result is returned to Boolean.

function (result) {

    // result value true: pass, false: fail
}


rulesString[]

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:

항목설명

image-alt

이미지 대체텍스트(alt) 검사
Inspect image alt text
se-custom-image-alt
se-custom-table-has-th
테이블 제목 셀
Inspect table title cell (th)
검사
se-custom-table-has-caption
테이블 제목(caption) 검사
Inspect table captions
se-custom-link-has-title-attr
링크
Inspect link title
속성 검사
attribute
se-custom-video-has-title-attr
비디오 title 속성 검사
Inspect video title attribute

frame-title

Inspect frame
title 속성 검사
title attribute
se-custom-iframe-has-title-attr



Example:

Code Block
languagejs
themeEmacs
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
languagejs
themeEmacs
// // 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.

...