Update: provide alternative title text override for menu button ARIA label (fixes #214)

README.md

@@ -137,6 +137,8 @@ The following attributes, set within *contentObjects.json*, configure the defaul
 
 **displayTitle** (string):  This text is displayed on the menu item.
 
+>**titleAriaLabel** (string): This will be read out by screen readers instead of **title** for the menu button text. Use if **title** contains punctuation or html syntax that shouldn't be read.
+
 **body** (string):  Optional text that appears on the menu item. Often used to inform the learner about the menu choice. If no **pageBody** is supplied, this text will also appear as the body text of the page header.
 
 **pageBody** (string): Optional text that appears as the body text of the page header. If this text is not provided, the **body** text will be used (if it is supplied). Reference [*adapt-contrib-vanilla/templates/page.hbs*](https://github.com/adaptlearning/adapt-contrib-vanilla/blob/master/templates/page.hbs).

example.json

@@ -50,6 +50,7 @@
         "_isHidden": false,
         "title": "Welcome to Adapt Learning",
         "displayTitle": "Welcome to Adapt Learning",
+        "titleAriaLabel": "",
         "body": "This page contains a working Adapt page with all core bundled components and plugins working.",
         "_graphic": {
             "alt": "",

properties.schema

@@ -289,6 +289,15 @@
               "type": "object",
               "required": false,
               "properties": {
+                "titleAriaLabel": {
+                  "type": "string",
+                  "inputType": "Text",
+                  "validators": [],
+                  "title": "Title ARIA label",
+                  "help": "Alternative title text read out by screen readers for the menu button text"
+                  "required": false,
+                  "translatable": true
+                },
                 "_renderAsGroup": {
                   "type": "boolean",
                   "required": false,

schema/contentobject.schema.json

@@ -13,6 +13,15 @@
           "title": "Box Menu",
           "default": {},
           "properties": {
+            "titleAriaLabel": {
+              "type": "string",
+              "title": "Title ARIA label",
+              "description": "Alternative title text read out by screen readers for the menu button text",
+              "default": "",
+              "_adapt": {
+                "translatable": true
+              }
+            },
             "_renderAsGroup": {
               "type": "boolean",
               "title": "Make this a parent group of menu items",

templates/boxMenuItem.jsx

@@ -14,6 +14,7 @@ export default function BoxMenuItem (props) {
     _isLocked,
     _isComplete,
     title,
+    titleAriaLabel,
     _isOptional,
     _nthChild,
     _totalChild
@@ -31,8 +32,9 @@ export default function BoxMenuItem (props) {
   const locked = _isLocked ? _globals?._accessibility?._ariaLabels?.locked : linkText;
   const optional = _isOptional ? _globals?._accessibility?._ariaLabels?.optional : '';
   const itemCount = compile(_globals?._menu?._boxMenu?.itemCount || '', { _nthChild, _totalChild });
+  const itemTitle = titleAriaLabel || title;
   const ariaLabel = [
-    completion, locked, `${title}.`, `${itemCount}.`, `${optional}`
+    completion, locked, `${itemTitle}.`, `${itemCount}.`, `${optional}`
   ].filter(Boolean).join(' ');
 
   return (