#2405

Build # #2405

Build Type

push

Committed by

Commit Message

<a href="https://github.com/markuplint/markuplint/commit/<a class=hub.com/markuplint/markuplint/commit/47da403d02f830061d77d2c49e626e5c27bf4bcf">47da403d0<a href="https://github.com/markuplint/markuplint/commit/47da403d02f830061d77d2c49e626e5c27bf4bcf">">Merge </a><a class="double-link" href="https://github.com/markuplint/markuplint/commit/<a class="double-link" href="https://github.com/markuplint/markuplint/commit/ef8af7e785a18cdfc57cdb58b1fa71c885ed0d70">ef8af7e78</a>">ef8af7e78</a><a href="https://github.com/markuplint/markuplint/commit/47da403d02f830061d77d2c49e626e5c27bf4bcf"> into 04b79f03f">04b79f03f</a>

Run Details

3565 of 5284 branches covered (67.47%)

Branch coverage included in aggregate %.

32 of 32 new or added lines in 7 files covered. (100.0%)

6512 of 9074 relevant lines covered (71.77%)

304.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.24

/packages/@markuplint/ml-spec/src/dom-traverse/is-exposed.ts

import type { ARIAVersion, MLMLSpec } from '../types';

import { ariaSpecs } from '../specs/aria-specs';
import { isPalpableElement } from '../specs/is-palpable-elements';
import { isPresentational } from '../specs/is-presentational';

import { getComputedRole } from './get-computed-role';

/**
 * Detect including/excluding from the Accessibility Tree
 *
 * @see https://www.w3.org/TR/wai-aria-1.2/#accessibility_tree
 *
 * @param specs
 * @param el
 * @param version
 */
export function isExposed(el: Element, specs: Readonly<MLMLSpec>, version: ARIAVersion): boolean {
        // According to WAI-ARIA
        if (isExcluding(el, specs, version)) {
                return false;
        }

        // According to HTML and SVG Specs with **the author's interpretation**
        {
                if (!isPalpableElement(el, specs, { extendsSvg: true, extendsExposableElements: true })) {
                        return false;
                }
        }

        // According to WAI-ARIA
        {
                const exposable = isIncluding(el, specs, version);
                if (exposable) {
                        return true;
                }
        }

        // Default
        return true;
}

/**
 * Excluding Elements from the Accessibility Tree
 *
 * @see https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion
 *
 * @param specs
 * @param el
 * @param version
 */
function isExcluding(el: Element, specs: Readonly<MLMLSpec>, version: ARIAVersion): boolean {
        /**
         * The following elements are not exposed via the accessibility API and
         * user agents MUST NOT include them in the accessibility tree:
         * - Elements, including their descendent elements,
         *   that have host language semantics specifying
         *   that the element is not displayed, such as CSS display:none,
         *   visibility:hidden, or the HTML hidden attribute.
         */
        {
                let currentEl: Element | null = el;
                while (currentEl) {
                        if (hasDisplayNodeOrVisibilityHidden(currentEl) || currentEl.hasAttribute('hidden')) {
                                return true;
                        }
                        currentEl = currentEl.parentElement;
                }
        }

        /**
         * - Elements with none or presentation as the first role in the role attribute.
         *   However, their exclusion is conditional. In addition,
         *   the element's descendants and text content are generally included.
         *   These exceptions and conditions are documented in the presentation (role)
         *   section.
         */
        if (isPresentational((el.getAttribute('role') || '').split(/\s+/)[0])) {
                return true;
        }

        /**
         * If not already excluded from the accessibility tree per the above rules,
         * user agents SHOULD NOT include the following elements
         * in the accessibility tree:
         * - Elements, including their descendants, that have aria-hidden set to true.
         *   In other words, aria-hidden="true" on a parent overrides aria-hidden="false"
         *   on descendants.
         */
        {
                let currentEl: Element | null = el;
                while (currentEl) {
                        if (currentEl.getAttribute('aria-hidden') === 'true') {
                                return true;
                        }
                        currentEl = currentEl.parentElement;
                }
        }

        /**
         * - Any descendants of elements that have the characteristic
         *   "Children Presentational: True" unless the descendant
         *   is not allowed to be presentational because it meets one of
         *   the conditions for exception described in
         *   Presentational Roles Conflict Resolution.
         *   However, the text content of any excluded descendants is included.
         */
        {
                let currentEl = el.parentElement;
                while (currentEl) {
                        const { role } = getComputedRole(specs, currentEl, version);
                        if (role?.childrenPresentational) {
                                return true;
                        }
                        currentEl = currentEl.parentElement;
                }
        }

        return false;
}

/**
 * Including Elements in the Accessibility Tree
 *
 * If not excluded from or marked as hidden in the accessibility tree
 * per the rules above in Excluding Elements in the Accessibility Tree,
 * user agents MUST provide an accessible object in the accessibility tree
 * for DOM elements that meet any of the following criteria:
 *
 * @see https://www.w3.org/TR/wai-aria-1.2/#tree_inclusion
 *
 * @param specs
 * @param el
 * @param version
 */
function isIncluding(el: Element, specs: Readonly<MLMLSpec>, version: ARIAVersion): boolean {
        /**
         * > **meet any** of the following criteria:
         */
        const results: boolean[] = [];

        /**
         * Elements that are not hidden and may fire an accessibility API event,
         * including:
         * - Elements that are currently focused, even if the element or one of
         *   its ancestor elements has its aria-hidden attribute set to true.
         */
        // 🚫 Can't detect the element is focused.
        // results.push(true);

        /**
         * - Elements that are a valid target of an aria-activedescendant attribute.
         */
        // TODO: Compute aria-activedescendant.
        // results.push(true);

        /**
         * Elements that have an explicit role or a global WAI-ARIA attribute and
         * do not have aria-hidden set to true.
         * (See Excluding Elements in the Accessibility Tree for
         * additional guidance on aria-hidden.)
         */
        if (el.getAttribute('aria-hidden') !== 'true') {
                const globalAria = ariaSpecs(specs, version).props.filter(prop => prop.isGlobal);
                const { role } = getComputedRole(specs, el, version);
                // Has an explicit role
                if (role && !role.isImplicit) {
                        results.push(true);
                }
                // Has a global WAI-ARIA attribute
                for (const attr of Array.from(el.attributes)) {
                        if (globalAria.some(aria => aria.name === attr.localName)) {
                                results.push(true);
                                break;
                        }
                }
        }

        /**
         * Elements that are not hidden and have an ID that is referenced
         * by another element via a WAI-ARIA property.
         */
        // TODO: Compute refering ID.
        // results.push(true);

        return results.includes(true);
}

function hasDisplayNodeOrVisibilityHidden(el: Element) {
        const style = el.getAttribute('style');
        if (!style) {
                return false;
        }
        // TODO: Improve accuracy
        return /display\s*:\s*none|visibility\s*:\s*hidden/gi.test(style);
}

1	import type { ARIAVersion, MLMLSpec } from '../types';
2
3	import { ariaSpecs } from '../specs/aria-specs';	1✔
4	import { isPalpableElement } from '../specs/is-palpable-elements';	1✔
5	import { isPresentational } from '../specs/is-presentational';	1✔
6
7	import { getComputedRole } from './get-computed-role';	1✔
8
9	/**
10	* Detect including/excluding from the Accessibility Tree
11	*
12	* @see https://www.w3.org/TR/wai-aria-1.2/#accessibility_tree
13	*
14	* @param specs
15	* @param el
16	* @param version
17	*/
18	export function isExposed(el: Element, specs: Readonly<MLMLSpec>, version: ARIAVersion): boolean {	1✔
19	// According to WAI-ARIA
20	if (isExcluding(el, specs, version)) {	20✔
21	return false;	10✔
22	}
23
24	// According to HTML and SVG Specs with the author's interpretation
25	{
26	if (!isPalpableElement(el, specs, { extendsSvg: true, extendsExposableElements: true })) {	10✔
27	return false;	4✔
28	}
29	}
30
31	// According to WAI-ARIA
32	{
33	const exposable = isIncluding(el, specs, version);	6✔
34	if (exposable) {	6!
35	return true;	×
36	}
37	}
38
39	// Default
40	return true;	6✔
41	}
42
43	/**
44	* Excluding Elements from the Accessibility Tree
45	*
46	* @see https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion
47	*
48	* @param specs
49	* @param el
50	* @param version
51	*/
52	function isExcluding(el: Element, specs: Readonly<MLMLSpec>, version: ARIAVersion): boolean {
53	/**
54	* The following elements are not exposed via the accessibility API and
55	* user agents MUST NOT include them in the accessibility tree:
56	* - Elements, including their descendent elements,
57	* that have host language semantics specifying
58	* that the element is not displayed, such as CSS display:none,
59	* visibility:hidden, or the HTML hidden attribute.
60	*/
61	{
62	let currentEl: Element \| null = el;	20✔
63	while (currentEl) {	20✔
64	if (hasDisplayNodeOrVisibilityHidden(currentEl) \|\| currentEl.hasAttribute('hidden')) {	70✔
65	return true;	5✔
66	}
67	currentEl = currentEl.parentElement;	65✔
68	}
69	}
70
71	/**
72	* - Elements with none or presentation as the first role in the role attribute.
73	* However, their exclusion is conditional. In addition,
74	* the element's descendants and text content are generally included.
75	* These exceptions and conditions are documented in the presentation (role)
76	* section.
77	*/
78	if (isPresentational((el.getAttribute('role') \|\| '').split(/\s+/)[0])) {	15✔
79	return true;	2✔
80	}
81
82	/**
83	* If not already excluded from the accessibility tree per the above rules,
84	* user agents SHOULD NOT include the following elements
85	* in the accessibility tree:
86	* - Elements, including their descendants, that have aria-hidden set to true.
87	* In other words, aria-hidden="true" on a parent overrides aria-hidden="false"
88	* on descendants.
89	*/
90	{
91	let currentEl: Element \| null = el;	13✔
92	while (currentEl) {	13✔
93	if (currentEl.getAttribute('aria-hidden') === 'true') {	47✔
94	return true;	2✔
95	}
96	currentEl = currentEl.parentElement;	45✔
97	}
98	}
99
100	/**
101	* - Any descendants of elements that have the characteristic
102	* "Children Presentational: True" unless the descendant
103	* is not allowed to be presentational because it meets one of
104	* the conditions for exception described in
105	* Presentational Roles Conflict Resolution.
106	* However, the text content of any excluded descendants is included.
107	*/
108	{
109	let currentEl = el.parentElement;	11✔
110	while (currentEl) {	11✔
111	const { role } = getComputedRole(specs, currentEl, version);	30✔
112	if (role?.childrenPresentational) {	30!
113	return true;	1✔
114	}
115	currentEl = currentEl.parentElement;	29✔
116	}
117	}
118
119	return false;	10✔
120	}
121
122	/**
123	* Including Elements in the Accessibility Tree
124	*
125	* If not excluded from or marked as hidden in the accessibility tree
126	* per the rules above in Excluding Elements in the Accessibility Tree,
127	* user agents MUST provide an accessible object in the accessibility tree
128	* for DOM elements that meet any of the following criteria:
129	*
130	* @see https://www.w3.org/TR/wai-aria-1.2/#tree_inclusion
131	*
132	* @param specs
133	* @param el
134	* @param version
135	*/
136	function isIncluding(el: Element, specs: Readonly<MLMLSpec>, version: ARIAVersion): boolean {
137	/**
138	* > meet any of the following criteria:
139	*/
140	const results: boolean[] = [];	6✔
141
142	/**
143	* Elements that are not hidden and may fire an accessibility API event,
144	* including:
145	* - Elements that are currently focused, even if the element or one of
146	* its ancestor elements has its aria-hidden attribute set to true.
147	*/
148	// 🚫 Can't detect the element is focused.
149	// results.push(true);
150
151	/**
152	* - Elements that are a valid target of an aria-activedescendant attribute.
153	*/
154	// TODO: Compute aria-activedescendant.
155	// results.push(true);
156
157	/**
158	* Elements that have an explicit role or a global WAI-ARIA attribute and
159	* do not have aria-hidden set to true.
160	* (See Excluding Elements in the Accessibility Tree for
161	* additional guidance on aria-hidden.)
162	*/
163	if (el.getAttribute('aria-hidden') !== 'true') {	6✔
164	const globalAria = ariaSpecs(specs, version).props.filter(prop => prop.isGlobal);	288✔
165	const { role } = getComputedRole(specs, el, version);	6✔
166	// Has an explicit role
167	if (role && !role.isImplicit) {	6!
168	results.push(true);	×
169	}
170	// Has a global WAI-ARIA attribute
171	for (const attr of Array.from(el.attributes)) {	6✔
172	if (globalAria.some(aria => aria.name === attr.localName)) {	21!
173	results.push(true);	×
174	break;	×
175	}
176	}
177	}
178
179	/**
180	* Elements that are not hidden and have an ID that is referenced
181	* by another element via a WAI-ARIA property.
182	*/
183	// TODO: Compute refering ID.
184	// results.push(true);
185
186	return results.includes(true);	6✔
187	}
188
189	function hasDisplayNodeOrVisibilityHidden(el: Element) {
190	const style = el.getAttribute('style');	70✔
191	if (!style) {	70✔
192	return false;	69✔
193	}
194	// TODO: Improve accuracy
195	return /display\s:\snone\|visibility\s:\shidden/gi.test(style);	1✔
196	}

markuplint / markuplint / #2405

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous