forked from jsx-eslint/eslint-plugin-jsx-a11y
/
no-static-element-interactions.js
113 lines (103 loc) · 3.73 KB
/
no-static-element-interactions.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
111
112
113
/**
* @fileoverview Enforce static elements have no interactive handlers.
* @author Ethan Cohen
* @flow
*/
// ----------------------------------------------------------------------------
// Rule Definition
// ----------------------------------------------------------------------------
import { dom } from 'aria-query';
import {
elementType,
eventHandlersByType,
getPropValue,
getProp,
hasProp,
} 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 { arraySchema, generateObjSchema } from '../util/schemas';
import isAbstractRole from '../util/isAbstractRole';
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 isNonLiteralProperty from '../util/isNonLiteralProperty';
import isPresentationRole from '../util/isPresentationRole';
const errorMessage = 'Static HTML elements with event handlers require a role.';
const domElements = [...dom.keys()];
const defaultInteractiveProps = [
...eventHandlersByType.focus,
...eventHandlersByType.keyboard,
...eventHandlersByType.mouse,
];
const schema = generateObjSchema({
handlers: arraySchema,
});
export default ({
meta: {
docs: {
url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-static-element-interactions.md',
description: 'Enforce that non-interactive, visible elements (such as `<div>`) that have click handlers use the role attribute.',
errorOptions: true,
},
schema: [schema],
},
create: (context: ESLintContext): ESLintVisitorSelectorConfig => {
const { options } = context;
return {
JSXOpeningElement: (node: JSXOpeningElement) => {
const { attributes } = node;
const type = elementType(node);
const {
allowExpressionValues,
handlers = defaultInteractiveProps,
} = (options[0] || {});
const hasInteractiveProps = handlers
.some((prop) => (
hasProp(attributes, prop)
&& getPropValue(getProp(attributes, prop)) != null
));
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
|| 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 (
isInteractiveElement(type, attributes)
|| isInteractiveRole(type, attributes)
|| isNonInteractiveElement(type, attributes)
|| isNonInteractiveRole(type, attributes)
|| isAbstractRole(type, attributes)
) {
// This rule has no opinion about abstract roles.
return;
}
if (
allowExpressionValues === true
&& isNonLiteralProperty(attributes, 'role')
) {
// This rule has no opinion about non-literal roles.
return;
}
// Visible, non-interactive elements should not have an interactive handler.
context.report({
node,
message: errorMessage,
});
},
};
},
}: ESLintConfig);