# API

The $axe is available on the property injected into the Vue instance, so it is available everywhere in your application.

# Run

To execute the $axe.run method to check manually your document or any desired HTMLElement.

# $axe.run

Key Type Default
clearConsole Boolean The same as clearConsoleOnUpdate
element Document or HTMLElement document
label Strong Run manually
methods: {
  axeRun() {
    this.$axe.run({
      clearConsole: true,
      element: this.$el,     // or document, document.querySelector('.selector'), ...
      label: 'Logo component'
    })
  }
}

# Plugins

Use the $axe.plugins method to have access to registered plugins.

TIP

To see how to register your plugins click here

# $axe.plugins


methods: {
  handle () {
    this.$axe.plugins.myPlugin.run()
  }
}