forked from jsx-eslint/eslint-plugin-jsx-a11y
/
interactive-supports-focus.js
110 lines (102 loc) · 3.61 KB
/
interactive-supports-focus.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/**
* @fileoverview Enforce that elements with onClick handlers must be tabbable.
* @author Ethan Cohen
* @flow
*/
import {
dom,
roles,
} from 'aria-query';
import {
getProp,
elementType,
eventHandlersByType,
getLiteralPropValue,
hasAnyProp,
} from 'jsx-ast-utils';
import type { JSXOpeningElement } from 'ast-types-flow';
import includes from 'array-includes';
import type { ESLintConfig, ESLintContext, ESLintVisitorSelectorConfig } from '../../flow/eslint';
import {
enumArraySchema,
generateObjSchema,
} from '../util/schemas';
import isDisabledElement from '../util/isDisabledElement';
import isHiddenFromScreenReader from '../util/isHiddenFromScreenReader';
import isInteractiveElement from '../util/isInteractiveElement';
import isInteractiveRole from '../util/isInteractiveRole';
import isNonInteractiveElement from '../util/isNonInteractiveElement';
import isNonInteractiveRole from '../util/isNonInteractiveRole';
import isPresentationRole from '../util/isPresentationRole';
import getTabIndex from '../util/getTabIndex';
// ----------------------------------------------------------------------------
// Rule Definition
// ----------------------------------------------------------------------------
const schema = generateObjSchema({
tabbable: enumArraySchema([...roles.keys()]
.filter((name) => !roles.get(name).abstract)
.filter((name) => roles.get(name).superClass.some((klasses) => includes(klasses, 'widget')))),
});
const domElements = [...dom.keys()];
const interactiveProps = [
...eventHandlersByType.mouse,
...eventHandlersByType.keyboard,
];
export default ({
meta: {
docs: {
url: 'https://github.com/evcohen/eslint-plugin-jsx-a11y/tree/master/docs/rules/interactive-supports-focus.md',
},
schema: [schema],
},
create: (context: ESLintContext): ESLintVisitorSelectorConfig => ({
JSXOpeningElement: (node: JSXOpeningElement) => {
const tabbable = (
context.options && context.options[0] && context.options[0].tabbable
) || [];
const { attributes } = node;
const type = elementType(node);
const hasInteractiveProps = hasAnyProp(attributes, interactiveProps);
const hasTabindex = getTabIndex(getProp(attributes, 'tabIndex')) !== undefined;
if (!includes(domElements, type)) {
// Do not test higher level JSX components, as we do not know what
// low-level DOM element this maps to.
return;
}
if (
!hasInteractiveProps
|| isDisabledElement(attributes)
|| isHiddenFromScreenReader(type, attributes)
|| isPresentationRole(type, attributes)
) {
// Presentation is an intentional signal from the author that this
// element is not meant to be perceivable. For example, a click screen
// to close a dialog .
return;
}
if (
hasInteractiveProps
&& isInteractiveRole(type, attributes)
&& !isInteractiveElement(type, attributes)
&& !isNonInteractiveElement(type, attributes)
&& !isNonInteractiveRole(type, attributes)
&& !hasTabindex
) {
const role = getLiteralPropValue(getProp(attributes, 'role'));
if (includes(tabbable, role)) {
// Always tabbable, tabIndex = 0
context.report({
node,
message: `Elements with the '${role}' interactive role must be tabbable.`,
});
} else {
// Focusable, tabIndex = -1 or 0
context.report({
node,
message: `Elements with the '${role}' interactive role must be focusable.`,
});
}
}
},
}),
}: ESLintConfig);