feat: Adding option to register and execute plugins

vue-a11y · May 12, 2020 · fb21d52 · fb21d52
1 parent a9e0323
commit fb21d52
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -9,6 +9,8 @@ export interface VueAxe
 {
     run({ clearConsole, element }: RunOptions): void;
 
+    plugins: Record<object>;
+
     clearConsole(forceClear: boolean): void;
 
     debounce(): void;

diff --git a/src/index.js b/src/index.js
@@ -28,19 +28,25 @@ export default function install (Vue, options) {
       minor: 'padding:2px 4px;border-radius:5px;background-color:#333;color:#FFCE85;font-weight:normal;',
       title: 'font-color:black;font-weight:bold;',
       url: 'font-color:#4D4D4D;font-weight:normal;'
-    }
+    },
+    plugins: []
   }
 
   options = merge(defaultOptions, options)
 
   axeCore.configure({ ...options.config })
 
+  // register plugins
+  options.plugins.forEach(plugin => axeCore.registerPlugin(plugin))
+
+  // vue-axe methods in Vue Instance
   Vue.prototype.$axe = {
     run ({ clearConsole = true, element = document } = {}) {
       this.clearConsole(clearConsole)
       if (!clearConsole) resetLastNotification()
       Vue.nextTick().then(() => checkAndReport(options, element))
     },
+    plugins: axeCore.plugins,
     clearConsole (forceClear = false) {
       resetCache()
 
@@ -54,10 +60,12 @@ export default function install (Vue, options) {
     }, 1000, { maxWait: 5000 })
   }
 
+  // Rechecking when updating specific component
   Vue.mixin({
     updated () {
       this.$axe.debounce()
     },
+    // Used for change of route
     beforeDestroy () {
       this.$axe.clearConsole(true)
     }