Skip to content

Commit cb6788c

Browse files
lb-ljharb
authored andcommitted
[Docs] Use consistent spelling of 'screen reader'
See PR #725
1 parent 4925ba8 commit cb6788c

13 files changed

+55
-55
lines changed

Diff for: README.md

+41-41
Large diffs are not rendered by default.

Diff for: __tests__/src/rules/anchor-ambiguous-text-test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const DEFAULT_AMBIGUOUS_WORDS = [
2727
];
2828

2929
const expectedErrorGenerator = (words) => ({
30-
message: `Ambiguous text within anchor. Screenreader users rely on link text for context; the words "${words.join('", "')}" are ambiguous and do not provide enough context.`,
30+
message: `Ambiguous text within anchor. Screen reader users rely on link text for context; the words "${words.join('", "')}" are ambiguous and do not provide enough context.`,
3131
type: 'JSXOpeningElement',
3232
});
3333

Diff for: __tests__/src/rules/no-access-key-test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import rule from '../../../src/rules/no-access-key';
1919
const ruleTester = new RuleTester();
2020

2121
const expectedError = {
22-
message: 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreaders and keyboard-only users create a11y complications.',
22+
message: 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screen readers and keyboard-only users create a11y complications.',
2323
type: 'JSXOpeningElement',
2424
};
2525

Diff for: docs/rules/accessible-emoji.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Emoji have become a common way of communicating content to the end user. To a person using a screenreader, however, they may not be aware that this content is there at all. By wrapping the emoji in a `<span>`, giving it the `role="img"`, and providing a useful description in `aria-label`, the screenreader will treat the emoji as an image in the accessibility tree with an accessible name for the end user.
7+
Emoji have become a common way of communicating content to the end user. To a person using a screen reader, however, they may not be aware that this content is there at all. By wrapping the emoji in a `<span>`, giving it the `role="img"`, and providing a useful description in `aria-label`, the screen reader will treat the emoji as an image in the accessibility tree with an accessible name for the end user.
88

99
## Rule details
1010

Diff for: docs/rules/anchor-ambiguous-text.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Enforces `<a>` values are not exact matches for the phrases "click here", "here", "link", "a link", or "learn more". Screenreaders announce tags as links/interactive, but rely on values for context. Ambiguous anchor descriptions do not provide sufficient context for users.
7+
Enforces `<a>` values are not exact matches for the phrases "click here", "here", "link", "a link", or "learn more". Screen readers announce tags as links/interactive, but rely on values for context. Ambiguous anchor descriptions do not provide sufficient context for users.
88

99
## Rule options
1010

Diff for: docs/rules/click-events-have-key-events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Enforce `onClick` is accompanied by at least one of the following: `onKeyUp`, `onKeyDown`, `onKeyPress`. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screenreader users. This does not apply for interactive or hidden elements.
7+
Enforce `onClick` is accompanied by at least one of the following: `onKeyUp`, `onKeyDown`, `onKeyPress`. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screen reader users. This does not apply for interactive or hidden elements.
88

99
## Rule details
1010

Diff for: docs/rules/img-redundant-alt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Enforce img alt attribute does not contain the word image, picture, or photo. Screenreaders already announce `img` elements as an image. There is no need to use words such as *image*, *photo*, and/or *picture*.
7+
Enforce img alt attribute does not contain the word image, picture, or photo. Screen readers already announce `img` elements as an image. There is no need to use words such as *image*, *photo*, and/or *picture*.
88

99
## Rule options
1010

Diff for: docs/rules/mouse-events-have-key-events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Enforce onmouseover/onmouseout are accompanied by onfocus/onblur. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screenreader users.
7+
Enforce onmouseover/onmouseout are accompanied by onfocus/onblur. Coding for the keyboard is important for users with physical disabilities who cannot use a mouse, AT compatibility, and screen reader users.
88

99
## Rule options
1010

Diff for: docs/rules/no-access-key.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<!-- end auto-generated rule header -->
66

7-
Enforce no accessKey prop on element. Access keys are HTML attributes that allow web developers to assign keyboard shortcuts to elements. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreaders and keyboard-only users create accessibility complications so to avoid complications, access keys should not be used.
7+
Enforce no accessKey prop on element. Access keys are HTML attributes that allow web developers to assign keyboard shortcuts to elements. Inconsistencies between keyboard shortcuts and keyboard commands used by screen readers and keyboard-only users create accessibility complications so to avoid complications, access keys should not be used.
88

99
### References
1010
1. [WebAIM](https://webaim.org/techniques/keyboard/accesskey#spec)

Diff for: docs/rules/no-noninteractive-element-interactions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Adjust the list of handler prop names in the handlers array to increase or decre
122122
<div onClick={() => void 0} role="presentation" />
123123
<input type="text" onClick={() => void 0} /> // Interactive element does not require role.
124124
<button onClick={() => void 0} className="foo" /> // button is interactive.
125-
<div onClick={() => void 0} role="button" aria-hidden /> // This is hidden from screenreader.
125+
<div onClick={() => void 0} role="button" aria-hidden /> // This is hidden from screen reader.
126126
<Input onClick={() => void 0} type="hidden" /> // This is a higher-level DOM component
127127
```
128128

Diff for: src/rules/accessible-emoji.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @fileoverview Enforce emojis are wrapped in <span> and provide screenreader access.
2+
* @fileoverview Enforce emojis are wrapped in <span> and provide screen reader access.
33
* @author Ethan Cohen
44
*/
55

@@ -21,7 +21,7 @@ const schema = generateObjSchema();
2121
export default {
2222
meta: {
2323
docs: {
24-
description: 'Enforce emojis are wrapped in `<span>` and provide screenreader access.',
24+
description: 'Enforce emojis are wrapped in `<span>` and provide screen reader access.',
2525
url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md',
2626
},
2727
deprecated: true,

Diff for: src/rules/anchor-ambiguous-text.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export default ({
6060

6161
context.report({
6262
node,
63-
message: 'Ambiguous text within anchor. Screenreader users rely on link text for context; the words "{{wordsList}}" are ambiguous and do not provide enough context.',
63+
message: 'Ambiguous text within anchor. Screen reader users rely on link text for context; the words "{{wordsList}}" are ambiguous and do not provide enough context.',
6464
data: {
6565
wordsList: words.join('", "'),
6666
},

Diff for: src/rules/no-access-key.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
import { getProp, getPropValue } from 'jsx-ast-utils';
1111
import { generateObjSchema } from '../util/schemas';
1212

13-
const errorMessage = 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screenreaders and keyboard-only users create a11y complications.';
13+
const errorMessage = 'No access key attribute allowed. Inconsistencies between keyboard shortcuts and keyboard commands used by screen readers and keyboard-only users create a11y complications.';
1414

1515
const schema = generateObjSchema();
1616

1717
export default {
1818
meta: {
1919
docs: {
2020
url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-access-key.md',
21-
description: 'Enforce that the `accessKey` prop is not used on any element to avoid complications with keyboard commands used by a screenreader.',
21+
description: 'Enforce that the `accessKey` prop is not used on any element to avoid complications with keyboard commands used by a screen reader.',
2222
},
2323
schema: [schema],
2424
},

0 commit comments

Comments
 (0)