# Options
# auto
Type | Default |
---|---|
Boolean | true |
If false disables automatic verification. Only checks with $axe.run
Vue.use(VueAxe, {
auto: false // Disable auto check.
})
TIP
To check manually, use $axe.run
# allowConsoleClears
Type | Default |
---|---|
Boolean | true |
If false, disables all console clears (overriding clearConsoleOnUpdate
).
Vue.use(VueAxe, {
allowConsoleClears: false // disable all console clears
})
# clearConsoleOnUpdate
Type | Default |
---|---|
Boolean | false |
If true, clean the console each time the component is updated. No effect if allowConsoleClears = false
.
Vue.use(VueAxe, {
clearConsoleOnUpdate: true
})
# customResultHandler
Type | Default |
---|---|
Function | standardResultHandler |
The customResultHandler
config property expects a callback like the axeCore.run()
callback (see documentation, opens in a new window ). It will be triggered after each call to axeCore.run()
.
Vue.use(VueAxe, {
customResultHandler: (error, results) => {
results.violations.forEach(violation => console.log(violation))
}
})
# config
Type | Default |
---|---|
Object | { branding: { application: 'vue-axe' } |
To configure the format of the data used by axe. This can be used to add new rules, which must be registered with the library to execute. Provide your
TIP
Learn more about Axe-core configuration, opens in a new window
# runOptions
Type | Default |
---|---|
Object | { runOptions: { reporter: 'v2', resultTypes: ['violations'] } |
Flexible way to configure how axeCore.run()
operates.
TIP
Learn more about Axe-core runtime options, opens in a new window
# delay
Type | Default |
---|---|
Number | 500 |
Used only to delay the first check.
# style
Type |
---|
Object |
Customize style for console logs.
key | description |
---|---|
head | Style title "New axe issues" |
boldCourier | Font style |
critical | Critical logs badge |
serious | Serious logs badge |
moderate | Moderate logs badge |
minor | Minor logs badge |
title | Issue title |
url | Issue URL |
TIP
To see more about default style, opens in a new window
# plugins
Type |
---|
Array |
Register Axe plugins.
import { myPlugin, myPlugin2 } from '@/plugins/axe'
Vue.use(VueAxe, {
plugins: [myPlugin, myPlugin2]
})
TIP
Learn more about Axe docs: Plugins, opens in a new window