| 1 | /**
|
|---|
| 2 | * @fileoverview Enforce a clickable non-interactive element has at least 1 keyboard event listener.
|
|---|
| 3 | * @author Ethan Cohen
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | // -----------------------------------------------------------------------------
|
|---|
| 7 | // Requirements
|
|---|
| 8 | // -----------------------------------------------------------------------------
|
|---|
| 9 |
|
|---|
| 10 | import { RuleTester } from 'eslint';
|
|---|
| 11 | import parserOptionsMapper from '../../__util__/parserOptionsMapper';
|
|---|
| 12 | import parsers from '../../__util__/helpers/parsers';
|
|---|
| 13 | import rule from '../../../src/rules/click-events-have-key-events';
|
|---|
| 14 |
|
|---|
| 15 | // -----------------------------------------------------------------------------
|
|---|
| 16 | // Tests
|
|---|
| 17 | // -----------------------------------------------------------------------------
|
|---|
| 18 |
|
|---|
| 19 | const ruleTester = new RuleTester();
|
|---|
| 20 |
|
|---|
| 21 | const errorMessage = 'Visible, non-interactive elements with click handlers must have at least one keyboard listener.';
|
|---|
| 22 |
|
|---|
| 23 | const expectedError = {
|
|---|
| 24 | message: errorMessage,
|
|---|
| 25 | type: 'JSXOpeningElement',
|
|---|
| 26 | };
|
|---|
| 27 |
|
|---|
| 28 | ruleTester.run('click-events-have-key-events', rule, {
|
|---|
| 29 | valid: parsers.all([].concat(
|
|---|
| 30 | { code: '<div onClick={() => void 0} onKeyDown={foo}/>;' },
|
|---|
| 31 | { code: '<div onClick={() => void 0} onKeyUp={foo} />;' },
|
|---|
| 32 | { code: '<div onClick={() => void 0} onKeyPress={foo}/>;' },
|
|---|
| 33 | { code: '<div onClick={() => void 0} onKeyDown={foo} onKeyUp={bar} />;' },
|
|---|
| 34 | { code: '<div onClick={() => void 0} onKeyDown={foo} {...props} />;' },
|
|---|
| 35 | { code: '<div className="foo" />;' },
|
|---|
| 36 | { code: '<div onClick={() => void 0} aria-hidden />;' },
|
|---|
| 37 | { code: '<div onClick={() => void 0} aria-hidden={true} />;' },
|
|---|
| 38 | { code: '<div onClick={() => void 0} aria-hidden={false} onKeyDown={foo} />;' },
|
|---|
| 39 | {
|
|---|
| 40 | code: '<div onClick={() => void 0} onKeyDown={foo} aria-hidden={undefined} />;',
|
|---|
| 41 | },
|
|---|
| 42 | { code: '<input type="text" onClick={() => void 0} />' },
|
|---|
| 43 | { code: '<input onClick={() => void 0} />' },
|
|---|
| 44 | { code: '<button onClick={() => void 0} className="foo" />' },
|
|---|
| 45 | { code: '<option onClick={() => void 0} className="foo" />' },
|
|---|
| 46 | { code: '<select onClick={() => void 0} className="foo" />' },
|
|---|
| 47 | { code: '<textarea onClick={() => void 0} className="foo" />' },
|
|---|
| 48 | { code: '<a onClick={() => void 0} href="http://x.y.z" />' },
|
|---|
| 49 | { code: '<a onClick={() => void 0} href="http://x.y.z" tabIndex="0" />' },
|
|---|
| 50 | { code: '<input onClick={() => void 0} type="hidden" />;' },
|
|---|
| 51 | { code: '<div onClick={() => void 0} role="presentation" />;' },
|
|---|
| 52 | { code: '<div onClick={() => void 0} role="none" />;' },
|
|---|
| 53 | { code: '<TestComponent onClick={doFoo} />' },
|
|---|
| 54 | { code: '<Button onClick={doFoo} />' },
|
|---|
| 55 | { code: '<Footer onClick={doFoo} />' },
|
|---|
| 56 | )).map(parserOptionsMapper),
|
|---|
| 57 | invalid: parsers.all([].concat(
|
|---|
| 58 | { code: '<div onClick={() => void 0} />;', errors: [expectedError] },
|
|---|
| 59 | {
|
|---|
| 60 | code: '<div onClick={() => void 0} role={undefined} />;',
|
|---|
| 61 | errors: [expectedError],
|
|---|
| 62 | },
|
|---|
| 63 | { code: '<div onClick={() => void 0} {...props} />;', errors: [expectedError] },
|
|---|
| 64 | { code: '<section onClick={() => void 0} />;', errors: [expectedError] },
|
|---|
| 65 | { code: '<main onClick={() => void 0} />;', errors: [expectedError] },
|
|---|
| 66 | { code: '<article onClick={() => void 0} />;', errors: [expectedError] },
|
|---|
| 67 | { code: '<header onClick={() => void 0} />;', errors: [expectedError] },
|
|---|
| 68 | { code: '<footer onClick={() => void 0} />;', errors: [expectedError] },
|
|---|
| 69 | {
|
|---|
| 70 | code: '<div onClick={() => void 0} aria-hidden={false} />;',
|
|---|
| 71 | errors: [expectedError],
|
|---|
| 72 | },
|
|---|
| 73 | { code: '<a onClick={() => void 0} />', errors: [expectedError] },
|
|---|
| 74 | { code: '<a tabIndex="0" onClick={() => void 0} />', errors: [expectedError] },
|
|---|
| 75 | { code: '<Footer onClick={doFoo} />', errors: [expectedError], settings: { 'jsx-a11y': { components: { Footer: 'footer' } } } },
|
|---|
| 76 | )).map(parserOptionsMapper),
|
|---|
| 77 | });
|
|---|