Merge pull request #207 from jessebeach/axmodel-query-integration

Axmodel query integration

Author: jessebeach

README.md

@@ -104,6 +104,7 @@ You can also enable all the recommended rules at once. Add `plugin:jsx-a11y/reco
 - [iframe-has-title](docs/rules/iframe-has-title.md): Enforce iframe elements have a title attribute.
 - [img-has-alt](docs/rules/img-has-alt.md): Enforce that `<img>` JSX elements use the `alt` prop.
 - [img-redundant-alt](docs/rules/img-redundant-alt.md): Enforce `<img>` alt prop does not contain the word "image", "picture", or "photo".
+- [interactive-supports-focus](docs/rules/interactive-supports-focus.md): Enforce that elements with interactive handlers like `onClick` must be focusable.
 - [label-has-for](docs/rules/label-has-for.md): Enforce that `<label>` elements have the `htmlFor` prop.
 - [lang](docs/rules/lang.md): Enforce lang attribute has a valid value.
 - [mouse-events-have-key-events](docs/rules/mouse-events-have-key-events.md): Enforce that `onMouseOver`/`onMouseOut` are accompanied by `onFocus`/`onBlur` for keyboard-only users.
@@ -112,9 +113,7 @@ You can also enable all the recommended rules at once. Add `plugin:jsx-a11y/reco
 - [no-distracting-elements](docs/rules/no-distracting-elements.md): Enforce distracting elements are not used.
 - [no-onchange](docs/rules/no-onchange.md): Enforce usage of `onBlur` over `onChange` on select menus for accessibility.
 - [no-redundant-roles](docs/rules/no-redundant-roles.md): Enforce explicit role property is not the same as implicit/default role property on element.
-- [no-static-element-interactions](docs/rules/no-static-element-interactions.md): Enforce non-interactive elements have no interactive handlers.
-- [onclick-has-focus](docs/rules/onclick-has-focus.md): Enforce that elements with `onClick` handlers must be focusable.
-- [onclick-has-role](docs/rules/onclick-has-role.md): Enforce that non-interactive, visible elements (such as `<div>`) that have click handlers use the role attribute.
+- [no-static-element-interactions](docs/rules/no-static-element-interactions.md): Enforce that non-interactive, visible elements (such as `<div>`) that have click handlers use the role attribute.
 - [role-has-required-aria-props](docs/rules/role-has-required-aria-props.md): Enforce that elements with ARIA roles must have all required attributes for that role.
 - [role-supports-aria-props](docs/rules/role-supports-aria-props.md): Enforce that elements with explicit or implicit roles defined contain only `aria-*` properties supported by that `role`.
 - [scope](docs/rules/scope.md): Enforce `scope` prop is only used on `<th>` elements.
@@ -129,6 +128,39 @@ script to scaffold the new files.
 $ ./scripts/create-rule.js my-new-rule
 ```
 
+## Some background on WAI-ARIA, the AX Tree and Browsers
+
+### Accessibility API
+An operating system will provide an accessibility API that maps application state and content onto input/output controllers such as a screen reader, braille device, keyboard, etc.
+
+These APIs were developed as computer interfaces shifted from buffers (which are text based and inherently quite accessible) to graphical user interfaces (GUIs). The first attempts to make GUIs accessible involved raster image parsing to recognize characters, words, etc. This information was stored in a parallel buffer and made accessible to assistive technology (AT) devices.
+
+As GUIs became more complex, the raster parsing approach became untenable. Accessibility APIs were developed to replace them. Check out [NSAccessibility (AXAPI)](https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Protocols/NSAccessibility_Protocol/index.html) for an example. See [Core Accessibility API Mappings 1.1](https://www.w3.org/TR/core-aam-1.1/) for more details.
+
+### Browsers
+Browsers support an Accessibility API on a per operating system basis. For instance Firefox implements the MSAA accessibility API on Windows, but does not implement the AXAPI on OSX.
+
+### The Accessibility (AX) Tree & DOM
+From the [W3 Core Accessibility API Mappings 1.1](https://www.w3.org/TR/core-aam-1.1/#intro_treetypes)
+
+> The accessibility tree and the DOM tree are parallel structures. Roughly speaking the accessibility tree is a subset of the DOM tree. It includes the user interface objects of the user agent and the objects of the document. Accessible objects are created in the accessibility tree for every DOM element that should be exposed to an assistive technology, either because it may fire an accessibility event or because it has a property, relationship or feature which needs to be exposed. Generally if something can be trimmed out it will be, for reasons of performance and simplicity. For example, a <span> with just a style change and no semantics may not get its own accessible object, but the style change will be exposed by other means.
+
+Browser vendors are beginning to expose the AX Tree through inspection tools. Chrome has an experiment available to enable their inspection tool.
+
+You can also see a text-based version of the AX Tree in Chrome in the stable release version.
+
+#### Viewing the AX Tree in Chrome
+  1. Navigate to `chrome://accessibility/` in Chrome.
+  1. Toggle the `accessibility off` link for any tab that you want to inspect.
+  1. A link labeled `show accessibility tree` will appear; click this link.
+  1. Balk at the wall of text that gets displayed, but then regain your conviction.
+  1. Use the browser's find command to locate strings and values in the wall of text.
+
+### Pulling it all together
+A browser constructs an AX Tree as a subset of the DOM. ARIA heavily informs the properties of this AX Tree. This AX Tree is exposed to the system level Accessibility API which mediates assistive technology agents.
+
+We model ARIA in the [aria-query](https://github.com/a11yance/aria-query) project. We model AXObjects (that comprise the AX Tree) in the [axobject-query](https://github.com/A11yance/axobject-query) project. The goal of the WAI-ARIA specification is to be a complete complete declarative interface to the AXObject model. The [in-draft 1.2 version](https://github.com/w3c/aria/issues?q=is%3Aissue+is%3Aopen+label%3A%22ARIA+1.2%22) is moving towards this goal. But until then, we must consider the semantics constructs affored by ARIA as well as those afforded by the AXObject model (AXAPI) in order to determine how HTML can be used to express user interface affordances to assistive technology users.
+
 ## License
 
 eslint-plugin-jsx-a11y is licensed under the [MIT License](LICENSE.md).

__mocks__/genInteractives.js

@@ -15,7 +15,11 @@ const roleNames = [...roles.keys()];
 const interactiveElementsMap = {
   a: [{prop: 'href', value: '#'}],
   area: [{prop: 'href', value: '#'}],
+  audio: [],
   button: [],
+  canvas: [],
+  embed: [],
+  link: [],
   input: [],
   'input[type=\"button\"]': [{prop: 'type', value: 'button'}],
   'input[type=\"checkbox\"]': [{prop: 'type', value: 'checkbox'}],
@@ -42,20 +46,33 @@ const interactiveElementsMap = {
   menuitem:[],
   option: [],
   select: [],
-  'table[role="grid"]': [{prop: 'role', value: 'grid'}],
-  'td[role="gridcell"]': [{prop: 'role', value: 'gridcell'}],
+  // Whereas ARIA makes a distinction between cell and gridcell, the AXObject
+  // treats them both as CellRole and since gridcell is interactive, we consider
+  // cell interactive as well.
+  // td: [],
+  th: [],
   tr: [],
   textarea: [],
+  video: [],
 };
 
 const nonInteractiveElementsMap = {
-  area: [],
+  abbr: [],
   article: [],
+  blockquote: [],
+  br: [],
+  caption: [],
   dd: [],
+  details: [],
   dfn: [],
+  dialog: [],
+  dir: [],
+  dl: [],
   dt: [],
   fieldset: [],
+  figcaption: [],
   figure: [],
+  footer: [],
   form: [],
   frame: [],
   h1: [],
@@ -65,17 +82,28 @@ const nonInteractiveElementsMap = {
   h5: [],
   h6: [],
   hr: [],
+  iframe: [],
   img: [],
-  'input[type=\"hidden\"]': [{prop: 'type', value: 'hidden'}],
+  label: [],
+  legend: [],
   li: [],
   main: [],
+  mark: [],
+  marquee: [],
+  menu: [],
+  meter: [],
   nav: [],
   ol: [],
+  p: [],
+  pre: [],
+  progress: [],
+  ruby: [],
   table: [],
-  td: [],
   tbody: [],
+  td: [],
   tfoot: [],
   thead: [],
+  time: [],
   ul: [],
 };
 

__tests__/src/rules/click-events-have-key-events-test.js

@@ -46,7 +46,6 @@ ruleTester.run('click-events-have-key-events', rule, {
     { code: '<option onClick={() => void 0} className="foo" />' },
     { code: '<select onClick={() => void 0} className="foo" />' },
     { code: '<textarea onClick={() => void 0} className="foo" />' },
-    { code: '<a tabIndex="0" onClick={() => void 0} />' },
     { code: '<a onClick={() => void 0} href="http://x.y.z" />' },
     { code: '<a onClick={() => void 0} href="http://x.y.z" tabIndex="0" />' },
     { code: '<input onClick={() => void 0} type="hidden" />;' },
@@ -70,5 +69,6 @@ ruleTester.run('click-events-have-key-events', rule, {
       errors: [expectedError],
     },
     { code: '<a onClick={() => void 0} />', errors: [expectedError] },
+    { code: '<a tabIndex="0" onClick={() => void 0} />', errors: [expectedError] },
   ].map(parserOptionsMapper),
 });

__tests__/src/rules/no-interactive-element-to-noninteractive-role-test.js

@@ -34,7 +34,6 @@ const alwaysValid = [
   { code: '<TestComponent onClick={doFoo} />' },
   { code: '<Button onClick={doFoo} />' },
   /* Interactive elements */
-  { code: '<a tabIndex="0" role="button" />' },
   { code: '<a href="http://x.y.z" role="button" />' },
   { code: '<a href="http://x.y.z" tabIndex="0" role="button" />' },
   { code: '<button className="foo" role="button" />' },
@@ -63,7 +62,6 @@ const alwaysValid = [
   { code: '<input type="url" role="button" />' },
   { code: '<input type="week" role="button" />' },
   { code: '<input type="hidden" role="button" />' },
-  { code: '<input type="hidden" role="img" />' },
   /* End all flavors of input */
   { code: '<menuitem role="button" />;' },
   { code: '<option className="foo" role="button" />' },
@@ -72,7 +70,9 @@ const alwaysValid = [
   { code: '<tr role="button" />;' },
   /* HTML elements with neither an interactive or non-interactive valence (static) */
   { code: '<a role="button" />' },
-  { code: '<a role="button" />;' },
+  { code: '<a role="img" />;' },
+  { code: '<a tabIndex="0" role="button" />' },
+  { code: '<a tabIndex="0" role="img" />' },
   { code: '<acronym role="button" />;' },
   { code: '<address role="button" />;' },
   { code: '<applet role="button" />;' },
@@ -292,7 +292,6 @@ const alwaysValid = [
 
 const neverValid = [
   /* Interactive elements */
-  { code: '<a tabIndex="0" role="img" />', errors: [expectedError] },
   { code: '<a href="http://x.y.z" role="img" />', errors: [expectedError] },
   { code: '<a href="http://x.y.z" tabIndex="0" role="img" />', errors: [expectedError] },
   /* All flavors of input */
@@ -305,6 +304,7 @@ const neverValid = [
   { code: '<input type="datetime-local" role="img" />', errors: [expectedError] },
   { code: '<input type="email" role="img" />', errors: [expectedError] },
   { code: '<input type="file" role="img" />', errors: [expectedError] },
+  { code: '<input type="hidden" role="img" />', errors: [expectedError] },
   { code: '<input type="image" role="img" />', errors: [expectedError] },
   { code: '<input type="month" role="img" />', errors: [expectedError] },
   { code: '<input type="number" role="img" />', errors: [expectedError] },
@@ -326,7 +326,6 @@ const neverValid = [
   { code: '<textarea className="foo" role="img" />', errors: [expectedError] },
   { code: '<tr role="img" />;', errors: [expectedError] },
   /* Interactive elements */
-  { code: '<a tabIndex="0" role="listitem" />', errors: [expectedError] },
   { code: '<a href="http://x.y.z" role="listitem" />', errors: [expectedError] },
   { code: '<a href="http://x.y.z" tabIndex="0" role="listitem" />', errors: [expectedError] },
   /* All flavors of input */

__tests__/src/rules/no-noninteractive-element-interactions-test.js

@@ -61,6 +61,7 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
     { code: '<a tabIndex="0" onClick={() => void 0} />' },
     { code: '<a onClick={() => void 0} href="http://x.y.z" />' },
     { code: '<a onClick={() => void 0} href="http://x.y.z" tabIndex="0" />' },
+    { code: '<area onClick={() => {}} />;' },
     { code: '<button onClick={() => void 0} className="foo" />' },
     { code: '<menuitem onClick={() => {}} />;' },
     { code: '<option onClick={() => void 0} className="foo" />' },
@@ -79,11 +80,8 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
     { code: '<bdo onClick={() => {}} />;' },
     { code: '<big onClick={() => {}} />;' },
     { code: '<blink onClick={() => {}} />;' },
-    { code: '<blockquote onClick={() => {}} />;' },
     { code: '<body onClick={() => {}} />;' },
-    { code: '<br onClick={() => {}} />;' },
     { code: '<canvas onClick={() => {}} />;' },
-    { code: '<caption onClick={() => {}} />;' },
     { code: '<center onClick={() => {}} />;' },
     { code: '<cite onClick={() => {}} />;' },
     { code: '<code onClick={() => {}} />;' },
@@ -93,8 +91,6 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
     { code: '<data onClick={() => {}} />;' },
     { code: '<datalist onClick={() => {}} />;' },
     { code: '<del onClick={() => {}} />;' },
-    { code: '<details onClick={() => {}} />;' },
-    { code: '<dir onClick={() => {}} />;' },
     { code: '<div />;' },
     { code: '<div className="foo" />;' },
     { code: '<div className="foo" {...props} />;' },
@@ -105,47 +101,33 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
     { code: '<div onClick={() => void 0} {...props} />;' },
     { code: '<div onClick={null} />;' },
     { code: '<div onKeyUp={() => void 0} aria-hidden={false} />;' },
-    { code: '<dl onClick={() => {}} />;' },
     { code: '<em onClick={() => {}} />;' },
     { code: '<embed onClick={() => {}} />;' },
-    { code: '<figcaption onClick={() => {}} />;' },
     { code: '<font onClick={() => {}} />;' },
-    { code: '<footer onClick={() => {}} />;' },
     { code: '<frameset onClick={() => {}} />;' },
     { code: '<head onClick={() => {}} />;' },
     { code: '<header onClick={() => {}} />;' },
     { code: '<hgroup onClick={() => {}} />;' },
     { code: '<html onClick={() => {}} />;' },
     { code: '<i onClick={() => {}} />;' },
-    { code: '<iframe onClick={() => {}} />;' },
     { code: '<ins onClick={() => {}} />;' },
     { code: '<kbd onClick={() => {}} />;' },
     { code: '<keygen onClick={() => {}} />;' },
-    { code: '<label onClick={() => {}} />;' },
-    { code: '<legend onClick={() => {}} />;' },
     { code: '<link onClick={() => {}} />;' },
     { code: '<main onClick={null} />;' },
     { code: '<map onClick={() => {}} />;' },
-    { code: '<mark onClick={() => {}} />;' },
-    { code: '<marquee onClick={() => {}} />;' },
-    { code: '<menu onClick={() => {}} />;' },
     { code: '<meta onClick={() => {}} />;' },
-    { code: '<meter onClick={() => {}} />;' },
     { code: '<noembed onClick={() => {}} />;' },
     { code: '<noscript onClick={() => {}} />;' },
     { code: '<object onClick={() => {}} />;' },
     { code: '<optgroup onClick={() => {}} />;' },
     { code: '<output onClick={() => {}} />;' },
-    { code: '<p onClick={() => {}} />;' },
     { code: '<param onClick={() => {}} />;' },
     { code: '<picture onClick={() => {}} />;' },
-    { code: '<pre onClick={() => {}} />;' },
-    { code: '<progress onClick={() => {}} />;' },
     { code: '<q onClick={() => {}} />;' },
     { code: '<rp onClick={() => {}} />;' },
     { code: '<rt onClick={() => {}} />;' },
     { code: '<rtc onClick={() => {}} />;' },
-    { code: '<ruby onClick={() => {}} />;' },
     { code: '<s onClick={() => {}} />;' },
     { code: '<samp onClick={() => {}} />;' },
     { code: '<script onClick={() => {}} />;' },
@@ -161,7 +143,6 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
     { code: '<summary onClick={() => {}} />;' },
     { code: '<sup onClick={() => {}} />;' },
     { code: '<th onClick={() => {}} />;' },
-    { code: '<time onClick={() => {}} />;' },
     { code: '<title onClick={() => {}} />;' },
     { code: '<track onClick={() => {}} />;' },
     { code: '<tt onClick={() => {}} />;' },
@@ -220,14 +201,21 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
   invalid: [
     /* HTML elements with an inherent, non-interactive role */
     { code: '<main onClick={() => void 0} />;', errors: [expectedError] },
-    { code: '<area onClick={() => {}} />;', errors: [expectedError] },
     { code: '<article onClick={() => {}} />;', errors: [expectedError] },
     { code: '<article onDblClick={() => void 0} />;', errors: [expectedError] },
+    { code: '<blockquote onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<br onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<caption onClick={() => {}} />;', errors: [expectedError] },
     { code: '<dd onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<details onClick={() => {}} />;', errors: [expectedError] },
     { code: '<dfn onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<dl onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<dir onClick={() => {}} />;', errors: [expectedError] },
     { code: '<dt onClick={() => {}} />;', errors: [expectedError] },
     { code: '<fieldset onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<figcaption onClick={() => {}} />;', errors: [expectedError] },
     { code: '<figure onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<footer onClick={() => {}} />;', errors: [expectedError] },
     { code: '<form onClick={() => {}} />;', errors: [expectedError] },
     { code: '<frame onClick={() => {}} />;', errors: [expectedError] },
     { code: '<h1 onClick={() => {}} />;', errors: [expectedError] },
@@ -237,15 +225,27 @@ ruleTester.run('no-noninteractive-element-handlers', rule, {
     { code: '<h5 onClick={() => {}} />;', errors: [expectedError] },
     { code: '<h6 onClick={() => {}} />;', errors: [expectedError] },
     { code: '<hr onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<iframe onClick={() => {}} />;', errors: [expectedError] },
     { code: '<img onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<label onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<legend onClick={() => {}} />;', errors: [expectedError] },
     { code: '<li onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<mark onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<marquee onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<menu onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<meter onClick={() => {}} />;', errors: [expectedError] },
     { code: '<nav onClick={() => {}} />;', errors: [expectedError] },
     { code: '<ol onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<p onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<pre onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<progress onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<ruby onClick={() => {}} />;', errors: [expectedError] },
     { code: '<table onClick={() => {}} />;', errors: [expectedError] },
     { code: '<tbody onClick={() => {}} />;', errors: [expectedError] },
     { code: '<td onClick={() => {}} />;', errors: [expectedError] },
     { code: '<tfoot onClick={() => {}} />;', errors: [expectedError] },
     { code: '<thead onClick={() => {}} />;', errors: [expectedError] },
+    { code: '<time onClick={() => {}} />;', errors: [expectedError] },
     { code: '<ol onClick={() => {}} />;', errors: [expectedError] },
     { code: '<ul onClick={() => {}} />;', errors: [expectedError] },
     /* HTML elements attributed with a non-interactive role */