-
Notifications
You must be signed in to change notification settings - Fork 779
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: generate ARIA supported documentation for roles and attributes.
- Loading branch information
Showing
5 changed files
with
311 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| /*eslint-env node */ | ||
| 'use strict'; | ||
|
|
||
| const aQ = require('aria-query'); | ||
|
|
||
| module.exports = function (grunt) { | ||
| grunt.registerMultiTask( | ||
| 'aria-supported', | ||
| 'Task for generating a diff of supported aria-roles.', | ||
| function () { | ||
| const entry = this.data.entry; | ||
| const destFile = this.data.destFile; | ||
| const axe = require('../../axe'); | ||
|
|
||
| const getDiff = (base, subject) => { | ||
| return [...[...new Map([...base.entries()].sort())]] | ||
| .reduce((out, [key] = item) => { | ||
| return `${out} | ${key} | ${subject.includes(key) ? 'Yes' : 'No'} |\n` | ||
| }, ``); | ||
| } | ||
|
|
||
| const getMdContent = (roles, attributes) => { | ||
| return `# ARIA Roles supported by axe-core. \n \n \n | aria-role | axe-core support | \n | :------- | :------- | \n ${roles} \n \n \n # ARIA Attributes supported by axe-core. \n \n \n | aria-attribute | axe-core support| \n | :------- | :------- | \n ${attributes}`; | ||
| } | ||
|
|
||
| const generateDoc = () => { | ||
| const content = getMdContent( | ||
| getDiff(aQ.roles, Object.keys(axe.commons.aria.lookupTable.role)), | ||
| getDiff(aQ.aria, Object.keys(axe.commons.aria.lookupTable.attributes)) | ||
| ); | ||
| grunt.file.write(destFile, content) | ||
| } | ||
|
|
||
| generateDoc(); | ||
| } | ||
| ); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| # ARIA Roles supported by axe-core. | ||
|
|
||
|
|
||
| | aria-role | axe-core support | | ||
| | :------- | :------- | | ||
| | alert | Yes | | ||
| | alertdialog | Yes | | ||
| | application | Yes | | ||
| | article | Yes | | ||
| | banner | Yes | | ||
| | button | Yes | | ||
| | cell | Yes | | ||
| | checkbox | Yes | | ||
| | columnheader | Yes | | ||
| | combobox | Yes | | ||
| | command | Yes | | ||
| | complementary | Yes | | ||
| | composite | Yes | | ||
| | contentinfo | Yes | | ||
| | definition | Yes | | ||
| | dialog | Yes | | ||
| | directory | Yes | | ||
| | doc-abstract | Yes | | ||
| | doc-acknowledgments | Yes | | ||
| | doc-afterword | Yes | | ||
| | doc-appendix | Yes | | ||
| | doc-backlink | Yes | | ||
| | doc-biblioentry | Yes | | ||
| | doc-bibliography | Yes | | ||
| | doc-biblioref | Yes | | ||
| | doc-chapter | Yes | | ||
| | doc-colophon | Yes | | ||
| | doc-conclusion | Yes | | ||
| | doc-cover | Yes | | ||
| | doc-credit | Yes | | ||
| | doc-credits | Yes | | ||
| | doc-dedication | Yes | | ||
| | doc-endnote | Yes | | ||
| | doc-endnotes | Yes | | ||
| | doc-epigraph | Yes | | ||
| | doc-epilogue | Yes | | ||
| | doc-errata | Yes | | ||
| | doc-example | Yes | | ||
| | doc-footnote | Yes | | ||
| | doc-foreword | Yes | | ||
| | doc-glossary | Yes | | ||
| | doc-glossref | Yes | | ||
| | doc-index | Yes | | ||
| | doc-introduction | Yes | | ||
| | doc-noteref | Yes | | ||
| | doc-notice | Yes | | ||
| | doc-pagebreak | Yes | | ||
| | doc-pagelist | Yes | | ||
| | doc-part | Yes | | ||
| | doc-preface | Yes | | ||
| | doc-prologue | Yes | | ||
| | doc-pullquote | Yes | | ||
| | doc-qna | Yes | | ||
| | doc-subtitle | Yes | | ||
| | doc-tip | Yes | | ||
| | doc-toc | Yes | | ||
| | document | Yes | | ||
| | feed | Yes | | ||
| | figure | No | | ||
| | form | Yes | | ||
| | grid | Yes | | ||
| | gridcell | Yes | | ||
| | group | Yes | | ||
| | heading | Yes | | ||
| | img | Yes | | ||
| | input | Yes | | ||
| | landmark | Yes | | ||
| | link | Yes | | ||
| | list | Yes | | ||
| | listbox | Yes | | ||
| | listitem | Yes | | ||
| | log | Yes | | ||
| | main | Yes | | ||
| | marquee | Yes | | ||
| | math | Yes | | ||
| | menu | Yes | | ||
| | menubar | Yes | | ||
| | menuitem | Yes | | ||
| | menuitemcheckbox | Yes | | ||
| | menuitemradio | Yes | | ||
| | navigation | Yes | | ||
| | none | Yes | | ||
| | note | Yes | | ||
| | option | Yes | | ||
| | presentation | Yes | | ||
| | progressbar | Yes | | ||
| | radio | Yes | | ||
| | radiogroup | Yes | | ||
| | range | Yes | | ||
| | region | Yes | | ||
| | roletype | Yes | | ||
| | row | Yes | | ||
| | rowgroup | Yes | | ||
| | rowheader | Yes | | ||
| | scrollbar | Yes | | ||
| | search | Yes | | ||
| | searchbox | Yes | | ||
| | section | Yes | | ||
| | sectionhead | Yes | | ||
| | select | Yes | | ||
| | separator | Yes | | ||
| | slider | Yes | | ||
| | spinbutton | Yes | | ||
| | status | Yes | | ||
| | structure | Yes | | ||
| | switch | Yes | | ||
| | tab | Yes | | ||
| | table | Yes | | ||
| | tablist | Yes | | ||
| | tabpanel | Yes | | ||
| | term | Yes | | ||
| | textbox | Yes | | ||
| | timer | Yes | | ||
| | toolbar | Yes | | ||
| | tooltip | Yes | | ||
| | tree | Yes | | ||
| | treegrid | Yes | | ||
| | treeitem | Yes | | ||
| | widget | Yes | | ||
| | window | Yes | | ||
|
|
||
|
|
||
|
|
||
| # ARIA Attributes supported by axe-core. | ||
|
|
||
|
|
||
| | aria-attribute | axe-core support| | ||
| | :------- | :------- | | ||
| | aria-activedescendant | Yes | | ||
| | aria-atomic | Yes | | ||
| | aria-autocomplete | Yes | | ||
| | aria-busy | Yes | | ||
| | aria-checked | Yes | | ||
| | aria-colcount | Yes | | ||
| | aria-colindex | Yes | | ||
| | aria-colspan | Yes | | ||
| | aria-controls | Yes | | ||
| | aria-current | Yes | | ||
| | aria-describedby | Yes | | ||
| | aria-disabled | Yes | | ||
| | aria-dropeffect | Yes | | ||
| | aria-expanded | Yes | | ||
| | aria-flowto | Yes | | ||
| | aria-grabbed | Yes | | ||
| | aria-haspopup | Yes | | ||
| | aria-hidden | Yes | | ||
| | aria-invalid | Yes | | ||
| | aria-keyshortcuts | Yes | | ||
| | aria-label | Yes | | ||
| | aria-labelledby | Yes | | ||
| | aria-level | Yes | | ||
| | aria-live | Yes | | ||
| | aria-modal | Yes | | ||
| | aria-multiline | Yes | | ||
| | aria-multiselectable | Yes | | ||
| | aria-orientation | Yes | | ||
| | aria-owns | Yes | | ||
| | aria-placeholder | Yes | | ||
| | aria-posinset | Yes | | ||
| | aria-pressed | Yes | | ||
| | aria-readonly | Yes | | ||
| | aria-relevant | Yes | | ||
| | aria-required | Yes | | ||
| | aria-roledescription | No | | ||
| | aria-rowcount | Yes | | ||
| | aria-rowindex | Yes | | ||
| | aria-rowspan | Yes | | ||
| | aria-selected | Yes | | ||
| | aria-setsize | Yes | | ||
| | aria-sort | Yes | | ||
| | aria-valuemax | Yes | | ||
| | aria-valuemin | Yes | | ||
| | aria-valuenow | Yes | | ||
| | aria-valuetext | Yes | |
Oops, something went wrong.