@oat-sa/tao-core-ui 1.54.2 → 1.55.0

package/dist/itemButtonList.js

@@ -23,24 +23,24 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
     hb.registerHelper('__', function (key) {
       return __(key);
     });
-    /**
-     * Register dompurify helper
-     *
-     * https://github.com/cure53/DOMPurify
-     * with config SAFE_FOR_TEMPLATES: true
-     * to make output safe for template systems
+    /**
+     * Register dompurify helper
+     *
+     * https://github.com/cure53/DOMPurify
+     * with config SAFE_FOR_TEMPLATES: true
+     * to make output safe for template systems
      */
 
     hb.registerHelper('dompurify', function (context) {
       return DOMPurify.sanitize(context);
     });
-    /**
-     * Register join helper
-     *
-     * Example :
-     * var values = {a:v1, b:v2, c:v3};
-     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
-     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
+    /**
+     * Register join helper
+     *
+     * Example :
+     * var values = {a:v1, b:v2, c:v3};
+     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
+     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
      */
 
     hb.registerHelper('join', function (arr, keyValueGlue, fragmentGlue, wrapper) {
@@ -121,7 +121,7 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
   function program1(depth0,data) {
     
     var buffer = "", stack1, helper;
-    buffer += "\r\n    <li class=\"buttonlist-item ";
+    buffer += "\n    <li class=\"buttonlist-item ";
     if (helper = helpers.status) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.status); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1);
@@ -133,30 +133,30 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
     if (helper = helpers.id) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.id); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\">\r\n        <button class=\"buttonlist-btn\"\r\n                role=\"link\"\r\n                ";
+      + "\">\n        <button class=\"buttonlist-btn\"\n                role=\"link\"\n                ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.title), {hash:{},inverse:self.noop,fn:self.program(6, program6, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n                aria-label=\"";
+    buffer += "\n                aria-label=\"";
     if (helper = helpers.ariaLabel) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.ariaLabel); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\"\r\n                ";
+      + "\"\n                ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.disabled), {hash:{},inverse:self.noop,fn:self.program(8, program8, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n                data-id=\"";
+    buffer += "\n                data-id=\"";
     if (helper = helpers.id) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.id); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\">\r\n            <span class=\"icon-indicator indicator\" aria-hidden=\"true\"></span>\r\n            ";
+      + "\">\n            <span class=\"icon-indicator indicator\" aria-hidden=\"true\"></span>\n            ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.scoreType), {hash:{},inverse:self.noop,fn:self.program(10, program10, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n            <span class=\"buttonlist-icon";
+    buffer += "\n            <span class=\"buttonlist-icon";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.icon), {hash:{},inverse:self.noop,fn:self.program(12, program12, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\" aria-hidden=\"true\"></span>\r\n            <span class=\"buttonlist-label\" aria-hidden=\"true\">";
+    buffer += "\" aria-hidden=\"true\"></span>\n            <span class=\"buttonlist-label\" aria-hidden=\"true\">";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.numericLabel), {hash:{},inverse:self.noop,fn:self.program(14, program14, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "</span>\r\n        </button>\r\n    </li>\r\n    ";
+    buffer += "</span>\n        </button>\n    </li>\n    ";
     return buffer;
     }
   function program2(depth0,data) {
@@ -195,11 +195,11 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
   function program10(depth0,data) {
     
     var buffer = "", stack1, helper;
-    buffer += "\r\n                <span class=\"buttonlist-score-badge\">\r\n                    <span class=\"buttonlist-score-icon icon-";
+    buffer += "\n                <span class=\"buttonlist-score-badge\">\n                    <span class=\"buttonlist-score-icon icon-";
     if (helper = helpers.scoreType) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.scoreType); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\" aria-hidden=\"true\"></span>\r\n                </span>\r\n            ";
+      + "\" aria-hidden=\"true\"></span>\n                </span>\n            ";
     return buffer;
     }
 
@@ -221,10 +221,10 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
     return escapeExpression(stack1);
     }
 
-    buffer += "<ol class=\"buttonlist-items\">\r\n    ";
+    buffer += "<ol class=\"buttonlist-items\">\n    ";
     stack1 = helpers.each.call(depth0, (depth0 && depth0.items), {hash:{},inverse:self.noop,fn:self.program(1, program1, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n</ol>\r\n";
+    buffer += "\n</ol>\n";
     return buffer;
     });
   function itemButtonListTpl(data, options, asString) {
@@ -232,35 +232,35 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
     return (asString || true) ? html : $(html);
   }
 
-  /**
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; under version 2
-   * of the License (non-upgradable).
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-   *
-   * Copyright (c) 2022 Open Assessment Technologies SA ;
+  /**
+   * This program is free software; you can redistribute it and/or
+   * modify it under the terms of the GNU General Public License
+   * as published by the Free Software Foundation; under version 2
+   * of the License (non-upgradable).
+   *
+   * This program is distributed in the hope that it will be useful,
+   * but WITHOUT ANY WARRANTY; without even the implied warranty of
+   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   * GNU General Public License for more details.
+   *
+   * You should have received a copy of the GNU General Public License
+   * along with this program; if not, write to the Free Software
+   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+   *
+   * Copyright (c) 2022 Open Assessment Technologies SA ;
    */
-  /**
-   * CSS classes involved in the component
-   * @type {Object}
+  /**
+   * CSS classes involved in the component
+   * @type {Object}
    */
 
   var cssClasses = {
     active: 'buttonlist-item-active',
     keyfocused: 'buttonlist-btn-focus'
   };
-  /**
-   * CSS selectors that match some particular elements
-   * @type {Object}
+  /**
+   * CSS selectors that match some particular elements
+   * @type {Object}
    */
 
   var cssSelectors = {
@@ -274,30 +274,30 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
       return ".buttonlist-btn[data-id=\"".concat(id, "\"]");
     }
   };
-  /**
-   * @typedef {Object} ItemButton
-   * @property {String} id - item id
-   * @property {Number} position - 0-based list index
-   * @property {String} numericLabel - displayed number
-   * @property {String} ariaLabel
-   * @property {String} status - 'answered'/'viewed'/'unseen'
-   * @property {String} scoreType - 'correct'/'incorrect'/null
-   * @property {String} icon - 'info'/'flagged'/null
-   * @property {Boolean} disabled
-   * @property {String} [title] - optional tooltip
+  /**
+   * @typedef {Object} ItemButton
+   * @property {String} id - item id
+   * @property {Number} position - 0-based list index
+   * @property {String} numericLabel - displayed number
+   * @property {String} ariaLabel
+   * @property {String} status - 'answered'/'viewed'/'unseen'
+   * @property {String} scoreType - 'correct'/'incorrect'/null
+   * @property {String} icon - 'info'/'flagged'/null
+   * @property {Boolean} disabled
+   * @property {String} [title] - optional tooltip
    */
 
-  /**
-   * Item Button List
-   * Ordered list of buttons representing items from a testMap section
-   * Mostly presentational component
-   *
-   * @param {Object} config
-   * @param {ItemButton[]} [config.items] - The list of entries to display
-   * @param {String|jQuery|HTMLElement} [scrollContainer] - scroll container element, for autoscroll
-   * @returns {component}
-   * @fires ready - When the component is ready to work
-   * @fires click When an item is selected by the user
+  /**
+   * Item Button List
+   * Ordered list of buttons representing items from a testMap section
+   * Mostly presentational component
+   *
+   * @param {Object} config
+   * @param {ItemButton[]} [config.items] - The list of entries to display
+   * @param {String|jQuery|HTMLElement} [scrollContainer] - scroll container element, for autoscroll
+   * @returns {component}
+   * @fires ready - When the component is ready to work
+   * @fires click When an item is selected by the user
    */
 
   function itemButtonListFactory() {
@@ -305,17 +305,17 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
     var component;
     var activeItemId = null; //jQuery or HTMLElement!
 
-    /**
-     * Get scroll container element
-     * @returns {HTMLElement}
+    /**
+     * Get scroll container element
+     * @returns {HTMLElement}
      */
 
     var getScrollContainer = function getScrollContainer() {
       return config.scrollContainer || component.getElement();
     };
-    /**
-     * Selects the active item
-     * @param {String|null} itemId
+    /**
+     * Selects the active item
+     * @param {String|null} itemId
      */
 
 
@@ -336,11 +336,11 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
         }
       }
     };
-    /**
-     * Update single item properties:
-     * Only `icon`, `numericLabel`, `ariaLabel` are supported
-     * @param {String} itemId
-     * @param {Object} itemData
+    /**
+     * Update single item properties:
+     * Only `icon`, `numericLabel`, `ariaLabel` are supported
+     * @param {String} itemId
+     * @param {Object} itemData
      */
 
 
@@ -371,9 +371,9 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
         }
       }
     };
-    /**
-     * 'tabfocus' styling, for Safari until :focus-visible supported
-     * @param {jQuery|null}  $target
+    /**
+     * 'tabfocus' styling, for Safari until :focus-visible supported
+     * @param {jQuery|null}  $target
      */
 
 
@@ -384,17 +384,17 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
         $target.addClass(cssClasses.keyfocused);
       }
     };
-    /**
-     * Apply a callback on each navigable element
-     * @param {*} callback
+    /**
+     * Apply a callback on each navigable element
+     * @param {*} callback
      */
 
 
     var eachNavigable = function eachNavigable(callback) {
       component.getElement().find(cssSelectors.navigable).each(callback);
     };
-    /**
-     * Enables the keyboard navigation using 'tab' keys
+    /**
+     * Enables the keyboard navigation using 'tab' keys
      */
 
 
@@ -403,8 +403,8 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
         return el.removeAttribute('tabindex');
       });
     };
-    /**
-     * Disables the keyboard navigation using 'tab' keys
+    /**
+     * Disables the keyboard navigation using 'tab' keys
      */
 
 
@@ -414,33 +414,33 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
       });
       setFocusStyle(null);
     };
-    /**
-     * Emits the click event detailing the clicked item
-     * The active item change should be handled by the consumer through the API, in case it is conditional or asynchronous
-     * @param {String} itemId
+    /**
+     * Emits the click event detailing the clicked item
+     * The active item change should be handled by the consumer through the API, in case it is conditional or asynchronous
+     * @param {String} itemId
      */
 
 
     var onClick = function onClick(itemId) {
-      /**
-       * @event click
-       * @param {String} itemId
+      /**
+       * @event click
+       * @param {String} itemId
        */
       component.trigger('click', {
         id: itemId
       });
     };
-    /**
-     * Defines the buttonList API
-     * @type {buttonList}
+    /**
+     * Defines the buttonList API
+     * @type {buttonList}
      */
 
 
     var api = {
-      /**
-       * Sets the active item
-       * @param {String} itemId
-       * @returns {buttonList}
+      /**
+       * Sets the active item
+       * @param {String} itemId
+       * @returns {buttonList}
        */
       setActiveItem: function setActiveItem(itemId) {
         activeItemId = itemId;
@@ -452,12 +452,12 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
         return this;
       },
 
-      /**
-       * Update single item properties:
-       * Only `icon`, `numericLabel`, `ariaLabel` are supported
-       * @param {String} itemId
-       * @param {Object} itemData
-       * @returns {buttonList}
+      /**
+       * Update single item properties:
+       * Only `icon`, `numericLabel`, `ariaLabel` are supported
+       * @param {String} itemId
+       * @param {Object} itemData
+       * @returns {buttonList}
        */
       updateItem: function updateItem(itemId, itemData) {
         if (this.is('rendered')) {
@@ -467,8 +467,8 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
         return this;
       }
     };
-    /**
-     * @typedef {component} buttonList
+    /**
+     * @typedef {component} buttonList
      */
 
     component = componentFactory(api, {}) // set the component's layout
@@ -500,8 +500,8 @@ define(['jquery', 'ui/autoscroll', 'ui/component', 'handlebars', 'i18n', 'lodash
       } else {
         disableKeyboard();
       }
-      /**
-       * @event ready
+      /**
+       * @event ready
        */
 
 

package/dist/keyNavigation/navigableDomElement.js

@@ -5,54 +5,54 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
     eventifier = eventifier && Object.prototype.hasOwnProperty.call(eventifier, 'default') ? eventifier['default'] : eventifier;
     shortcutRegistry = shortcutRegistry && Object.prototype.hasOwnProperty.call(shortcutRegistry, 'default') ? shortcutRegistry['default'] : shortcutRegistry;
 
-    /*
-     * This program is free software; you can redistribute it and/or
-     * modify it under the terms of the GNU General Public License
-     * as published by the Free Software Foundation; under version 2
-     * of the License (non-upgradable).
-     *
-     * This program is distributed in the hope that it will be useful,
-     * but WITHOUT ANY WARRANTY; without even the implied warranty of
-     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-     * GNU General Public License for more details.
-     *
-     * You should have received a copy of the GNU General Public License
-     * along with this program; if not, write to the Free Software
-     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-     *
-     * Copyright (c) 2017-2020 (original work) Open Assessment Technologies SA;
-     *
+    /*
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; under version 2
+     * of the License (non-upgradable).
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+     *
+     * Copyright (c) 2017-2020 (original work) Open Assessment Technologies SA;
+     *
      */
     var navigableCls = 'key-navigation-highlight';
     var eventNS = '.ui-key-navigator';
-    /**
-     * The list of mandatory methods a navigable element must expose.
-     * @type {String[]}
+    /**
+     * The list of mandatory methods a navigable element must expose.
+     * @type {String[]}
      */
 
     var navigableApi = ['init', 'destroy', 'getType', 'getElement', 'isVisible', 'isEnabled', 'isFocused', 'blur', 'focus'];
-    /**
-     * From a dom element, create a navigable element compatible with ui/KeyNavigator/navigator
-     * @param {String|Element|jQuery} element
-     * @returns {navigableDomElement}
-     * @fires key
-     * @fires blur
-     * @fires focus
+    /**
+     * From a dom element, create a navigable element compatible with ui/KeyNavigator/navigator
+     * @param {String|Element|jQuery} element
+     * @returns {navigableDomElement}
+     * @fires key
+     * @fires blur
+     * @fires focus
      */
 
     function navigableDomElement(element) {
       var $element = $(element);
       var shortcuts = shortcutRegistry($element);
       var initialTabIndex = null;
-      /**
-       * @typedef navigableDomElement
+      /**
+       * @typedef navigableDomElement
        */
 
       return eventifier({
-        /**
-         * Inits the navigableDomElement instance
-         * @param {Boolean} propagateTab - allows the key event to propagate when the Tab key is pressed.
-         * @returns {navigableDomElement}
+        /**
+         * Inits the navigableDomElement instance
+         * @param {Boolean} propagateTab - allows the key event to propagate when the Tab key is pressed.
+         * @returns {navigableDomElement}
          */
         init: function init() {
           var _this = this;
@@ -62,10 +62,10 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
               propagateTab = _ref$propagateTab === void 0 ? false : _ref$propagateTab;
 
           var keyboard = function keyboard(key, el) {
-            /**
-             * @event key
-             * @param {String} key
-             * @param {Element} el
+            /**
+             * @event key
+             * @param {String} key
+             * @param {Element} el
              */
             _this.trigger('key', key, el);
           };
@@ -81,15 +81,15 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
           initialTabIndex = $element.attr('tabindex'); // add a tabindex to enable focusing, this tabindex is not actually used in tabbing order
 
           $element.addClass(navigableCls).attr('tabindex', -1).on("focus".concat(eventNS), function (e) {
-            /**
-             * @event focus
-             * @param {Element} el
+            /**
+             * @event focus
+             * @param {Element} el
              */
             _this.trigger('focus', e.target);
           }).on("blur".concat(eventNS), function (e) {
-            /**
-             * @event blur
-             * @param {Element} el
+            /**
+             * @event blur
+             * @param {Element} el
              */
             _this.trigger('blur', e.target);
           }) // requires a keyup event to make unselecting radio button work with space bar
@@ -140,9 +140,9 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
           return this;
         },
 
-        /**
-         * Destroys the navigableDomElement instance
-         * @returns {navigableDomElement}
+        /**
+         * Destroys the navigableDomElement instance
+         * @returns {navigableDomElement}
          */
         destroy: function destroy() {
           $element.removeClass(navigableCls).off(eventNS);
@@ -162,59 +162,59 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
           return this;
         },
 
-        /**
-         * Gets the type of navigable element
-         * @returns {String}
+        /**
+         * Gets the type of navigable element
+         * @returns {String}
          */
         getType: function getType() {
           return 'element';
         },
 
-        /**
-         * Gets the dom element
-         * @returns {jQuery}
+        /**
+         * Gets the dom element
+         * @returns {jQuery}
          */
         getElement: function getElement() {
           return $element;
         },
 
-        /**
-         * Checks if the navigable element is visible
-         * @returns {Boolean}
+        /**
+         * Checks if the navigable element is visible
+         * @returns {Boolean}
          */
         isVisible: function isVisible() {
           return $element.is(':visible');
         },
 
-        /**
-         * Checks if the navigable element is enabled
-         * @returns {Boolean}
+        /**
+         * Checks if the navigable element is enabled
+         * @returns {Boolean}
          */
         isEnabled: function isEnabled() {
           return !$element.is(':disabled');
         },
 
-        /**
-         * Checks if the navigable element is focused
-         * @returns {Boolean}
+        /**
+         * Checks if the navigable element is focused
+         * @returns {Boolean}
          */
         isFocused: function isFocused() {
           var el = $element.get(0);
           return document.activeElement && el === document.activeElement;
         },
 
-        /**
-         * Removes the focus from the navigable element
-         * @returns {navigableDomElement}
+        /**
+         * Removes the focus from the navigable element
+         * @returns {navigableDomElement}
          */
         blur: function blur() {
           $element.blur();
           return this;
         },
 
-        /**
-         * Sets the focus on the navigable element
-         * @returns {navigableDomElement}
+        /**
+         * Sets the focus on the navigable element
+         * @returns {navigableDomElement}
          */
         focus: function focus() {
           $element.focus();
@@ -222,10 +222,10 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
         }
       });
     }
-    /**
-     * From a jQuery container, returns an array of navigableDomElement
-     * @param {jQuery|Element[]} $elements
-     * @returns {Array}
+    /**
+     * From a jQuery container, returns an array of navigableDomElement
+     * @param {jQuery|Element[]} $elements
+     * @returns {Array}
      */
 
     navigableDomElement.createFromDoms = function ($elements) {
@@ -247,11 +247,11 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
 
       return list;
     };
-    /**
-     * Checks if the provided object is a valid navigable element
-     *
-     * @param {Object} navigable
-     * @returns {Boolean}
+    /**
+     * Checks if the provided object is a valid navigable element
+     *
+     * @param {Object} navigable
+     * @returns {Boolean}
      */