@oat-sa/tao-core-ui 1.64.2 → 1.66.0

package/dist/keyNavigation/navigableDomElement.js

@@ -5,64 +5,64 @@ 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;
+     *
      */
     const navigableCls = 'key-navigation-highlight';
     const 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[]}
      */
     const 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) {
       const $element = $(element);
       const shortcuts = shortcutRegistry($element);
       let 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() {
           let {
             propagateTab = false
           } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
           const keyboard = (key, el) => {
-            /**
-             * @event key
-             * @param {String} key
-             * @param {Element} el
+            /**
+             * @event key
+             * @param {String} key
+             * @param {Element} el
              */
             this.trigger('key', key, el);
           };
@@ -74,15 +74,15 @@ define(['jquery', 'lodash', 'core/eventifier', 'util/shortcut/registry'], functi
 
           // add a tabindex to enable focusing, this tabindex is not actually used in tabbing order
           $element.addClass(navigableCls).attr('tabindex', -1).on(`focus${eventNS}`, e => {
-            /**
-             * @event focus
-             * @param {Element} el
+            /**
+             * @event focus
+             * @param {Element} el
              */
             this.trigger('focus', e.target);
           }).on(`blur${eventNS}`, e => {
-            /**
-             * @event blur
-             * @param {Element} el
+            /**
+             * @event blur
+             * @param {Element} el
              */
             this.trigger('blur', e.target);
           })
@@ -129,9 +129,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() {
           $element.removeClass(navigableCls).off(eventNS);
@@ -146,53 +146,53 @@ 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() {
           return 'element';
         },
-        /**
-         * Gets the dom element
-         * @returns {jQuery}
+        /**
+         * Gets the dom element
+         * @returns {jQuery}
          */
         getElement() {
           return $element;
         },
-        /**
-         * Checks if the navigable element is visible
-         * @returns {Boolean}
+        /**
+         * Checks if the navigable element is visible
+         * @returns {Boolean}
          */
         isVisible() {
           return $element.is(':visible');
         },
-        /**
-         * Checks if the navigable element is enabled
-         * @returns {Boolean}
+        /**
+         * Checks if the navigable element is enabled
+         * @returns {Boolean}
          */
         isEnabled() {
           return !$element.is(':disabled');
         },
-        /**
-         * Checks if the navigable element is focused
-         * @returns {Boolean}
+        /**
+         * Checks if the navigable element is focused
+         * @returns {Boolean}
          */
         isFocused() {
           const 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() {
           $element.blur();
           return this;
         },
-        /**
-         * Sets the focus on the navigable element
-         * @returns {navigableDomElement}
+        /**
+         * Sets the focus on the navigable element
+         * @returns {navigableDomElement}
          */
         focus() {
           $element.focus();
@@ -201,10 +201,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 = $elements => {
       const list = [];
@@ -219,11 +219,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}
      */
     navigableDomElement.isNavigableElement = navigable => !!navigable && navigableApi.every(n => 'function' === typeof navigable[n]);