msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

Convert src/compiler/compile/utils/a11y.ts to JavaScript

Browse Source
pull/8569/head
Simon Holthausen 3 years ago
parent dfee586567
commit 13de5cbdad
1 changed files with 290 additions and 303 deletions
Show Stats Download Patch File Download Diff File

593
src/compiler/compile/utils/a11y.ts
Unescape View File

@ -1,354 +1,341 @@
import { import { roles as roles_map, elementRoles } from 'aria-query';
ARIARoleDefinitionKey,
roles as roles_map,
elementRoles,
ARIARoleRelationConcept
} from 'aria-query';
import { AXObjects, AXObjectRoles, elementAXObjects } from 'axobject-query'; import { AXObjects, AXObjectRoles, elementAXObjects } from 'axobject-query';
import Attribute from '../nodes/Attribute'; import { regex_whitespaces } from '../../utils/patterns.js';
import { regex_whitespaces } from '../../utils/patterns';
const aria_roles = roles_map.keys(); const aria_roles = roles_map.keys();
const abstract_roles = new Set(aria_roles.filter((role) => roles_map.get(role).abstract)); const abstract_roles = new Set(aria_roles.filter((role) => roles_map.get(role).abstract));
const non_abstract_roles = aria_roles.filter((name) => !abstract_roles.has(name)); const non_abstract_roles = aria_roles.filter((name) => !abstract_roles.has(name));
const non_interactive_roles = new Set(non_abstract_roles
const non_interactive_roles = new Set( .filter((name) => {
non_abstract_roles const role = roles_map.get(name);
.filter((name) => { return (
const role = roles_map.get(name); // 'toolbar' does not descend from widget, but it does support
return ( // aria-activedescendant, thus in practice we treat it as a widget.
// 'toolbar' does not descend from widget, but it does support // focusable tabpanel elements are recommended if any panels in a set contain content where the first element in the panel is not focusable.
// aria-activedescendant, thus in practice we treat it as a widget. // 'generic' is meant to have no semantic meaning.
// focusable tabpanel elements are recommended if any panels in a set contain content where the first element in the panel is not focusable. !['toolbar', 'tabpanel', 'generic'].includes(name) &&
// 'generic' is meant to have no semantic meaning. !role.superClass.some((classes) => classes.includes('widget')));
!['toolbar', 'tabpanel', 'generic'].includes(name) && })
!role.superClass.some((classes) => classes.includes('widget')) .concat(
); // The `progressbar` is descended from `widget`, but in practice, its
}) // value is always `readonly`, so we treat it as a non-interactive role.
.concat( 'progressbar'));
// The `progressbar` is descended from `widget`, but in practice, its const interactive_roles = new Set(non_abstract_roles.filter((name) => !non_interactive_roles.has(name) &&
// value is always `readonly`, so we treat it as a non-interactive role. // 'generic' is meant to have no semantic meaning.
'progressbar' name !== 'generic'));
)
); /**
* @param {ARIARoleDefinitionKey} role
const interactive_roles = new Set( */
non_abstract_roles.filter( export function is_non_interactive_roles(role) {
(name) => return non_interactive_roles.has(role);
!non_interactive_roles.has(name) &&
// 'generic' is meant to have no semantic meaning.
name !== 'generic'
)
);
export function is_non_interactive_roles(role: ARIARoleDefinitionKey) {
return non_interactive_roles.has(role);
} }
export function is_interactive_roles(role: ARIARoleDefinitionKey) { /**
return interactive_roles.has(role); * @param {ARIARoleDefinitionKey} role
*/
export function is_interactive_roles(role) {
return interactive_roles.has(role);
} }
export function is_abstract_role(role: ARIARoleDefinitionKey) { /**
return abstract_roles.has(role); * @param {ARIARoleDefinitionKey} role
*/
export function is_abstract_role(role) {
return abstract_roles.has(role);
} }
const presentation_roles = new Set(['presentation', 'none']); const presentation_roles = new Set(['presentation', 'none']);
export function is_presentation_role(role: ARIARoleDefinitionKey) { /**
return presentation_roles.has(role); * @param {ARIARoleDefinitionKey} role
*/
export function is_presentation_role(role) {
return presentation_roles.has(role);
} }
export function is_hidden_from_screen_reader( /**
tag_name: string, * @param {string} tag_name
attribute_map: Map<string, Attribute> * @param {Map<string, Attribute>} attribute_map
) { */
if (tag_name === 'input') { export function is_hidden_from_screen_reader(tag_name, attribute_map) {
const type = attribute_map.get('type')?.get_static_value(); if (tag_name === 'input') {
const type = attribute_map.get('type')?.get_static_value();
if (type && type === 'hidden') { if (type && type === 'hidden') {
return true; return true;
} }
} }
const aria_hidden = attribute_map.get('aria-hidden');
const aria_hidden = attribute_map.get('aria-hidden'); if (!aria_hidden)
if (!aria_hidden) return false; return false;
if (!aria_hidden.is_static) return true; if (!aria_hidden.is_static)
const aria_hidden_value = aria_hidden.get_static_value(); return true;
return aria_hidden_value === true || aria_hidden_value === 'true'; const aria_hidden_value = aria_hidden.get_static_value();
return aria_hidden_value === true || aria_hidden_value === 'true';
} }
export function has_disabled_attribute(attribute_map: Map<string, Attribute>) { /**
const disabled_attr = attribute_map.get('disabled'); * @param {Map<string, Attribute>} attribute_map
const disabled_attr_value = disabled_attr && disabled_attr.get_static_value(); */
if (disabled_attr_value) { export function has_disabled_attribute(attribute_map) {
return true; const disabled_attr = attribute_map.get('disabled');
} const disabled_attr_value = disabled_attr && disabled_attr.get_static_value();
if (disabled_attr_value) {
const aria_disabled_attr = attribute_map.get('aria-disabled'); return true;
if (aria_disabled_attr) { }
const aria_disabled_attr_value = aria_disabled_attr.get_static_value(); const aria_disabled_attr = attribute_map.get('aria-disabled');
if (aria_disabled_attr_value === true) { if (aria_disabled_attr) {
return true; const aria_disabled_attr_value = aria_disabled_attr.get_static_value();
} if (aria_disabled_attr_value === true) {
} return true;
}
return false; }
return false;
} }
const non_interactive_element_role_schemas: ARIARoleRelationConcept[] = []; /**
* @type {ARIARoleRelationConcept[]}
*/
const non_interactive_element_role_schemas = [];
elementRoles.entries().forEach(([schema, roles]) => { elementRoles.entries().forEach(([schema, roles]) => {
if ([...roles].every((role) => role !== 'generic' && non_interactive_roles.has(role))) { if ([...roles].every((role) => role !== 'generic' && non_interactive_roles.has(role))) {
non_interactive_element_role_schemas.push(schema); non_interactive_element_role_schemas.push(schema);
} }
}); });
const interactive_element_role_schemas: ARIARoleRelationConcept[] = []; /**
* @type {ARIARoleRelationConcept[]}
*/
const interactive_element_role_schemas = [];
elementRoles.entries().forEach(([schema, roles]) => { elementRoles.entries().forEach(([schema, roles]) => {
if ([...roles].every((role) => interactive_roles.has(role))) { if ([...roles].every((role) => interactive_roles.has(role))) {
interactive_element_role_schemas.push(schema); interactive_element_role_schemas.push(schema);
} }
}); });
const interactive_ax_objects = new Set([...AXObjects.keys()].filter((name) => AXObjects.get(name).type === 'widget'));
const non_interactive_ax_objects = new Set([...AXObjects.keys()].filter((name) => ['windows', 'structure'].includes(AXObjects.get(name).type)));
const interactive_ax_objects = new Set( /**
[...AXObjects.keys()].filter((name) => AXObjects.get(name).type === 'widget') * @type {ARIARoleRelationConcept[]}
); */
const interactive_element_ax_object_schemas = [];
const non_interactive_ax_objects = new Set(
[...AXObjects.keys()].filter((name) =>
['windows', 'structure'].includes(AXObjects.get(name).type)
)
);
const interactive_element_ax_object_schemas: ARIARoleRelationConcept[] = [];
elementAXObjects.entries().forEach(([schema, ax_object]) => { elementAXObjects.entries().forEach(([schema, ax_object]) => {
if ([...ax_object].every((role) => interactive_ax_objects.has(role))) { if ([...ax_object].every((role) => interactive_ax_objects.has(role))) {
interactive_element_ax_object_schemas.push(schema); interactive_element_ax_object_schemas.push(schema);
} }
}); });
const non_interactive_element_ax_object_schemas: ARIARoleRelationConcept[] = []; /**
* @type {ARIARoleRelationConcept[]}
*/
const non_interactive_element_ax_object_schemas = [];
elementAXObjects.entries().forEach(([schema, ax_object]) => { elementAXObjects.entries().forEach(([schema, ax_object]) => {
if ([...ax_object].every((role) => non_interactive_ax_objects.has(role))) { if ([...ax_object].every((role) => non_interactive_ax_objects.has(role))) {
non_interactive_element_ax_object_schemas.push(schema); non_interactive_element_ax_object_schemas.push(schema);
} }
}); });
function match_schema( /**
schema: ARIARoleRelationConcept, * @param {ARIARoleRelationConcept} schema
tag_name: string, * @param {string} tag_name
attribute_map: Map<string, Attribute> * @param {Map<string, Attribute>} attribute_map
) { */
if (schema.name !== tag_name) return false; function match_schema(schema, tag_name, attribute_map) {
if (!schema.attributes) return true; if (schema.name !== tag_name)
return schema.attributes.every((schema_attribute) => { return false;
const attribute = attribute_map.get(schema_attribute.name); if (!schema.attributes)
if (!attribute) return false; return true;
if (schema_attribute.value && schema_attribute.value !== attribute.get_static_value()) { return schema.attributes.every((schema_attribute) => {
return false; const attribute = attribute_map.get(schema_attribute.name);
} if (!attribute)
return true; return false;
}); if (schema_attribute.value && schema_attribute.value !== attribute.get_static_value()) {
} return false;
}
export enum ElementInteractivity { return true;
Interactive = 'interactive', });
NonInteractive = 'non-interactive',
Static = 'static'
} }
export var ElementInteractivity;
export function element_interactivity( (function (ElementInteractivity) {
tag_name: string, ElementInteractivity["Interactive"] = "interactive";
attribute_map: Map<string, Attribute> ElementInteractivity["NonInteractive"] = "non-interactive";
): ElementInteractivity { ElementInteractivity["Static"] = "static";
if ( })(ElementInteractivity || (ElementInteractivity = {}));
interactive_element_role_schemas.some((schema) => match_schema(schema, tag_name, attribute_map))
) { /**
return ElementInteractivity.Interactive; * @param {string} tag_name
} * @param {Map<string, Attribute>} attribute_map
* @returns {import("C:/repos/svelte/svelte/a11y.ts-to-jsdoc").ElementInteractivity}
if ( */
tag_name !== 'header' && export function element_interactivity(tag_name, attribute_map) {
non_interactive_element_role_schemas.some((schema) => if (interactive_element_role_schemas.some((schema) => match_schema(schema, tag_name, attribute_map))) {
match_schema(schema, tag_name, attribute_map) return ElementInteractivity.Interactive;
) }
) { if (tag_name !== 'header' &&
return ElementInteractivity.NonInteractive; non_interactive_element_role_schemas.some((schema) => match_schema(schema, tag_name, attribute_map))) {
} return ElementInteractivity.NonInteractive;
}
if ( if (interactive_element_ax_object_schemas.some((schema) => match_schema(schema, tag_name, attribute_map))) {
interactive_element_ax_object_schemas.some((schema) => return ElementInteractivity.Interactive;
match_schema(schema, tag_name, attribute_map) }
) if (non_interactive_element_ax_object_schemas.some((schema) => match_schema(schema, tag_name, attribute_map))) {
) { return ElementInteractivity.NonInteractive;
return ElementInteractivity.Interactive; }
} return ElementInteractivity.Static;
if (
non_interactive_element_ax_object_schemas.some((schema) =>
match_schema(schema, tag_name, attribute_map)
)
) {
return ElementInteractivity.NonInteractive;
}
return ElementInteractivity.Static;
} }
export function is_interactive_element( /**
tag_name: string, * @param {string} tag_name
attribute_map: Map<string, Attribute> * @param {Map<string, Attribute>} attribute_map
): boolean { * @returns {boolean}
return element_interactivity(tag_name, attribute_map) === ElementInteractivity.Interactive; */
export function is_interactive_element(tag_name, attribute_map) {
return element_interactivity(tag_name, attribute_map) === ElementInteractivity.Interactive;
} }
export function is_non_interactive_element( /**
tag_name: string, * @param {string} tag_name
attribute_map: Map<string, Attribute> * @param {Map<string, Attribute>} attribute_map
): boolean { * @returns {boolean}
return element_interactivity(tag_name, attribute_map) === ElementInteractivity.NonInteractive; */
export function is_non_interactive_element(tag_name, attribute_map) {
return element_interactivity(tag_name, attribute_map) === ElementInteractivity.NonInteractive;
} }
export function is_static_element( /**
tag_name: string, * @param {string} tag_name
attribute_map: Map<string, Attribute> * @param {Map<string, Attribute>} attribute_map
): boolean { * @returns {boolean}
return element_interactivity(tag_name, attribute_map) === ElementInteractivity.Static; */
export function is_static_element(tag_name, attribute_map) {
return element_interactivity(tag_name, attribute_map) === ElementInteractivity.Static;
} }
export function is_semantic_role_element( /**
role: ARIARoleDefinitionKey, * @param {ARIARoleDefinitionKey} role
tag_name: string, * @param {string} tag_name
attribute_map: Map<string, Attribute> * @param {Map<string, Attribute>} attribute_map
) { */
for (const [schema, ax_object] of elementAXObjects.entries()) { export function is_semantic_role_element(role, tag_name, attribute_map) {
if ( for (const [schema, ax_object] of elementAXObjects.entries()) {
schema.name === tag_name && if (schema.name === tag_name &&
(!schema.attributes || (!schema.attributes ||
schema.attributes.every( schema.attributes.every((attr) => attribute_map.has(attr.name) &&
(attr) => attribute_map.get(attr.name).get_static_value() === attr.value))) {
attribute_map.has(attr.name) && for (const name of ax_object) {
attribute_map.get(attr.name).get_static_value() === attr.value const roles = AXObjectRoles.get(name);
)) if (roles) {
) { for (const { name } of roles) {
for (const name of ax_object) { if (name === role) {
const roles = AXObjectRoles.get(name); return true;
if (roles) { }
for (const { name } of roles) { }
if (name === role) { }
return true; }
} }
} }
} return false;
}
}
}
return false;
} }
// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute
const address_type_tokens = new Set(['shipping', 'billing']); const address_type_tokens = new Set(['shipping', 'billing']);
const autofill_field_name_tokens = new Set([ const autofill_field_name_tokens = new Set([
'', '',
'on', 'on',
'off', 'off',
'name', 'name',
'honorific-prefix', 'honorific-prefix',
'given-name', 'given-name',
'additional-name', 'additional-name',
'family-name', 'family-name',
'honorific-suffix', 'honorific-suffix',
'nickname', 'nickname',
'username', 'username',
'new-password', 'new-password',
'current-password', 'current-password',
'one-time-code', 'one-time-code',
'organization-title', 'organization-title',
'organization', 'organization',
'street-address', 'street-address',
'address-line1', 'address-line1',
'address-line2', 'address-line2',
'address-line3', 'address-line3',
'address-level4', 'address-level4',
'address-level3', 'address-level3',
'address-level2', 'address-level2',
'address-level1', 'address-level1',
'country', 'country',
'country-name', 'country-name',
'postal-code', 'postal-code',
'cc-name', 'cc-name',
'cc-given-name', 'cc-given-name',
'cc-additional-name', 'cc-additional-name',
'cc-family-name', 'cc-family-name',
'cc-number', 'cc-number',
'cc-exp', 'cc-exp',
'cc-exp-month', 'cc-exp-month',
'cc-exp-year', 'cc-exp-year',
'cc-csc', 'cc-csc',
'cc-type', 'cc-type',
'transaction-currency', 'transaction-currency',
'transaction-amount', 'transaction-amount',
'language', 'language',
'bday', 'bday',
'bday-day', 'bday-day',
'bday-month', 'bday-month',
'bday-year', 'bday-year',
'sex', 'sex',
'url', 'url',
'photo' 'photo'
]); ]);
const contact_type_tokens = new Set(['home', 'work', 'mobile', 'fax', 'pager']); const contact_type_tokens = new Set(['home', 'work', 'mobile', 'fax', 'pager']);
const autofill_contact_field_name_tokens = new Set([ const autofill_contact_field_name_tokens = new Set([
'tel', 'tel',
'tel-country-code', 'tel-country-code',
'tel-national', 'tel-national',
'tel-area-code', 'tel-area-code',
'tel-local', 'tel-local',
'tel-local-prefix', 'tel-local-prefix',
'tel-local-suffix', 'tel-local-suffix',
'tel-extension', 'tel-extension',
'email', 'email',
'impp' 'impp'
]); ]);
export function is_valid_autocomplete(autocomplete: null | true | string) { /**
if (autocomplete === true) { * @param {null | true | string} autocomplete
return false; */
} else if (!autocomplete) { export function is_valid_autocomplete(autocomplete) {
return true; // dynamic value if (autocomplete === true) {
} return false;
}
const tokens = autocomplete.trim().toLowerCase().split(regex_whitespaces); else if (!autocomplete) {
return true; // dynamic value
if (typeof tokens[0] === 'string' && tokens[0].startsWith('section-')) { }
tokens.shift(); const tokens = autocomplete.trim().toLowerCase().split(regex_whitespaces);
} if (typeof tokens[0] === 'string' && tokens[0].startsWith('section-')) {
tokens.shift();
if (address_type_tokens.has(tokens[0])) { }
tokens.shift(); if (address_type_tokens.has(tokens[0])) {
} tokens.shift();
}
if (autofill_field_name_tokens.has(tokens[0])) {
tokens.shift();
}
else {
if (contact_type_tokens.has(tokens[0])) {
tokens.shift();
}
if (autofill_contact_field_name_tokens.has(tokens[0])) {
tokens.shift();
}
else {
return false;
}
}
if (tokens[0] === 'webauthn') {
tokens.shift();
}
return tokens.length === 0;
}
if (autofill_field_name_tokens.has(tokens[0])) {
tokens.shift();
} else {
if (contact_type_tokens.has(tokens[0])) {
tokens.shift();
}
if (autofill_contact_field_name_tokens.has(tokens[0])) {
tokens.shift();
} else {
return false;
}
}
if (tokens[0] === 'webauthn') {
tokens.shift();
}
return tokens.length === 0;
}

Write Preview
Loading…
Cancel
Save