From c4b00efba14f78d6d32cae02b4c43a013f206e4e Mon Sep 17 00:00:00 2001 From: Jun Pataleta Date: Tue, 1 Jun 2021 12:04:12 +0800 Subject: [PATCH 1/4] MDL-71669 editor_atto: Set proper roles to toolbar menus * Menu button fix - Added aria-haspopup, aria-controls, and aria-expanded attributes. * Menu fixes - Added aria-labelledby that points to the menu button label. - Removed the dialog role in the menu's container. - The ul tag needs the "menu" role. - The li tag needs the role "none" instead of the "presentation" role Reference: https://www.w3.org/TR/wai-aria-practices-1.1/#menubutton --- .../moodle-editor_atto-menu-debug.js | 40 ++++++++++++++----- .../moodle-editor_atto-menu-min.js | 2 +- .../moodle-editor_atto-menu.js | 40 ++++++++++++++----- .../moodle-editor_atto-plugin-debug.js | 19 +++++++-- .../moodle-editor_atto-plugin-min.js | 4 +- .../moodle-editor_atto-plugin.js | 19 +++++++-- .../src/editor/js/editor-plugin-buttons.js | 19 +++++++-- lib/editor/atto/yui/src/editor/js/menu.js | 40 ++++++++++++++----- 8 files changed, 141 insertions(+), 42 deletions(-) diff --git a/lib/editor/atto/yui/build/moodle-editor_atto-menu/moodle-editor_atto-menu-debug.js b/lib/editor/atto/yui/build/moodle-editor_atto-menu/moodle-editor_atto-menu-debug.js index e0d9cdbbf23..9bc53896819 100644 --- a/lib/editor/atto/yui/build/moodle-editor_atto-menu/moodle-editor_atto-menu-debug.js +++ b/lib/editor/atto/yui/build/moodle-editor_atto-menu/moodle-editor_atto-menu-debug.js @@ -29,9 +29,9 @@ var LOGNAME = 'moodle-editor_atto-menu'; var MENUDIALOGUE = '' + '
' + - '
'),this.toolbar.append(e)),e}}}}),u.namespace("M.editor_atto").EditorPlugin=e,l='',a="disabled",o="highlight",h=".editor_atto_content",c=".editor_atto_menu_icon",d=".editor_atto_menu_expand",s.ATTRS={},s.prototype={buttons:null,buttonNames:null,buttonStates:null,menus:null,DISABLED:0,ENABLED:1,_buttonHandlers:null,_menuHideHandlers:null,_primaryKeyboardShortcut:null,_highlightQueue:null,addButton:function(e){var n,i,o,t=this.get("group"),a=this.name,s="atto_"+a+"_button",r=this.get("host");return e.exec&&(s=s+"_"+e.exec),e.buttonName?s=s+"_"+e.buttonName:e.buttonName=e.exec||a,e.buttonClass=s,(e=this._normalizeIcon(e)).title||(e.title="pluginname"),i=M.util.get_string(e.title,"atto_"+a),(n=u.Node.create('')).setAttribute("title",i),window.require(["core/templates"],function(t){t.renderPix(e.icon,e.iconComponent,i).then(function(t){n.append(t)})}),t.append(n),this.toolbar.getAttribute("aria-activedescendant")||(n.setAttribute("tabindex","0"),this.toolbar.setAttribute("aria-activedescendant",n.generateID()),this.get("host")._tabFocus=n),e=this._normalizeCallback(e),this._buttonHandlers.push(this.toolbar.delegate("click",e.callback,"."+s,this)),e.keys&&("undefined"!=typeof e.keyDescription&&(this._primaryKeyboardShortcut[s]=e.keyDescription),this._addKeyboardListener(e.callback,e.keys,s),this._primaryKeyboardShortcut[s]&&n.setAttribute("title",M.util.get_string("plugin_title_shortcut","editor_atto",{title:i,shortcut:this._primaryKeyboardShortcut[s]}))),e.tags&&(o=!0,"boolean"==typeof e.tagMatchRequiresAll&&(o=e.tagMatchRequiresAll),this._buttonHandlers.push(r.on(["atto:selectionchanged","change"],function(t){"undefined"!=typeof this._highlightQueue[e.buttonName]&&this._highlightQueue[e.buttonName].cancel(),this._highlightQueue[e.buttonName]=u.soon(u.bind(function(t){r.selectionFilterMatches(e.tags,t.selectedNodes,o)?this.highlightButtons(e.buttonName):this.unHighlightButtons(e.buttonName)},this,t))},this))),this.buttonNames.push(e.buttonName),this.buttons[e.buttonName]=n,this.buttonStates[e.buttonName]=this.ENABLED,n},addBasicButton:function(t){return t.exec?(t.icon||(t.icon="e/"+t.exec),t.callback=function(){document.execCommand(t.exec,!1,null),this.markUpdated()},this.addButton(t)):null},addToolbarMenu:function(e){var n,i,t,o,a=this.get("group"),s=this.name,r="atto_"+s+"_button";return e.buttonName?r=r+"_"+e.buttonName:e.buttonName=s,e.buttonClass=r,(e=this._normalizeIcon(e)).title||(e.title="pluginname"),i=M.util.get_string(e.title,"atto_"+s),e.menuColor||(e.menuColor="transparent"),t="atto_"+s+"_menubutton_"+u.stamp(this),o=u.Handlebars.compile(l),n=u.Node.create(o({buttonClass:r,config:e,title:i,id:t})),e.buttonId=t,window.require(["core/templates"],function(t){t.renderPix(e.icon,e.iconComponent,i).then(function(t){n.one(c).append(t)}),t.renderPix("t/expanded","core","").then(function(t){n.one(d).append(t)})}),a.append(n),this.toolbar.getAttribute("aria-activedescendant")||(n.setAttribute("tabindex","0"),this.toolbar.setAttribute("aria-activedescendant",n.generateID())),this._buttonHandlers.push(this.toolbar.delegate("click",this._showToolbarMenu,"."+r,this,e),this.toolbar.delegate("key",this._showToolbarMenuAndFocus,"40, 32, enter","."+r,this,e)),this.buttonNames.push(e.buttonName),this.buttons[e.buttonName]=n,this.buttonStates[e.buttonName]=this.ENABLED,n},_showToolbarMenu:function(t,e){var n,i,o;t.preventDefault(),this.isEnabled()&&((n=t.currentTarget.ancestor("button",!0)).hasAttribute(a)||(this.menus[e.buttonClass]||(e.overlayWidth||(e.overlayWidth="14"),e.innerOverlayWidth||(e.innerOverlayWidth=parseInt(e.overlayWidth,10)-2+"em"),e.overlayWidth=parseInt(e.overlayWidth,10)+"em",this.menus[e.buttonClass]=new u.M.editor_atto.Menu(e),this.menus[e.buttonClass].get("contentBox").delegate("click",this._chooseMenuItem,".atto_menuentry a",this,e)),u.Array.each(this.get("host").openMenus,function(t){t.set("focusAfterHide",null)}),(o=this.buttons[e.buttonName]).focus(),this.get("host")._setTabFocus(o),(i=this.menus[e.buttonClass]).set("focusAfterHide",o),i.show(),n.setAttribute("aria-expanded",!0),i.align(this.buttons[e.buttonName],[u.WidgetPositionAlign.TL,u.WidgetPositionAlign.BL]),this.get("host").openMenus=[i]))},_showToolbarMenuAndFocus:function(t,e){this._showToolbarMenu(t,e),this.menus[e.buttonClass].get("boundingBox").one("a").focus()},_chooseMenuItem:function(t,e,n){var i=t.target.ancestor("a",!0).getData("index"),o=this._normalizeCallback(e.items[i],e.globalItemConfig);(n=this.menus[e.buttonClass]).set("preventHideMenu",!0),o.callback(t,o._callback,o.callbackArgs),n.set("preventHideMenu",!1),n.set("focusAfterHide",this.get("host").editor),n.hide(t)},_normalizeCallback:function(n,t){return n._callbackNormalized||(t=t||{},n.inlineFormat=n.inlineFormat||t.inlineFormat,n._inlineCallback=n.callback||t.callback,n._callback=n.callback||t.callback,n.inlineFormat&&"function"==typeof n._inlineCallback&&(n._callback=function(t,e){ +this.get("host").applyFormat(t,n._inlineCallback,this,e)}),n.callback=u.rbind(this._callbackWrapper,this,n._callback,n.callbackArgs),n._callbackNormalized=!0),n},_normalizeIcon:function(t){return t.iconurl||(t.iconComponent&&"moodle"!=t.iconComponent||(t.iconComponent="core"),t.iconurl=M.util.image_url(t.icon,t.iconComponent)),t},_callbackWrapper:function(t,e,n){var i,o;if(t.preventDefault(),this.isEnabled()&&(!(i=t.currentTarget.ancestor("button",!0))||!i.hasAttribute(a)))return YUI.Env.UA.android||this.get("host").isActive()||this.get("host").focus(),this.get("host").saveSelection(),i&&this.get("host")._setTabFocus(i),o=[t,n],this.get("host").restoreSelection(),e.apply(this,o)},_addKeyboardListener:function(n,t,e){var i,o,a,s="key",r=h;if(u.Lang.isArray(t))return u.Array.each(t,function(t){this._addKeyboardListener(n,t)},this),this;o="object"==typeof t?(t.eventtype&&(s=t.eventtype),t.container&&(r=t.container),i=t.keyCodes,n):(a=this._getDefaultMetaKey(),i=this._getKeyEvent()+t+"+"+a,"undefined"==typeof this._primaryKeyboardShortcut[e]&&(this._primaryKeyboardShortcut[e]=this._getDefaultMetaKeyDescription(t)),u.bind(function(t,e){this._eventUsesExactKeyModifiers(t,e)&&n.apply(this,[e])},this,[a])),this._buttonHandlers.push(this.editor.delegate(s,o,i,r,this))},_eventUsesExactKeyModifiers:function(t,e){var n,i=!0;return"key"===e.type&&(n=-1' + + 'title="{{title}}" ' + + 'aria-haspopup="true" ' + + 'aria-controls="{{id}}_menu">' + '' + '' + ''; @@ -525,13 +527,18 @@ EditorPluginButtons.prototype = { } // Create the actual button. + var id = 'atto_' + pluginname + '_menubutton_' + Y.stamp(this); var template = Y.Handlebars.compile(MENUTEMPLATE); button = Y.Node.create(template({ buttonClass: buttonClass, config: config, - title: title + title: title, + id: id })); + // Add this button id to the config. It will be used in the menu later. + config.buttonId = id; + window.require(['core/templates'], function(Templates) { Templates.renderPix(config.icon, config.iconComponent, title).then(function(iconhtml) { button.one(CSS.MENUICON).append(iconhtml); @@ -583,7 +590,8 @@ EditorPluginButtons.prototype = { return; } - if (e.currentTarget.ancestor('button', true).hasAttribute(DISABLED)) { + var menuButton = e.currentTarget.ancestor('button', true); + if (menuButton.hasAttribute(DISABLED)) { // Exit early if the clicked button was disabled. return; } @@ -625,6 +633,9 @@ EditorPluginButtons.prototype = { // Display the menu. menuDialogue.show(); + // Indicate that the menu is expanded. + menuButton.setAttribute("aria-expanded", true); + // Position it next to the button which opened it. menuDialogue.align(this.buttons[config.buttonName], [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.BL]); diff --git a/lib/editor/atto/yui/src/editor/js/editor-plugin-buttons.js b/lib/editor/atto/yui/src/editor/js/editor-plugin-buttons.js index 78db77f075e..95b9fca10bc 100644 --- a/lib/editor/atto/yui/src/editor/js/editor-plugin-buttons.js +++ b/lib/editor/atto/yui/src/editor/js/editor-plugin-buttons.js @@ -29,9 +29,11 @@ var MENUTEMPLATE = '' + ''; @@ -377,13 +379,18 @@ EditorPluginButtons.prototype = { } // Create the actual button. + var id = 'atto_' + pluginname + '_menubutton_' + Y.stamp(this); var template = Y.Handlebars.compile(MENUTEMPLATE); button = Y.Node.create(template({ buttonClass: buttonClass, config: config, - title: title + title: title, + id: id })); + // Add this button id to the config. It will be used in the menu later. + config.buttonId = id; + window.require(['core/templates'], function(Templates) { Templates.renderPix(config.icon, config.iconComponent, title).then(function(iconhtml) { button.one(CSS.MENUICON).append(iconhtml); @@ -435,7 +442,8 @@ EditorPluginButtons.prototype = { return; } - if (e.currentTarget.ancestor('button', true).hasAttribute(DISABLED)) { + var menuButton = e.currentTarget.ancestor('button', true); + if (menuButton.hasAttribute(DISABLED)) { // Exit early if the clicked button was disabled. return; } @@ -477,6 +485,9 @@ EditorPluginButtons.prototype = { // Display the menu. menuDialogue.show(); + // Indicate that the menu is expanded. + menuButton.setAttribute("aria-expanded", true); + // Position it next to the button which opened it. menuDialogue.align(this.buttons[config.buttonName], [Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.BL]); diff --git a/lib/editor/atto/yui/src/editor/js/menu.js b/lib/editor/atto/yui/src/editor/js/menu.js index bbe2e9d6f2f..352540f209b 100644 --- a/lib/editor/atto/yui/src/editor/js/menu.js +++ b/lib/editor/atto/yui/src/editor/js/menu.js @@ -27,9 +27,9 @@ var LOGNAME = 'moodle-editor_atto-menu'; var MENUDIALOGUE = '' + '
' + - '