accented 0.0.2 → 1.0.1

package/dist/scanner.js

@@ -1,16 +1,18 @@
 import axe from 'axe-core';
-import TaskQueue from './task-queue.js';
+import { getAccentedElementNames, issuesUrl } from './constants.js';
+import { logAndRethrow } from './log-and-rethrow.js';
 import { elementsWithIssues, enabled, extendedElementsWithIssues } from './state.js';
-import updateElementsWithIssues from './utils/update-elements-with-issues.js';
-import recalculatePositions from './utils/recalculate-positions.js';
-import recalculateScrollableAncestors from './utils/recalculate-scrollable-ancestors.js';
-import supportsAnchorPositioning from './utils/supports-anchor-positioning.js';
-import { issuesUrl } from './constants.js';
-import logAndRethrow from './log-and-rethrow.js';
-export default function createScanner(name, axeContext, axeOptions, throttle, callback) {
+import { TaskQueue } from './task-queue.js';
+import { getScanContext } from './utils/get-scan-context.js';
+import { recalculatePositions } from './utils/recalculate-positions.js';
+import { recalculateScrollableAncestors } from './utils/recalculate-scrollable-ancestors.js';
+import { createShadowDOMAwareMutationObserver } from './utils/shadow-dom-aware-mutation-observer.js';
+import { supportsAnchorPositioning } from './utils/supports-anchor-positioning.js';
+import { updateElementsWithIssues } from './utils/update-elements-with-issues.js';
+export function createScanner(name, context, axeOptions, throttle, callback) {
     const axeRunningWindowProp = `__${name}_axe_running__`;
     const win = window;
-    const taskQueue = new TaskQueue(async () => {
+    const taskQueue = new TaskQueue(async (nodes) => {
         // We may see errors coming from axe-core when Accented is toggled off and on in qiuck succession,
         // which I've seen happen with hot reloading of a React application.
         // This window property serves as a circuit breaker for that particular case.
@@ -18,40 +20,75 @@ export default function createScanner(name, axeContext, axeOptions, throttle, ca
             return;
         }
         try {
-            performance.mark('axe-start');
+            performance.mark('scan-start');
             win[axeRunningWindowProp] = true;
+            const scanContext = getScanContext(nodes, context);
             let result;
             try {
-                // TODO (https://github.com/pomerantsev/accented/issues/102):
-                // only run Axe on what's changed, not on the whole axeContext
-                result = await axe.run(axeContext, {
+                result = await axe.run(scanContext, {
+                    /**
+                     * By default, axe-core doesn't include element refs
+                     * in the violations array,
+                     * and we need those element refs.
+                     */
                     elementRef: true,
-                    // Although axe-core can perform iframe scanning, I haven't succeeded in it,
-                    // and the docs suggest that the axe-core script should be explicitly included
-                    // in each of the iframed documents anyway.
-                    // It seems preferable to disallow iframe scanning and not report issues in elements within iframes
-                    // in the case that such issues are for some reason reported by axe-core.
-                    // A consumer of Accented can instead scan the iframed document by calling Accented initialization from that document.
+                    /**
+                     * Although axe-core can perform iframe scanning, I haven't succeeded in it,
+                     * and the docs suggest that the axe-core script should be explicitly included
+                     * in each of the iframed documents anyway.
+                     * It seems preferable to disallow iframe scanning and not report issues in elements within iframes
+                     * in the case that such issues are for some reason reported by axe-core.
+                     * A consumer of Accented can instead scan the iframed document by calling Accented initialization from that document.
+                     */
                     iframes: false,
+                    /**
+                     * The `preload` docs are not clear to me,
+                     * but when it's set to `true` by default,
+                     * axe-core tries to fetch cross-origin CSS,
+                     * which fails in the absence of CORS headers.
+                     * I'm not sure why axe-core needs to preload
+                     * those resources in the first place,
+                     * so disabling it seems to be the safe option.
+                     */
+                    preload: false,
+                    /**
+                     * We're only interested in violations,
+                     * not in passes or incomplete results.
+                     */
                     resultTypes: ['violations'],
-                    ...axeOptions
+                    ...axeOptions,
                 });
             }
             catch (error) {
-                console.error('Accented: axe-core (the accessibility testing engine) threw an error. ' +
-                    'Check the `axeOptions` property that you’re passing to Accented. ' +
-                    `If you still think it’s a bug in Accented, file an issue at ${issuesUrl}.\n`, error);
-                result = { violations: [] };
+                console.error(`Accented: axe-core (the accessibility testing engine) threw an error. Check the \`axeOptions\` property (https://accented.dev/api#axeoptions) that you’re passing to Accented. If you still think it’s a bug in Accented, file an issue at ${issuesUrl}.\n`, error);
             }
             win[axeRunningWindowProp] = false;
-            const axeMeasure = performance.measure('axe', 'axe-start');
-            if (!enabled.value) {
+            const scanMeasure = performance.measure('scan', 'scan-start');
+            const scanDuration = Math.round(scanMeasure.duration);
+            if (!enabled.value || !result) {
                 return;
             }
-            updateElementsWithIssues(extendedElementsWithIssues, result.violations, window, name);
+            performance.mark('dom-update-start');
+            updateElementsWithIssues({
+                extendedElementsWithIssues,
+                scanContext,
+                violations: result.violations,
+                win: window,
+                name,
+            });
+            const domUpdateMeasure = performance.measure('dom-update', 'dom-update-start');
+            const domUpdateDuration = Math.round(domUpdateMeasure.duration);
             callback({
+                // Assuming that the {include, exclude} shape of the context object will be used less often
+                // than other variants, we'll output just the `include` array in case nothing is excluded
+                // in the scan.
+                scanContext: scanContext.exclude.length > 0 ? scanContext : scanContext.include,
                 elementsWithIssues: elementsWithIssues.value,
-                scanDuration: Math.round(axeMeasure.duration)
+                performance: {
+                    totalBlockingTime: scanDuration + domUpdateDuration,
+                    scan: scanDuration,
+                    domUpdate: domUpdateDuration,
+                },
             });
         }
         catch (error) {
@@ -59,19 +96,16 @@ export default function createScanner(name, axeContext, axeOptions, throttle, ca
             logAndRethrow(error);
         }
     }, throttle);
-    // TODO (https://github.com/pomerantsev/accented/issues/102):
-    // limit to what's in axeContext,
-    // if that's an element or array of elements (not a selector).
     taskQueue.add(document);
-    const accentedElementNames = [`${name}-trigger`, `${name}-dialog`];
-    const mutationObserver = new MutationObserver(mutationList => {
+    const accentedElementNames = getAccentedElementNames(name);
+    const mutationObserver = createShadowDOMAwareMutationObserver(name, (mutationList) => {
         try {
             // We're not interested in mutations that are caused exclusively by the custom elements
             // introduced by Accented.
-            const listWithoutAccentedElements = mutationList.filter(mutationRecord => {
+            const listWithoutAccentedElements = mutationList.filter((mutationRecord) => {
                 const onlyAccentedElementsAddedOrRemoved = mutationRecord.type === 'childList' &&
-                    [...mutationRecord.addedNodes].every(node => accentedElementNames.includes(node.nodeName.toLowerCase())) &&
-                    [...mutationRecord.removedNodes].every(node => accentedElementNames.includes(node.nodeName.toLowerCase()));
+                    [...mutationRecord.addedNodes].every((node) => accentedElementNames.includes(node.nodeName.toLowerCase())) &&
+                    [...mutationRecord.removedNodes].every((node) => accentedElementNames.includes(node.nodeName.toLowerCase()));
                 const accentedElementChanged = mutationRecord.type === 'attributes' &&
                     accentedElementNames.includes(mutationRecord.target.nodeName.toLowerCase());
                 return !(onlyAccentedElementsAddedOrRemoved || accentedElementChanged);
@@ -90,28 +124,27 @@ export default function createScanner(name, axeContext, axeOptions, throttle, ca
             // we may miss other mutations on those same elements caused by Accented,
             // leading to extra runs of the mutation observer.
             const elementsWithAccentedAttributeChanges = listWithoutAccentedElements.reduce((nodes, mutationRecord) => {
-                if (mutationRecord.type === 'attributes' && mutationRecord.attributeName === `data-${name}`) {
+                if (mutationRecord.type === 'attributes' &&
+                    mutationRecord.attributeName === `data-${name}`) {
                     nodes.add(mutationRecord.target);
                 }
                 return nodes;
             }, new Set());
-            const filteredMutationList = listWithoutAccentedElements.filter(mutationRecord => {
+            const filteredMutationList = listWithoutAccentedElements.filter((mutationRecord) => {
                 return !elementsWithAccentedAttributeChanges.has(mutationRecord.target);
             });
-            taskQueue.addMultiple(filteredMutationList.map(mutationRecord => mutationRecord.target));
+            const nodes = filteredMutationList.map((mutationRecord) => mutationRecord.target);
+            taskQueue.addMultiple(nodes);
         }
         catch (error) {
             logAndRethrow(error);
         }
     });
-    // TODO (https://github.com/pomerantsev/accented/issues/102):
-    // possibly limit the observer to what's in axeContext,
-    // if that's an element or array of elements (not a selector).
     mutationObserver.observe(document, {
         subtree: true,
         childList: true,
         attributes: true,
-        characterData: true
+        characterData: true,
     });
     return () => {
         mutationObserver.disconnect();

package/dist/scanner.js.map

@@ -1 +1 @@
-{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAErF,OAAO,wBAAwB,MAAM,wCAAwC,CAAC;AAC9E,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,8BAA8B,MAAM,6CAA6C,CAAC;AACzF,OAAO,yBAAyB,MAAM,wCAAwC,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,aAAa,MAAM,sBAAsB,CAAC;AAEjD,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,IAAY,EAAE,UAAsB,EAAE,UAAsB,EAAE,QAA4B,EAAE,QAAkB;IAClJ,MAAM,oBAAoB,GAAG,KAAK,IAAI,gBAAgB,CAAC;IACvD,MAAM,GAAG,GAAwB,MAAM,CAAC;IACxC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAO,KAAK,IAAI,EAAE;QAC/C,kGAAkG;QAClG,oEAAoE;QACpE,6EAA6E;QAC7E,IAAI,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YAEH,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAE9B,GAAG,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;YAEjC,IAAI,MAAM,CAAC;YAEX,IAAI,CAAC;gBACH,6DAA6D;gBAC7D,8DAA8D;gBAC9D,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE;oBACjC,UAAU,EAAE,IAAI;oBAChB,4EAA4E;oBAC5E,8EAA8E;oBAC9E,2CAA2C;oBAC3C,mGAAmG;oBACnG,yEAAyE;oBACzE,sHAAsH;oBACtH,OAAO,EAAE,KAAK;oBACd,WAAW,EAAE,CAAC,YAAY,CAAC;oBAC3B,GAAG,UAAU;iBACd,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CACX,wEAAwE;oBACtE,mEAAmE;oBACnE,+DAA+D,SAAS,KAAK,EAC/E,KAAK,CACN,CAAC;gBACF,MAAM,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;YAC9B,CAAC;YACD,GAAG,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC;YAElC,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAE3D,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,wBAAwB,CAAC,0BAA0B,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YAEtF,QAAQ,CAAC;gBACP,kBAAkB,EAAE,kBAAkB,CAAC,KAAK;gBAC5C,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC;aAC9C,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC;YAClC,aAAa,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEb,6DAA6D;IAC7D,iCAAiC;IACjC,8DAA8D;IAC9D,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAExB,MAAM,oBAAoB,GAAG,CAAC,GAAG,IAAI,UAAU,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC;IACnE,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,YAAY,CAAC,EAAE;QAC3D,IAAI,CAAC;YACH,uFAAuF;YACvF,0BAA0B;YAC1B,MAAM,2BAA2B,GAAG,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE;gBACvE,MAAM,kCAAkC,GAAG,cAAc,CAAC,IAAI,KAAK,WAAW;oBAC5E,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;oBACxG,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBAC7G,MAAM,sBAAsB,GAAG,cAAc,CAAC,IAAI,KAAK,YAAY;oBACjE,oBAAoB,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;gBAC9E,OAAO,CAAC,CAAC,kCAAkC,IAAI,sBAAsB,CAAC,CAAC;YACzE,CAAC,CAAC,CAAC;YAEH,IAAI,2BAA2B,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnF,iGAAiG;gBACjG,oBAAoB,EAAE,CAAC;gBAEvB,gEAAgE;gBAChE,0EAA0E;gBAC1E,gFAAgF;gBAChF,uHAAuH;gBACvH,8BAA8B,EAAE,CAAC;YACnC,CAAC;YAED,sFAAsF;YACtF,2EAA2E;YAC3E,yEAAyE;YACzE,kDAAkD;YAClD,MAAM,oCAAoC,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;gBACxG,IAAI,cAAc,CAAC,IAAI,KAAK,YAAY,IAAI,cAAc,CAAC,aAAa,KAAK,QAAQ,IAAI,EAAE,EAAE,CAAC;oBAC5F,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBACnC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,EAAE,IAAI,GAAG,EAAQ,CAAC,CAAC;YAEpB,MAAM,oBAAoB,GAAG,2BAA2B,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE;gBAC/E,OAAO,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAC1E,CAAC,CAAC,CAAC;YAEH,SAAS,CAAC,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,6DAA6D;IAC7D,uDAAuD;IACvD,8DAA8D;IAC9D,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE;QACjC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE,IAAI;KACpB,CAAC,CAAC;IAEH,OAAO,GAAG,EAAE;QACV,gBAAgB,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../src/scanner.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,MAAM,6CAA6C,CAAC;AAC7F,OAAO,EAAE,oCAAoC,EAAE,MAAM,+CAA+C,CAAC;AACrG,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAElF,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,OAAgB,EAChB,UAAsB,EACtB,QAA4B,EAC5B,QAAkB;IAElB,MAAM,oBAAoB,GAAG,KAAK,IAAI,gBAAgB,CAAC;IACvD,MAAM,GAAG,GAAG,MAA4C,CAAC;IACzD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAO,KAAK,EAAE,KAAK,EAAE,EAAE;QACpD,kGAAkG;QAClG,oEAAoE;QACpE,6EAA6E;QAC7E,IAAI,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC;YAC9B,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAE/B,GAAG,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;YAEjC,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAEnD,IAAI,MAAkC,CAAC;YAEvC,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE;oBAClC;;;;uBAIG;oBACH,UAAU,EAAE,IAAI;oBAEhB;;;;;;;uBAOG;oBACH,OAAO,EAAE,KAAK;oBAEd;;;;;;;;uBAQG;oBACH,OAAO,EAAE,KAAK;oBAEd;;;uBAGG;oBACH,WAAW,EAAE,CAAC,YAAY,CAAC;oBAE3B,GAAG,UAAU;iBACd,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CACX,8OAA8O,SAAS,KAAK,EAC5P,KAAK,CACN,CAAC;YACJ,CAAC;YACD,GAAG,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC;YAElC,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YAC9D,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAEtD,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC9B,OAAO;YACT,CAAC;YAED,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAErC,wBAAwB,CAAC;gBACvB,0BAA0B;gBAC1B,WAAW;gBACX,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,GAAG,EAAE,MAAM;gBACX,IAAI;aACL,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;YAC/E,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAEhE,QAAQ,CAAC;gBACP,2FAA2F;gBAC3F,yFAAyF;gBACzF,eAAe;gBACf,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO;gBAC/E,kBAAkB,EAAE,kBAAkB,CAAC,KAAK;gBAC5C,WAAW,EAAE;oBACX,iBAAiB,EAAE,YAAY,GAAG,iBAAiB;oBACnD,IAAI,EAAE,YAAY;oBAClB,SAAS,EAAE,iBAAiB;iBAC7B;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC;YAClC,aAAa,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEb,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAExB,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,oCAAoC,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,EAAE;QACnF,IAAI,CAAC;YACH,uFAAuF;YACvF,0BAA0B;YAC1B,MAAM,2BAA2B,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE;gBACzE,MAAM,kCAAkC,GACtC,cAAc,CAAC,IAAI,KAAK,WAAW;oBACnC,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAC5C,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAC3D;oBACD,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9C,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAC3D,CAAC;gBACJ,MAAM,sBAAsB,GAC1B,cAAc,CAAC,IAAI,KAAK,YAAY;oBACpC,oBAAoB,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;gBAC9E,OAAO,CAAC,CAAC,kCAAkC,IAAI,sBAAsB,CAAC,CAAC;YACzE,CAAC,CAAC,CAAC;YAEH,IAAI,2BAA2B,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnF,iGAAiG;gBACjG,oBAAoB,EAAE,CAAC;gBAEvB,gEAAgE;gBAChE,0EAA0E;gBAC1E,gFAAgF;gBAChF,uHAAuH;gBACvH,8BAA8B,EAAE,CAAC;YACnC,CAAC;YAED,sFAAsF;YACtF,2EAA2E;YAC3E,yEAAyE;YACzE,kDAAkD;YAClD,MAAM,oCAAoC,GAAG,2BAA2B,CAAC,MAAM,CAC7E,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;gBACxB,IACE,cAAc,CAAC,IAAI,KAAK,YAAY;oBACpC,cAAc,CAAC,aAAa,KAAK,QAAQ,IAAI,EAAE,EAC/C,CAAC;oBACD,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBACnC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,EACD,IAAI,GAAG,EAAQ,CAChB,CAAC;YAEF,MAAM,oBAAoB,GAAG,2BAA2B,CAAC,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE;gBACjF,OAAO,CAAC,oCAAoC,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAC1E,CAAC,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAClF,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE;QACjC,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE,IAAI;KACpB,CAAC,CAAC;IAEH,OAAO,GAAG,EAAE;QACV,gBAAgB,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC,CAAC;AACJ,CAAC"}

package/dist/scroll-listeners.d.ts

@@ -1,2 +1,2 @@
-export default function setupScrollListeners(): () => void;
+export declare function setupScrollListeners(): () => void;
 //# sourceMappingURL=scroll-listeners.d.ts.map

package/dist/scroll-listeners.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scroll-listeners.d.ts","sourceRoot":"","sources":["../src/scroll-listeners.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAU,oBAAoB,eA+B3C"}
+{"version":3,"file":"scroll-listeners.d.ts","sourceRoot":"","sources":["../src/scroll-listeners.ts"],"names":[],"mappings":"AAKA,wBAAgB,oBAAoB,eAuCnC"}

package/dist/scroll-listeners.js

@@ -1,8 +1,8 @@
 import { effect } from '@preact/signals-core';
-import recalculatePositions from './utils/recalculate-positions.js';
+import { logAndRethrow } from './log-and-rethrow.js';
 import { scrollableAncestors } from './state.js';
-import logAndRethrow from './log-and-rethrow.js';
-export default function setupScrollListeners() {
+import { recalculatePositions } from './utils/recalculate-positions.js';
+export function setupScrollListeners() {
     const documentAbortController = new AbortController();
     document.addEventListener('scroll', () => {
         try {
@@ -34,5 +34,4 @@ export default function setupScrollListeners() {
         disposeOfEffect();
     };
 }
-;
 //# sourceMappingURL=scroll-listeners.js.map

package/dist/scroll-listeners.js.map

@@ -1 +1 @@
-{"version":3,"file":"scroll-listeners.js","sourceRoot":"","sources":["../src/scroll-listeners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,aAAa,MAAM,sBAAsB,CAAC;AAEjD,MAAM,CAAC,OAAO,UAAU,oBAAoB;IAC1C,MAAM,uBAAuB,GAAG,IAAI,eAAe,EAAE,CAAC;IACtD,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE;QACvC,IAAI,CAAC;YACH,oBAAoB,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,EAAE,EAAE,MAAM,EAAE,uBAAuB,CAAC,MAAM,EAAE,CAAC,CAAC;IAE/C,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,EAAE;QAClC,wCAAwC;QACxC,MAAM,sBAAsB,GAAG,IAAI,eAAe,EAAE,CAAC;QACrD,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,CAAC,KAAK,EAAE,CAAC;YAC3D,kBAAkB,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACjD,IAAI,CAAC;oBACH,oBAAoB,EAAE,CAAC;gBACzB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,aAAa,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,EAAE,EAAE,MAAM,EAAE,sBAAsB,CAAC,MAAM,EAAE,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,GAAG,EAAE;YACV,sBAAsB,CAAC,KAAK,EAAE,CAAC;QACjC,CAAC,CAAA;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,EAAE;QACV,uBAAuB,CAAC,KAAK,EAAE,CAAC;QAChC,eAAe,EAAE,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAAA,CAAC"}
+{"version":3,"file":"scroll-listeners.js","sourceRoot":"","sources":["../src/scroll-listeners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE,MAAM,UAAU,oBAAoB;IAClC,MAAM,uBAAuB,GAAG,IAAI,eAAe,EAAE,CAAC;IACtD,QAAQ,CAAC,gBAAgB,CACvB,QAAQ,EACR,GAAG,EAAE;QACH,IAAI,CAAC;YACH,oBAAoB,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,EACD,EAAE,MAAM,EAAE,uBAAuB,CAAC,MAAM,EAAE,CAC3C,CAAC;IAEF,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,EAAE;QAClC,wCAAwC;QACxC,MAAM,sBAAsB,GAAG,IAAI,eAAe,EAAE,CAAC;QACrD,KAAK,MAAM,kBAAkB,IAAI,mBAAmB,CAAC,KAAK,EAAE,CAAC;YAC3D,kBAAkB,CAAC,gBAAgB,CACjC,QAAQ,EACR,GAAG,EAAE;gBACH,IAAI,CAAC;oBACH,oBAAoB,EAAE,CAAC;gBACzB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,aAAa,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,EACD,EAAE,MAAM,EAAE,sBAAsB,CAAC,MAAM,EAAE,CAC1C,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,EAAE;YACV,sBAAsB,CAAC,KAAK,EAAE,CAAC;QACjC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,EAAE;QACV,uBAAuB,CAAC,KAAK,EAAE,CAAC;QAChC,eAAe,EAAE,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}

package/dist/state.d.ts

@@ -1,6 +1,7 @@
-import type { ElementWithIssues, ExtendedElementWithIssues } from './types';
+import type { ElementWithIssues, ExtendedElementWithIssues } from './types.ts';
 export declare const enabled: import("@preact/signals-core").Signal<boolean>;
 export declare const extendedElementsWithIssues: import("@preact/signals-core").Signal<ExtendedElementWithIssues[]>;
 export declare const elementsWithIssues: import("@preact/signals-core").ReadonlySignal<ElementWithIssues[]>;
-export declare const scrollableAncestors: import("@preact/signals-core").ReadonlySignal<Set<HTMLElement>>;
+export declare const rootNodes: import("@preact/signals-core").ReadonlySignal<Set<Node>>;
+export declare const scrollableAncestors: import("@preact/signals-core").ReadonlySignal<Set<Element>>;
 //# sourceMappingURL=state.d.ts.map

package/dist/state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAE5E,eAAO,MAAM,OAAO,gDAAgB,CAAC;AAErC,eAAO,MAAM,0BAA0B,oEAA+C,CAAC;AAEvF,eAAO,MAAM,kBAAkB,oEAG3B,CAAC;AAEL,eAAO,MAAM,mBAAmB,iEAU/B,CAAC"}
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAE/E,eAAO,MAAM,OAAO,gDAAgB,CAAC;AAErC,eAAO,MAAM,0BAA0B,oEAA+C,CAAC;AAEvF,eAAO,MAAM,kBAAkB,oEAM9B,CAAC;AAEF,eAAO,MAAM,SAAS,0DASrB,CAAC;AAEF,eAAO,MAAM,mBAAmB,6DAO/B,CAAC"}

package/dist/state.js

@@ -1,10 +1,12 @@
-import { signal, computed } from '@preact/signals-core';
+import { computed, signal } from '@preact/signals-core';
 export const enabled = signal(false);
 export const extendedElementsWithIssues = signal([]);
-export const elementsWithIssues = computed(() => extendedElementsWithIssues.value.map(extendedElementWithIssues => ({
+export const elementsWithIssues = computed(() => extendedElementsWithIssues.value.map((extendedElementWithIssues) => ({
     element: extendedElementWithIssues.element,
-    issues: extendedElementWithIssues.issues.value
+    rootNode: extendedElementWithIssues.rootNode,
+    issues: extendedElementWithIssues.issues.value,
 })));
+export const rootNodes = computed(() => new Set((enabled.value ? [document] : []).concat(...extendedElementsWithIssues.value.map((extendedElementWithIssues) => extendedElementWithIssues.rootNode))));
 export const scrollableAncestors = computed(() => extendedElementsWithIssues.value.reduce((scrollableAncestors, extendedElementWithIssues) => {
     for (const scrollableAncestor of extendedElementWithIssues.scrollableAncestors.value) {
         scrollableAncestors.add(scrollableAncestor);

package/dist/state.js.map

@@ -1 +1 @@
-{"version":3,"file":"state.js","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIxD,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAErC,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAmC,EAAE,CAAC,CAAC;AAEvF,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAA2B,GAAG,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;IAC5I,OAAO,EAAE,yBAAyB,CAAC,OAAO;IAC1C,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,KAAK;CAC/C,CAAC,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,mBAAmB,GAAG,QAAQ,CAAmB,GAAG,EAAE,CACjE,0BAA0B,CAAC,KAAK,CAAC,MAAM,CACrC,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE;IACjD,KAAK,MAAM,kBAAkB,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACrF,mBAAmB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,mBAAmB,CAAC;AAC7B,CAAC,EACD,IAAI,GAAG,EAAe,CACvB,CACF,CAAC"}
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAIxD,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAErC,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAmC,EAAE,CAAC,CAAC;AAEvF,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAA2B,GAAG,EAAE,CACxE,0BAA0B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IACnE,OAAO,EAAE,yBAAyB,CAAC,OAAO;IAC1C,QAAQ,EAAE,yBAAyB,CAAC,QAAQ;IAC5C,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,KAAK;CAC/C,CAAC,CAAC,CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAC/B,GAAG,EAAE,CACH,IAAI,GAAG,CACL,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAC9C,GAAG,0BAA0B,CAAC,KAAK,CAAC,GAAG,CACrC,CAAC,yBAAyB,EAAE,EAAE,CAAC,yBAAyB,CAAC,QAAQ,CAClE,CACF,CACF,CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,QAAQ,CAAe,GAAG,EAAE,CAC7D,0BAA0B,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,yBAAyB,EAAE,EAAE;IACzF,KAAK,MAAM,kBAAkB,IAAI,yBAAyB,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;QACrF,mBAAmB,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,mBAAmB,CAAC;AAC7B,CAAC,EAAE,IAAI,GAAG,EAAW,CAAC,CACvB,CAAC"}

package/dist/task-queue.d.ts

@@ -1,8 +1,8 @@
-import type { Throttle } from './types';
-type TaskCallback = () => void;
-export default class TaskQueue<T> {
+import type { Throttle } from './types.ts';
+type TaskCallback<T> = (items: Array<T>) => void;
+export declare class TaskQueue<T> {
     #private;
-    constructor(asyncCallback: TaskCallback, throttle: Required<Throttle>);
+    constructor(asyncCallback: TaskCallback<T>, throttle: Required<Throttle>);
     addMultiple(items: Array<T>): void;
     add(item: T): void;
 }

package/dist/task-queue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"task-queue.d.ts","sourceRoot":"","sources":["../src/task-queue.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,KAAK,YAAY,GAAG,MAAM,IAAI,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,SAAS,CAAC,CAAC;;gBAOlB,aAAa,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAmCrE,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAS3B,GAAG,CAAC,IAAI,EAAE,CAAC;CAGZ"}
+{"version":3,"file":"task-queue.d.ts","sourceRoot":"","sources":["../src/task-queue.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEjD,qBAAa,SAAS,CAAC,CAAC;;gBAOV,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAqCxE,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IAS3B,GAAG,CAAC,IAAI,EAAE,CAAC;CAGZ"}

package/dist/task-queue.js

@@ -1,4 +1,4 @@
-export default class TaskQueue {
+export class TaskQueue {
     #throttle;
     #asyncCallback = null;
     #items = new Set();
@@ -22,9 +22,10 @@ export default class TaskQueue {
             this.#inRunLoop = false;
             return;
         }
+        const items = Array.from(this.#items);
         this.#items.clear();
         if (this.#asyncCallback) {
-            await this.#asyncCallback();
+            await this.#asyncCallback(items);
         }
         await new Promise((resolve) => setTimeout(resolve, this.#throttle.wait));
         await this.#run();

package/dist/task-queue.js.map

@@ -1 +1 @@
-{"version":3,"file":"task-queue.js","sourceRoot":"","sources":["../src/task-queue.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,SAAS,CAAW;IACpB,cAAc,GAAwB,IAAI,CAAC;IAE3C,MAAM,GAAG,IAAI,GAAG,EAAK,CAAC;IACtB,UAAU,GAAG,KAAK,CAAC;IAEnB,YAAY,aAA2B,EAAE,QAA4B;QACnE,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,CAAC;QAED,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAEpB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC9B,CAAC;QAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAEzE,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAED,WAAW,CAAC,KAAe;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;IACH,CAAC;IAED,GAAG,CAAC,IAAO;QACT,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3B,CAAC;CACF"}
+{"version":3,"file":"task-queue.js","sourceRoot":"","sources":["../src/task-queue.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,SAAS;IACpB,SAAS,CAAW;IACpB,cAAc,GAA2B,IAAI,CAAC;IAE9C,MAAM,GAAG,IAAI,GAAG,EAAK,CAAC;IACtB,UAAU,GAAG,KAAK,CAAC;IAEnB,YAAY,aAA8B,EAAE,QAA4B;QACtE,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3E,CAAC;QAED,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAEpB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAEzE,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAED,WAAW,CAAC,KAAe;QACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;IACH,CAAC;IAED,GAAG,CAAC,IAAO;QACT,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3B,CAAC;CACF"}

package/dist/types.d.ts

@@ -1,62 +1,84 @@
-import type axe from 'axe-core';
 import type { Signal } from '@preact/signals-core';
-import type { AccentedTrigger } from './elements/accented-trigger';
+import type axe from 'axe-core';
+import type { AccentedTrigger } from './elements/accented-trigger.ts';
 export type Throttle = {
     /**
-     * The minimal time between scans.
+     * How long Accented must wait (in milliseconds) to run a scan after a mutation or after the previous scan (whichever finished last).
+     *
+     * If the page you’re scanning has a lot of nodes,
+     * scanning may take a noticeable time (~ a few hundred milliseconds),
+     * during which time the main thread will be blocked most of the time.
      *
-     * Default: `1000`.
+     * You may want to experiment with this value if your page contents change frequently
+     * or if it has JavaScript-based animations running on the main thread.
+     *
+     * @default 1000
      * */
     wait?: number;
     /**
-     * When to run the scan on Accented initialization or on a mutation.
+     * If `leading` is set to `true`, the scan runs immediately after a mutation.
+     * In this case, `wait` only applies to subsequent scans,
+     * giving the page at least `wait` milliseconds between the end of the previous scan
+     * and the beginning of the next one.
      *
-     * If `true`, the scan will run immediately. If `false`, the scan will run after the first throttle delay.
+     * If `leading` is set to `false`, the wait applies to mutations as well,
+     * delaying the output.
+     * This may be useful if you’re expecting quick bursts of mutations on your page.
      *
-     * Default: `true`.
+     * @default true
      * */
     leading?: boolean;
 };
 export type Output = {
     /**
-     * Whether to output the issues to the console.
+     * Whether the list of elements with issues should be printed to the browser console whenever issues are added, removed, or changed.
      *
-     * Default: `true`.
+     * @default true
      * */
     console?: boolean;
 };
-export type AxeContext = axe.ElementContext;
+/**
+ * Model context type based on axe.ElementContext,
+ * excluding frame selectors (since we don't support scanning iframes).
+ */
+export type Selector = Exclude<axe.Selector, axe.LabelledFramesSelector>;
+export type SelectorList = Array<Selector> | NodeList;
+export type ContextProp = Selector | SelectorList;
+export type ContextObject = {
+    include: ContextProp;
+    exclude?: ContextProp;
+} | {
+    exclude: ContextProp;
+    include?: ContextProp;
+};
+export type Context = ContextProp | ContextObject;
 export declare const allowedAxeOptions: readonly ["rules", "runOnly"];
-export type AxeOptions = Pick<axe.RunOptions, typeof allowedAxeOptions[number]>;
+export type AxeOptions = Pick<axe.RunOptions, (typeof allowedAxeOptions)[number]>;
 type CallbackParams = {
     /**
-     * The most current array of elements with issues.
+     * The most up-to-date array of all elements with accessibility issues.
      * */
     elementsWithIssues: Array<ElementWithIssues>;
     /**
-     * How long the scan took in milliseconds.
+     * Runtime performance of the last scan. An object with the following props:
+     * - `totalBlockingTime`: how long the main thread was blocked by Accented during the last scan, in milliseconds.
+     *   It’s further divided into the `scan` and `domUpdate` phases.
+     * - `scan`: how long scanning (the execution of `axe.run()`) took, in milliseconds.
+     * - `domUpdate`: how long the DOM update (adding / removing outlines and dialog trigger buttons) took, in milliseconds.
      * */
-    scanDuration: number;
+    performance: {
+        totalBlockingTime: number;
+        scan: number;
+        domUpdate: number;
+    };
+    /**
+     * Nodes that got scanned. Either an array of nodes,
+     * or an object with `include` and `exclude` properties (if any nodes were excluded).
+     */
+    scanContext: ScanContext | Array<Node>;
 };
 export type Callback = (params: CallbackParams) => void;
 export type AccentedOptions = {
-    /**
-     * The `context` parameter for `axe.run()`.
-     *
-     * Determines what element(s) to scan for accessibility issues.
-     *
-     * Accepts a variety of shapes:
-     * * an element reference;
-     * * a selector;
-     * * a `NodeList`;
-     * * an include / exclude object;
-     * * and more.
-     *
-     * See documentation: https://www.deque.com/axe/core-documentation/api-documentation/#context-parameter
-     *
-     * Default: `document`.
-     */
-    axeContext?: AxeContext;
     /**
      * The `options` parameter for `axe.run()`.
      *
@@ -69,13 +91,70 @@ export type AccentedOptions = {
      *
      * See documentation: https://www.deque.com/axe/core-documentation/api-documentation/#options-parameter
      *
-     * Default: `{}`.
+     * @default {}
      */
     axeOptions?: AxeOptions;
+    /**
+     * A function that will be called after each scan.
+     *
+     * Potential uses:
+  
+     * - do something with the scan results,
+     * for example send them to a backend for storage and analysis;
+     * - analyze Accented’s performance.
+     *
+     * @default () => {}
+     *
+     * @example
+     *
+     * accented({
+     *   callback: ({ elementsWithIssues, performance, scanContext }) => {
+     *     console.log('Elements with issues:', elementsWithIssues);
+     *     console.log('Total blocking time:', performance.totalBlockingTime);
+     *     console.log('Scan context:', scanContext);
+     *   }
+     * });
+     *
+     * */
+    callback?: Callback;
+    /**
+     * The `context` parameter for `axe.run()`.
+     *
+     * Determines what part(s) of the page to scan for accessibility issues.
+     *
+     * Accepts a variety of shapes:
+     *
+     * - a [`Node`](https://developer.mozilla.org/en-US/docs/Web/API/Node) (in practice it will likely be an instance of [`Element`](https://developer.mozilla.org/en-US/docs/Web/API/Element), [`Document`](https://developer.mozilla.org/en-US/docs/Web/API/Document), or [`DocumentFragment`](https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment));
+     * - a valid [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors);
+     * - an object for selecting elements within shadow DOM,
+     *   whose shape is `{ fromShadowDom: [selector1, selector2, ...] }`,
+     *   where `selector1`, `selector2`, etc. select shadow hosts, and the last selector selects the actual context.
+     *   `selector2` in this example is _within_ the shadow root created on the element(s) that match `selector1`,
+     *   so in practice you shouldn’t have more than two elements in such an array
+     *   unless you have a very complex structure with multiple shadow DOM layers;
+     * - a [`NodeList`](https://developer.mozilla.org/en-US/docs/Web/API/NodeList) (likely a result of a [`querySelectorAll()`](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll) call);
+     * - an array containing any combination of selectors, nodes, or shadow DOM objects (described above);
+     * - an object containing `include` and / or `exclude` properties.
+     *   It’s useful if you’d like to exclude certain elements or parts of the page.
+     *   The values for `include` and `exclude` can take any of the above shapes.
+     *   It’s unlikely that you’d want to have complex `include` / `exclude` rules,
+     *   but if you do, the exact behavior is documented by the relevant tests:
+     *   [`is-node-in-scan-context.test.ts`](https://github.com/pomerantsev/accented/blob/main/packages/accented/src/utils/is-node-in-scan-context.test.ts).
+     *
+     * See also the documentation for the [`context` parameter of `axe.run()`](https://www.deque.com/axe/core-documentation/api-documentation/#context-parameter),
+     * which the `context` option from Accented mostly mirrors
+     * (note that Accented doesn’t support the `fromFrames` object shape).
+     *
+     * @default document
+     */
+    context?: Context;
     /**
      * The character sequence that’s used in various elements, attributes and stylesheets that Accented adds to the page.
+     *
+     * You shouldn’t have to provide this prop unless some of the names on your page have "accented" in it and conflict with what Accented provides by default.
+     *
      * * The data attribute that’s added to elements with issues (default: `data-accented`).
-     * * The custom elements for the button and the dialog that get created for each element with issues
+     * * The names of custom elements for the button and the dialog that get created for each element with issues
      *   (default: `accented-trigger`, `accented-dialog`).
      * * The CSS cascade layer containing page-wide Accented-specific styles (default: `accented`).
      * * The prefix for some of the CSS custom properties used by Accented (default: `--accented-`).
@@ -85,23 +164,25 @@ export type AccentedOptions = {
      * Only lowercase alphanumeric characters and dashes (-) are allowed in the name,
      * and it must start with a lowercase letter.
      *
-     * Default: `accented`.
+     * @default 'accented'
+     *
+     * @example
+     *
+     * accented({name: 'my-name'});
+     *
+     * With the above option provided, the attribute set on elements with issues will be `data-my-name`,
+     * a custom element will be called `my-name-trigger`, and so on.
+     *
      */
     name?: string;
     /**
-     * Output options object.
+     * An object controlling how the results of scans are presented.
      * */
     output?: Output;
     /**
-     * Scan throttling options object.
+     * An object controlling at what moments Accented will run its scans.
      * */
     throttle?: Throttle;
-    /**
-     * A callback that will be called after each scan.
-     *
-     * Default: `() => {}`.
-     * */
-    callback?: Callback;
 };
 /**
  * A function that fully disables Accented,
@@ -109,9 +190,10 @@ export type AccentedOptions = {
  */
 export type DisableAccented = () => void;
 export type Position = {
-    inlineEndLeft: number;
-    blockStartTop: number;
-    direction: 'ltr' | 'rtl';
+    left: number;
+    top: number;
+    width: number;
+    height: number;
 };
 export type Issue = {
     id: string;
@@ -120,17 +202,26 @@ export type Issue = {
     url: string;
     impact: axe.ImpactValue;
 };
-export type ElementWithIssues = {
-    element: HTMLElement;
+export type BaseElementWithIssues = {
+    element: HTMLElement | SVGElement;
+    rootNode: Node;
+};
+export type ElementWithIssues = BaseElementWithIssues & {
     issues: Array<Issue>;
 };
-export type ExtendedElementWithIssues = Omit<ElementWithIssues, 'issues'> & {
+export type ExtendedElementWithIssues = BaseElementWithIssues & {
     issues: Signal<ElementWithIssues['issues']>;
     visible: Signal<boolean>;
     trigger: AccentedTrigger;
     position: Signal<Position>;
-    scrollableAncestors: Signal<Set<HTMLElement>>;
+    skipRender: boolean;
+    anchorNameValue: string;
+    scrollableAncestors: Signal<Set<Element>>;
     id: number;
 };
+export type ScanContext = {
+    include: Array<Node>;
+    exclude: Array<Node>;
+};
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC;AAChC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;SAIK;IACL,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;SAMK;IACL,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB;;;;SAIK;IACL,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,cAAc,CAAC;AAE5C,eAAO,MAAM,iBAAiB,+BAAgC,CAAC;AAE/D,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;AAEhF,KAAK,cAAc,GAAG;IACpB;;SAEK;IACL,kBAAkB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE7C;;SAEK;IACL,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;AAExD,MAAM,MAAM,eAAe,GAAG;IAE5B;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;SAEK;IACL,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;SAEK;IACL,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;;SAIK;IACL,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC;AAEzC,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,KAAK,GAAG,KAAK,CAAA;CACzB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,GAAG,CAAC,WAAW,CAAA;CACxB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC,GAAG;IAC1E,MAAM,EAAE,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAA;IAC7C,EAAE,EAAE,MAAM,CAAA;CACX,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC;AAChC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEtE,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;;;;;;;;SAWK;IACL,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;SAWK;IACL,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB;;;;SAIK;IACL,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AAEH,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAIzE,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAGtD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,YAAY,CAAC;AAElD,MAAM,MAAM,aAAa,GACrB;IACE,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,GACD;IACE,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEN,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,aAAa,CAAC;AAElD,eAAO,MAAM,iBAAiB,+BAAgC,CAAC;AAE/D,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAElF,KAAK,cAAc,GAAG;IACpB;;SAEK;IACL,kBAAkB,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAE7C;;;;;;SAMK;IACL,WAAW,EAAE;QACX,iBAAiB,EAAE,MAAM,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF;;;OAGG;IACH,WAAW,EAAE,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;AAExD,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;SAqBK;IACL,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;SAEK;IACL,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;SAEK;IACL,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC;AAEzC,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,GAAG,CAAC,WAAW,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,WAAW,GAAG,UAAU,CAAC;IAClC,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG;IACtD,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,qBAAqB,GAAG;IAC9D,MAAM,EAAE,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACzB,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;CACtB,CAAC"}