issue/2799 Remove redundant behaviour and improve intellisense (#84)

adaptlearning · Apr 4, 2022 · 9c80622 · 9c80622
1 parent 4b010c9
commit 9c80622
Show file tree

Hide file tree

Showing 55 changed files with 1,198 additions and 765 deletions.
diff --git a/js/a11y.js b/js/a11y.js
@@ -1,14 +1,17 @@
 import Adapt from 'core/js/adapt';
+import offlineStorage from 'core/js/offlineStorage';
+import device from 'core/js/device';
+import location from 'core/js/location';
 import BrowserFocus from 'core/js/a11y/browserFocus';
 import FocusOptions from 'core/js/a11y/focusOptions';
 import KeyboardFocusOutline from 'core/js/a11y/keyboardFocusOutline';
 import Log from 'core/js/a11y/log';
 import Scroll from 'core/js/a11y/scroll';
 import WrapFocus from 'core/js/a11y/wrapFocus';
 import Popup from 'core/js/a11y/popup';
-import defaultAriaLevels from './enums/defaultAriaLevels';
-
-import 'core/js/a11y/deprecated';
+import defaultAriaLevels from 'core/js/enums/defaultAriaLevels';
+import deprecated from 'core/js/a11y/deprecated';
+import logging from 'core/js/logging';
 
 class A11y extends Backbone.Controller {
 
@@ -70,12 +73,13 @@ class A11y extends Backbone.Controller {
     this._htmlCharRegex = /&.*;/g;
     /** @type {Object} */
     this.config = null;
-    this._browserFocus = new BrowserFocus();
-    this._keyboardFocusOutline = new KeyboardFocusOutline();
-    this._wrapFocus = new WrapFocus();
-    this._popup = new Popup();
-    this._scroll = new Scroll();
-    this.log = new Log();
+    this._browserFocus = new BrowserFocus({ a11y: this });
+    this._keyboardFocusOutline = new KeyboardFocusOutline({ a11y: this });
+    this._wrapFocus = new WrapFocus({ a11y: this });
+    this._popup = new Popup({ a11y: this });
+    this._scroll = new Scroll({ a11y: this });
+    this.log = new Log({ a11y: this });
+    deprecated(this);
 
     this._removeLegacyElements();
     this.listenToOnce(Adapt, {
@@ -93,7 +97,7 @@ class A11y extends Backbone.Controller {
     this.config = Adapt.config.get('_accessibility');
     this.config._isActive = false;
     this.config._options = _.defaults(this.config._options || {}, this.defaults());
-    Adapt.offlineStorage.set('a11y', false);
+    offlineStorage.set('a11y', false);
     this.$html.toggleClass('has-accessibility', this.isEnabled());
     this._setupNoSelect();
     this._addFocuserDiv();
@@ -126,7 +130,7 @@ class A11y extends Backbone.Controller {
     if (!$legacyElements.length && !$navigationElements.length) {
       return;
     }
-    Adapt.log.warn('REMOVED: #accessibility-toggle and #accessibility-instructions have been removed. Please remove them from all of your .html files.');
+    logging.warn('REMOVED: #accessibility-toggle and #accessibility-instructions have been removed. Please remove them from all of your .html files.');
     $legacyElements.remove();
     $navigationElements.remove();
   }
@@ -141,7 +145,7 @@ class A11y extends Backbone.Controller {
 
   _onNavigationEnd(view) {
     // Prevent sub-menu items provoking behaviour
-    if ((view?.model?.get('_id') !== Adapt.location._currentId) || !this.isEnabled()) {
+    if ((view?.model?.get('_id') !== location._currentId) || !this.isEnabled()) {
       return;
     }
     // Allow document to be read
@@ -667,7 +671,7 @@ class A11y extends Backbone.Controller {
           // Drop focus errors as only happens when the element
           // isn't attached to the DOM.
         }
-        switch (Adapt.device.browser) {
+        switch (device.browser) {
           case 'internet explorer':
           case 'microsoft edge':
           case 'safari':
@@ -792,4 +796,13 @@ class A11y extends Backbone.Controller {
 
 }
 
-export default (Adapt.a11y = new A11y());
+const a11y = new A11y();
+
+Object.defineProperty(Adapt, 'a11y', {
+  get() {
+    logging.deprecated('Adapt.a11y, please use core/js/a11y directly');
+    return a11y;
+  }
+});
+
+export default a11y;
diff --git a/js/a11y/browserFocus.js b/js/a11y/browserFocus.js
@@ -6,7 +6,8 @@ import Adapt from 'core/js/adapt';
  */
 export default class BrowserFocus extends Backbone.Controller {
 
-  initialize() {
+  initialize({ a11y }) {
+    this.a11y = a11y;
     this._onBlur = this._onBlur.bind(this);
     this._onClick = this._onClick.bind(this);
     this.$body = $('body');
@@ -32,7 +33,7 @@ export default class BrowserFocus extends Backbone.Controller {
    * @param {JQuery.Event} event
    */
   _onBlur(event) {
-    const config = Adapt.a11y.config;
+    const config = this.a11y.config;
     if (!config._isEnabled || !config._options._isFocusNextOnDisabled) {
       return;
     }
@@ -50,7 +51,7 @@ export default class BrowserFocus extends Backbone.Controller {
       return;
     }
     // Move focus to next readable element
-    Adapt.a11y.focusNext($element);
+    this.a11y.focusNext($element);
   }
 
   /**
@@ -68,7 +69,7 @@ export default class BrowserFocus extends Backbone.Controller {
       event.preventDefault();
       event.stopImmediatePropagation();
     }
-    const config = Adapt.a11y.config;
+    const config = this.a11y.config;
     if (!config._isEnabled || !config._options._isFocusOnClickEnabled) {
       return;
     }