Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vue-a11y/vue-axe-next
Accessibility auditing for Vue.js 3 applications using axe-core
https://github.com/vue-a11y/vue-axe-next
a11y accessibility accessibility-audits auditing axe axe-core deque vue vue-axe vue3
Last synced: about 1 month ago
JSON representation
Accessibility auditing for Vue.js 3 applications using axe-core
- Host: GitHub
- URL: https://github.com/vue-a11y/vue-axe-next
- Owner: vue-a11y
- License: mit
- Created: 2020-09-26T14:52:31.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-28T19:09:32.000Z (almost 4 years ago)
- Last Synced: 2024-04-14T02:44:31.104Z (8 months ago)
- Topics: a11y, accessibility, accessibility-audits, auditing, axe, axe-core, deque, vue, vue-axe, vue3
- Language: Vue
- Homepage: https://vue-axe-next.surge.sh/
- Size: 594 KB
- Stars: 48
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-a11y-vue - vue-axe-next - Dynamic accessibility analysis for Vue.js 3 using axe-core. (Components and plugins / Development)
- awesome-access - vue-axe-next - Dynamic accessibility analysis for Vue.js 3 using axe-core. (Components and plugins / Development)
README
## [@vue-a11y/axe](https://github.com/vue-a11y/vue-axe)
Accessibility auditing for Vue.js 3 applications by running [dequelabs/axe-core](https://github.com/dequelabs/axe-core/) validation on the page you're viewing.
- [Links](#links)
- [Setup](#setup)
- [Options](#options)
- [Locales](#locales)
## Links
- [Demo](https://vue-axe-next.surge.sh/)
## Setup
```shell
npm install -D axe-core vue-axe@next
# or
yarn add -D axe-core vue-axe@next
```
### main.js
```js
import { createApp, h, Fragment } from 'vue'
import App from './App.vue'
let app = null
if (process.env.NODE_ENV === 'development') {
const VueAxe = require('vue-axe')
app = createApp({
render: () => h(Fragment, [h(App), h(VueAxe.VueAxePopup)])
})
app.use(VueAxe.default)
} else {
app = createApp(App)
}
app.mount('#app')
```
## Vite
In Vite you need to add `axe-core` in the dependency optimization option (optimizeDeps).
In your `vite.config.js`
```js
import vue from '@vitejs/plugin-vue'
export default {
plugins: [vue()],
optimizeDeps: {
include: ['axe-core']
}
}
```
## Options
### auto
| Type | Default |
| -------- | -------- |
| Boolean | `true` |
If false disables automatic verification.
It is necessary to click on `run again` for a new analysis.
### 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.
NOTE: Learn more about [Axe-core configuration](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#api-name-axeconfigure)
### runOptions
| Type | Default |
| -------- | --------------------------------------------------------------- |
| Object | `{ runOptions: { reporter: 'v2', resultTypes: ['violations'] }` |
Flexible way to configure how `axeCore.run()` operates.
NOTE: Learn more about [Axe-core runtime options](https://github.com/dequelabs/axe-core/blob/master/doc/API.md#options-parameter)
### plugins
| Type |
| -------- |
| Array |
Register Axe plugins.
```js
const plugins = require('@/plugins/axe')
app.use(VueAxe, {
plugins: [plugins.myPlugin, plugins.myPlugin2]
})
```
## Locales
Through the settings it is possible to define the language that will be used for the violations.
NOTE: axe-core already has several languages available.
[See axe-core locales](https://github.com/dequelabs/axe-core/tree/develop/locales)
```js
const ptBR = require('axe-core/locales/pt_BR.json')
app.use(VueAxe, {
config: {
locale: ptBR
}
})
```
## Roadmap
- [x] Enable highlighting of elements with errors on the page;
- [x] i18n;
- [x] Announce "views" changes to the screen reader;
- [x] New documentation;
- [x] Add focus trap in the popup;
- [x] How to use (Vite)
- [ ] Add links (references file) to learn more;
- [ ] Typescript support;
- [ ] Add keyboard shortcut to open pop-up;
- [ ] Animation slide-right (to details view) & slide-left (to violations view);
- [ ] Carousel to element source when greater than 3;
- [ ] Export violations (Output format to be defined);
## Contributing
- From typos in documentation to coding new features;
- Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found;
- Fork repository, make changes and send a pull request;
Follow us on Twitter [@vue_a11y](https://twitter.com/vue_a11y)
**Thank you**