Skip to content

Commit

Permalink
docs: make quotes usage consistent in messages of rules and checks (d…
Browse files Browse the repository at this point in the history 
…equelabs#4144)

* Replace name='value' with name=\"value\"
* don't enclose name=value in single quotes
  • Loading branch information
@ma10
ma10 committed Sep 5, 2023
1 parent b78fba6 commit 2bddcaf
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions doc/rule-descriptions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| [aria-command-name](https://dequeuniversity.com/rules/axe/4.7/aria-command-name?application=RuleDescription) | Ensures every ARIA button, link and menuitem has an accessible name | Serious | cat.aria, wcag2a, wcag412, TTv5, TT6.a, EN-301-549, EN-9.4.1.2, ACT | failure, needs review | [97a4e1](https://act-rules.github.io/rules/97a4e1) |
| [aria-conditional-attr](https://dequeuniversity.com/rules/axe/4.7/aria-conditional-attr?application=RuleDescription) | Ensures ARIA attributes are used as described in the specification of the element's role | Serious | cat.aria, wcag2a, wcag412, EN-301-549, EN-9.4.1.2 | failure | [5c01ea](https://act-rules.github.io/rules/5c01ea) |
| [aria-deprecated-role](https://dequeuniversity.com/rules/axe/4.7/aria-deprecated-role?application=RuleDescription) | Ensures elements do not use deprecated roles | Minor | cat.aria, wcag2a, wcag412, EN-301-549, EN-9.4.1.2 | failure | [674b10](https://act-rules.github.io/rules/674b10) |
| [aria-hidden-body](https://dequeuniversity.com/rules/axe/4.7/aria-hidden-body?application=RuleDescription) | Ensures aria-hidden='true' is not present on the document body. | Critical | cat.aria, wcag2a, wcag412, EN-301-549, EN-9.4.1.2 | failure | |
| [aria-hidden-body](https://dequeuniversity.com/rules/axe/4.7/aria-hidden-body?application=RuleDescription) | Ensures aria-hidden="true" is not present on the document body. | Critical | cat.aria, wcag2a, wcag412, EN-301-549, EN-9.4.1.2 | failure | |
| [aria-hidden-focus](https://dequeuniversity.com/rules/axe/4.7/aria-hidden-focus?application=RuleDescription) | Ensures aria-hidden elements are not focusable nor contain focusable elements | Serious | cat.name-role-value, wcag2a, wcag412, TTv5, TT6.a, EN-301-549, EN-9.4.1.2 | failure, needs review | [6cfa84](https://act-rules.github.io/rules/6cfa84) |
| [aria-input-field-name](https://dequeuniversity.com/rules/axe/4.7/aria-input-field-name?application=RuleDescription) | Ensures every ARIA input field has an accessible name | Serious | cat.aria, wcag2a, wcag412, TTv5, TT5.c, EN-301-549, EN-9.4.1.2, ACT | failure, needs review | [e086e5](https://act-rules.github.io/rules/e086e5) |
| [aria-meter-name](https://dequeuniversity.com/rules/axe/4.7/aria-meter-name?application=RuleDescription) | Ensures every ARIA meter node has an accessible name | Serious | cat.aria, wcag2a, wcag111, EN-301-549, EN-9.1.1.1 | failure, needs review | |
Expand Down Expand Up @@ -63,7 +63,7 @@
| [nested-interactive](https://dequeuniversity.com/rules/axe/4.7/nested-interactive?application=RuleDescription) | Ensures interactive controls are not nested as they are not always announced by screen readers or can cause focus problems for assistive technologies | Serious | cat.keyboard, wcag2a, wcag412, TTv5, TT6.a, EN-301-549, EN-9.4.1.2 | failure, needs review | [307n5z](https://act-rules.github.io/rules/307n5z) |
| [no-autoplay-audio](https://dequeuniversity.com/rules/axe/4.7/no-autoplay-audio?application=RuleDescription) | Ensures <video> or <audio> elements do not autoplay audio for more than 3 seconds without a control mechanism to stop or mute the audio | Moderate | cat.time-and-media, wcag2a, wcag142, TTv5, TT2.a, EN-301-549, EN-9.1.4.2, ACT | needs review | [80f0bf](https://act-rules.github.io/rules/80f0bf) |
| [object-alt](https://dequeuniversity.com/rules/axe/4.7/object-alt?application=RuleDescription) | Ensures <object> elements have alternate text | Serious | cat.text-alternatives, wcag2a, wcag111, section508, section508.22.a, EN-301-549, EN-9.1.1.1 | failure, needs review | [8fc3b6](https://act-rules.github.io/rules/8fc3b6) |
| [role-img-alt](https://dequeuniversity.com/rules/axe/4.7/role-img-alt?application=RuleDescription) | Ensures [role='img'] elements have alternate text | Serious | cat.text-alternatives, wcag2a, wcag111, section508, section508.22.a, TTv5, TT7.a, EN-301-549, EN-9.1.1.1, ACT | failure, needs review | [23a2a8](https://act-rules.github.io/rules/23a2a8) |
| [role-img-alt](https://dequeuniversity.com/rules/axe/4.7/role-img-alt?application=RuleDescription) | Ensures [role="img"] elements have alternate text | Serious | cat.text-alternatives, wcag2a, wcag111, section508, section508.22.a, TTv5, TT7.a, EN-301-549, EN-9.1.1.1, ACT | failure, needs review | [23a2a8](https://act-rules.github.io/rules/23a2a8) |
| [scrollable-region-focusable](https://dequeuniversity.com/rules/axe/4.7/scrollable-region-focusable?application=RuleDescription) | Ensure elements that have scrollable content are accessible by keyboard | Serious | cat.keyboard, wcag2a, wcag211, TTv5, TT4.a, EN-301-549, EN-9.2.1.1 | failure | [0ssw9k](https://act-rules.github.io/rules/0ssw9k) |
| [select-name](https://dequeuniversity.com/rules/axe/4.7/select-name?application=RuleDescription) | Ensures select element has an accessible name | Critical | cat.forms, wcag2a, wcag412, section508, section508.22.n, TTv5, TT5.c, EN-301-549, EN-9.4.1.2, ACT | failure, needs review | [e086e5](https://act-rules.github.io/rules/e086e5) |
| [server-side-image-map](https://dequeuniversity.com/rules/axe/4.7/server-side-image-map?application=RuleDescription) | Ensures that server-side image maps are not used | Minor | cat.text-alternatives, wcag2a, wcag211, section508, section508.22.f, TTv5, TT4.a, EN-301-549, EN-9.2.1.1 | needs review | |
Expand Down
2 changes: 1 addition & 1 deletion lib/checks/keyboard/focusable-not-tabbable.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"messages": {
"pass": "No focusable elements contained within element",
"incomplete": "Check if the focusable elements immediately move the focus indicator",
"fail": "Focusable content should have tabindex='-1' or be removed from the DOM"
"fail": "Focusable content should have tabindex=\"-1\" or be removed from the DOM"
}
}
}
2 changes: 1 addition & 1 deletion lib/checks/keyboard/no-focusable-content.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"pass": "Element does not have focusable descendants",
"fail": {
"default": "Element has focusable descendants",
"notHidden": "Using a negative tabindex on an element inside an interactive control does not prevent assistive technologies from focusing the element (even with 'aria-hidden=true')"
"notHidden": "Using a negative tabindex on an element inside an interactive control does not prevent assistive technologies from focusing the element (even with aria-hidden=\"true\")"
},
"incomplete": "Could not determine if element has descendants"
}
Expand Down
4 changes: 2 additions & 2 deletions lib/rules/aria-hidden-body.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"matches": "is-initiator-matches",
"tags": ["cat.aria", "wcag2a", "wcag412", "EN-301-549", "EN-9.4.1.2"],
"metadata": {
"description": "Ensures aria-hidden='true' is not present on the document body.",
"help": "aria-hidden='true' must not be present on the document body"
"description": "Ensures aria-hidden=\"true\" is not present on the document body.",
"help": "aria-hidden=\"true\" must not be present on the document body"
},
"all": [],
"any": ["aria-hidden-body"],
Expand Down
4 changes: 2 additions & 2 deletions lib/rules/role-img-alt.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
],
"actIds": ["23a2a8"],
"metadata": {
"description": "Ensures [role='img'] elements have alternate text",
"help": "[role='img'] elements must have an alternative text"
"description": "Ensures [role=\"img\"] elements have alternate text",
"help": "[role=\"img\"] elements must have an alternative text"
},
"all": [],
"any": ["aria-label", "aria-labelledby", "non-empty-title"],
Expand Down
12 changes: 6 additions & 6 deletions locales/_template.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
"help": "ARIA dialog and alertdialog nodes should have an accessible name"
},
"aria-hidden-body": {
"description": "Ensures aria-hidden='true' is not present on the document body.",
"help": "aria-hidden='true' must not be present on the document body"
"description": "Ensures aria-hidden=\"true\" is not present on the document body.",
"help": "aria-hidden=\"true\" must not be present on the document body"
},
"aria-hidden-focus": {
"description": "Ensures aria-hidden elements are not focusable nor contain focusable elements",
Expand Down Expand Up @@ -350,8 +350,8 @@
"help": "All page content should be contained by landmarks"
},
"role-img-alt": {
"description": "Ensures [role='img'] elements have alternate text",
"help": "[role='img'] elements must have an alternative text"
"description": "Ensures [role=\"img\"] elements have alternate text",
"help": "[role=\"img\"] elements must have an alternative text"
},
"scope-attr-valid": {
"description": "Ensures the scope attribute is used correctly on tables",
Expand Down Expand Up @@ -710,7 +710,7 @@
"focusable-not-tabbable": {
"pass": "No focusable elements contained within element",
"incomplete": "Check if the focusable elements immediately move the focus indicator",
"fail": "Focusable content should have tabindex='-1' or be removed from the DOM"
"fail": "Focusable content should have tabindex=\"-1\" or be removed from the DOM"
},
"frame-focusable-content": {
"pass": "Element does not have focusable descendants",
Expand All @@ -725,7 +725,7 @@
"pass": "Element does not have focusable descendants",
"fail": {
"default": "Element has focusable descendants",
"notHidden": "Using a negative tabindex on an element inside an interactive control does not prevent assistive technologies from focusing the element (even with 'aria-hidden=true')"
"notHidden": "Using a negative tabindex on an element inside an interactive control does not prevent assistive technologies from focusing the element (even with aria-hidden=\"true\")"
},
"incomplete": "Could not determine if element has descendants"
},
Expand Down

0 comments on commit 2bddcaf

Please sign in to comment.